> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Execution API

> Start and monitor agent, task, and workflow runs.

Start and monitor agent, task, and workflow runs.

Find every run operation under [Runs](/docs/cloud/rest/apis/execution-api#runs): lifecycle, events, input requests, children, and the runs that triggers start. Configure [schedules](/docs/cloud/rest/apis/execution-api#project-schedules) and [webhooks](/docs/cloud/rest/apis/execution-api#project-webhooks) to trigger runs automatically.

[Runs](#runs) · [Conversations](#conversations) · [Conversation Messages](#conversation-messages) · [Conversation Branches](#conversation-branches) · [Conversation Participants](#conversation-participants) · [Conversation Read State](#conversation-read-state) · [Participant lookup](#participant-lookup) · [Project schedules](#project-schedules) · [Project webhooks](#project-webhooks)

## 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.

### Lifecycle

Create, list, get, cancel, pause, and resume runs, and read account run analytics.

| Endpoint | Methods | Description |
| - | - | - |
| `/runs` | [POST](/docs/cloud/rest/api-reference/runs/create-run) | Create run |
| `/runs/{run_id}` | [GET](/docs/cloud/rest/api-reference/runs/get-run) | Get run |
| `/runs/{run_id}/artifacts/{artifact_id}` | [GET](/docs/cloud/rest/api-reference/runs/download-a-run-artifact) | Download a run artifact |
| `/runs/{run_id}/cancel` | [POST](/docs/cloud/rest/api-reference/runs/cancel-run) | Cancel run |
| `/runs/{run_id}/pause` | [POST](/docs/cloud/rest/api-reference/runs/pause-run) | Pause run |
| `/runs/{run_id}/resume` | [POST](/docs/cloud/rest/api-reference/runs/resume-waiting-run) | Resume waiting run |
| `/projects/{project_reference}/runs` | [GET](/docs/cloud/rest/api-reference/runs/list-project-runs) | List project runs |
| `/conversations/{conversation_id}/runs` | [GET](/docs/cloud/rest/api-reference/runs/list-conversation-runs) | List conversation runs |
| `/conversations/{conversation_id}/runs/active` | [GET](/docs/cloud/rest/api-reference/runs/get-active-conversation-run) | Get active conversation run |
| `/conversations/{conversation_id}/runs/{run_id}` | [GET](/docs/cloud/rest/api-reference/runs/get-conversation-run) | Get conversation run |
| `/account/analytics/runs` | [GET](/docs/cloud/rest/api-reference/runs/get-account-run-analytics) | Get account run analytics |

### Events

Read, summarize, and stream run events, and list the event types.

| Endpoint | Methods | Description |
| - | - | - |
| `/runs/{run_id}/events` | [GET](/docs/cloud/rest/api-reference/runs/list-run-events) | List run events |
| `/runs/{run_id}/events/{event_id}` | [GET](/docs/cloud/rest/api-reference/runs/get-run-event) | Get run event |
| `/runs/{run_id}/events/summary` | [GET](/docs/cloud/rest/api-reference/runs/summarize-run-events) | Summarize run events |
| `/runs/{run_id}/snapshot` | [GET](/docs/cloud/rest/api-reference/runs/get-run-snapshot) | Get run snapshot |
| `/runs/{run_id}/stream` | [GET](/docs/cloud/rest/api-reference/runs/stream-run-events) | Stream run events |
| `/runs/event-types` | [GET](/docs/cloud/rest/api-reference/runs/list-run-event-types) | List run event types |
| `/schemas/run-events/{schema_file}` | [GET](/docs/cloud/rest/api-reference/runs/get-run-event-data-schema) | Get run event data schema |
| `/conversations/{conversation_id}/runs/{run_id}/events` | [GET](/docs/cloud/rest/api-reference/runs/list-conversation-run-events) | List conversation run events |
| `/conversations/{conversation_id}/runs/{run_id}/snapshot` | [GET](/docs/cloud/rest/api-reference/runs/get-conversation-run-snapshot) | Get conversation run snapshot |
| `/conversations/{conversation_id}/runs/{run_id}/stream` | [GET](/docs/cloud/rest/api-reference/runs/stream-conversation-run-events) | Stream conversation run events |

### Input requests

Create, find, cancel, and respond to the input requests a run waits for.

| Endpoint | Methods | Description |
| - | - | - |
| `/runs/{run_id}/input-requests` | [GET](/docs/cloud/rest/api-reference/runs/list-run-input-requests), [POST](/docs/cloud/rest/api-reference/runs/create-run-input-request) | List run input requests; Create run input request |
| `/runs/{run_id}/input-requests/{input_request_id}` | [GET](/docs/cloud/rest/api-reference/runs/get-run-input-request) | Get run input request |
| `/runs/{run_id}/input-requests/{input_request_id}/responses` | [POST](/docs/cloud/rest/api-reference/runs/respond-to-run-input-request) | Respond to run input request |
| `/conversations/{conversation_id}/input-requests` | [GET](/docs/cloud/rest/api-reference/runs/list-conversation-input-requests), [POST](/docs/cloud/rest/api-reference/runs/create-a-conversation-input-request) | List conversation input requests; Create a conversation input request |
| `/conversations/{conversation_id}/input-requests/{input_request_id}` | [GET](/docs/cloud/rest/api-reference/runs/get-a-conversation-input-request) | Get a conversation input request |
| `/conversations/{conversation_id}/input-requests/{input_request_id}/responses` | [POST](/docs/cloud/rest/api-reference/runs/respond-to-a-conversation-input-request) | Respond to a conversation input request |
| `/conversations/{conversation_id}/input-requests/{input_request_id}/cancel` | [POST](/docs/cloud/rest/api-reference/runs/cancel-a-conversation-input-request) | Cancel a conversation input request |

### Children

List the child runs a run starts.

| Endpoint | Methods | Description |
| - | - | - |
| `/runs/{run_id}/children` | [GET](/docs/cloud/rest/api-reference/runs/list-child-runs) | List child runs |
| `/conversations/{conversation_id}/runs/{run_id}/children` | [GET](/docs/cloud/rest/api-reference/runs/list-conversation-child-runs) | List conversation child runs |
| `/conversations/{conversation_id}/runs/children-by-parent-conversation` | [GET](/docs/cloud/rest/api-reference/runs/list-child-runs-by-parent-conversation) | List child runs by parent conversation |

### Triggers

Start runs from schedules, webhooks, and evaluations, and list the runs they started.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/schedules/{schedule_id}/runs` | [POST](/docs/cloud/rest/api-reference/runs/create-scheduled-run) | Create scheduled run |
| `/projects/{project_reference}/webhooks/{webhook_definition_id}/runs` | [GET](/docs/cloud/rest/api-reference/runs/list-project-webhook-runs) | List project webhook runs |
| `/projects/{project_reference}/webhooks/{webhook_definition_id}/run` | [POST](/docs/cloud/rest/api-reference/runs/run-project-webhook) | Run project webhook |
| `/projects/{project_reference}/evals/{eval_id}/runs` | [GET](/docs/cloud/rest/api-reference/runs/list-evaluation-runs), [POST](/docs/cloud/rest/api-reference/runs/start-an-evaluation-run) | List evaluation runs; Start an evaluation run |
| `/projects/{project_reference}/evals/{eval_id}/runs/{run_id}` | [GET](/docs/cloud/rest/api-reference/runs/get-evaluation-run) | Get evaluation run |
| `/projects/{project_reference}/evals/{eval_id}/runs/{run_id}/report` | [GET](/docs/cloud/rest/api-reference/runs/get-evaluation-run-report) | Get evaluation run report |

## Conversations

Create, read, update, or delete conversations. Find runs and input requests under [Runs](/docs/cloud/rest/apis/execution-api#runs).

| Endpoint | Methods | Description |
| - | - | - |
| `/conversations` | [GET](/docs/cloud/rest/api-reference/conversations/list-conversations), [POST](/docs/cloud/rest/api-reference/conversations/create-conversation) | List conversations; Create conversation |
| `/conversations/{id}` | [GET](/docs/cloud/rest/api-reference/conversations/get-conversation), [PATCH](/docs/cloud/rest/api-reference/conversations/update-conversation), [DELETE](/docs/cloud/rest/api-reference/conversations/delete-conversation) | Get conversation; Update conversation; Delete conversation |
| `/conversations/{id}/tree` | [GET](/docs/cloud/rest/api-reference/conversations/get-conversation-tree) | Get conversation tree |

## Conversation Messages

List, send, read, edit, or delete messages.

| Endpoint | Methods | Description |
| - | - | - |
| `/conversations/{id}/messages` | [GET](/docs/cloud/rest/api-reference/conversation-messages/list-messages), [POST](/docs/cloud/rest/api-reference/conversation-messages/send-message) | List messages; Send message |
| `/conversations/{conversation_id}/messages/{message_id}` | [GET](/docs/cloud/rest/api-reference/conversation-messages/get-message), [PATCH](/docs/cloud/rest/api-reference/conversation-messages/edit-message), [DELETE](/docs/cloud/rest/api-reference/conversation-messages/delete-message) | Get message; Edit message; Delete message |

## Conversation Branches

Fork messages and select the active branch.

| Endpoint | Methods | Description |
| - | - | - |
| `/conversations/{conversation_id}/branches` | [POST](/docs/cloud/rest/api-reference/conversation-branches/fork-message) | Fork message |
| `/conversations/{conversation_id}/branches/{message_id}` | [GET](/docs/cloud/rest/api-reference/conversation-branches/list-message-branches) | List message branches |
| `/conversations/{conversation_id}/branch-selection` | [GET](/docs/cloud/rest/api-reference/conversation-branches/get-branch-selection), [PUT](/docs/cloud/rest/api-reference/conversation-branches/update-branch-selection) | Get branch selection; Update branch selection |

## Conversation Participants

List, add, or remove participants.

| Endpoint | Methods | Description |
| - | - | - |
| `/conversations/{conversation_id}/participants` | [GET](/docs/cloud/rest/api-reference/conversation-participants/list-participants), [POST](/docs/cloud/rest/api-reference/conversation-participants/add-participant) | List participants; Add participant |
| `/conversations/{conversation_id}/participants/{user_id}` | [DELETE](/docs/cloud/rest/api-reference/conversation-participants/remove-participant) | Remove participant |

## Conversation Read State

Read or update conversation read state.

| Endpoint | Methods | Description |
| - | - | - |
| `/conversations/{conversation_id}/read-state` | [GET](/docs/cloud/rest/api-reference/conversation-read-state/get-read-state), [PUT](/docs/cloud/rest/api-reference/conversation-read-state/update-read-state) | Get read state; Update read state |

## Participant lookup

Find an existing participant identity by user or agent ID. Use the conversation participant endpoints to [add](/docs/cloud/rest/api-reference/conversation-participants/add-participant) or [remove](/docs/cloud/rest/api-reference/conversation-participants/remove-participant) users.

| Endpoint | Methods | Description |
| - | - | - |
| `/participants` | [GET](/docs/cloud/rest/api-reference/participant-lookup/list-participant-identities) | List participant identities |

## Project schedules

Configure schedules. To start a run from an existing schedule, use [`POST /projects/{project_reference}/schedules/{schedule_id}/runs`](/docs/cloud/rest/api-reference/runs/create-scheduled-run).

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/schedules` | [GET](/docs/cloud/rest/api-reference/project-schedules/list-project-schedules), [POST](/docs/cloud/rest/api-reference/project-schedules/create-project-schedule) | List project schedules; Create project schedule |
| `/projects/{project_reference}/schedules/{schedule_id}` | [GET](/docs/cloud/rest/api-reference/project-schedules/get-project-schedule), [PATCH](/docs/cloud/rest/api-reference/project-schedules/update-project-schedule), [DELETE](/docs/cloud/rest/api-reference/project-schedules/delete-project-schedule) | Get project schedule; Update project schedule; Delete project schedule |

## Project webhooks

Configure automation webhooks and replay recorded deliveries. Start a webhook run and list its runs under [Runs](/docs/cloud/rest/apis/execution-api#runs).

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/webhooks` | [GET](/docs/cloud/rest/api-reference/project-webhooks/list-project-webhooks), [POST](/docs/cloud/rest/api-reference/project-webhooks/create-project-webhook) | List project webhooks; Create project webhook |
| `/projects/{project_reference}/webhooks/{webhook_definition_id}` | [GET](/docs/cloud/rest/api-reference/project-webhooks/get-project-webhook), [PATCH](/docs/cloud/rest/api-reference/project-webhooks/update-project-webhook), [DELETE](/docs/cloud/rest/api-reference/project-webhooks/delete-project-webhook) | Get project webhook; Update project webhook; Delete project webhook |
| `/projects/{project_reference}/webhooks/{webhook_definition_id}/events/{webhook_event_id}/replay` | [POST](/docs/cloud/rest/api-reference/project-webhooks/replay-project-webhook-event) | Replay project webhook event |

[Back to REST API reference](/docs/cloud/rest)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.