inference

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. For OpenAI GPT-5.5 and GPT-5.6 function-tool requests, Aixy sets reasoning_effort to none because reasoning with tools requires the Responses API.

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."
    }
  ]
}
'

import requests

url = "https://api.aixy-gateway.com/v1/chat/completions"

payload = {
    "model": "openai/gpt-4.1-mini",
    "messages": [
        {
            "role": "user",
            "content": "Explain this code."
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'openai/gpt-4.1-mini',
    messages: [{role: 'user', content: 'Explain this code.'}]
  })
};

fetch('https://api.aixy-gateway.com/v1/chat/completions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "object": "chat.completion",
  "created": 123,
  "model": "<string>",
  "choices": [
    {}
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  }
}

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

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

temperature

number

max_tokens

integer

Required range: x >= 1

Response

Successful response or server-sent event stream.

string

object

string

Example:

"chat.completion"

created

integer

model

string

choices

object[]

usage

object

Show child attributes

Create a chat completion

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."
    }
  ]
}
'

import requests

url = "https://api.aixy-gateway.com/v1/chat/completions"

payload = {
    "model": "openai/gpt-4.1-mini",
    "messages": [
        {
            "role": "user",
            "content": "Explain this code."
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'openai/gpt-4.1-mini',
    messages: [{role: 'user', content: 'Explain this code.'}]
  })
};

fetch('https://api.aixy-gateway.com/v1/chat/completions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "object": "chat.completion",
  "created": 123,
  "model": "<string>",
  "choices": [
    {}
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1
  }
}

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

users

authentication

privacy

activity

api-keys

audit

identity connections

billing

cost-optimization

cost-control

custom domains

data processing

feature flags

system

guardrails

operations

MCP beta

metrics

monitors

organizations

playground

pricing

projects

provider-catalog

provider-credentials

provider-models

roles

routing

teams

telemetry exports

inference

models

Create a chat completion

Authorizations

Headers

Body

Response