APIAgents

Serialize

Serialize an Agent to the .agent file format.

Useful for storing the Agent with your code in a version control system, or for editing with an AI tool.

By default, the deployed version of the Agent is returned. Use the query parameters version_id or environment to target a specific version of the Agent.

Path parameters

idstringRequired

Unique identifier for Agent.

Headers

X-API-KEYstringRequired

Query parameters

version_idstringOptional

A specific Version ID of the Agent to retrieve.

environmentstringOptional

Name of the Environment to retrieve a deployed Version from.

Response

This endpoint returns an object.

Errors