POST/v1/cards

Завантажити файл як картку

upload_card

Надішліть документ у полі file форми multipart/form-data. Перед збереженням Sursa перевіряє, що розширення імені файлу, оголошений Content-Type частини та сигнатура вмісту узгоджуються:
- PDF;
- DOCX, XLSX, XLSM, PPTX: ZIP з оголошеним типом основного документа;
- ODS: ZIP із записом mimetype;
- XLS: документ OLE2 з потоком книги;
- TXT, MD, CSV, TSV, HTML, AsciiDoc, EML: текст без нульових байтів у UTF-8 або в однобайтовому кодуванні, а для електронних листів — із заголовками на початку;
- PNG, JPEG, TIFF, WebP, BMP: за сигнатурою.

Невідповідність повертає 415 files.type_mismatch; розширення поза списком форматів повертає 415 cards.unsupported_format. Файл, більший за ліміт завантаження інсталяції або за загальне сховище організації на її тарифі, повертає 413 files.too_large. Якщо ввімкнено антивірусну перевірку, заражений файл повертає 422 files.infected, а якщо антивірус недоступний і діє політика «reject», запит повертає 503 files.scan_unavailable. Кожне відхилення записується до журналу аудиту як file.rejected.

Замість форми можна надіслати тіло application/json (CardUploadFromUpload, починаючи з 1.62.0): файлом слугує готове завантаження частинами upload_id (POST /v1/uploads з метою card_file), поля такі самі, як у формі, а tags — список рядків. Файл завантаження вже перевірено під час complete (формат, антивірус), а ліміт розміру — це ліміт завантаження частинами, а не ліміт завантаження одним запитом. Завантаження використовується один раз, у тій самій транзакції, що створює картку: уже використане завантаження повертає 409 uploads.already_used, ще не готове — 409 uploads.not_ready, відхилене — 422 uploads.rejected, з іншою метою — 422 uploads.purpose_mismatch, прострочене — 410 uploads.expired, а чуже або невідоме завантаження — 404 uploads.not_found. Якщо перевірки картки не пройдено (колекція, категорія, ліміти), завантаження не витрачається.

Автентифікація

Передайте ключ API в заголовку Authorization: Authorization: Bearer <ключ>.

Параметри заголовка

Idempotency-Keystring
Ключ для безпечного повтору операції запису: від 1 до 255 друкованих символів ASCII; рекомендовано окремий UUID v4 для кожної логічної операції. Повтор із тим самим ключем протягом 24 годин не виконує операцію знову: він повертає збережену відповідь (статус, заголовки й тіло) із заголовком Idempotency-Replayed: true. Той самий ключ з іншим методом, шляхом, Content-Type або тілом повертає 409 api.idempotency_mismatch; поки перший запит ще виконується — 409 api.idempotency_in_progress з Retry-After: 1. Після відповіді 5xx або 429 ключ звільняється, і повтор знову виконує операцію. Ключ діє в межах організації та того, хто викликає (ключ API, користувач або ключ власного джерела).
length ≥ 1, length ≤ 255
X-View-Asstring
Лише для ключів API з роллю admin. Виконує запит від імені профілю доступу <profile>[:viewer|verifier|editor], наприклад employee:viewer. Ключ інсталяції не може використовувати цей заголовок (403).

Параметри cookie

kb_view_asstring
Cookie режиму «View as» для сесії. Встановлюється через POST /auth/view-as, очищається через DELETE /auth/view-as.

Тіло запиту

multipart/form-data

Об’єкт: CardUploadForm

filestring (application/octet-stream)обов’язково
collectionstring
Типове значення: "default"
tagsstring
Типове значення: ""
forceboolean
Типове значення: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Типове значення: false
reviewboolean
Типове значення: false
folder_idstring | null
Папка колекції collection, у яку треба покласти нову картку. Для папки іншої колекції повертається 400 folders.card_collection_mismatch, для неіснуючої папки — 404 folders.not_found, а без дозволу COLLECTION_EDIT_CARDS на папку — 403 authz.forbidden. Перевірка виконується до збереження файлу. Дублікат уже завантаженого файлу (skipped) до папки не переміщується.
length ≤ 64
collection_idinteger | null
Колекція за ID. Якщо передано також collection, перевагу має collection_id. Для колекції, якої немає в організації або яку не видно, повертається 404 collections.not_found.
external_idstring | null
external_id нової картки. З ним картка створюється, навіть якщо в колекції вже є такий самий файл. Якщо його використовує інша картка організації, запит повертає 409 cards.external_id_taken. Щоб створити або замінити картку за external_id, використовуйте PUT /v1/cards-by-external-id/{external_id}.
length ≤ 512
metadatastring | null
metadata нової картки: об’єкт JSON як значення поля форми. Правила — як у MetadataPatch.

application/json

Об’єкт: CardUploadFromUpload

