Inkeep Agents Manage API

REST API for the management of the Inkeep Agent Framework.

Health check

Check if the management service is healthy

Response Body

curl -X GET "http://localhost:3002/health"

curl -X GET "http://localhost:3002/health"

Empty

List Projects

List all projects within a tenant with pagination

Path Parameters

tenantIdstring

Tenant identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "models": "string",
      "stopWhen": "string",
      "sandboxConfig": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Project

Create a new project

Path Parameters

tenantIdstring

Tenant identifier

Request Body

idstring

namestring

descriptionstring

models

stopWhen?

sandboxConfig?

Response Body

application/json

application/problem+json

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {}
    }
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "name": "string",    "description": "string",    "models": {      "base": {}    }  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": "string",
    "stopWhen": "string",
    "sandboxConfig": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "error": "string",
  "message": "string",
  "details": null
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Project

Get a single project by ID

Path Parameters

tenantIdstring

Tenant identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/resource_789"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": "string",
    "stopWhen": "string",
    "sandboxConfig": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Update Project

Update an existing project

Path Parameters

tenantIdstring

Tenant identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

name?string

description?string

models?

stopWhen?

sandboxConfig?

Response Body

application/json

application/problem+json

curl -X PATCH "http://localhost:3002/tenants/tenant_123/projects/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PATCH "http://localhost:3002/tenants/tenant_123/projects/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": "string",
    "stopWhen": "string",
    "sandboxConfig": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Project

Delete a project. Will fail if the project has existing resources.

Path Parameters

tenantIdstring

Tenant identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/problem+json

application/json

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/resource_789"

Empty

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "error": "string",
  "message": "string",
  "details": null
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List SubAgents

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "prompt": "string",
      "conversationHistoryConfig": "string",
      "models": "string",
      "stopWhen": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create SubAgent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

descriptionstring

promptstring

conversationHistoryConfig?string|number|boolean||

models?

stopWhen?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "prompt": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "description": "string",    "prompt": "string"  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "prompt": "string",
    "conversationHistoryConfig": "string",
    "models": "string",
    "stopWhen": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get SubAgent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents/resource_789"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "prompt": "string",
    "conversationHistoryConfig": "string",
    "models": "string",
    "stopWhen": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete SubAgent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update SubAgent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string

description?string

prompt?string

conversationHistoryConfig?string|number|boolean||

models?

stopWhen?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agents/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "prompt": "string",
    "conversationHistoryConfig": "string",
    "models": "string",
    "stopWhen": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Agent Relations

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

sourceSubAgentId?string

targetSubAgentId?string

externalSubAgentId?string

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations?page=1&limit=10&sourceSubAgentId=string&targetSubAgentId=string&externalSubAgentId=string"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations?page=1&limit=10&sourceSubAgentId=string&targetSubAgentId=string&externalSubAgentId=string"

