For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
DocsReferenceChangelog
DocsReferenceChangelog
  • Introduction
    • Overview
    • Errors
  • SDK
    • Overview
    • Decorators
    • Run Evaluation
  • API
      • POSTLog to an Agent
      • PATCHUpdate Agent Log
      • STREAMCall Agent
      • STREAMContinue Agent Call
      • GETList Agents
      • POSTUpsert Agent
      • DELDelete Agent Version
      • PATCHUpdate Agent Version
      • GETGet Agent
      • DELDelete Agent
      • PATCHMove Agent
      • GETList Versions of a Agent
      • POSTDeploy Agent
      • DELRemove Deployment
      • GETList an Agent's Environments
      • POSTUpdate Monitoring
      • GETSerialize
      • POSTDeserialize
LogoLogo
Sign inBook a demo
APIAgents

Serialize

GET
https://api.humanloop.com/v5/agents/:id/serialize
GET
/v5/agents/:id/serialize
$curl https://api.humanloop.com/v5/agents/id/serialize \
>     -H "X-API-KEY: <apiKey>"
1"string"

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.

Was this page helpful?
Previous

Deserialize

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Unique identifier for Agent.

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

422
Serialize Agents ID Serialize Get Request Unprocessable Entity Error