Export agent

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

Returns a portable snapshot of the agent, suitable for import.

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

ID of the agent to export. Resolves to the latest revision.

Responses
200

A successful response.

Expand All
object

AgentExport is a portable, dependency-free subset of an agent's configuration, shared by ExportAgent's response and ImportAgent's request. Carries no id, timestamps, or workspace- specific provenance - only fields meaningful to reconstruct the agent elsewhere.

name
string

The agent's name.

description
string

The agent's description.

model_name
string

The LLM model the agent uses.

prompt
string

The agent's system prompt.

subscription
string

The subscription tier the agent requires.

integration_name
string

The name of the integration the agent is bound to, if any.

integration_additional_args
object

Additional configuration args for the bound integration.

property*
string additionalProperties
output_schema
object

JSON schema describing the agent's output.

parameters
object

The agent's runtime parameters.

tools
Array of object (v1alphaAgentExportTool)

The tools attached to the agent, in a portable representation.

object

AgentExportTool is the portable projection of a tool attached to an exported agent. It carries the full per-type body needed to reconstruct the internal agentic_tools.tools.v1.Tool on import (not just a type discriminator), minus OUTPUT_ONLY fields (id/created_at/updated_at/deleted_at/state/invalidated_at/warnings/errors/ agents_hub_tool). predefined/omitted params are preserved for fidelity.

Portability caveat: every tool body references its resource by an environment-specific id (workflow_id/revision_id, step_manifest_id, mcp tool_id, agent_id). Import recreates the tool pointing at that id, so a round-trip is lossless only within the same environment; cross-environment the referenced resource (workflow/step/mcp registration, or the sub-agent) must already exist in the destination or import fails. Builtin and internal tools cannot be recreated by import at all (the internal create-tool RPC's oneof only supports workflow/step/mcp/agent) - they are exported for visibility only; import surfaces the resulting internal error transparently, not silently.

name
string

The tool's name.

description
string

The tool's description.

schema
object

The tool's schema.

tags
Array of string

The tool's tags.

string
predefined_parameters
Array of object (v1alphaAgentExportPredefinedParameter)

Predefined parameter values configured for this tool on the agent.

object

AgentExportPredefinedParameter mirrors agentic_tools.PredefinedParameter. possible_values is a singular nested message, not a repeated string.

name
string
possible_values
object (v1alphaAgentExportPredefinedParameterValue)
value
string
description
string
omitted_parameters
Array of string

Names of parameters omitted from the tool on the agent.

string
workflow
object (v1alphaAgentExportWorkflowTool)
workflow_id
string

The workflow's ID.

revision_id
string

The workflow revision ID used by the tool, if pinned to a specific revision.

step
object (v1alphaAgentExportStepTool)
step_manifest_id
string

The step manifest ID.

step_image
string

The step's container image.

integration_name
string

The name of the integration instance the step uses, if any.

vendor
string

The integration vendor.

runner
string

The runner the step executes on.

builtin
object (v1alphaAgentExportBuiltinTool)
name
string

The built-in tool's name.

mcp
object (v1alphaAgentExportMcpTool)

AgentExportMcpTool mirrors the internal McpTool message. Note that integration_name/vendor are server-derived (OUTPUT_ONLY) on the internal message; export carries the real values for visibility, but import should not assume the internal service accepts caller-supplied values for them.

tool_id
string
tool_name
string
description
string
tool_parameters
Array of object (v1alphaAgentExportMcpToolParameter)
object

AgentExportMcpToolParameter mirrors the internal McpToolParameter message field-for-field.

name
string
type
string

AgentExportMcpVariableType mirrors the internal McpVariableType enum verbatim.

Valid values[ "AGENT_EXPORT_MCP_VARIABLE_TYPE_UNSPECIFIED", "AGENT_EXPORT_MCP_VARIABLE_TYPE_STRING", "AGENT_EXPORT_MCP_VARIABLE_TYPE_NUMBER", "AGENT_EXPORT_MCP_VARIABLE_TYPE_INTEGER", "AGENT_EXPORT_MCP_VARIABLE_TYPE_BOOLEAN", "AGENT_EXPORT_MCP_VARIABLE_TYPE_ARRAY", "AGENT_EXPORT_MCP_VARIABLE_TYPE_OBJECT" ]
Default"AGENT_EXPORT_MCP_VARIABLE_TYPE_UNSPECIFIED"
description
string
required
boolean
items_type
string

AgentExportMcpVariableType mirrors the internal McpVariableType enum verbatim.

Valid values[ "AGENT_EXPORT_MCP_VARIABLE_TYPE_UNSPECIFIED", "AGENT_EXPORT_MCP_VARIABLE_TYPE_STRING", "AGENT_EXPORT_MCP_VARIABLE_TYPE_NUMBER", "AGENT_EXPORT_MCP_VARIABLE_TYPE_INTEGER", "AGENT_EXPORT_MCP_VARIABLE_TYPE_BOOLEAN", "AGENT_EXPORT_MCP_VARIABLE_TYPE_ARRAY", "AGENT_EXPORT_MCP_VARIABLE_TYPE_OBJECT" ]
Default"AGENT_EXPORT_MCP_VARIABLE_TYPE_UNSPECIFIED"
integration_name
string
vendor
string
internal
object (v1alphaAgentExportInternalTool)
tool_name
string

The internal tool's name.

agent
object (v1alphaAgentExportAgentTool)
agent_id
string

The ID of the sub-agent this tool references.

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