Inkeep Agents Run API

Chat completions, MCP, and A2A run endpoints in the Inkeep Agent Framework.

Health check

Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. All endpoints require a valid API key in the Authorization header as "Bearer ". API keys can be created in the management UI.

In: header

Response Body

curl -X GET "https://agents-run-api.preview.inkeep.com/health"

curl -X GET "https://agents-run-api.preview.inkeep.com/health"

Empty

Create chat completion

Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. All endpoints require a valid API key in the Authorization header as "Bearer ". API keys can be created in the management UI.

In: header

Request Body

application/json

model*string

The model to use for the completion

messages*

The conversation messages

temperature?number

Controls randomness (0-1)

top_p?number

Controls nucleus sampling

n?number

Number of completions to generate

stream?boolean

Whether to stream the response

max_tokens?number

Maximum tokens to generate

presence_penalty?number

Presence penalty (-2 to 2)

frequency_penalty?number

Frequency penalty (-2 to 2)

logit_bias?

Token logit bias

user?string

User identifier

conversationId?string

Conversation ID for multi-turn chat

tools?array<string>

Available tools

runConfig?

Run configuration

headers?

Headers data for template processing (validated against context config schema)

Response Body

text/event-stream

application/json

curl -X POST "https://agents-run-api.preview.inkeep.com/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "string",
    "messages": [
      {
        "role": "system",
        "content": "string"
      }
    ]
  }'

curl -X POST "https://agents-run-api.preview.inkeep.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "messages": [      {        "role": "system",        "content": "string"      }    ]  }'

"string"

{
  "error": "string",
  "details": [
    {
      "field": "string",
      "message": "string",
      "value": null
    }
  ]
}

{
  "error": "string"
}

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

Chat (Vercel Streaming Protocol)

Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. All endpoints require a valid API key in the Authorization header as "Bearer ". API keys can be created in the management UI.

In: header

Request Body

application/json

model?string

messages*

id?string

conversationId?string

stream?boolean

Whether to stream the response

Defaulttrue

max_tokens?number

Maximum tokens to generate

headers?

Headers data for template processing

runConfig?

Run configuration

Response Body

application/problem+json

curl -X POST "https://agents-run-api.preview.inkeep.com/api/chat" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "system"
      }
    ]
  }'

curl -X POST "https://agents-run-api.preview.inkeep.com/api/chat" \  -H "Content-Type: application/json" \  -d '{    "messages": [      {        "role": "system"      }    ]  }'

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"
  }
}

Approve or deny tool execution

Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. All endpoints require a valid API key in the Authorization header as "Bearer ". API keys can be created in the management UI.

In: header

Request Body

application/json

conversationId*string

The conversation ID

toolCallId*string

The tool call ID to respond to

approved*boolean

Whether the tool execution is approved

reason?string

Optional reason for the decision

Response Body

application/json

curl -X POST "https://agents-run-api.preview.inkeep.com/api/tool-approvals" \
  -H "Content-Type: application/json" \
  -d '{
    "conversationId": "string",
    "toolCallId": "string",
    "approved": true
  }'

curl -X POST "https://agents-run-api.preview.inkeep.com/api/tool-approvals" \  -H "Content-Type: application/json" \  -d '{    "conversationId": "string",    "toolCallId": "string",    "approved": true  }'

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

{
  "error": "string"
}

{
  "error": "string"
}

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

MCP Protocol

Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. All endpoints require a valid API key in the Authorization header as "Bearer ". API keys can be created in the management UI.

In: header

Header Parameters

x-inkeep-tenant-id?string

Tenant identifier

x-inkeep-project-id?string

Project identifier

x-inkeep-agent-id?string

Agent identifier

Response Body

curl -X POST "https://agents-run-api.preview.inkeep.com/v1/mcp"

curl -X POST "https://agents-run-api.preview.inkeep.com/v1/mcp"

Empty

/agents/.well-known/agent.json

Authorization

bearerAuth

AuthorizationBearer <token>

API key authentication. All endpoints require a valid API key in the Authorization header as "Bearer ". API keys can be created in the management UI.

In: header

Header Parameters

x-inkeep-tenant-id?string

Tenant identifier

x-inkeep-project-id?string

Project identifier

x-inkeep-agent-id?string

Agent identifier

Response Body

application/json

curl -X GET "https://agents-run-api.preview.inkeep.com/agents/.well-known/agent.json"

curl -X GET "https://agents-run-api.preview.inkeep.com/agents/.well-known/agent.json"

{
  "name": "string",
  "description": "string",
  "url": "string",
  "version": "string",
  "defaultInputModes": [
    "string"
  ],
  "defaultOutputModes": [
    "string"
  ],
  "skills": [
    null
  ]
}

Empty

204

200text/event-stream

400application/json

404application/json

500application/json

200

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

422application/problem+json

500application/problem+json

200application/json

400application/json

404application/json

500application/json

200

401

404

500

200application/json

404

text/event-stream

application/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/json

application/json

application/json

application/json