ionicons-v5_logos
StarInkeep Cloud
Inkeep Agents Manage API

Inkeep Agents Run API

Copy page

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

Health check

Check if the execution service is healthy

GET
/health

Authorization

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

Create chat completion

Creates a new chat completion with streaming SSE response using the configured agent

POST
/v1/chat/completions

Authorization

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

modelstring

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

application/json

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"      }    ]  }'
"string"
{
  "error": "string",
  "details": [
    {
      "field": "string",
      "message": "string",
      "value": null
    }
  ]
}
{
  "error": "string"
}
{
  "error": "string",
  "message": "string"
}

Chat (Vercel Streaming Protocol)

Chat completion endpoint streaming with Vercel data stream protocol.

POST
/api/chat

Authorization

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

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

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

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

MCP Protocol

Handles Model Context Protocol (MCP) JSON-RPC requests

POST
/v1/mcp

Authorization

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

/agents/.well-known/agent.json

GET
/agents/.well-known/agent.json

Authorization

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"
{
  "name": "string",
  "description": "string",
  "url": "string",
  "version": "string",
  "defaultInputModes": [
    "string"
  ],
  "defaultOutputModes": [
    "string"
  ],
  "skills": [
    null
  ]
}
Empty