ZvenoAI
API Reference

Create Rerank

POST
/v1/rerank

Ранжирует документы по релевантности поисковому запросу. Принимает строки или объекты с текстом и/или изображением. Результаты отсортированы по убыванию релевантности. usage.cost — фактически списанная сумма в рублях.

Ошибки 400: error.metadata.reason = empty_documents при пустом списке; top_n_out_of_range, если top_n меньше 1 или больше количества документов.

Аутентификация: Authorization: Bearer .

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:8080/v1/rerank" \  -H "Content-Type: application/json" \  -d '{    "model": "string",    "query": "string",    "documents": [      "string"    ]  }'
{
  "id": "string",
  "object": "rerank",
  "model": "string",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.1,
      "document": {
        "text": "string",
        "image": "string"
      }
    }
  ],
  "usage": {
    "search_units": 0,
    "total_tokens": 0,
    "cost": 0.1
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }
}

List Embedding Models GET

Возвращает список доступных embedding моделей с информацией о размерности, ценах и поддерживаемых возможностях. Авторизация не требуется.

Audio Transcriptions POST

Транскрибирует аудиофайл в текст. Совместим с OpenAI Audio Transcriptions API — можно использовать любой OpenAI SDK, указав `base_url: "https://api.zveno.ai/v1"`. Ограничение на размер файла: **25 MB**. Поддерживаемые форматы входного аудио: `mp3`, `mp4`, `mpeg`, `mpga`, `m4a`, `wav`, `webm`. Формат ответа (`response_format`) зависит от модели и подключения. При прямом подключении: - `openai/whisper-1` — `json`, `text`, `srt`, `verbose_json`, `vtt` - `openai/gpt-4o-transcribe`, `openai/gpt-4o-mini-transcribe` — `json`, `text` - `openai/gpt-4o-transcribe-diarize` — `json`, `text`, `diarized_json` (с сегментами по говорящим) Для остальных подключений доступны только `json` и `text`. Неподдерживаемый формат возвращает 400 с `error.metadata.reason = response_format_unsupported` до обращения к поставщику. Референсные аудио-сэмплы говорящих (`known_speaker_references`) передаются как data URLs и принимают те же форматы, что и входной файл. Модель указывается в формате `vendor/model` (например, `openai/whisper-1`). Аутентификация: `Authorization: Bearer <api-key>`.