Skip to main content
POST

Path Parameters

keyOrId
string
required

The agent's UUID or its macro (key). You can find the UUID in the agent's properties panel.

Example:

"a1b2c3d4-5678-9abc-def0-1234567890ab"

Query Parameters

apiKey
string

API key for authentication. Alternative to using the Authorization header.

Body

application/json

Arbitrary JSON payload passed to the agent as event context. Your agent instructions can reference any values in this payload.

The body is of type object.

Response

Agent triggered successfully

id
string<uuid>
required

Unique identifier for the queued job

task
string
required

The type of job that was queued

Example:

"RunAgent"

status
string
required

Current status of the job

Example:

"pending"

priority
integer
required

Job priority

Example:

5

createdAt
string<date-time>
required
updatedAt
string<date-time>
required