NylorunDocsBeta
Runtime APIAgentsTriggers

Run a trigger now

POST
/v1/agents/{agentId}/triggers/{triggerId}/run

Runs it once now, paused or not, as if it had fired: a turn on its session, or a queued message when a turn runs there. A retried request with the same Idempotency-Key answers the same run.

Authorization

headerAuthorizationBearer <token>

An application key of the Tenant (PUT /v1/tenant/keys/{keyId}), or Studio's key, derived from the admin key. With Nylorun-Subject and Nylorun-Scopes, it acts for that person, narrowed to those scopes. Never accepted from a browser (Origin).

Path Parameters

agentId*string

The Agent id, percent-encoded

triggerId*string

The trigger's id in the manifest's runtime.triggers

Header Parameters

Nylorun-Protocol*string

The protocol version, 18

Nylorun-Subject?string

The person an application key acts for

Nylorun-Scopes?string

The subject's space-separated scopes; required with a subject

Idempotency-Key*string
Length1 <= length <= 200

Response Body

The run

application/json
  1. response
run*
import { createClient } from "@nylorun/agents";const client = await createClient();const run = await client.agents.runTrigger("users/alice/assistant", "nightly", {  idempotencyKey: crypto.randomUUID(),});
{  "run": {    "id": "string",    "triggerId": "string",    "kind": "schedule",    "dueAt": "string",    "firedAt": "string",    "late": true,    "status": "started",    "reason": "string",    "sessionId": "string",    "turnId": "string",    "queuedMessageId": "string"  }}

Resume a trigger POST

It fires again from its next time after now; missed times are not run. An `at` whose time has passed is refused (`trigger_expired`).

List an Agent's runs GET

Each time one of its triggers fired or was run by hand, newest first: when it was due, whether it was late, and what came of it (`started`, `queued`, `skipped` or `failed`, with a reason), with the session and turn.