Get Agent Trigger

Beta

GET

https://api.speechify.ai/v1/agents/:agent_id/triggers/:trigger_id

GET

/v1/agents/:agent_id/triggers/:trigger_id

$ curl https://api.speechify.ai/v1/agents/agent_01jqr8x9zg5k2m3n4p5q6r7s8t/triggers/trigger_01jqr8x9zg5k2m3n4p5q6r7s8t \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "string",
3   "agent_id": "string",
4   "type": "schedule",
5   "name": "string",
6   "enabled": true,
7   "run": {
8     "instruction": "string",
9     "variables": {},
10     "max_turns": 1,
11     "output_schema": {
12       "properties": {
13         "items": {
14           "items": {
15             "properties": {
16               "title": {
17                 "type": "string"
18               },
19               "url": {
20                 "type": "string"
21               }
22             },
23             "required": [
24               "title",
25               "url"
26             ],
27             "type": "object"
28           },
29           "type": "array"
30         }
31       },
32       "required": [
33         "items"
34       ],
35       "type": "object"
36     }
37   },
38   "created_at": "2024-01-15T09:30:00Z",
39   "updated_at": "2024-01-15T09:30:00Z",
40   "schedule": {
41     "cron": "0 9 * * 1-5",
42     "interval_seconds": 1,
43     "timezone": "string"
44   },
45   "webhook": {
46     "payload_variable": "string"
47   },
48   "next_fire_at": "2024-01-15T09:30:00Z",
49   "last_fired_at": "2024-01-15T09:30:00Z",
50   "fire_path": "string",
51   "secret": "string",
52   "secret_hint": "string"
53 }

Retrieve a trigger by id.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

agent_idstringRequired

Agent id (prefixed external id, agent_...).

trigger_idstringRequired

Trigger id (prefixed external id, trigger_...).

Response headers

Speechify-Request-IdstringOptional

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a Speechify-Request-Id request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests

it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

The legacy alias X-Request-ID carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends a `Speechify-Request-Id` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope. The legacy alias `X-Request-ID` carries the same value and is still accepted on requests, until 2027-07-24. Prefer the un-prefixed name (RFC 6648).

Response

The requested trigger.

idstringformat: "^trigger_[0-9a-hjkmnp-tv-z]{26}$"

Prefixed wire identifier (trigger_<26 char Crockford base32>).

agent_idstringformat: "^agent_[0-9a-hjkmnp-tv-z]{26}$"

typeenum

namestring

enabledboolean

runobject

The durable run a trigger starts when it fires.

created_atdatetime

updated_atdatetime

scheduleobjectOptional

The cadence of a schedule trigger. Set exactly one of cron or interval_seconds.

webhookobjectOptional

The inbound-fire config of a webhook trigger.

next_fire_atdatetimeOptional

When a schedule trigger next fires. Absent for a webhook or a disabled schedule.

last_fired_atdatetimeOptional

fire_pathstringOptional

The inbound fire URL path for a webhook trigger; prepend the API host. Absent for a schedule trigger.

secretstringOptional

The plaintext fire token for a webhook trigger. Present in the create response ONLY and never again - store it securely.

secret_hintstringOptional

A masked fragment of the webhook fire token, for display.

Errors

401

Unauthorized Error

404

Not Found Error

Authentication

Path parameters

Headers

Response headers

Response

Errors