Sign in

v1

latestOpenAPI 3.1.02026-07-266016.5 KB

Trigger Agent

Trigger an agent with an arbitrary JSON payload, which is passed to the agent as event context.

You can identify the agent by either its UUID or its macro (key). The API key can be supplied via the Authorization: Bearer header or the apiKey query parameter.

post/agent/{keyOrId}/trigger

Path parameters

keyOrIdstring required
Example:a1b2c3d4-5678-9abc-def0-1234567890ab

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

Query parameters

apiKeystring

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

Request body

object required

Example request

{
  "issue_url": "https://github.com/org/repo/issues/42",
  "priority": "high"
}

Response

Agent triggered successfully

idstring uuid required

Unique identifier for the queued job

taskstring required

The type of job that was queued

statusstring required

Current status of the job

priorityinteger required

Job priority

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "task": "RunAgent",
  "status": "pending",
  "priority": 5
}