upload_idstringобов’язково
Готове завантаження (ready) з метою card_file; використовується один раз.
collectionstring
Типове значення: "default"
collection_idinteger | null
Колекція за ID. Якщо передано також collection, перевагу має collection_id. Для колекції, якої немає в організації, яку не видно або яка лежить поза колекціями ключа, повертається 404 collections.not_found.
tagsarray of string
items ≤ 30
forceboolean
Типове значення: false
owner_idinteger | null
verify_interval_daysinteger | null
categorystring | null
sensitiveboolean | null
asyncboolean
Типове значення: false
reviewboolean
Типове значення: false
folder_idstring | null
length ≤ 64
external_idstring | null
external_id нової картки, як у полі форми. З ним картку створюють, навіть якщо в колекції вже є такий самий файл. Якщо його використовує інша картка організації, запит повертає 409 cards.external_id_taken.
length ≤ 512
metadataMetadataPatch

Відповіді

200`queued` (асинхронно), `skipped` (дублікат), `ready` або `error` (синхронно).

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.
Idempotency-Replayed
true означає, що відповідь відтворено зі збереженої для цього Idempotency-Key: операцію не виконано повторно.

application/json

Об’єкт: UploadResult

statusstringобов’язково
Допустимі значення: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged або an identical file is already indexed.
tablesinteger
timingsobject
Поля
- total_snumber
errorstring

400Неправильний запит: значення параметра або стан об’єкта не дозволяє виконати дію (`detail` — повідомлення).

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

401Облікові дані не надіслано (ні cookie сесії, ні ключа API) або ключ не знайдено.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

402Організація досягла ліміту тарифу (картки, сховище або користувачі). `error.details` містить `kind`, `limit` і `used`.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

403Дію не дозволено: роль не має достатніх прав, немає доступу до колекції чи картки, запит виконується в режимі «View as» або організацію призупинено чи видалено (`detail` — об’єкт із `code: org_suspended | org_deleted`).

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

404Об’єкт не існує або недоступний вам. API не підтверджує існування об’єкта з обмеженим доступом.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

409Стан об’єкта не дозволяє виконати дію: наприклад, це дублікат, індексація ще триває або завдання вже оброблено.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

410Об’єкт існував, але більше не доступний: посилання вже використано або строк його дії сплив, або файл видалено після закінчення строку зберігання.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

413Тіло запиту перевищує допустимий розмір.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

415Формат файлу не підтримується.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

422Помилка валідації: тіло або параметри не відповідають схемі (`detail` — список помилок валідації) або значення параметра виходить за допустимі межі (`detail` — повідомлення).

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

429Забагато запитів (`api.rate_limited`), квоту організації на хвилину, день або місяць вичерпано (`api.quota_exceeded`; `error.details` містить `quota`, `limit` і `reset_at`), досягнуто ліміту організації або сервіс відповідей зайнятий (`answers.engine_busy`). Зачекайте стільки, скільки вказано в заголовку `Retry-After`.

Заголовки відповіді

Retry-After
Кількість секунд, які слід зачекати перед повторним запитом.
RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

503Сервіс, від якого залежить цей запит, тимчасово недоступний. Повторіть спробу пізніше.

Заголовки відповіді

RateLimit-Policy
Чинні ліміти у форматі чернетки IETF draft-ietf-httpapi-ratelimit-headers: елементи через кому "<name>";q=<quota>;w=<window in seconds>. key — частота запитів ключа API (квота — це сплеск, вікно — час, за який квота повністю відновлюється; для сесії цей елемент називається user, без облікових даних — ip); minute, day і month — квоти організації на календарну хвилину, день і місяць за UTC.
RateLimit
Скільки лишилося за кожним лімітом із RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Ліміт найсуворішого елемента в RateLimit-Policy (того, за яким лишилося найменше запитів).
X-RateLimit-Remaining
Скільки запитів лишилося за найсуворішим лімітом.
X-RateLimit-Reset
Кількість секунд до скидання найсуворішого ліміту.

application/json

Об’єкт: Error

Коди помилок

Коди, які ця операція може повернути в error.code, крім загальних кодів будь-якого запиту.

Безпечні повтори

Надсилайте заголовок Idempotency-Key (наприклад, UUID) з кожним POST і PATCH. Повтор із тим самим ключем протягом 24 годин повертає збережену відповідь, а не виконує запит знову.

Ліміти частоти

Відповіді містять заголовки RateLimit і RateLimit-Policy, а також давніші X-RateLimit-Limit, X-RateLimit-Remaining і X-RateLimit-Reset. Відповідь 429 містить Retry-After у секундах: зачекайте й повторіть запит.

← cards · Довідник API

curl -X POST 'https://api.sursa.com/v1/cards' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"upload_id":"upl_0123456789abcdef0123456789abcdef"}' \
  -H "Authorization: Bearer $SURSA_API_KEY"

Спробувати

Ключ API

Ключ зберігається лише в пам’яті цієї вкладки й надсилається тільки на https://api.sursa.com.

Запити працюють зі справжніми даними вашої організації.

Idempotency-Key header

X-View-As header

Idempotency-Key

Якщо поле порожнє, для кожного запиту генерується новий ключ.

Тіло запиту (JSON)