Skip to main content
POST
/
api
/
v1
/
analyses
/
batch
Batch submit
curl --request POST \
  --url https://shelfforce.ai/api/v1/analyses/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "images": [
    {
      "imageUrl": "<string>",
      "placeId": "<string>",
      "taskId": "<string>",
      "externalId": "<string>",
      "metadata": {}
    }
  ],
  "callbackUrl": "<string>"
}
'
{
  "data": {
    "analyses": [
      {
        "id": "<string>",
        "imageUrl": "<string>",
        "status": "<string>"
      }
    ],
    "creditsConsumed": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If a request with the same key was already processed within the last 24 hours, the cached response is returned with X-Idempotent-Replayed: true.

Example:

"idk_550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
images
object[]
required

Array of image submissions. Max size depends on your plan tier (20-200). Check GET /api/v1/usage for your maxBatchSize.

Minimum array length: 1
​
callbackUrl
string<uri>

HTTPS URL to receive a signed POST when each analysis completes or fails. A callbackSecret is returned per analysis for signature verification.

Example:

"https://your-app.com/callbacks/shelfforce"

Response

Batch accepted. All analyses are queued.

​
data
object
required