Skip to main content
An actor is the user, API key, or system process that performed an action. Task batches return their actor in created_by, so you can tell manual operations from automated ones and build an audit trail.

Actor types

The type field tells you which kind of actor you are looking at.

Actor fields

Every actor has the same fields, whatever its type. A user actor:
An apikey actor:
A system actor:

Actors in task batches

When you create, list, or get a task batch, created_by holds the actor that created it:

When actor information is missing

created_by doesn’t always identify a person or key. Handle these cases in your integration:

See also

  • Tasks: create task batches and track their results
  • Authentication: create a Workspace API Key