Deploy Agent

POST/v1/agents/{agentId}/deploy

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

agentId (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`agentId`	path	`string`	Yes

Request Body

Property	Type	Required
`tenantId`	`string`	No
`name`	`string`	No
`description`	`string`	No
`changelog`	`string`	No
`rateLimitRpm`	`integer`	No
`maxConcurrentSessions`	`integer`	No
`maxTurnsPerSession`	`integer`	No
`sessionTimeoutSeconds`	`integer`	No
`disableSessionTracking`	`boolean`	No

Responses

200 Deploy an agent as an API endpoint

Property	Type	Description
`deployment`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/v1/agents/{agentId}/deploy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","name":"string","description":"string","changelog":"string","rateLimitRpm":0,"maxConcurrentSessions":0,"maxTurnsPerSession":0,"sessionTimeoutSeconds":0,"disableSessionTracking":true}'

const response = await fetch("http://localhost:8089/v1/agents/{agentId}/deploy", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "changelog": "string",
  "rateLimitRpm": 0,
  "maxConcurrentSessions": 0,
  "maxTurnsPerSession": 0,
  "sessionTimeoutSeconds": 0,
  "disableSessionTracking": true
}),
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/v1/agents/{agentId}/deploy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "changelog": "string",
  "rateLimitRpm": 0,
  "maxConcurrentSessions": 0,
  "maxTurnsPerSession": 0,
  "sessionTimeoutSeconds": 0,
  "disableSessionTracking": true
},
)
data = response.json()

Response

{
  "deployment": {
    "id": "string",
    "tenantId": "string",
    "agentId": "string",
    "name": "string",
    "version": 0,
    "status": "string",
    "description": "string",
    "changelog": "string",
    "rateLimitRpm": 0,
    "maxConcurrentSessions": 0,
    "maxTurnsPerSession": 0,
    "sessionTimeoutSeconds": 0,
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "deployedBy": "string",
    "disableSessionTracking": true
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}