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

For API groups, see [Execution API](/docs/cloud/apis/execution).

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

| Operation | Description |
| - | - |
| [`activeAgentRun`](/docs/cloud/graphql/operations/execution-api/queries/activeagentrun) | Returns the active agent run for a conversation. |
| [`agentRun`](/docs/cloud/graphql/operations/execution-api/queries/agentrun) | Returns an agent run for a conversation. |
| [`agentRuns`](/docs/cloud/graphql/operations/execution-api/queries/agentruns) | Lists agent runs associated with a conversation. |
| [`getRun`](/docs/cloud/graphql/operations/execution-api/queries/getrun) | Read a run through the canonical Runs query use case. |
| [`listConversationRuns`](/docs/cloud/graphql/operations/execution-api/queries/listconversationruns) | List readable runs in a conversation. |
| [`listProjectRuns`](/docs/cloud/graphql/operations/execution-api/queries/listprojectruns) | List readable runs in a project with the target filters and pagination. |
| [`listRuns`](/docs/cloud/graphql/operations/execution-api/queries/listruns) | List readable account runs with the canonical target filters and pagination. |
| [`projectRuns`](/docs/cloud/graphql/operations/execution-api/queries/projectruns) | Project runs, as REST GET /projects/\{project\_reference}/runs, with the same filters and values. |
| [`run`](/docs/cloud/graphql/operations/execution-api/queries/run) | A run of any kind, as REST GET /runs/\{run\_id}. |
| [`cancelRun`](/docs/cloud/graphql/operations/execution-api/mutations/cancelrun) | Cancel an agent, workflow or task run and every active descendant, as REST POST /runs/\{run\_id}/cancel. |
| [`createRun`](/docs/cloud/graphql/operations/execution-api/mutations/createrun) | Start a run of any kind, as REST POST /runs. |
| [`deleteRun`](/docs/cloud/graphql/operations/execution-api/mutations/deleterun) | Delete an eligible terminal run through its authorized owning use case. |
| [`pauseRun`](/docs/cloud/graphql/operations/execution-api/mutations/pauserun) | Pause an agent, task or workflow run at its next safe boundary, as REST POST /runs/\{run\_id}/pause. |
| [`resumeRun`](/docs/cloud/graphql/operations/execution-api/mutations/resumerun) | Resume a supported waiting run, as REST POST /runs/\{run\_id}/resume. |
| [`updateRun`](/docs/cloud/graphql/operations/execution-api/mutations/updaterun) | Update a run's title or labels using the If-Match request header. |

### Events

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

| Operation | Description |
| - | - |
| [`agentRunEvents`](/docs/cloud/graphql/operations/execution-api/queries/agentrunevents) | Returns the agent run’s event history after applying the requested cursor. |
| [`agentRunSnapshot`](/docs/cloud/graphql/operations/execution-api/queries/agentrunsnapshot) | Returns the current replay snapshot for an agent run’s event stream. |
| [`getRunEvent`](/docs/cloud/graphql/operations/execution-api/queries/getrunevent) | Read a run event with its canonical envelope and payload. |
| [`getRunEventsSummary`](/docs/cloud/graphql/operations/execution-api/queries/getruneventssummary) | Summarize visible run events over the selected time window. |
| [`getRunSnapshot`](/docs/cloud/graphql/operations/execution-api/queries/getrunsnapshot) | Read the canonical snapshot of visible run events. |
| [`listRunEvents`](/docs/cloud/graphql/operations/execution-api/queries/listrunevents) | List run events with the shared visibility policy, filters and event cursor. |
| [`listRunEventTypes`](/docs/cloud/graphql/operations/execution-api/queries/listruneventtypes) | List the public run event types and their payload schemas. |
| [`runEvent`](/docs/cloud/graphql/operations/execution-api/queries/runevent) | One run event, as REST GET /runs/\{run\_id}/events/\{event\_id}. |
| [`runEvents`](/docs/cloud/graphql/operations/execution-api/queries/runevents) | A page of a run's events, as REST GET /runs/\{run\_id}/events. |
| [`runEventSummary`](/docs/cloud/graphql/operations/execution-api/queries/runeventsummary) | Event counts, as REST GET /runs/\{run\_id}/events/summary, with the same filters. |
| [`runEventTypes`](/docs/cloud/graphql/operations/execution-api/queries/runeventtypes) | The run event catalog, as REST GET /runs/event-types. |
| [`runSnapshot`](/docs/cloud/graphql/operations/execution-api/queries/runsnapshot) | The replay snapshot of an agent run with or without a conversation, as REST GET /runs/\{run\_id}/snapshot. |

