Create Agent Trigger | SpeechifyAI API

curl -X POST https://api.speechify.ai/v1/agents/agent_01jqr8x9zg5k2m3n4p5q6r7s8t/triggers \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "type": "schedule",
  "name": "string",
  "run": {
    "instruction": "string"
  }
}'

{
  "id": "string",
  "agent_id": "string",
  "type": "schedule",
  "name": "string",
  "enabled": true,
  "run": {
    "instruction": "string",
    "variables": {},
    "max_turns": 1,
    "output_schema": {
      "properties": {
        "items": {
          "items": {
            "properties": {
              "title": {
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "title",
              "url"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    }
  },
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "schedule": {
    "cron": "0 9 * * 1-5",
    "interval_seconds": 1,
    "timezone": "string"
  },
  "webhook": {
    "payload_variable": "string"
  },
  "next_fire_at": "2024-01-15T09:30:00Z",
  "last_fired_at": "2024-01-15T09:30:00Z",
  "fire_path": "string",
  "secret": "string",
  "secret_hint": "string"
}

Create a trigger that starts a durable run of a task agent. A schedule trigger fires on a cron expression or an interval; a webhook trigger returns a one-time secret plus a fire_path your backend POSTs to. Idempotent via Idempotency-Key.

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

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

Headers

Idempotency-KeystringOptional<=255 characters

A client-generated key (an opaque string, max 255 chars) that makes a side-effect POST safe to retry: the server runs the operation exactly once and replays the first response (its status and body) for 24 hours. Reusing a key with a different request body, or while the first request is still in flight, returns 409 idempotency_conflict. A replayed response carries the Idempotent-Replayed: true header.

A client-generated key (an opaque string, max 255 chars) that makes a side-effect POST safe to retry: the server runs the operation exactly once and replays the first response (its status and body) for 24 hours. Reusing a key with a different request body, or while the first request is still in flight, returns `409 idempotency_conflict`. A replayed response carries the `Idempotent-Replayed: true` header.

Request

This endpoint expects an object.

typeenumRequired

namestringRequired

runobjectRequired

The durable run a trigger starts when it fires.

enabledbooleanOptional

scheduleobjectOptional

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

webhookobjectOptional

The inbound-fire config of a webhook 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 created trigger. For a webhook trigger the plaintext secret is present in this response only.

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

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error