Generative Content Extraction

CAUTION

É obrigatório o envio do parâmetro tags para determinar o modelo a ser utilizado no processamento do arquivo.

Valores aceitos:

tag	modelo
id=bra-nlp-registro-imovel-1	Registro de Imóveis
id=bra-nlp-contrato-social-1	Contrato Social

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

required

Binário do arquivo a ser processado.

tags

string

required

Parâmetro obrigatório para determinar o modelo a ser utilizado no processamento do arquivo. Valores aceitos (envie apenas um deles):

id=bra-nlp-registro-imovel-[0-9]+

filePassword

string

optional

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

webhook.url

string

optional

Endpoint para o qual o mostValid fará uma requisição enviando os dados processados do documento durante o processo de extração. Insira no valor a URL que receberá a chamada do mostValid.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 mostValid ao endpoint especificado no cabeçalho webhook.

requestId

string

required

Identificador único da solicitação.

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.

message

string | null

required

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

code

string

required

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

errors

array [object {2}] | null

required

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

Example

{
  "result": {
    "processId": "6652fe96-3f8f-4336-9be8-44c81d957e53"
  },
  "requestId": "l82gYzaRN0jcs06sxUoqe",
  "elapsedMilliseconds": 45,
  "status": {
    "message": "Ok",
    "code": "S200",
    "errors": null
  }
}

🟠400R101 A specified parameter is wrong

🟠400R300 Client isn't registered yet or has a invalid token

🔴500E100 The request could not be processed