### Input requests

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

| Operation | Description |
| - | - |
| [`getInputRequest`](/docs/cloud/graphql/operations/execution-api/queries/getinputrequest) | Read an input request and its redacted response through its owning use case. |
| [`inputRequest`](/docs/cloud/graphql/operations/execution-api/queries/inputrequest) | Returns a structured input request for a conversation. |
| [`inputRequests`](/docs/cloud/graphql/operations/execution-api/queries/inputrequests) | Lists structured input requests associated with a conversation. |
| [`listConversationInputRequests`](/docs/cloud/graphql/operations/execution-api/queries/listconversationinputrequests) | List readable input requests in a conversation. |
| [`listRunInputRequests`](/docs/cloud/graphql/operations/execution-api/queries/listruninputrequests) | List readable input requests of a run through its owning use case. |
| [`runInputRequest`](/docs/cloud/graphql/operations/execution-api/queries/runinputrequest) | One input request of a run, as REST GET /runs/\{run\_id}/input-requests/\{input\_request\_id}. |
| [`runInputRequests`](/docs/cloud/graphql/operations/execution-api/queries/runinputrequests) | A run's input requests with or without a conversation, as REST GET /runs/\{run\_id}/input-requests. |
| [`cancelInputRequest`](/docs/cloud/graphql/operations/execution-api/mutations/cancelinputrequest) | Cancels an open input request. |
| [`createInputRequest`](/docs/cloud/graphql/operations/execution-api/mutations/createinputrequest) | Creates a structured request for human input within a conversation. |
| [`createRunInputRequest`](/docs/cloud/graphql/operations/execution-api/mutations/createruninputrequest) | Create an input request for a run. |
| [`submitInputResponse`](/docs/cloud/graphql/operations/execution-api/mutations/submitinputresponse) | Submits a human response to an open input request. |
| [`submitRunInputResponse`](/docs/cloud/graphql/operations/execution-api/mutations/submitruninputresponse) | Respond to a run input request, as REST POST /runs/\{run\_id}/input-requests/\{input\_request\_id}/responses. |

### Children

List the child runs a run starts.

| Operation | Description |
| - | - |
| [`childAgentRuns`](/docs/cloud/graphql/operations/execution-api/queries/childagentruns) | Lists every child agent run started by the specified parent run. |
| [`childAgentRunsByParentConversation`](/docs/cloud/graphql/operations/execution-api/queries/childagentrunsbyparentconversation) | Lists child agent runs associated with the parent conversation’s execution history. |
| [`childAgentRunsConnection`](/docs/cloud/graphql/operations/execution-api/queries/childagentrunsconnection) | Lists child agent runs started by the specified parent run, one page at a time. |
| [`listConversationChildRuns`](/docs/cloud/graphql/operations/execution-api/queries/listconversationchildruns) | List readable child runs in a conversation. |
| [`listRunChildRuns`](/docs/cloud/graphql/operations/execution-api/queries/listrunchildruns) | List readable child runs of a run. |
| [`runChildren`](/docs/cloud/graphql/operations/execution-api/queries/runchildren) | Lists independently readable direct children of any supported parent run, in canonical REST order. |

### Triggers

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

| Operation | Description |
| - | - |
| [`listProjectWebhookRuns`](/docs/cloud/graphql/operations/execution-api/queries/listprojectwebhookruns) | List the runs started by a project webhook. |
| [`projectWebhookRuns`](/docs/cloud/graphql/operations/execution-api/queries/projectwebhookruns) | A webhook definition's runs, newest first by default, as REST GET /projects/\{project\_reference}/webhooks/\{webhook\_definition\_id}/runs. |
| [`createScheduledRun`](/docs/cloud/graphql/operations/execution-api/mutations/createscheduledrun) | Start a run from a schedule now, as REST POST /projects/\{project\_reference}/schedules/\{schedule\_id}/runs. |
| [`runWebhook`](/docs/cloud/graphql/operations/execution-api/mutations/runwebhook) | Starts execution from a project webhook definition. |

## Queries

