> ## Documentation Index > Fetch the complete documentation index at: https://developers.torq.io/llms.txt > Use this file to discover all available pages before exploring further. # Get agent > Returns the details of an existing agent by ID, optionally for a specific revision or the published revision. ## OpenAPI ````json GET /v1alpha/agents/{id} { "openapi": "3.0.1", "info": { "contact": { "email": "support@torq.io", "name": "torq.io", "url": "https://torq.io" }, "title": "Torq Public API[production]", "version": "${DH_DEPLOY_VERSION}" }, "servers": [ { "url": "https://api.torq.io/public", "description": "US Environment" }, { "url": "https://api.eu.torq.io/public", "description": "European Enviornment" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Files" }, { "name": "ActivityLogs" }, { "name": "AgentsHubService" }, { "name": "Users" }, { "name": "ApiKeys" }, { "name": "AuditLogs" }, { "name": "ContextGraph" }, { "name": "Executions" }, { "name": "ShareRequests" }, { "name": "StepRunners" }, { "name": "Integrations" }, { "name": "IPAccessService" }, { "name": "RolesService" }, { "name": "Secrets" }, { "name": "SecuritySettingsService" }, { "name": "ClaimMappings" }, { "name": "IdpSsoService" }, { "name": "Workflows" }, { "name": "Workspaces" }, { "name": "WorkspaceVariables" }, { "name": "Auto Triage Alerts" }, { "name": "Auto Triage Guidance" }, { "name": "Auto Triage Alert History" }, { "name": "Auto Triage Verdict Actions" }, { "name": "Cases" }, { "name": "Cases Custom Fields" }, { "name": "Cases Notes" }, { "name": "ExtendedCaseService" }, { "name": "Cases Attachments" }, { "name": "Observables" }, { "name": "Cases Observables" }, { "name": "CaseSearchService" }, { "name": "Cases Tasks" }, { "name": "Cases Task Templates" }, { "name": "Cases Links" }, { "name": "Cases Events" }, { "name": "Cases Runbooks" } ], "externalDocs": { "description": "Torq Documentation", "url": "https://learn.torq.io" }, "x-original-swagger-version": "2.0", "paths": { "/v1alpha/agents/{id}": { "get": { "description": "Returns the details of an existing agent by ID, optionally for a specific revision or the published revision.", "operationId": "getAgent", "parameters": [ { "description": "The ID of the agent to retrieve. To get a list of agent IDs make a `List agents` request.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "If true, returns the agent's published revision; returns an error if the agent has no published revision.\nDefaults to false, which returns the latest revision.", "in": "query", "name": "published", "schema": { "type": "boolean" } }, { "description": "Optional ID of a specific revision to retrieve. When set, the `published` field is ignored.", "in": "query", "name": "revision_id", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1alphaAgentRevision" } } }, "description": "A successful response." }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token." }, "403": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "You don't have permission to access this resource." } }, "summary": "Get agent", "tags": [ "AgentsHubService" ] } } }, "components": { "schemas": { "v1alphaAgentRevision": { "description": "AgentRevision represents a configured agent and the settings of the requested revision.", "properties": { "id": { "title": "Unique identifier of the agent", "type": "string" }, "name": { "title": "Display name of the agent", "type": "string" }, "description": { "title": "Optional description of the agent", "type": "string" }, "created_by": { "description": "The email address of the user who created the agent.", "type": "string" }, "updated_by": { "description": "The email address of the user who last updated the agent.", "type": "string" }, "status": { "$ref": "#/components/schemas/v1alphaAgentStatus" }, "created_at": { "format": "date-time", "readOnly": true, "title": "When the agent was created", "type": "string" }, "updated_at": { "format": "date-time", "readOnly": true, "title": "When the agent was last updated", "type": "string" }, "model_name": { "description": "The name of the LLM model used by the agent.", "type": "string" }, "prompt": { "description": "The agent's instructions prompt.", "type": "string" }, "subscription": { "description": "The name of the LLM provider account (subscription) the agent uses to make model calls.", "type": "string" }, "integration_name": { "description": "The name of the integration instance configured for the agent.", "type": "string" }, "integration_additional_args": { "additionalProperties": { "type": "string" }, "description": "Additional configuration values required by the agent's integration.\nThe applicable keys depend on the integration vendor.", "type": "object" }, "output_schema": { "description": "The JSON schema the agent's output must conform to, if configured.", "properties": {}, "type": "object" }, "parameters": { "description": "A JSON schema describing the agent's input parameters. A field may set `format` to `integration` or `file`\nto indicate a value backed by a configured integration or an uploaded file, respectively.", "properties": {}, "type": "object" }, "tools": { "description": "The tools attached to the agent.", "items": { "$ref": "#/components/schemas/v1alphaAgentTool" }, "type": "array" }, "availability": { "$ref": "#/components/schemas/v1alphaAgentAvailability" } }, "type": "object" }, "v1alphaAgentStatus": { "default": "AGENT_STATUS_UNSPECIFIED", "description": "AgentStatus represents the lifecycle status of an agent.\n\n - AGENT_STATUS_UNSPECIFIED: Unspecified or unknown status.\n - AGENT_STATUS_DRAFT: Draft: the agent has no published revision.\n - AGENT_STATUS_PUBLISHED: Published: the agent's latest revision is published, with no unpublished changes.\n - AGENT_STATUS_UNPUBLISHED_CHANGES: Unpublished changes: the agent has a published revision, but a newer draft exists.", "enum": [ "AGENT_STATUS_UNSPECIFIED", "AGENT_STATUS_DRAFT", "AGENT_STATUS_PUBLISHED", "AGENT_STATUS_UNPUBLISHED_CHANGES" ], "type": "string" }, "v1alphaAgentTool": { "description": "AgentTool represents a tool available to an agent.", "properties": { "id": { "title": "The tool ID", "type": "string" }, "name": { "title": "The tool name", "type": "string" }, "description": { "title": "The tool description", "type": "string" }, "schema": { "properties": {}, "title": "The tool schema", "type": "object" }, "tags": { "items": { "type": "string" }, "title": "Tool tags", "type": "array" }, "created_at": { "description": "The timestamp when the tool was created.", "format": "date-time", "readOnly": true, "type": "string" }, "updated_at": { "description": "The timestamp when the tool was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "type": { "$ref": "#/components/schemas/v1alphaAgentToolType" } }, "type": "object" }, "v1alphaAgentAvailability": { "description": "AgentAvailability holds which surfaces may offer an agent. Sent whole: an omitted field\nreads as false, so a partial message narrows the agent rather than leaving it unchanged.", "properties": { "workflows": { "description": "Whether the agent may be offered in the workflow builder.", "type": "boolean" }, "socrates": { "description": "Whether the agent may be offered in Socrates.", "type": "boolean" } }, "type": "object" }, "v1alphaAgentToolType": { "default": "AGENT_TOOL_TYPE_UNSPECIFIED", "description": "AgentToolType enumerates the kinds of tools that can be attached to an agent.\n\n - AGENT_TOOL_TYPE_UNSPECIFIED: Unspecified tool type.\n - AGENT_TOOL_TYPE_WORKFLOW: A Torq workflow used as a tool.\n - AGENT_TOOL_TYPE_STEP: A single Torq step used as a tool.\n - AGENT_TOOL_TYPE_BUILTIN: A built-in tool provided by Torq.\n - AGENT_TOOL_TYPE_MCP: A tool backed by a Model Context Protocol (MCP) server.\n - AGENT_TOOL_TYPE_AGENT: Another agent used as a tool.", "enum": [ "AGENT_TOOL_TYPE_UNSPECIFIED", "AGENT_TOOL_TYPE_WORKFLOW", "AGENT_TOOL_TYPE_STEP", "AGENT_TOOL_TYPE_BUILTIN", "AGENT_TOOL_TYPE_MCP", "AGENT_TOOL_TYPE_AGENT" ], "type": "string" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "64fb4b65-44d8-4304-881c-b1f8b6b3100a" } } } } ````