batches

Submit 1 to plan limit jobs atomically

post/v1/batches

Request

  • Base URL: https://api.transcriptdock.com
  • URL: https://api.transcriptdock.com/v1/batches
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sb-access-token

Headers

Idempotency-Keystring required

Workspace plus endpoint scoped replay key, 8 to 128 ASCII chars

Request body

metadataobject
webhook_endpoint_idstring uuid nullable

Response

Same batch idempotency key replayed

idstring uuid required

Batch id; use with GET /v1/batches/{id}.

status'queued' | 'processing' | 'succeeded' | 'partial_success' | 'failed' | 'cancelled' required

Aggregate of the child jobs: partial_success when some succeeded and some failed.

total_itemsinteger required

Number of submitted items; duplicate URLs share one child job.

succeeded_itemsinteger required

Items whose child job succeeded.

failed_itemsinteger required

Items whose child job failed.

cancelled_itemsinteger required

Items whose child job was cancelled.

child_job_idsstring[] required

Distinct child job ids, in item order.

created_atstring date-time required

Submission time, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.