Content Extraction Async [multipart/form-data]

POST

https://mostqiapi.com/process-image/content-extraction

iocrcontent extractiondoc extractionextração de dadosocr

Last modified:2025-03-13 17:43:30

Rota assíncrona para extração do conteúdo textual de arquivos.

INFO

O resultado enviado ao servidor de callback segue o mesmo padrão do resultado é o mesmo da rota Content Extraction [multipart/form-data], com a adição do processId.

INFO

Ao chamar a API pelo body em multipart/form-data, para enviar múltiplas tags no parâmetro tags o cliente deve repetir o parâmetro, fornecendo um valor para cada tag desejada. Isso implica em redundância do parâmetro, onde cada valor corresponde a uma tag específica.

Imagem demonstrando a forma de envio de múltiplas tags via multipart/form-data.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

file

optional

🔸Requerido quando o parâmetro fileUrl não é informado.
Binário do arquivo a ser processado.

fileUrl

string

optional

🔸Requerido quando o parâmetro file não é informado.
Url pública do arquivo a ser processado.

filePassword

string <base64>

optional

🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha.
A senha deve ser codificada em uma string base64 (RFC 4648), pois PDFs permitem que as senhas sejam dados binários.

returnImage

string

optional

Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida

Default:

false

Examples:

truefalse

returnedImageQuality

string

optional

Não obrigatorio. Permite definir a qualidade da imagem de deskew retornada na rota de extração. O atributo é opcional, e seu valor padrão (quando não informando) é 75.

>= 0 characters<= 100 characters

Default:

returnCrops

string

optional

Se verdadeiro, retorna os recortes dos binários das imagens contidas dentro de um documento tipificado com a perspectiva corrigida, como recortes de foto, assinatura, código de barras e impressão digital. Consulte a lista de documentos lidos para visualizar todos os crops disponíveis.

Default:

false

Examples:

truefalse

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mostqiapi.com/process-image/content-extraction' \
--header 'Authorization: Bearer ' \
--form 'file=@""' \
--form 'fileUrl=""' \
--form 'filePassword=""' \
--form 'returnImage=""' \
--form 'returnedImageQuality=""' \
--form 'returnCrops=""' \
--form 'tags=""' \
--form 'webhookUrl=""' \
--form 'webhookFallbackUrl=""' \
--form 'webhookAuthorizationHeaders[0].name=""' \
--form 'webhookAuthorizationHeaders[0].value=""' \
--form 'webhookAuthorizationQueryStrings[0].name=""' \
--form 'webhookAuthorizationQueryStrings[0].value=""' \
--form 'webhookAuthorizationMtls=""'

Responses

🟢200OK

application/json

Body

result

object

required

Lista contendo o resultado do método (consulte na documentação específica de cada um).

processId

string

required

ID referente ao processo assíncrono de extração iniciado a partir desta requisição. Este ID é uma referência, e será enviado nas requisições assíncronas que serão feitas pelo servidor do mostQI ao endpoint especificado no corpo da requisição através dos parâmetros webhookUrl ou webhookFallbackUrl.

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

object | null

required

Lista de objetos do tipo Error, o formato é variável.

Example

{
  "result": {
    "processId": "67a7ae91-4d7f-48e2-ad03-94ff19e1b32d"
  },
  "requestId": "kyamMSMguEe19elsr6SFB",
  "elapsedMilliseconds": 17,
  "status": {
    "message": "Ok",
    "code": "201",
    "errors": null
  }
}

🟢200OK webhook

🟠401R117 Invalid authorization data

🟠400R101 A specified parameter is wrong

🟠400R130 Unsupported file format

🔴500E100 The request could not be processed

Modified at 2025-03-13 17:43:30

Content Extraction Async

Content Extraction Async Status [multipart/form-data]