Skip to main content

​
API reference

Pindeck exposes HTTP endpoints through Convex HTTP actions. These endpoints allow agents, automations, and external services like Discord or Pinterest import workers to send images into Pindeck programmatically.

​
Base URL

​
Authentication

All endpoints require a bearer token in the Authorization header:
The INGEST_API_KEY is configured in the Convex dashboard and must match the key used by the calling service.

​
Available endpoints

​
Agent integrations

Start with Agent ingest when building a connector that watches another service and forwards images into Pindeck. It covers required fields, idempotency keys, source tracing, and a JavaScript fetch helper.

​
Request format

All endpoints accept POST requests with JSON bodies. Content type should be application/json.

​
Response format

Responses are JSON objects. Successful responses include the relevant data; errors return a JSON object with an error field describing the issue.

​
Rate limits

Convex HTTP actions are subject to Convex’s standard rate limits. For high-volume ingest, consider batching or implementing backoff logic in the calling service.