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

# Agents API

> Define agents, tasks and workflows, and configure their prompts, skills, tools and resources.

Define agents, tasks and workflows, and configure their prompts, skills, tools and resources.

List agents across the projects you can access, or edit definitions within a project. To start an agent run, use [`POST /runs`](/docs/cloud/rest/api-reference/runs/create-run) with `kind: "agent"` and the agent’s execution target.

[Accessible agents](#accessible-agents) · [Agent templates](#agent-templates) · [Project agents](#project-agents) · [Agent Capabilities](#agent-capabilities) · [Agent Tool References](#agent-tool-references) · [Agent Labels](#agent-labels) · [Agent Avatars](#agent-avatars) · [Agent Installation](#agent-installation) · [Project prompts](#project-prompts) · [Project skills](#project-skills) · [Project tools](#project-tools) · [Project tasks](#project-tasks) · [Project workflows](#project-workflows) · [Project resources](#project-resources)

## Accessible agents

List agents you can access across projects. Each result includes the project needed to locate its definition.

| Endpoint | Methods | Description |
| - | - | - |
| `/agents` | [GET](/docs/cloud/rest/api-reference/accessible-agents/list-available-agents) | List available agents |

## Agent templates

Browse agent templates. Use [agent installation](/docs/cloud/rest/apis/agents-api#agent-installation) to add a selected template.

| Endpoint | Methods | Description |
| - | - | - |
| `/agent-templates` | [GET](/docs/cloud/rest/api-reference/agent-templates/browse-agent-templates) | Browse agent templates |

## Project agents

Create and edit project agent definitions. Use [Runs](/docs/cloud/rest/apis/execution-api#runs) to start and monitor agent runs.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/agents` | [GET](/docs/cloud/rest/api-reference/project-agents/list-agents), [POST](/docs/cloud/rest/api-reference/project-agents/create-agent) | List agents; Create agent |
| `/projects/{project_reference}/agents/{agent_id}` | [GET](/docs/cloud/rest/api-reference/project-agents/get-agent), [PUT](/docs/cloud/rest/api-reference/project-agents/update-agent), [DELETE](/docs/cloud/rest/api-reference/project-agents/delete-agent) | Get agent; Update agent; Delete agent |
| `/projects/{project_reference}/agents/{agent_id}/rename` | [POST](/docs/cloud/rest/api-reference/project-agents/rename-agent) | Rename agent |

## Agent Capabilities

Read project capabilities and the capabilities enabled for an agent.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/capabilities` | [GET](/docs/cloud/rest/api-reference/agent-capabilities/get-project-capabilities) | Get project capabilities |
| `/projects/{project_reference}/agents/{agent_id}/capabilities` | [GET](/docs/cloud/rest/api-reference/agent-capabilities/get-agent-capabilities) | Get agent capabilities |

## Agent Tool References

Search tools that can be attached to agents.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/agent-tool-references` | [GET](/docs/cloud/rest/api-reference/agent-tool-references/search-attachable-agent-tools) | Search attachable agent tools |

## Agent Labels

List, create, update, or delete labels on an agent.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/agents/{agent_id}/labels` | [GET](/docs/cloud/rest/api-reference/agent-labels/list-project-agent-labels), [POST](/docs/cloud/rest/api-reference/agent-labels/create-project-agent-label) | List project agent labels; Create project agent label |
| `/projects/{project_reference}/agents/{agent_id}/labels/{label_id}` | [PUT](/docs/cloud/rest/api-reference/agent-labels/update-project-agent-label), [DELETE](/docs/cloud/rest/api-reference/agent-labels/delete-project-agent-label) | Update project agent label; Delete project agent label |

## Agent Avatars

Preview, generate, or read agent avatars.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/agents/{agent_id}/avatar.svg` | [GET](/docs/cloud/rest/api-reference/agent-avatars/get-agent-avatar-svg) | Get agent avatar SVG |
| `/projects/{project_reference}/agents/{agent_id}/avatar` | [POST](/docs/cloud/rest/api-reference/agent-avatars/generate-agent-avatar) | Generate agent avatar |
| `/projects/{project_reference}/agents/avatar` | [POST](/docs/cloud/rest/api-reference/agent-avatars/preview-agent-avatar) | Preview agent avatar |

## Agent Installation

Install or remove agents from selected projects.

| Endpoint | Methods | Description |
| - | - | - |
| `/projects/{project_reference}/agents/{agent_id}/install` | [POST](/docs/cloud/rest/api-reference/agent-installation/install-agent), [DELETE](/docs/cloud/rest/api-reference/agent-installation/uninstall-agent) | Install agent; Uninstall agent |
| `/projects/{project_reference}/agents/{agent_id}/install-selected` | [POST](/docs/cloud/rest/api-reference/agent-installation/install-agent-for-selected-projects) | Install agent for selected projects |

## Project prompts

Manage prompts stored in project source. List prompts, read their source, and edit supported fields for the selected source version.

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

## Project skills

Manage skills stored in project source. List skills, read their source, and edit the fields supported by the selected source and definition format.

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

## Project tools

Manage tool definitions in project source. Use [integration tool endpoints](/docs/cloud/rest/apis/integrations-api#integration-tools) to discover and invoke connected-service tools.

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

## Project tasks

Manage task definitions stored in project source. List definitions, read their source, and edit supported fields. To start a task run, use [`POST /runs`](/docs/cloud/rest/api-reference/runs/create-run) with `kind: "task"` and the task’s execution target.

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

## Project workflows

Manage workflow definitions stored in project source. List definitions, read their source, and edit supported fields. To start a workflow run, use [`POST /runs`](/docs/cloud/rest/api-reference/runs/create-run) with `kind: "workflow"` and the workflow’s execution target.

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

## Project resources

Create and edit project resource documents. Manage servers and other deployment infrastructure through the [Deployment API](/docs/cloud/rest/apis/deployment-api).

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

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


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