OpenAI

Create a chat completion

Create an OpenAI-compatible chat completion. Use a provider-qualified model such as openai/gpt-4.1-mini to select a provider explicitly, or an aixy/<routing-model> reference to use a project routing policy. Set stream to true to receive incremental server-sent events. Aixy preserves matching native protocols and translates supported stateless conversations otherwise. Advanced fields without a supported translation are rejected explicitly. Aixy selects a compatible provider API for reviewed model contracts while preserving the requested reasoning effort. Plaintext assistant history in reasoning or reasoning_content is accepted during translation but is omitted when the destination has no compatible plaintext history carrier; it does not recreate signed or encrypted provider continuation.

POST

chat

completions

curl --request POST \
  --url https://api.aixy-gateway.com/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-4.1-mini",
  "messages": [
    {
      "role": "user",
      "content": "Explain this code."
    }
  ]
}
'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 0,
  "model": "openai/gpt-4.1-mini",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 8,
    "completion_tokens": 2,
    "total_tokens": 10
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "gateway_rate_limit_exceeded",
    "message": "The configured rate limit was reached. Retry later."
  }
}

Internal Server Error

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{}

Authorizations

Authorization

string

header

required

A project-scoped Aixy API key. Create keys in the dashboard and send the secret as a Bearer token.

Headers

X-Request-ID

string

Optional caller-generated request identifier for end-to-end tracing.

Maximum string length: 255

X-Aixy-Client

string

Optional application[/version] for Activity attribution. Overrides User-Agent detection. Use a product name, not personal data or credentials. Names are 1-64 ASCII letters, digits, spaces, dots, underscores or hyphens, starting with a letter or digit. Optional versions start with a digit and use up to 32 letters, digits, dots, underscores, plus signs or hyphens. Invalid values are ignored. This self-declared label grants no permissions and is not forwarded.

Maximum string length: 97

Example:

"Acme Support/1.2.3"

X-Aixy-Session

string

Optional opaque session identifier for virtual routes with session affinity. Scoped to the authenticated caller and alias; never forwarded or recorded. Send full conversation history. Invalid values return 400 when affinity is enabled. Omission retains the route's normal strategy.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"conversation-82"

X-Aixy-Session-ID

string

Optional opaque conversation identifier recorded in Activity metadata. Reuse it for every call in a conversation. Sessions are isolated by organization, project, user and API key. Use no personal data or secrets. Invalid values are ignored. The header is not forwarded, grants no permissions and does not change routing affinity.

Required string length: 1 - 128

Pattern: ^[A-Za-z0-9._:-]+$

Example:

"conversation-82"

X-Provider

string

Select a configured provider without changing an unqualified model identifier. A provider-qualified model is preferred for new integrations.

Body

application/json

model

string

required

Provider-qualified or Aixy routing model identifier.

Example:

"openai/gpt-4.1-mini"

messages

object[]

required

Minimum array length: 1

Show child attributes

stream

boolean

default:false

stream_options

object

Show child attributes

temperature

number

top_p

number

max_tokens

integer

Legacy output-token bound; use the field supported by your selected model.

Required range: x >= 1

max_completion_tokens

integer

Output-token bound, including reasoning where the provider counts it.

Required range: x >= 1

stop

tools

object[]

Show child attributes

tool_choice

Available options:

none,

auto,

required

parallel_tool_calls

boolean

response_format

object

Structured output support depends on the model and provider API.

Show child attributes

reasoning_effort

enum<string> | null

Requested reasoning effort. Supported values depend on the destination model.

Available options:

auto,

none,

minimal,

low,

medium,

high,

xhigh,

max,

null

seed

integer

frequency_penalty

number

presence_penalty

number

integer

default:1

Translated requests support one completion. Native model limits apply.

Required range: x >= 1

service_tier

string | null

Provider service tier when supported; also affects pricing attribution.

Response

Successful response or server-sent event stream.

string

object

string

Example:

"chat.completion"

created

integer

model

string

choices

object[]

Show child attributes

usage

object | null

Show child attributes

curl --request POST \
  --url https://api.aixy-gateway.com/v1/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "openai/gpt-4.1-mini",
  "messages": [
    {
      "role": "user",
      "content": "Explain this code."
    }
  ]
}
'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 0,
  "model": "openai/gpt-4.1-mini",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 8,
    "completion_tokens": 2,
    "total_tokens": 10
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "gateway_rate_limit_exceeded",
    "message": "The configured rate limit was reached. Retry later."
  }
}

Internal Server Error

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{
  "error": {
    "code": "invalid_gateway_api_key",
    "message": "Gateway API key is invalid or revoked"
  }
}

{}

OpenAI

Decisions

Anthropic

Models

Create a chat completion

Authorizations

Headers

Body

Response