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

При необходимости сервис можно подключить к вашей учётной системе или CRM — инструкции и ключи доступа находятся в личном кабинете.

OpenAPI 3.1.0 · JSON
HTTPURLЗадача
POST /api/v1/jobs Create Analysis Job
GET /api/v1/jobs List Jobs
GET /api/v1/jobs/{job_id} Get Job Status
GET /api/v1/jobs/{job_id}/events Stream Job Events
GET /api/v1/jobs/{job_id}/report Get Job Report
GET /api/v1/jobs/{job_id}/export.xlsx Export Job Xlsx
GET /api/v1/jobs/{job_id}/export-clarification.docx Export Job Clarification Docx
GET /api/v1/jobs/{job_id}/export-fas.docx Export Job Fas Docx
GET /api/v1/catalogs/sample.xlsx Download Sample Catalog
POST /api/v1/catalogs/preview Preview Catalog
POST /api/v1/catalogs/upload Upload Catalog
GET /api/v1/catalogs List Catalogs
GET /api/v1/catalogs/{catalog_id} Get Catalog Detail
DELETE /api/v1/catalogs/{catalog_id} Delete Catalog
GET /api/v1/billing/tariffs List Tariffs
POST /api/v1/billing/orders Create Billing Order
POST /api/v1/billing/mock/pay/{order_id} Mock Pay Order
POST /api/v1/billing/webhooks/{provider} Handle Payment Webhook
POST /api/v1/billing/unlock/{job_id} Unlock With Balance
POST /api/v1/billing/invoice Create B2B Invoice
GET /api/v1/billing/orders/{order_id}/invoice.pdf Download Invoice Pdf
GET /api/v1/billing/balance Get Balance And History
POST /api/v1/auth/register Register User
POST /api/v1/auth/login Login User
POST /api/v1/auth/logout Logout User
GET /api/v1/auth/me Get Me
POST /api/v1/api-keys Create Api Key
GET /api/v1/api-keys List Api Keys
DELETE /api/v1/api-keys/{key_id} Revoke Api Key
GET /healthz Healthz