Skip to main content
Manage conversations and runs. List agents across the projects you can access, or edit definitions within a project. To start an agent run, use POST /runs with project_id and target: { type: "agent", id }. Find every run operation under Runs: lifecycle, events, input requests, children, the runs that triggers start, and the runtime callbacks workers use. Configure schedules and webhooks to trigger runs automatically. Conversations · Triggers · Runs · Executors

Conversations

Create, read, update, and delete conversations. Find a conversation’s runs and the input requests that need a response under Runs. List, create, read, update, or delete messages, branch from a message, and select the current branch. List, add, or remove participants. Read or update conversation read state.

Triggers

Configure schedules. To start a run from an existing schedule, use POST /runs with project_id and source: { type: "schedule", id }. Create and configure webhooks, and list the webhooks declared in source files. A webhook is a project URL that external services post to. Start a webhook run and list the runs a webhook started under Runs. List the events a webhook received and replay a stored event. Each delivery is stored as a webhook event that may start a run.

Runs

Start, list, inspect, cancel, and resume agent, task, and workflow runs, follow their events, answer their input requests, and find the runs that schedules, webhooks, and evaluations start.

Executors

List the push runtime services and pull workers connected to a project. Requires project.runtime.manage. Register workers, claim runs, renew leases, and report session state. Project administrators manage workers; worker operations accept credentials scoped to the worker. Back to REST API reference