{
  "data": [
    {
      "id": "string",
      "sourceSubAgentId": "string",
      "targetSubAgentId": "string",
      "externalSubAgentId": "string",
      "relationType": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Agent Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

sourceSubAgentIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

targetSubAgentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

externalSubAgentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

relationTypestring

Value in"transfer" | "delegate"

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "sourceSubAgentId": "resource_789",
    "relationType": "transfer"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "sourceSubAgentId": "resource_789",    "relationType": "transfer"  }'

{
  "data": {
    "id": "string",
    "sourceSubAgentId": "string",
    "targetSubAgentId": "string",
    "externalSubAgentId": "string",
    "relationType": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Agent Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations/resource_789"

{
  "data": {
    "id": "string",
    "sourceSubAgentId": "string",
    "targetSubAgentId": "string",
    "externalSubAgentId": "string",
    "relationType": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Agent Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update Agent Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

sourceSubAgentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

targetSubAgentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

externalSubAgentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

relationType?string

Value in"transfer" | "delegate"

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-relations/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "sourceSubAgentId": "string",
    "targetSubAgentId": "string",
    "externalSubAgentId": "string",
    "relationType": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Agent Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "defaultSubAgentId": "string",
      "contextConfigId": "string",
      "models": "string",
      "statusUpdates": "string",
      "prompt": "string",
      "stopWhen": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Agent Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

description?string|null

defaultSubAgentId?string|null

contextConfigId?string|null

models?string|number|boolean||

statusUpdates?string|number|boolean||

prompt?string|null

stopWhen?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string"  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": "string",
    "statusUpdates": "string",
    "prompt": "string",
    "stopWhen": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Agent Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/resource_789"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": "string",
    "statusUpdates": "string",
    "prompt": "string",
    "stopWhen": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Agent Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update Agent Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string

description?string|null

defaultSubAgentId?string|null

contextConfigId?string|null

models?string|number|boolean||

statusUpdates?string|number|boolean||

prompt?string|null

stopWhen?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": "string",
    "statusUpdates": "string",
    "prompt": "string",
    "stopWhen": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

subAgentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/string/sub-agents/string/related"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/string/sub-agents/string/related"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Full Agent Definition

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/full"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/full"

{
  "data": {
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "prompt": "string",
    "stopWhen": {
      "transferCountIs": 1
    },
    "createdAt": "string",
    "updatedAt": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functionTools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "contextConfig": {
      "id": "resource_789",
      "headersSchema": {},
      "contextVariables": {}
    }
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List SubAgent Tool Relations

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

subAgentId?string

toolId?string

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations?page=1&limit=10&subAgentId=string&toolId=string"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations?page=1&limit=10&subAgentId=string&toolId=string"

{
  "data": [
    {
      "id": "string",
      "subAgentId": "string",
      "toolId": "string",
      "selectedTools": "string",
      "headers": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create SubAgent Tool Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

subAgentIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

toolIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

selectedTools?|null

headers?|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "subAgentId": "resource_789",
    "toolId": "resource_789"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "subAgentId": "resource_789",    "toolId": "resource_789"  }'

{
  "data": {
    "id": "string",
    "subAgentId": "string",
    "toolId": "string",
    "selectedTools": "string",
    "headers": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get SubAgent Tool Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/resource_789"

{
  "data": {
    "id": "string",
    "subAgentId": "string",
    "toolId": "string",
    "selectedTools": "string",
    "headers": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete SubAgent Tool Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update SubAgent Tool Relation

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

subAgentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

toolId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

selectedTools?|null

headers?|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "subAgentId": "string",
    "toolId": "string",
    "selectedTools": "string",
    "headers": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get SubAgents for Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

toolIdstring

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/tool/string/sub-agents?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-tool-relations/tool/string/sub-agents?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "subAgentId": "string",
      "toolId": "string",
      "selectedTools": "string",
      "headers": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Artifact Components for Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

subAgentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/agent/:subAgentId"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/agent/:subAgentId"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "props": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Agents Using Artifact Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

artifactComponentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/component/:artifactComponentId/agents"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/component/:artifactComponentId/agents"

{
  "data": [
    {
      "subAgentId": "string",
      "createdAt": "string"
    }
  ]
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Associate Artifact Component with Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

agentIdstring

subAgentIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

artifactComponentIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "string",
    "subAgentId": "resource_789",
    "artifactComponentId": "resource_789"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components" \  -H "Content-Type: application/json" \  -d '{    "agentId": "string",    "subAgentId": "resource_789",    "artifactComponentId": "resource_789"  }'

{
  "data": {
    "id": "string",
    "subAgentId": "string",
    "artifactComponentId": "string",
    "createdAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "error": "string",
  "message": "string",
  "details": null
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Remove Artifact Component from Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

subAgentIdstring

artifactComponentIdstring

Response Body

application/json

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/agent/:subAgentId/component/:artifactComponentId"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/agent/:subAgentId/component/:artifactComponentId"

{
  "message": "string",
  "removed": true
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Check if Artifact Component is Associated with Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

subAgentIdstring

artifactComponentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/agent/:subAgentId/component/:artifactComponentId/exists"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-artifact-components/agent/:subAgentId/component/:artifactComponentId/exists"

{
  "exists": true
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Data Components for Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

subAgentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/agent/:subAgentId"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/agent/:subAgentId"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "props": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Agents Using Data Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

dataComponentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/component/:dataComponentId/agents"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/component/:dataComponentId/agents"

{
  "data": [
    {
      "subAgentId": "string",
      "createdAt": "string"
    }
  ]
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Associate Data Component with Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

agentIdstring

subAgentIdstring

dataComponentIdstring

Response Body

application/json

application/problem+json

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "string",
    "subAgentId": "string",
    "dataComponentId": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components" \  -H "Content-Type: application/json" \  -d '{    "agentId": "string",    "subAgentId": "string",    "dataComponentId": "string"  }'

{
  "data": {
    "id": "string",
    "subAgentId": "string",
    "dataComponentId": "string",
    "createdAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "error": "string",
  "message": "string",
  "details": null
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Remove Data Component from Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

subAgentIdstring

dataComponentIdstring

Response Body

application/json

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/agent/:subAgentId/component/:dataComponentId"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/agent/:subAgentId/component/:dataComponentId"

{
  "message": "string",
  "removed": true
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Check if Data Component is Associated with Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

subAgentIdstring

dataComponentIdstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/agent/:subAgentId/component/:dataComponentId/exists"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/sub-agent-data-components/agent/:subAgentId/component/:dataComponentId/exists"

{
  "exists": true
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Artifact Components

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "props": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Artifact Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

descriptionstring

props?string|number|boolean||

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "description": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "description": "string"  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "props": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Artifact Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components/resource_789"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "props": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Artifact Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update Artifact Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string

description?string

props?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/artifact-components/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "props": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Context Configurations

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "headersSchema": {},
      "contextVariables": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Context Configuration

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

headersSchema?object

JSON Schema for validating request headers

contextVariables?object

Context variables configuration with fetch definitions

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "headersSchema": {},
    "contextVariables": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Context Configuration

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs/resource_789"

{
  "data": {
    "id": "string",
    "headersSchema": {},
    "contextVariables": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Context Configuration

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs/resource_789"

Empty

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Update Context Configuration

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

headersSchema?object

JSON Schema for validating request headers

contextVariables?object

Context variables configuration with fetch definitions

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/context-configs/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "headersSchema": {},
    "contextVariables": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Credentials

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "type": "memory",
      "credentialStoreId": "string",
      "retrievalParams": {
        "property1": null,
        "property2": null
      },
      "createdAt": "string",
      "updatedAt": "string",
      "tools": [
        {
          "tenantId": "string",
          "id": "string",
          "projectId": "string",
          "name": "string",
          "description": "string",
          "config": "string",
          "credentialReferenceId": "string",
          "headers": "string",
          "imageUrl": "string",
          "capabilities": "string",
          "lastError": "string",
          "createdAt": "string",
          "updatedAt": "string"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Credential

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

typestring

Value in"memory" | "keychain" | "nango"

credentialStoreIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

retrievalParams?|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "type": "memory",
    "credentialStoreId": "resource_789"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "type": "memory",    "credentialStoreId": "resource_789"  }'

{
  "data": {
    "id": "string",
    "type": "memory",
    "credentialStoreId": "string",
    "retrievalParams": {
      "property1": null,
      "property2": null
    },
    "createdAt": "string",
    "updatedAt": "string",
    "tools": [
      {
        "tenantId": "string",
        "id": "string",
        "projectId": "string",
        "name": "string",
        "description": "string",
        "config": "string",
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Credential

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials/resource_789"

{
  "data": {
    "id": "string",
    "type": "memory",
    "credentialStoreId": "string",
    "retrievalParams": {
      "property1": null,
      "property2": null
    },
    "createdAt": "string",
    "updatedAt": "string",
    "tools": [
      {
        "tenantId": "string",
        "id": "string",
        "projectId": "string",
        "name": "string",
        "description": "string",
        "config": "string",
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Credential

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update Credential

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

type?string

Value in"memory" | "keychain" | "nango"

credentialStoreId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

retrievalParams?|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/credentials/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "type": "memory",
    "credentialStoreId": "string",
    "retrievalParams": {
      "property1": null,
      "property2": null
    },
    "createdAt": "string",
    "updatedAt": "string",
    "tools": [
      {
        "tenantId": "string",
        "id": "string",
        "projectId": "string",
        "name": "string",
        "description": "string",
        "config": "string",
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ]
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Data Components

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "props": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Data Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

descriptionstring

props?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "description": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "description": "string"  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "props": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Data Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components/resource_789"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "props": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Data Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update Data Component

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string

description?string

props?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/data-components/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "props": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List External Agents

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "baseUrl": "string",
      "credentialReferenceId": "string",
      "headers": {
        "property1": "string",
        "property2": "string"
      },
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create External Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

descriptionstring

baseUrlstring

credentialReferenceId?string|null

headers?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "baseUrl": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "description": "string",    "baseUrl": "string"  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "baseUrl": "string",
    "credentialReferenceId": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get External Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents/resource_789"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "baseUrl": "string",
    "credentialReferenceId": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete External Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update External Agent

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string

description?string

baseUrl?string

credentialReferenceId?string|null

headers?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/external-agents/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "baseUrl": "string",
    "credentialReferenceId": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Function Tools

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "agentId": "string",
      "name": "string",
      "description": "string",
      "functionId": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Function Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

description?string|null

functionIdstring

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "functionId": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "functionId": "string"  }'

{
  "data": {
    "id": "string",
    "agentId": "string",
    "name": "string",
    "description": "string",
    "functionId": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Function Tool by ID

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools/:id"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools/:id"

{
  "data": {
    "id": "string",
    "agentId": "string",
    "name": "string",
    "description": "string",
    "functionId": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Function Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Response Body

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools/:id"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools/:id"

Empty

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Update Function Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

idstring

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

agentId?string

name?string

description?string|null

functionId?string

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools/:id" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agents/graph_789/function-tools/:id" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "agentId": "string",
    "name": "string",
    "description": "string",
    "functionId": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Functions

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/functions?page=1&limit=10"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/functions?page=1&limit=10"

{
  "data": [
    {
      "id": "string",
      "inputSchema": "string",
      "executeCode": "string",
      "dependencies": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Function

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

inputSchema?string|number|boolean||

executeCodestring

dependencies?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/functions" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "executeCode": "string"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/functions" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "executeCode": "string"  }'

{
  "data": {
    "id": "string",
    "inputSchema": "string",
    "executeCode": "string",
    "dependencies": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Function by ID

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/functions/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/functions/resource_789"

{
  "data": {
    "id": "string",
    "inputSchema": "string",
    "executeCode": "string",
    "dependencies": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Function

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/functions/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/functions/resource_789"

Empty

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Update Function

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

inputSchema?string|number|boolean||

executeCode?string

dependencies?string|number|boolean||

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/functions/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/functions/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "inputSchema": "string",
    "executeCode": "string",
    "dependencies": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List Tools

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

status?string

Value in"healthy" | "unhealthy" | "unknown" | "needs_auth"

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/tools?page=1&limit=10&status=healthy"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/tools?page=1&limit=10&status=healthy"

{
  "data": [
    {
      "tenantId": "string",
      "id": "resource_789",
      "projectId": "string",
      "name": "string",
      "description": "string",
      "config": {
        "type": "mcp",
        "mcp": {
          "server": {
            "url": "http://example.com"
          },
          "transport": {
            "type": "streamable_http",
            "requestInit": {
              "property1": null,
              "property2": null
            },
            "eventSourceInit": {
              "property1": null,
              "property2": null
            },
            "reconnectionOptions": {},
            "sessionId": "string"
          },
          "activeTools": [
            "string"
          ]
        }
      },
      "credentialReferenceId": "string",
      "headers": "string",
      "imageUrl": "string",
      "capabilities": "string",
      "lastError": "string",
      "createdAt": "2019-08-24",
      "updatedAt": "2019-08-24",
      "availableTools": [
        {
          "name": "string",
          "description": "string",
          "inputSchema": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "status": "healthy",
      "version": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

description?string|null

config

credentialReferenceId?string|null

headers?string|number|boolean||

imageUrl?string

capabilities?string|number|boolean||

lastError?string|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/tools" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "config": {
      "type": "mcp",
      "mcp": {
        "server": {
          "url": "http://example.com"
        }
      }
    }
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/tools" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "config": {      "type": "mcp",      "mcp": {        "server": {          "url": "http://example.com"        }      }    }  }'

{
  "data": {
    "tenantId": "string",
    "id": "resource_789",
    "projectId": "string",
    "name": "string",
    "description": "string",
    "config": {
      "type": "mcp",
      "mcp": {
        "server": {
          "url": "http://example.com"
        },
        "transport": {
          "type": "streamable_http",
          "requestInit": {
            "property1": null,
            "property2": null
          },
          "eventSourceInit": {
            "property1": null,
            "property2": null
          },
          "reconnectionOptions": {},
          "sessionId": "string"
        },
        "activeTools": [
          "string"
        ]
      }
    },
    "credentialReferenceId": "string",
    "headers": "string",
    "imageUrl": "string",
    "capabilities": "string",
    "lastError": "string",
    "createdAt": "2019-08-24",
    "updatedAt": "2019-08-24",
    "availableTools": [
      {
        "name": "string",
        "description": "string",
        "inputSchema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "status": "healthy",
    "version": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/tools/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/tools/resource_789"

{
  "data": {
    "tenantId": "string",
    "id": "resource_789",
    "projectId": "string",
    "name": "string",
    "description": "string",
    "config": {
      "type": "mcp",
      "mcp": {
        "server": {
          "url": "http://example.com"
        },
        "transport": {
          "type": "streamable_http",
          "requestInit": {
            "property1": null,
            "property2": null
          },
          "eventSourceInit": {
            "property1": null,
            "property2": null
          },
          "reconnectionOptions": {},
          "sessionId": "string"
        },
        "activeTools": [
          "string"
        ]
      }
    },
    "credentialReferenceId": "string",
    "headers": "string",
    "imageUrl": "string",
    "capabilities": "string",
    "lastError": "string",
    "createdAt": "2019-08-24",
    "updatedAt": "2019-08-24",
    "availableTools": [
      {
        "name": "string",
        "description": "string",
        "inputSchema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "status": "healthy",
    "version": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/tools/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/tools/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update Tool

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

id?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string

description?string|null

config?

credentialReferenceId?string|null

headers?string|number|boolean||

imageUrl?string

capabilities?string|number|boolean||

lastError?string|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/tools/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/tools/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "tenantId": "string",
    "id": "resource_789",
    "projectId": "string",
    "name": "string",
    "description": "string",
    "config": {
      "type": "mcp",
      "mcp": {
        "server": {
          "url": "http://example.com"
        },
        "transport": {
          "type": "streamable_http",
          "requestInit": {
            "property1": null,
            "property2": null
          },
          "eventSourceInit": {
            "property1": null,
            "property2": null
          },
          "reconnectionOptions": {},
          "sessionId": "string"
        },
        "activeTools": [
          "string"
        ]
      }
    },
    "credentialReferenceId": "string",
    "headers": "string",
    "imageUrl": "string",
    "capabilities": "string",
    "lastError": "string",
    "createdAt": "2019-08-24",
    "updatedAt": "2019-08-24",
    "availableTools": [
      {
        "name": "string",
        "description": "string",
        "inputSchema": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "status": "healthy",
    "version": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

List API Keys

List all API keys for a tenant with optional pagination

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Query Parameters

page?number

Default1

Range1 <= value

limit?number

Default10

Range1 <= value <= 100

agentId?string

Filter by agent ID

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys?page=1&limit=10&agentId=string"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys?page=1&limit=10&agentId=string"

{
  "data": [
    {
      "id": "string",
      "agentId": "string",
      "publicId": "string",
      "keyPrefix": "string",
      "name": "string",
      "lastUsedAt": "string",
      "expiresAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 0,
    "pages": 0
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create API Key

Create a new API key for an agent. Returns the full key (shown only once).

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

agentIdstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string|null

expiresAt?string|null

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys" \
  -H "Content-Type: application/json" \
  -d '{
    "agentId": "resource_789"
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys" \  -H "Content-Type: application/json" \  -d '{    "agentId": "resource_789"  }'

{
  "data": {
    "apiKey": {
      "id": "string",
      "agentId": "string",
      "publicId": "string",
      "keyPrefix": "string",
      "name": "string",
      "lastUsedAt": "string",
      "expiresAt": "string",
      "createdAt": "string",
      "updatedAt": "string"
    },
    "key": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get API Key

Get a specific API key by ID (does not return the actual key)

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys/resource_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys/resource_789"

{
  "data": {
    "id": "string",
    "agentId": "string",
    "publicId": "string",
    "keyPrefix": "string",
    "name": "string",
    "lastUsedAt": "string",
    "expiresAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete API Key

Delete an API key permanently

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Response Body

application/json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys/resource_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys/resource_789"

Empty

{
  "error": "string",
  "message": "string",
  "details": null
}

Update API Key

Update an API key (currently only expiration date can be changed)

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

Request Body

agentId?string

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

name?string|null

lastUsedAt?string|null

expiresAt?string|null

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys/resource_789" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/api-keys/resource_789" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "agentId": "string",
    "publicId": "string",
    "keyPrefix": "string",
    "name": "string",
    "lastUsedAt": "string",
    "expiresAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Full Agent

Create a complete agent with all agents, tools, and relationships from JSON definition

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

description?string|null

defaultSubAgentId?string|null

contextConfigId?string|null

models?

statusUpdates?

prompt?string

Lengthlength <= 5000

stopWhen?

createdAt?string

updatedAt?string

subAgents

tools?

functionTools?

functions?

contextConfig?

Response Body

application/json

application/problem+json

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agent" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "type": "internal",
        "canUse": [
          {
            "toolId": "string"
          }
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "type": "internal",
        "canUse": [
          {
            "toolId": "string"
          }
        ]
      }
    }
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/projects/project_456/agent" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "subAgents": {      "property1": {        "id": "resource_789",        "name": "string",        "description": "string",        "prompt": "string",        "type": "internal",        "canUse": [          {            "toolId": "string"          }        ]      },      "property2": {        "id": "resource_789",        "name": "string",        "description": "string",        "prompt": "string",        "type": "internal",        "canUse": [          {            "toolId": "string"          }        ]      }    }  }'

{
  "data": {
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "prompt": "string",
    "stopWhen": {
      "transferCountIs": 1
    },
    "createdAt": "string",
    "updatedAt": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functionTools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "contextConfig": {
      "id": "resource_789",
      "headersSchema": {},
      "contextVariables": {}
    }
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "error": "string",
  "message": "string",
  "details": null
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Full Agent

Retrieve a complete agent definition with all agents, tools, and relationships

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agent/graph_789"

curl -X GET "http://localhost:3002/tenants/tenant_123/projects/project_456/agent/graph_789"

{
  "data": {
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "prompt": "string",
    "stopWhen": {
      "transferCountIs": 1
    },
    "createdAt": "string",
    "updatedAt": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functionTools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "contextConfig": {
      "id": "resource_789",
      "headersSchema": {},
      "contextVariables": {}
    }
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Full Agent

Delete a complete agent and cascade to all related entities (relationships, not other agents/tools)

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Response Body

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agent/graph_789"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/projects/project_456/agent/graph_789"

Empty

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Update Full Agent

Update or create a complete agent with all agents, tools, and relationships from JSON definition

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

agentIdstring

Agent identifier

Request Body

idstring

Resource identifier

Match^[a-zA-Z0-9\-_.]+$

Length1 <= length <= 255

namestring

description?string|null

defaultSubAgentId?string|null

contextConfigId?string|null

models?

statusUpdates?

prompt?string

Lengthlength <= 5000

stopWhen?

createdAt?string

updatedAt?string

subAgents

tools?

functionTools?

functions?

contextConfig?

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agent/graph_789" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "resource_789",
    "name": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "type": "internal",
        "canUse": [
          {
            "toolId": "string"
          }
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "type": "internal",
        "canUse": [
          {
            "toolId": "string"
          }
        ]
      }
    }
  }'

curl -X PUT "http://localhost:3002/tenants/tenant_123/projects/project_456/agent/graph_789" \  -H "Content-Type: application/json" \  -d '{    "id": "resource_789",    "name": "string",    "subAgents": {      "property1": {        "id": "resource_789",        "name": "string",        "description": "string",        "prompt": "string",        "type": "internal",        "canUse": [          {            "toolId": "string"          }        ]      },      "property2": {        "id": "resource_789",        "name": "string",        "description": "string",        "prompt": "string",        "type": "internal",        "canUse": [          {            "toolId": "string"          }        ]      }    }  }'

{
  "data": {
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "prompt": "string",
    "stopWhen": {
      "transferCountIs": 1
    },
    "createdAt": "string",
    "updatedAt": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functionTools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "contextConfig": {
      "id": "resource_789",
      "headersSchema": {},
      "contextVariables": {}
    }
  }
}

{
  "data": {
    "id": "resource_789",
    "name": "string",
    "description": "string",
    "defaultSubAgentId": "string",
    "contextConfigId": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "prompt": "string",
    "stopWhen": {
      "transferCountIs": 1
    },
    "createdAt": "string",
    "updatedAt": "string",
    "subAgents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "prompt": "string",
        "conversationHistoryConfig": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "stopWhen": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "type": "internal",
        "canUse": [
          {
            "agentToolRelationId": "string",
            "toolId": "string",
            "toolSelection": [
              "string"
            ],
            "headers": {
              "property1": "string",
              "property2": "string"
            }
          }
        ],
        "dataComponents": [
          "string"
        ],
        "artifactComponents": [
          "string"
        ],
        "canTransferTo": [
          "string"
        ],
        "canDelegateTo": [
          "string"
        ]
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functionTools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "functionId": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "contextConfig": {
      "id": "resource_789",
      "headersSchema": {},
      "contextVariables": {}
    }
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Create Full Project

Create a complete project with all Agents, Sub Agents, tools, and relationships from JSON definition

Path Parameters

tenantIdstring

Tenant identifier

Request Body

idstring

namestring

descriptionstring

models

stopWhen?

sandboxConfig?

agents

tools

functions?

dataComponents?

artifactComponents?

statusUpdates?

credentialReferences?

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

application/json

application/problem+json

curl -X POST "http://localhost:3002/tenants/tenant_123/project-full" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {}
    },
    "agents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          }
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          }
        }
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            }
          }
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            }
          }
        }
      }
    }
  }'

curl -X POST "http://localhost:3002/tenants/tenant_123/project-full" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "name": "string",    "description": "string",    "models": {      "base": {}    },    "agents": {      "property1": {        "id": "resource_789",        "name": "string",        "subAgents": {          "property1": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          },          "property2": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          }        }      },      "property2": {        "id": "resource_789",        "name": "string",        "subAgents": {          "property1": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          },          "property2": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          }        }      }    },    "tools": {      "property1": {        "id": "resource_789",        "name": "string",        "config": {          "type": "mcp",          "mcp": {            "server": {              "url": "http://example.com"            }          }        }      },      "property2": {        "id": "resource_789",        "name": "string",        "config": {          "type": "mcp",          "mcp": {            "server": {              "url": "http://example.com"            }          }        }      }    }  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "stopWhen": {
      "transferCountIs": 1,
      "stepCountIs": 1
    },
    "sandboxConfig": {
      "provider": "vercel",
      "runtime": "node22",
      "timeout": 1000,
      "vcpus": 1
    },
    "agents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "dataComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "artifactComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "credentialReferences": {
      "property1": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "error": "string",
  "message": "string",
  "details": null
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Get Full Project

Retrieve a complete project definition with all Agents, Sub Agents, tools, and relationships

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Response Body

application/json

application/problem+json

curl -X GET "http://localhost:3002/tenants/tenant_123/project-full/project_456"

curl -X GET "http://localhost:3002/tenants/tenant_123/project-full/project_456"

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "stopWhen": {
      "transferCountIs": 1,
      "stepCountIs": 1
    },
    "sandboxConfig": {
      "provider": "vercel",
      "runtime": "node22",
      "timeout": 1000,
      "vcpus": 1
    },
    "agents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "dataComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "artifactComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "credentialReferences": {
      "property1": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Delete Full Project

Delete a complete project and cascade to all related entities (Agents, Sub Agents, tools, relationships)

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Response Body

application/problem+json

curl -X DELETE "http://localhost:3002/tenants/tenant_123/project-full/project_456"

curl -X DELETE "http://localhost:3002/tenants/tenant_123/project-full/project_456"

Empty

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Update Full Project

Update or create a complete project with all Agents, Sub Agents, tools, and relationships from JSON definition

Path Parameters

tenantIdstring

Tenant identifier

projectIdstring

Project identifier

Request Body

idstring

namestring

descriptionstring

models

stopWhen?

sandboxConfig?

agents

tools

functions?

dataComponents?

artifactComponents?

statusUpdates?

credentialReferences?

createdAt?string

updatedAt?string

Response Body

application/json

application/problem+json

curl -X PUT "http://localhost:3002/tenants/tenant_123/project-full/project_456" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {}
    },
    "agents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          }
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "type": "internal",
            "canUse": [
              {
                "toolId": "string"
              }
            ]
          }
        }
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            }
          }
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            }
          }
        }
      }
    }
  }'

curl -X PUT "http://localhost:3002/tenants/tenant_123/project-full/project_456" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "name": "string",    "description": "string",    "models": {      "base": {}    },    "agents": {      "property1": {        "id": "resource_789",        "name": "string",        "subAgents": {          "property1": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          },          "property2": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          }        }      },      "property2": {        "id": "resource_789",        "name": "string",        "subAgents": {          "property1": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          },          "property2": {            "id": "resource_789",            "name": "string",            "description": "string",            "prompt": "string",            "type": "internal",            "canUse": [              {                "toolId": "string"              }            ]          }        }      }    },    "tools": {      "property1": {        "id": "resource_789",        "name": "string",        "config": {          "type": "mcp",          "mcp": {            "server": {              "url": "http://example.com"            }          }        }      },      "property2": {        "id": "resource_789",        "name": "string",        "config": {          "type": "mcp",          "mcp": {            "server": {              "url": "http://example.com"            }          }        }      }    }  }'

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "stopWhen": {
      "transferCountIs": 1,
      "stepCountIs": 1
    },
    "sandboxConfig": {
      "provider": "vercel",
      "runtime": "node22",
      "timeout": 1000,
      "vcpus": 1
    },
    "agents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "dataComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "artifactComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "credentialReferences": {
      "property1": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "models": {
      "base": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "structuredOutput": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      },
      "summarizer": {
        "model": "string",
        "providerOptions": {
          "property1": null,
          "property2": null
        }
      }
    },
    "stopWhen": {
      "transferCountIs": 1,
      "stepCountIs": 1
    },
    "sandboxConfig": {
      "provider": "vercel",
      "runtime": "node22",
      "timeout": 1000,
      "vcpus": 1
    },
    "agents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "defaultSubAgentId": "string",
        "contextConfigId": "string",
        "models": {
          "base": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "structuredOutput": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          },
          "summarizer": {
            "model": "string",
            "providerOptions": {
              "property1": null,
              "property2": null
            }
          }
        },
        "statusUpdates": {
          "enabled": true,
          "numEvents": 1,
          "timeInSeconds": 1,
          "prompt": "string",
          "statusComponents": [
            {
              "type": "string",
              "description": "string",
              "detailsSchema": {
                "type": "object",
                "properties": {
                  "property1": null,
                  "property2": null
                },
                "required": [
                  "string"
                ]
              }
            }
          ]
        },
        "prompt": "string",
        "stopWhen": {
          "transferCountIs": 1
        },
        "createdAt": "string",
        "updatedAt": "string",
        "subAgents": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "prompt": "string",
            "conversationHistoryConfig": "string",
            "models": {
              "base": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "structuredOutput": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              },
              "summarizer": {
                "model": "string",
                "providerOptions": {
                  "property1": null,
                  "property2": null
                }
              }
            },
            "stopWhen": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "type": "internal",
            "canUse": [
              {
                "agentToolRelationId": "string",
                "toolId": "string",
                "toolSelection": [
                  "string"
                ],
                "headers": {
                  "property1": "string",
                  "property2": "string"
                }
              }
            ],
            "dataComponents": [
              "string"
            ],
            "artifactComponents": [
              "string"
            ],
            "canTransferTo": [
              "string"
            ],
            "canDelegateTo": [
              "string"
            ]
          }
        },
        "tools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "config": {
              "type": "mcp",
              "mcp": {
                "server": {
                  "url": "http://example.com"
                },
                "transport": {
                  "type": "streamable_http",
                  "requestInit": {
                    "property1": null,
                    "property2": null
                  },
                  "eventSourceInit": {
                    "property1": null,
                    "property2": null
                  },
                  "reconnectionOptions": {},
                  "sessionId": "string"
                },
                "activeTools": [
                  "string"
                ]
              }
            },
            "credentialReferenceId": "string",
            "headers": "string",
            "imageUrl": "string",
            "capabilities": "string",
            "lastError": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functionTools": {
          "property1": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "name": "string",
            "description": "string",
            "functionId": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "functions": {
          "property1": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          },
          "property2": {
            "id": "resource_789",
            "inputSchema": "string",
            "executeCode": "string",
            "dependencies": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        },
        "contextConfig": {
          "id": "resource_789",
          "headersSchema": {},
          "contextVariables": {}
        }
      }
    },
    "tools": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "config": {
          "type": "mcp",
          "mcp": {
            "server": {
              "url": "http://example.com"
            },
            "transport": {
              "type": "streamable_http",
              "requestInit": {
                "property1": null,
                "property2": null
              },
              "eventSourceInit": {
                "property1": null,
                "property2": null
              },
              "reconnectionOptions": {},
              "sessionId": "string"
            },
            "activeTools": [
              "string"
            ]
          }
        },
        "credentialReferenceId": "string",
        "headers": "string",
        "imageUrl": "string",
        "capabilities": "string",
        "lastError": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "functions": {
      "property1": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "inputSchema": "string",
        "executeCode": "string",
        "dependencies": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "dataComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "artifactComponents": {
      "property1": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      },
      "property2": {
        "id": "resource_789",
        "name": "string",
        "description": "string",
        "props": "string"
      }
    },
    "statusUpdates": {
      "enabled": true,
      "numEvents": 1,
      "timeInSeconds": 1,
      "prompt": "string",
      "statusComponents": [
        {
          "type": "string",
          "description": "string",
          "detailsSchema": {
            "type": "object",
            "properties": {
              "property1": null,
              "property2": null
            },
            "required": [
              "string"
            ]
          }
        }
      ]
    },
    "credentialReferences": {
      "property1": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      },
      "property2": {
        "id": "resource_789",
        "type": "memory",
        "credentialStoreId": "resource_789",
        "retrievalParams": {
          "property1": null,
          "property2": null
        },
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Bad Request",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "bad_request",
  "error": {
    "code": "bad_request",
    "message": "Bad Request"
  }
}

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

{
  "title": "Forbidden",
  "status": 403,
  "detail": "Forbidden",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "forbidden",
  "error": {
    "code": "forbidden",
    "message": "Forbidden"
  }
}

{
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "unprocessable_entity",
  "error": {
    "code": "unprocessable_entity",
    "message": "Unprocessable Entity"
  }
}

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Internal Server Error",
  "instance": "/conversations/123",
  "requestId": "req_1234567890",
  "code": "internal_server_error",
  "error": {
    "code": "internal_server_error",
    "message": "Internal Server Error"
  }
}

Detects OAuth requirements and redirects to authorization server (public endpoint)

Query Parameters

tenantIdstring

Length1 <= length

projectIdstring

Length1 <= length

toolIdstring

Length1 <= length

Response Body

text/html

curl -X GET "http://localhost:3002/oauth/login?tenantId=string&projectId=string&toolId=string"

curl -X GET "http://localhost:3002/oauth/login?tenantId=string&projectId=string&toolId=string"

Empty

"string"

"string"

"string"

OAuth authorization callback

Handles OAuth authorization codes and completes the authentication flow

Query Parameters

codestring

Length1 <= length

statestring

Length1 <= length

error?string

error_description?string

Response Body

text/html

curl -X GET "http://localhost:3002/oauth/callback?code=string&state=string&error=string&error_description=string"

curl -X GET "http://localhost:3002/oauth/callback?code=string&state=string&error=string&error_description=string"

Empty

"string"

"string"

204

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

409application/json

422application/problem+json

500application/problem+json

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

204

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

409application/json

422application/problem+json

500application/problem+json

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

204

404application/json

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/json