Agents

Trigger Agent

Trigger an agent with an arbitrary JSON payload. Tembo passes the request body to the agent as event context, so the agent can use values such as issue URLs, ticket IDs, Slack thread links, Sentry event IDs, priorities, or customer-provided instructions.

If the agent has a post-trigger hook, Tembo also exposes the same request body to that hook as the TRIGGER_PAYLOAD environment variable. To add dynamically fetched context to the agent’s starting thread, have the hook print the final useful context to standard output.

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

curl -s -X POST \
  "https://api.tembo.io/agent/${AGENT_ID}/trigger" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"issue_url": "https://github.com/org/repo/issues/42"}' | jq .

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task": "RunAgent",
  "status": "pending",
  "priority": 5,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "Agent not found"
}

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 and, when configured, to the post-trigger hook as TRIGGER_PAYLOAD.

The body is of type object.

Response

Agent triggered successfully

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

⌘I

curl -s -X POST \
  "https://api.tembo.io/agent/${AGENT_ID}/trigger" \
  -H "Authorization: Bearer ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"issue_url": "https://github.com/org/repo/issues/42"}' | jq .

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task": "RunAgent",
  "status": "pending",
  "priority": 5,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": "Agent not found"
}