Skip to main content
GET
Retrieve an egocentric batch
Use counts to follow progress and done to identify a finished batch. done: true means every job is either completed or failed; inspect the individual jobs to distinguish their outcomes. See progress and timing for the difference between execution timestamps and final completion. 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

Path Parameters

batch_id
string
required

Batch identifier.

Response

Batch

Progress, options, and timing for a batch of videos.

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.