Skip to main content
POST
Export Agent
Export an agent into a portable template that can be shared across organizations. The template packages all agent components including configuration, tools, sub-agents, and optionally knowledge bases with their documents.

Path Parameters

string
required
The unique identifier (UUID) of the agent to export

Request Body

string
required
Display name for the template
string
Description of what the template does
string
Emoji icon for the template (e.g., ”🎧”, ”🚀”)
boolean
default:true
Controls whether knowledge bases and their document files are included in the export
  • true: Includes all knowledge bases with their documents and files
  • false: Exports only agent configuration without knowledge bases

Response

Returns an AgentTemplate object:
string
Unique identifier for the template (UUID)
string
Template display name
string
Template description
string
Emoji icon representing the template
string
UUID of the organization that created the template
object
Complete agent configuration

Example Request

Example Response

Use Cases

  • Cross-Organization Sharing: Share agent templates with other organizations
  • Backup & Version Control: Create snapshots of agent configurations
  • Standardization: Distribute pre-built agents across teams
  • Reusability: Create templates for frequently used agent patterns

Notes

  • Cross-Organization Sharing: Templates can be shared across different organizations - the template ID works universally
  • Knowledge Base Size: When with_knowledge_bases: true, the export includes all document content which may result in larger payloads
  • Tool Credentials: Tool configurations are exported without credentials - recipients will need to provide their own API keys
  • Template Immutability: Exported templates are snapshots and won’t update if the original agent changes

See Also

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

agent_id
string
required

Body

application/json
name
string
required
description
string | null
icon
string | null
with_knowledge_bases
boolean | null
default:true

Response

Successful Response

id
string
required
name
string
required
icon
string
required
description
string | null
organization_id
string | null
agent_definition
AgentDefinition · object | null