Skip to main content
GET
Status e resultado de uma requisição
Consulta o status e o resultado de uma extração. Veja também GET /extract/{requestId}/markdown (texto em markdown) e GET /extract/{requestId}/bounding-box (coordenadas dos campos).

Authorizations

Authorization
string
header
required

Chave de API enviada no cabeçalho Authorization no formato: Authorization: Bearer <API_KEY>.

Path Parameters

requestId
string
required

Identificador da requisição.

Response

Estado da requisição.

request_id
string
document_type
string | null
status
string
current_step
string | null
callback_url
string | null
reference_id
string | null
validation_errors
object[] | null

Resultados de validação por campo (field, error, etc.). Para a visão consolidada, prefira fields e scanify.

payload
object | null

Quando status === 'completed' (ou 'success'/'partial_success'/'failed' no terminal), contém o ExtractionResult completo. Enquanto a requisição ainda está em processamento, é null.

metadata
object | null
created_at
string<date-time> | null
completed_at
string<date-time> | null
processed_at
string<date-time> | null
markdown_status
enum<string> | null
Available options:
pending,
success,
failed
markdown_generated_at
string<date-time> | null