#Models

Catalog of AI models available to the current API key. The catalog contents depend on the configured provider credentials: free Bitrix24 models are visible to everyone, the rest only to keys that have access to the provider credentials.

Scope: vibe:ai

#List models

The response comes in raw OpenAI format.

The {success, data} envelope used across the other Vibecode endpoints — /v1/deals, /v1/tasks and others — is not present here.

This is done for compatibility with the OpenAI SDK. If you have a single client with an if (!response.success) check, add an exception for the AI Router.

GET /v1/models

Returns the catalog of AI models available to the current API key. The response format is fully compatible with GET /v1/models from the OpenAI API. Free Bitrix24 models are visible to everyone. Third-party provider models are visible only to keys that have access to the provider credentials.

#Parameters

No request parameters.

#Examples

#curl — personal key

curl https://vibecode.bitrix24.com/v1/models \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth application

curl https://vibecode.bitrix24.com/v1/models \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/models', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
data.forEach((m) => {
  console.log(`${m.id} — ${m.name}, context ${m.context_length}, price ${m.pricing.prompt}/${m.pricing.completion} Vibe credits per 1M tokens`)
})

#JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/models', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { data } = await res.json()
console.log('Models available:', data.length)

#Response fields

#Response example

{
  "object": "list",
  "data": [
    {
      "id": "bitrix/bitrixgpt-5.5",
      "object": "model",
      "created": 0,
      "owned_by": "bitrix",
      "name": "BitrixGPT 5.5 (free)",
      "context_length": 262144,
      "max_output_tokens": 65536,
      "pricing": {"prompt": 0, "completion": 0, "unit": "vibes"},
      "capabilities": {"streaming": true, "vision": true, "structured_outputs": true}
    },
    {
      "id": "bitrix/bitrixgpt-5.5-thinking",
      "object": "model",
      "created": 0,
      "owned_by": "bitrix",
      "name": "BitrixGPT 5.5 Thinking (free)",
      "context_length": 262144,
      "max_output_tokens": 65536,
      "pricing": {"prompt": 0, "completion": 0, "unit": "vibes"},
      "capabilities": {"streaming": true, "vision": true, "reasoning": true, "structured_outputs": true}
    },
    {
      "id": "bitrix/bitrixgpt-5.5-agent",
      "object": "model",
      "created": 0,
      "owned_by": "bitrix",
      "name": "BitrixGPT 5.5 Agent",
      "context_length": 262144,
      "max_output_tokens": 65535,
      "pricing": {"prompt": 68.4, "completion": 342, "unit": "vibes"},
      "capabilities": {"streaming": true}
    }
  ]
}

#Error response example

403 scope_missing — the API key has no vibe:ai scope:

{
  "error": {
    "message": "API key does not have the vibe:ai scope required for AI endpoints. Add vibe:ai scope to your API key in portal settings.",
    "type": "invalid_request_error",
    "code": "scope_missing"
  }
}

#Errors

The full list of common API errors — Errors.

#Known specifics

Visibility depends on the configured credentials. The catalog shows only the models for which the current API key has access to provider credentials — shared across the whole platform, shared within the Bitrix24 account, or your personal BYOK. Bitrix24 models (bitrix/*) are available to everyone without connecting BYOK. If the model you need is not in the list — connect your own key.

Models in DEPRECATED status remain in the list. They are marked as deprecated, but requests to them still work — the Deprecation and Sunset headers will be returned. Models in DISABLED status are hidden from the list, but when explicitly specified in model they are transparently redirected to the successor model.

Prices are in Vibe credits per one million tokens. The pricing.unit: "vibes" field explicitly marks the currency so that an external client can programmatically check the unit of measure. Vibe credits are the platform's internal currency; the balance is topped up in your account.

Not all models are billed by tokens. For a speech-recognition model, prompt and completion are 0, and billing is driven by the perMinute field per audio minute and perCall per call. Zero prompt and completion on their own do not mean the call is free — check all four pricing fields.

#See also

• Get model
• Create chat completion
• Embeddings
• Your own keys (BYOK)