Create a batch

post/v1/batches

Create a new batch processing job for up to 10,000 pieces of content. Returns a presigned S3 URL where you can upload your CSV file containing items to process.

Body ParametersExpand Collapse

type: string

Type of content to review

ReturnsExpand Collapse

batch_id: string

Unique identifier for the batch

batch_status: "WAITING_FOR_UPLOAD" or "PENDING" or "SUCCESS" or 2 more

Status of the batch

Accepts one of the following:

"WAITING_FOR_UPLOAD"

"PENDING"

"SUCCESS"

"ERROR"

"CANCELLED"

download_url: string

Download URL (null until batch is complete)

upload_url: string

Presigned S3 URL for uploading the batch CSV file

Create a batch

curl https://api.safetykit.com/v1/batches \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $SAFETYKIT_API_KEY" \
    -d '{
          "type": "product_review"
        }'

{
  "batch_id": "batch_01hexzqs3n8hx83psy4ernj2zz",
  "batch_status": "WAITING_FOR_UPLOAD",
  "download_url": null,
  "upload_url": "https://safetykit-batch-uploads-production.s3.us-west-2.amazonaws.com/..."
}

Returns Examples

{
  "batch_id": "batch_01hexzqs3n8hx83psy4ernj2zz",
  "batch_status": "WAITING_FOR_UPLOAD",
  "download_url": null,
  "upload_url": "https://safetykit-batch-uploads-production.s3.us-west-2.amazonaws.com/..."
}