Documentation

Quickstart

1. 1. Sign up
2. 2. Top up your balance and create an API key in the dashboard.
3. 3. Paste your key into the snippet below and run the request.

curl https://apimira.com/v1/chat/completions \
  -H "Authorization: Bearer ya-ВАШ_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5.4-mini",
    "messages": [
      {
        "role": "user",
        "content": "Hello!"
      }
    ]
  }'

The base_url is the address above with a /v1 suffix. The model is set via the model parameter.

Copy the Model ID from the catalog in full, including the part before «/»: for example openai/gpt-5.4-mini or anthropic/claude-sonnet-4.6.

Connect your apps

Any app with an OpenAI-compatible API connects with three values:

If the field is just «Base URL», the app appends /chat/completions itself — do not add it. And make sure the address does not end up as /v1/v1.

To test the key without an app, run the request from the Quickstart block above.

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "yourapi": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "yourapi",
      "options": {
        "baseURL": "https://apimira.com/v1",
        "apiKey": "ya-ВАШ_КЛЮЧ"
      },
      "models": {
        "openai/gpt-5.4-mini": { "name": "GPT-5.4 Mini" },
        "anthropic/claude-sonnet-4.6": { "name": "Claude Sonnet 4.6" }
      }
    }
  }
}

Chat — generate a response

POST /v1/chat/completions

Generates a model response. Supports stream=true (SSE). Request and response formats match OpenAI.

Streaming: pass "stream": true. Chunks arrive as data: {...} and end with data: [DONE].

Supported: text chat, image generation and speech (TTS). In chat, the tools, response_format and vision parameters return 400 for now.

Image generation

POST /v1/images/generations

POST /v1/images/generations — synchronous, request and response are OpenAI Images-compatible. A fixed price per image is charged, multiplied by the count (n).

curl https://apimira.com/v1/images/generations \
  -H "Authorization: Bearer ya-ВАШ_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "image/gpt-image-2",
    "prompt": "a red cat wearing glasses",
    "n": 1
  }'

The model must be an image model (see GET /v1/models). The response is a data array with a b64_json field (base64 image) or url.

Speech (TTS)

POST /v1/audio/speech

POST /v1/audio/speech — synchronously turns text into speech. The response is binary audio bytes (mp3 by default). A fixed price per request is charged.

curl https://apimira.com/v1/audio/speech \
  -H "Authorization: Bearer ya-ВАШ_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "audio/elevenlabs-tts",
    "input": "Привет! Это синтез речи.",
    "voice": "alloy"
  }' \
  --output speech.mp3

The model must be an audio model (see GET /v1/models). Parameters: input (text), voice, response_format.

Endpoints

Error codes

Common questions