Skip to main content
POST
Submit an egocentric batch
Submit video URLs with one shared set of annotation options. A successful response returns 202, a batch ID, and job IDs in input order. Media validation and annotation happen asynchronously. Use one Idempotency-Key for each intended batch. Keys are scoped to your organization. Repeat the same key and request to recover an accepted batch; a changed request with that key returns 409. See submission and replay examples. For authentication, limits, and HTTP errors, see the workflow and error guide.

Authorizations

Authorization
string
header
required

Bearer token authentication using your Perceptron API key

Headers

Idempotency-Key
string
required

A single organization-scoped key of 1 to 255 visible ASCII characters; reuse only with the same request.

Required string length: 1 - 255

Body

application/json

Submit videos for annotation with shared options.

inputs
object[]
required

Videos to annotate, in the order their jobs will be returned.

Required array length: 1 - 1000 elements
hand_activity
boolean

Include hand activity annotations; defaults to true.

hand_tracking

Hand tracking selection; omitted or true enables the default 2d output, and false disables it.

Response

Batch accepted

The current batch and its job identifiers, in the original input order.

counts
object
required

Job counts by public state, including zero counts.

created_at
string<date-time>
required

UTC time the batch was accepted.

done
boolean
required

True once every job has completed or failed.

execution_finished_at
string<date-time> | null
required

Latest actual execution end once every job has a known end or is confirmed never to have run. Null if any end is unknown or no job ran.

finished_at
string<date-time> | null
required

Time the last job finished; null until done is true.

id
string
required

Unique batch identifier.

job_count
integer<int32>
required

Number of submitted inputs and jobs.

Required range: 1 <= x <= 1000
object
string
required

Object type, always egocentric.batch.

Example:

"egocentric.batch"

options
object
required

Options applied to every job, with defaults filled in at acceptance.

started_at
string<date-time> | null
required

Earliest known actual execution start across its jobs; null if no start is known.

jobs
object[]
required

Accepted job identifiers in the same order as the submitted inputs.