Get agent

  • Updated on Oct 25, 2026
  • Published on Oct 25, 2026
Prev Next
Get
/v1alpha/agents/{id}

Returns the details of an existing agent by ID, optionally for a specific revision or the published revision.

Security
HTTP
Type bearer
Path parameters
id
string (uuid) Required

The ID of the agent to retrieve. To get a list of agent IDs make a List agents request.

Query parameters
published
boolean

If true, returns the agent's published revision; returns an error if the agent has no published revision. Defaults to false, which returns the latest revision.

revision_id
string

Optional ID of a specific revision to retrieve. When set, the published field is ignored.

Responses
200

A successful response.

Expand All
object

AgentRevision represents a configured agent and the settings of the requested revision.

id
string
name
string
description
string
created_by
string

The email address of the user who created the agent.

updated_by
string

The email address of the user who last updated the agent.

status
string

AgentStatus represents the lifecycle status of an agent.

  • AGENT_STATUS_UNSPECIFIED: Unspecified or unknown status.
  • AGENT_STATUS_DRAFT: Draft: the agent has no published revision.
  • AGENT_STATUS_PUBLISHED: Published: the agent's latest revision is published, with no unpublished changes.
  • AGENT_STATUS_UNPUBLISHED_CHANGES: Unpublished changes: the agent has a published revision, but a newer draft exists.
Valid values[ "AGENT_STATUS_UNSPECIFIED", "AGENT_STATUS_DRAFT", "AGENT_STATUS_PUBLISHED", "AGENT_STATUS_UNPUBLISHED_CHANGES" ]
Default"AGENT_STATUS_UNSPECIFIED"
created_at
string (date-time)
updated_at
string (date-time)
model_name
string

The name of the LLM model used by the agent.

prompt
string

The agent's instructions prompt.

subscription
string

The name of the LLM provider account (subscription) the agent uses to make model calls.

integration_name
string

The name of the integration instance configured for the agent.

integration_additional_args
object

Additional configuration values required by the agent's integration. The applicable keys depend on the integration vendor.

property*
string additionalProperties
output_schema
object

The JSON schema the agent's output must conform to, if configured.

parameters
object

A JSON schema describing the agent's input parameters. A field may set format to integration or file to indicate a value backed by a configured integration or an uploaded file, respectively.

tools
Array of object (v1alphaAgentTool)

The tools attached to the agent.

object

AgentTool represents a tool available to an agent.

id
string
name
string
description
string
schema
object
tags
Array of string
string
created_at
string (date-time)

The timestamp when the tool was created.

updated_at
string (date-time)

The timestamp when the tool was last updated.

type
string

AgentToolType enumerates the kinds of tools that can be attached to an agent.

  • AGENT_TOOL_TYPE_UNSPECIFIED: Unspecified tool type.
  • AGENT_TOOL_TYPE_WORKFLOW: A Torq workflow used as a tool.
  • AGENT_TOOL_TYPE_STEP: A single Torq step used as a tool.
  • AGENT_TOOL_TYPE_BUILTIN: A built-in tool provided by Torq.
  • AGENT_TOOL_TYPE_MCP: A tool backed by a Model Context Protocol (MCP) server.
  • AGENT_TOOL_TYPE_AGENT: Another agent used as a tool.
Valid values[ "AGENT_TOOL_TYPE_UNSPECIFIED", "AGENT_TOOL_TYPE_WORKFLOW", "AGENT_TOOL_TYPE_STEP", "AGENT_TOOL_TYPE_BUILTIN", "AGENT_TOOL_TYPE_MCP", "AGENT_TOOL_TYPE_AGENT" ]
Default"AGENT_TOOL_TYPE_UNSPECIFIED"
availability
object (v1alphaAgentAvailability)

AgentAvailability holds which surfaces may offer an agent. Sent whole: an omitted field reads as false, so a partial message narrows the agent rather than leaving it unchanged.

workflows
boolean

Whether the agent may be offered in the workflow builder.

socrates
boolean

Whether the agent may be offered in Socrates.

401

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.

object
403

You don't have permission to access this resource.

object