> ## 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. # Get Agent Capabilities > Returns agent capabilities for the selected source target. ## OpenAPI ````yaml https://api.veryfront.com/openapi.json get /projects/{project_reference}/agents/{agent_id}/capabilities openapi: 3.1.0 info: title: Veryfront REST API version: 1.0.0 summary: Domain-first REST reference for the maintained Veryfront HTTP API surface. description: >- Project-first HTTP API for Veryfront project resources. Root account/platform endpoints that still appear in this reference are transitional compatibility surfaces unless the canonical inventory marks them otherwise. ## Start here - **Interactive REST reference:** [/docs](/docs) - **Raw OpenAPI document:** [/openapi.json](/openapi.json) - **Canonical inventory:** `docs/api-surface-inventory.md` in this repository - **GraphQL endpoint:** [/graphql](/graphql) - **MCP playground:** [/mcp/playground](/mcp/playground) ## Authentication Use one of these request headers: - `Authorization: Bearer ` - `Authorization: Bearer vf__` - `X-API-Key: vf__` JWTs must use the Bearer token contract. API keys work in either the Bearer header or `X-API-Key`. ## Discovery model Veryfront is one platform with multiple access modes: - **REST** for resource-oriented and operational HTTP workflows - **GraphQL** for connected app-facing data and typed mutations - **MCP** for tool-style automation and agent workflows For the fastest path through the platform, start with the project-scoped domain groups. Transitional account/platform groups are retained for compatibility and follow the removal register in the canonical inventory. contact: name: Veryfront API Support url: https://veryfront.com/docs email: support@veryfront.com servers: - url: https://api.veryfront.com description: Current request origin - url: http://localhost:4000 description: Local development security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Projects description: Core project operations - name: Account description: >- Transitional account-level users and settings retained for dashboard compatibility - name: Project Users description: Project members and invites - name: Members description: Project members and invites - name: Files description: Main branch files - name: Branch Files description: Files on branches - name: Environment Files description: Files in environments - name: Release Files description: Files in releases - name: Uploads description: File uploads and assets - name: Branches description: Content branches for previews - name: Releases description: Published file snapshots - name: Deployments description: Connect releases to environments - name: Environments description: Deployment targets and variables - name: Environment Variables description: Project environment variable management - name: Domains description: Custom domains for environments - name: Project Servers description: Project-scoped dedicated server instances - name: Root Servers description: >- Transitional root dedicated-server administration retained for compatibility - name: Tasks description: Project tasks - name: Evals description: Project eval definitions and eval run projections - name: Work description: Project business-process definitions and execution state - name: Workflows description: Project workflows - name: Workflow Runs description: Workflow run history and status - name: Schedules description: Recurring project automation schedules - name: Webhooks description: Webhook-triggered automation entry points - name: Skills description: Project skills - name: Prompts description: Project prompts - name: Tools description: Project tools - name: Resources description: Project-defined resource documents and source-backed resource definitions - name: Sandboxes description: Ephemeral sandbox execution environments - name: Search description: Text and vector search - name: Knowledge description: Knowledge manifest lookup across project knowledge files - name: Chunks description: File chunks for search indexing - name: Embeddings description: Vector embeddings - name: RAG Documents description: Project retrieval-augmented knowledge documents - name: Style Artifacts description: Project style artifact state and build outputs - name: External Storage description: Transitional connected cloud-provider file operations - name: Project Cache description: Project-scoped distributed cache operations - name: User Cache description: Transitional user cache helpers retained for compatibility - name: API Keys description: >- Transitional user/account API key management; prefer project-scoped keys for public integrations - name: User description: Transitional current-user profile endpoint for first-party clients - name: Favorites description: Transitional user favorites for first-party dashboard clients - name: Subscriptions description: Transitional account billing and subscription workflows - name: Credits description: Transitional account credit balance, purchase, and insufficiency flows - name: Usage description: >- Project/account usage limits and warnings; account-level usage is transitional - name: Gates description: Transitional plan and feature gate checks for first-party clients - name: Channels description: Project channel integrations and delivery settings - name: Agents description: Project agents - name: Agent Catalog description: Public catalog of agents assembled from curated template projects - name: Agent Workers description: Internal/transitional agent worker leases and sessions - name: Agent Runtimes description: Registered push-based agent runtime services and runtime target health - name: Project Integrations description: Project-scoped integration catalog and configuration - name: Integrations description: Transitional external integration catalog for first-party clients - name: Integration Tools description: >- Transitional dynamic integration tool listing, invocation, and connection state - name: OAuth description: >- Transitional OAuth integration flows for first-party and connected-app clients - name: Templates description: Transitional starter-template discovery used during project creation - name: AI description: >- Transitional platform AI gateway/model helpers; project AI assets use project-scoped routes - name: Images description: Generated images and image assets - name: Conversations description: Transitional conversation/run-control HTTP surface for first-party clients - name: Runs description: Transitional hosted run-control endpoints for conversation execution - name: MCP description: >- MCP catalog/playground helpers; primary MCP traffic uses the streamable MCP handler - name: Logs description: Project log queries via Loki - name: Metrics description: Project metric queries via a Prometheus-compatible backend - name: Traces description: Project trace queries via Grafana Tempo - name: Errors description: Internal/public error type catalog (RFC 9457) - name: Authentication description: Transitional auth token, login, logout, magic-link, and JWKS flows externalDocs: description: Interactive REST reference url: https://api.veryfront.com/docs paths: /projects/{project_reference}/agents/{agent_id}/capabilities: get: tags: - Agents summary: Get Agent Capabilities description: Returns agent capabilities for the selected source target. parameters: - schema: type: string required: true name: project_reference in: path - schema: type: string description: Agent identifier required: true name: agent_id in: path - schema: type: string nullable: true enum: - main_branch - environment - preview_branch description: Provide the runtime target kind. required: false description: Provide the runtime target kind. name: runtime_target_kind in: query - schema: type: string nullable: true format: uuid description: Provide the target environment id. required: false description: Provide the target environment id. name: target_environment_id in: query - schema: type: string nullable: true format: uuid description: Provide the target branch id. required: false description: Provide the target branch id. name: target_branch_id in: query - schema: type: string enum: - project - main_branch - environment - preview_branch description: Provide the source target kind. required: false description: Provide the source target kind. name: source_target_kind in: query responses: '200': description: Resolved agent capabilities content: application/json: schema: type: object properties: agent: type: object properties: id: type: string name: type: string description: type: string nullable: true provider: type: object properties: organization: type: string url: type: string required: - organization - url version: type: string capabilities: type: object properties: streaming: type: boolean push_notifications: type: boolean extensions: type: array items: type: string required: - streaming - push_notifications - extensions default_input_modes: type: array items: type: string default_output_modes: type: array items: type: string tools: type: array items: type: string skills: type: array items: type: object properties: id: type: string name: type: string description: type: string tags: type: array items: type: string examples: type: array items: type: string required: - id - name suggestions: type: array items: anyOf: - type: string minLength: 1 - type: object properties: title: type: string minLength: 1 prompt: type: string minLength: 1 required: - title - prompt additionalProperties: false kind: type: string enum: - source_project_agent - installed_project_agent can_run: type: boolean source_type: type: string enum: - project - catalog_install installed_access: type: object properties: grant_id: type: string format: uuid relation: type: string enum: - owner - admin - editor - viewer service_account_id: type: string format: uuid project_id: type: string format: uuid status: type: string required: - grant_id - relation - service_account_id - project_id - status runtime_readiness: type: object properties: status: type: string enum: - ready - offline - not_applicable - unknown reason: type: string nullable: true runtime_target_kind: type: string nullable: true enum: - registered_push_service - pull_worker runtime_service_key: type: string nullable: true required: - status - reason - runtime_target_kind - runtime_service_key source_path: type: string edit_mode: type: string enum: - structured - source_only avatar_url: type: string nullable: true format: uri description: >- Absolute URL for this agent avatar. Null when no custom avatar has been set. x-veryfront-model: type: string nullable: true x-veryfront-url: type: string required: - id - name - description - provider - version - capabilities - default_input_modes - default_output_modes - tools - skills - kind - can_run - source_type - source_path - edit_mode - x-veryfront-model - x-veryfront-url resolved_capabilities: type: object properties: source_target: type: object properties: kind: type: string enum: - project - main_branch - environment - preview_branch description: Provide the source target kind. target_environment_id: type: string nullable: true format: uuid target_branch_id: type: string nullable: true format: uuid required: - kind - target_environment_id - target_branch_id runtime_target: type: object properties: kind: type: string nullable: true enum: - main_branch - environment - preview_branch target_environment_id: type: string nullable: true format: uuid target_branch_id: type: string nullable: true format: uuid required: - kind - target_environment_id - target_branch_id skills: type: array items: oneOf: - type: object properties: type: type: string enum: - project id: type: string name: type: string description: type: string source_path: type: string edit_mode: type: string enum: - structured - source_only allowed_tools: type: array items: type: string required: - type - id - name - description - source_path - edit_mode title: ProjectSkill - type: object properties: type: type: string enum: - agent id: type: string name: type: string description: type: string nullable: true tags: type: array items: type: string examples: type: array items: type: string required: - type - id - name title: AgentSkill tools: type: array items: oneOf: - type: object properties: type: type: string enum: - control_plane name: type: string description: type: string parameters: type: object additionalProperties: nullable: true required: - type - name title: ControlPlaneTool - type: object properties: type: type: string enum: - integration name: type: string description: type: string input_schema: type: object additionalProperties: nullable: true required: - type - name - description - input_schema title: IntegrationTool - type: object properties: type: type: string enum: - project id: type: string name: type: string description: type: string nullable: true source_path: type: string edit_mode: type: string enum: - structured - source_only input_schema: type: object nullable: true additionalProperties: nullable: true required: - type - id - name - source_path - edit_mode title: ProjectTool integrations: type: array items: type: object properties: id: type: string name: type: string tool_names: type: array items: type: string required: - id - name - tool_names tool_access: type: object properties: version: type: number enum: - 1 description: The version associated with this tool result. freshness: type: object properties: resolved_at: type: string format: date-time description: >- The resolved at associated with this tool result. valid_for_ms: type: integer minimum: 0 exclusiveMinimum: true description: >- The valid for ms associated with this tool result. fail_closed_on_expiry: type: boolean enum: - true description: >- The fail closed on expiry associated with this tool result. required: - resolved_at - valid_for_ms - fail_closed_on_expiry description: >- Structured freshness details associated with this tool result. inputs: type: object properties: capabilities: type: array items: type: string enum: - project.read - project.settings.manage - project.delete - project.members.read - project.members.manage - project.invites.read - project.invites.manage - project.files.read - project.files.write - project.files.admin - project.uploads.read - project.uploads.write - project.uploads.admin - project.knowledge.read - project.knowledge.write - project.releases.read - project.releases.write - project.deployments.read - project.deployments.write - project.deploy.execute - project.runtime.manage - project.domains.write - project.environments.manage - project.env_vars.write - project.runs.read - project.runs.write - project.work.read - project.work.write - project.work.executions.read - project.work.executions.write - project.agents.read - project.agents.write - project.evals.read - project.evals.write - project.evals.run - project.conversations.read - project.conversations.write - project.integrations.read - project.integrations.connect - project.integrations.configure - project.api_keys.read - project.api_keys.manage - project.cache.read - project.cache.write - project.logs.read - project.metrics.read - project.resources.read description: >- One capability item associated with this tool result. description: >- List of capabilities associated with this tool result. billing: type: object properties: collaboration_allowed: type: boolean description: >- The collaboration allowed associated with this tool result. can_invite: type: boolean description: >- The can invite associated with this tool result. required: - collaboration_allowed - can_invite description: >- Structured billing details associated with this tool result. entitlements: type: object properties: dedicated_runtime: type: boolean description: >- The dedicated runtime associated with this tool result. custom_domains: type: boolean description: >- The custom domains associated with this tool result. export_apps: type: boolean description: >- The export apps associated with this tool result. required: - dedicated_runtime - custom_domains - export_apps description: >- Structured entitlements details associated with this tool result. required: - capabilities - billing - entitlements description: >- Structured inputs details associated with this tool result. families: type: array items: type: object properties: family: type: string enum: - collaboration - runtime - domains - export description: The family associated with this tool result. default_decision: type: object properties: visibility: type: string enum: - visible - hidden description: >- The visibility associated with this tool result. reason_code: type: string enum: - allowed - missing_capability - billing_plan_restriction - billing_seat_limit - target_not_supported - resource_state_restriction - policy_exception - unknown description: >- The reason code associated with this tool result. message: type: string description: >- The message associated with this tool result. required: - visibility - reason_code description: >- Structured default decision details associated with this tool result. action_overrides: type: array items: type: object properties: action: type: string enum: - create_invite - delete_member - create_server - delete_server - create_domain - download_release description: >- The action associated with this tool result. decision: type: object properties: visibility: type: string enum: - visible - hidden description: >- The visibility associated with this tool result. reason_code: type: string enum: - allowed - missing_capability - billing_plan_restriction - billing_seat_limit - target_not_supported - resource_state_restriction - policy_exception - unknown description: >- The reason code associated with this tool result. message: type: string description: >- The message associated with this tool result. required: - visibility - reason_code description: >- Structured default decision details associated with this tool result. required: - action - decision description: >- One action override item associated with this tool result. description: >- List of action overrides associated with this tool result. required: - family - default_decision - action_overrides description: >- One family item associated with this tool result. description: List of families associated with this tool result. required: - version - freshness - inputs - families prompts: type: array items: type: object properties: id: type: string name: type: string description: type: string nullable: true source_path: type: string edit_mode: type: string enum: - structured - source_only required: - id - name - source_path - edit_mode workflows: type: array items: type: object properties: id: type: string name: type: string description: type: string nullable: true target: type: string source_path: type: string edit_mode: type: string enum: - structured - source_only version: type: string nullable: true input_schema: type: object nullable: true additionalProperties: nullable: true output_schema: type: object nullable: true additionalProperties: nullable: true schedulable: type: boolean required: - id - name - target - source_path - edit_mode - schedulable tasks: type: array items: type: object properties: id: type: string name: type: string description: type: string nullable: true target: type: string source_path: type: string edit_mode: type: string enum: - structured - source_only input_schema: type: object nullable: true additionalProperties: nullable: true output_schema: type: object nullable: true additionalProperties: nullable: true schedulable: type: boolean required: - id - name - target - source_path - edit_mode - schedulable required: - source_target - runtime_target - skills - tools - integrations - tool_access - prompts - workflows - tasks required: - agent - resolved_capabilities '401': description: Unauthorized content: application/json: schema: type: object properties: type: type: string title: type: string status: type: number detail: type: string error: type: string message: type: string edit_mode: type: string enum: - structured - source_only source_only_reasons: type: array items: type: string source_path: type: string '403': description: Forbidden content: application/json: schema: type: object properties: type: type: string title: type: string status: type: number detail: type: string error: type: string message: type: string edit_mode: type: string enum: - structured - source_only source_only_reasons: type: array items: type: string source_path: type: string '404': description: Not found content: application/json: schema: type: object properties: type: type: string title: type: string status: type: number detail: type: string error: type: string message: type: string edit_mode: type: string enum: - structured - source_only source_only_reasons: type: array items: type: string source_path: type: string components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or API Key description: >- Use a JWT bearer token or a Veryfront API key in the Authorization header. apiKeyAuth: type: apiKey in: header name: X-API-Key description: Alternative API key header for vf__ tokens. ````