| Operation | Description |
| - | - |
| [`agentPushRuntimeServices`](/docs/cloud/graphql/operations/execution-api/queries/agentpushruntimeservices) | Lists registered agent runtime services visible in the selected scope. |
| [`agentWorkers`](/docs/cloud/graphql/operations/execution-api/queries/agentworkers) | Lists agent workers connected to a project. |
| [`conversation`](/docs/cloud/graphql/operations/execution-api/queries/conversation) | Returns a conversation by ID. |
| [`conversationReadState`](/docs/cloud/graphql/operations/execution-api/queries/conversationreadstate) | Returns the current user’s read state for a conversation. |
| [`conversations`](/docs/cloud/graphql/operations/execution-api/queries/conversations) | Lists conversations visible to the current user. |
| [`conversationTree`](/docs/cloud/graphql/operations/execution-api/queries/conversationtree) | Returns up to 1,000 conversation messages, including branches. |
| [`messageBranches`](/docs/cloud/graphql/operations/execution-api/queries/messagebranches) | Lists branches associated with a conversation message. |
| [`projectSchedulesDiscovery`](/docs/cloud/graphql/operations/execution-api/queries/projectschedulesdiscovery) | Lists schedule definitions discovered in project source. |
| [`projectWebhook`](/docs/cloud/graphql/operations/execution-api/queries/projectwebhook) | Returns a project webhook definition, or null when no webhook with that id exists in the project. |
| [`projectWebhooks`](/docs/cloud/graphql/operations/execution-api/queries/projectwebhooks) | Lists webhook definitions for a project. |
| [`projectWebhooksDiscovery`](/docs/cloud/graphql/operations/execution-api/queries/projectwebhooksdiscovery) | Lists webhook definitions discovered in project source. |
| [`unreadCount`](/docs/cloud/graphql/operations/execution-api/queries/unreadcount) | Returns the number of unread messages for the current user in a conversation. |

## Mutations

| Operation | Description |
| - | - |
| [`addParticipant`](/docs/cloud/graphql/operations/execution-api/mutations/addparticipant) | Adds a participant to a conversation. |
| [`archiveConversation`](/docs/cloud/graphql/operations/execution-api/mutations/archiveconversation) | Archives a conversation. |
| [`createConversation`](/docs/cloud/graphql/operations/execution-api/mutations/createconversation) | Creates a conversation for messages and related agent runs. |
| [`createWebhook`](/docs/cloud/graphql/operations/execution-api/mutations/createwebhook) | Creates a project webhook definition. |
| [`deleteConversation`](/docs/cloud/graphql/operations/execution-api/mutations/deleteconversation) | Deletes a conversation. |
| [`deleteMessage`](/docs/cloud/graphql/operations/execution-api/mutations/deletemessage) | Deletes a conversation message. |
| [`deleteWebhook`](/docs/cloud/graphql/operations/execution-api/mutations/deletewebhook) | Deletes a project webhook definition. |
| [`drainAgentPushRuntimeService`](/docs/cloud/graphql/operations/execution-api/mutations/drainagentpushruntimeservice) | Stops selecting the runtime service for new work. |
| [`editMessage`](/docs/cloud/graphql/operations/execution-api/mutations/editmessage) | Updates the content of a conversation message. |
| [`forkAtMessage`](/docs/cloud/graphql/operations/execution-api/mutations/forkatmessage) | Creates a conversation branch from a message. |
| [`markAsRead`](/docs/cloud/graphql/operations/execution-api/mutations/markasread) | Updates the current user’s read position in a conversation. |
| [`removeParticipant`](/docs/cloud/graphql/operations/execution-api/mutations/removeparticipant) | Removes a participant from a conversation. |
| [`replayWebhookEvent`](/docs/cloud/graphql/operations/execution-api/mutations/replaywebhookevent) | Replays a stored webhook event through its configured target. |
| [`resumeAgentPushRuntimeService`](/docs/cloud/graphql/operations/execution-api/mutations/resumeagentpushruntimeservice) | Makes the runtime service available for selection again. |
| [`sendMessage`](/docs/cloud/graphql/operations/execution-api/mutations/sendmessage) | Adds a user message to a conversation. |
| [`switchBranch`](/docs/cloud/graphql/operations/execution-api/mutations/switchbranch) | Changes the active message branch for a conversation. |
| [`updateConversation`](/docs/cloud/graphql/operations/execution-api/mutations/updateconversation) | Updates conversation settings. |
| [`updateWebhook`](/docs/cloud/graphql/operations/execution-api/mutations/updatewebhook) | Updates a project webhook definition. |


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