Документация

Минимальный пример запроса

Распознать текст на одном изображении.

curl --request POST \
  --url https://ai.wormsoft.ru/api/ocr \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "sources": [
      { "image": "data:image/jpeg;base64,/9j/4AAQSkZJRg..." }
    ],
    "prompt": "",
    "responseSchema": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "text": { "type": "string", "description": "Распознанный текст" }
      },
      "required": ["text"]
    },
    "model": "wormsoft/vision/medium"
  }'

Пакетная обработка

В sources можно отправить несколько изображений и PDF-файлов одним запросом (до 20 источников). Ответ — всегда массив: по элементу на каждый входной источник. Один prompt и одна responseSchema применяются ко всем источникам.

{
  "sources": [
    { "image": "data:image/jpeg;base64,/9j/4AAQ..." },
    { "pdfFile": "JVBERi0xLjQK..." },
    { "image": "iVBORw0KGgo..." }
  ],
  "prompt": "Распознай текст",
  "responseSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": { "text": { "type": "string" } },
    "required": ["text"]
  },
  "model": "wormsoft/vision/medium"
}

Структурированное распознавание

Схема под конкретный кейс: например, подсчёт людей на фото или извлечение полей договора. Рекомендации: указывайте additionalProperties: false и required; для полей, которые могут отсутствовать, используйте union-тип ["string", "null"]; описывайте каждое поле в description.

{
  "sources": [{ "image": "data:image/jpeg;base64,/9j/4AAQ..." }],
  "prompt": "Посчитай количество людей, видимых на фотографии",
  "responseSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "peopleCount": { "type": "integer", "description": "Количество людей на фотографии" }
    },
    "required": ["peopleCount"]
  },
  "model": "wormsoft/vision/medium"
}

PDF-документы

PDF-файл в sources (pdfFile) разбивается на страницы (до 50), каждая страница распознаётся отдельным запросом с той же схемой. В ответе по документу будет массив pages постранично. Если нужен единый результат по всему PDF — собирайте поля pages[i].data на своей стороне.

{
  "sources": [{ "pdfFile": "JVBERi0xLjQK..." }],
  "prompt": "Договор. Распознай стороны и сумму",
  "responseSchema": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "partyA": { "type": ["string", "null"] },
      "partyB": { "type": ["string", "null"] },
      "amount": { "type": ["number", "null"] }
    },
    "required": ["partyA", "partyB", "amount"]
  },
  "model": "wormsoft/vision/medium"
}

Пример ответа

documents — всегда массив: по элементу на каждый входной источник (для изображения — одна страница, для PDF — постранично).

{
  "model": "wormsoft/vision/medium",
  "documents": [
    {
      "documentIndex": 0,
      "pageNumbers": [1],
      "pages": [
        {
          "pageNumber": 1,
          "data": { "text": "Распознанный текст..." },
          "usage": { "inputTokens": 1234, "outputTokens": 567, "credits": 100 }
        }
      ]
    },
    {
      "documentIndex": 1,
      "pageNumbers": [1, 2],
      "pages": [
        { "pageNumber": 1, "data": { "text": "Страница 1..." },
          "usage": { "inputTokens": 1234, "outputTokens": 567, "credits": 100 } },
        { "pageNumber": 2, "data": { "text": "Страница 2..." },
          "usage": { "inputTokens": 1234, "outputTokens": 567, "credits": 100 } }
      ]
    }
  ],
  "usage": { "inputTokens": 4936, "outputTokens": 2268, "credits": 400 }
}

/api/ocr/document — распознавание «под ключ»

Метод «под ключ» для текстовых документов: промпт, схема ответа ({"text": "string"}) и модель зашиты на стороне сервиса. На вход — массив documents (то же самое, что sources: элементы с image или pdfFile), на выходе — постраничный текст каждого документа.

curl --request POST \
  --url https://ai.wormsoft.ru/api/ocr/document \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "documents": [
      { "pdfFile": "JVBERi0xLjQK..." },
      { "image": "data:image/png;base64,iVBORw0KGgo..." }
    ]
  }'

Ответ имеет тот же формат, что у /api/ocr (без поля model): documents[i].pages[j].data.text — текст страницы.

Ошибки и лимиты