Export agent for runtime | Runtype Documentation

{
  "agentType": "runtype",
  "config": {
    "language": "en",
    "timezone": "America/New_York",
    "retryPolicy": {
      "maxRetries": 3,
      "backoff": "exponential"
    }
  },
  "description": "Customer support chatbot agent for handling user inquiries and troubleshooting.",
  "id": "agent_1234567890abcdef",
  "name": "SupportBot",
  "capabilities": [
    {
      "name": "text-generation",
      "provider": "openai",
      "model": "gpt-4",
      "maxTokens": 1024,
      "temperature": 0.7,
      "credentials": {
        "apiKey": "secret:openai_api_key"
      }
    }
  ],
  "externalConfig": {
    "webhookUrl": "https://hooks.example.com/agent-events",
    "timeoutSeconds": 30
  },
  "primaryFlow": {
    "startNode": "greeting",
    "nodes": {
      "greeting": {
        "type": "message",
        "text": "Hello! How can I assist you today?",
        "next": "userInput"
      },
      "userInput": {
        "type": "input",
        "variable": "userQuery",
        "next": "processQuery"
      },
      "processQuery": {
        "type": "action",
        "capability": "text-generation",
        "parameters": {
          "prompt": "{{userQuery}}",
          "maxTokens": 150
        },
        "next": "response"
      },
      "response": {
        "type": "message",
        "text": "{{actionResult}}",
        "next": null
      }
    }
  }
}

Export a fully-resolved, self-contained agent definition that the @runtypelabs/runtime package can consume directly at boot. Capabilities, flows, and nested sub-agents are inlined recursively (up to 3 levels). MCP credential values are replaced with secret-name references.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Response

Exported agent definition

agentTypeenum

configmap from strings to any

descriptionstring or null

idstring

namestring

capabilitieslist of maps from strings to any

externalConfigmap from strings to any

primaryFlowmap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/agents/id/export-runtime \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"