Agents
Trigger Agent
Trigger an agent with an arbitrary JSON payload.
POST
Path Parameters
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
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
Unique identifier for the queued job
The type of job that was queued
Example:
"RunAgent"
Current status of the job
Example:
"pending"
Job priority
Example:
5