OCR Platform
Admin

URL base API

https://ocr.789.com.mx/v1

Referencia de endpoints

Base URL: https://ocr.789.com.mx/v1

Todos los endpoints requieren X-API-Key salvo el health check.

Health (sin autenticación)

Método Ruta Descripción
GET https://ocr.789.com.mx/health/live Estado del servicio

Documentos

Método Ruta Scope Descripción
POST /documents documents:create Subir documento (multipart/form-data)
GET /documents documents:read Listar documentos
GET /documents/{document_id} documents:read Detalle y estado
GET /documents/{document_id}/result results:read Resultado OCR
POST /documents/{document_id}/cancel documents:create Cancelar si aún no se procesó

GET /documents acepta status, profile, external_reference, created_from, created_to, page y per_page (máx. 100). Detalle de campos y respuestas en Flujo: documento OCR.

Extracciones

Método Ruta Scope Descripción
POST /extractions extractions:create Crear extracción (application/json)
GET /extractions extractions:read Listar extracciones
GET /extractions/{extraction_id} extractions:read Detalle y estado
GET /extractions/{extraction_id}/result extractions:read JSON validado

GET /extractions acepta status, document_id, created_from, created_to, page y per_page (máx. 100). Detalle en Flujo: extracción.

Uso / consumo

Método Ruta Scope Descripción
GET /usage usage:read Consumo del proyecto (tokens, costo estimado, documentos, páginas)

Acepta from y to (fechas YYYY-MM-DD, opcionales; por defecto el mes en curso). Ver Consumo.

Convenciones

  • Identificadores públicos: doc_..., ext_...
  • Fechas en respuestas: ISO 8601 UTC
  • POST /documents y POST /extractions: header Idempotency-Key obligatorio
  • Respuestas exitosas envuelven datos en { "data": ..., "meta": { "request_id": ... } }; los listados agregan meta.pagination (page, per_page, total, last_page)
  • Solo ves los recursos creados con tu API Key
  • Límite: 120 peticiones por minuto por API Key (429 rate_limit_exceeded)

Más detalle