Create Agent

POST 
/agent-studio/agent

Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production.

Request

Version stringrequired

API Version

Available optionsv3

source string

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

namestring

Name of the agent

descriptionstring

Description of the agent

agencyIdstring

Agency ID

authorIdstring

Author ID

authorNamestring

Author name

authorEmailstring

Author email

statusstringrequired
Status of the agent
Available optionsactiveinactivearchived
versionobjectrequired

Version data for the agent including nodes, edges, and configuration

nodesstring[]

Nodes array (deprecated, prefer using version.nodes)

edgesstring[]

Edges array (deprecated, prefer using version.edges)

Example (auto)

{
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "name": "Customer Support Agent",
  "description": "AI agent specialized in handling customer inquiries and support tickets",
  "agencyId": "gjL2sFNXJfJYa3d2OYSN",
  "authorId": "usr_abc123def456",
  "authorName": "John Doe",
  "authorEmail": "[email protected]",
  "status": "active",
  "version": {
    "versionName": "Version 1",
    "description": "Initial version",
    "nodes": [],
    "edges": [],
    "uiNodes": [],
    "uiEdges": [],
    "globalVariables": [],
    "inputVariables": [],
    "runtimeVariables": [],
    "scopes": []
  },
  "nodes": [],
  "edges": []
}

application/json

Agent created successfully

application/json

Schema

Schema

successbooleanrequired

Success status

messagestringrequired

Response message

agentobjectrequired

Created agent data with metadata

versionsarrayrequired

Created versions array (initial staging version)

Example (auto)

{
  "success": true,
  "message": "Agent created successfully with staging version.",
  "agent": {
    "agentId": "p1q2r3s4t5u6v7w8x9y0z1a2",
    "name": "Customer Support Agent",
    "description": "AI agent specialized in handling customer inquiries and support tickets",
    "locationId": "C2QujeCh8ZnC7al2InWR",
    "agencyId": "gjL2sFNXJfJYa3d2OYSN",
    "status": "active",
    "authorId": "usr_abc123def456",
    "folderId": "C2QujeCh8ZnC7al2InWR",
    "folderName": null,
    "createdAt": "2024-02-27T10:30:00.000Z",
    "updatedAt": "2024-02-27T10:30:00.000Z"
  },
  "versions": [
    {
      "versionId": "v1a2b3c4d5e6f7g8h9i0",
      "agentId": "p1q2r3s4t5u6v7w8x9y0z1a2",
      "versionName": "Customer Support Agent v1",
      "state": "staging",
      "isPublished": false,
      "version": 1,
      "createdAt": "2024-02-27T10:30:00.000Z"
    }
  ]
}