Image Properties [application/json]

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

optional

🔸Requerido quando o parâmetro fileUrl não é informado. Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648, usando a codificação base64.

fileUrl

string

optional

🔸Requerido quando o parâmetro fileBase64 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.

Example

{
  "fileBase64": "",
  "fileUrl": "",
  "filePassword": ""
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mostqiapi.com/process-image/image-properties' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileBase64":"",
    "fileUrl":"",
    "filePassword":""
}'

Responses

🟢200OK

application/json

Body

result

array [object {1}]

required

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

extractions

array [object {2}]

optional

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.

message

string | null

required

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": [
    {
      "extractions": [
        {
          "source": "compute-grayscale",
          "sections": [
            {
              "pages": [
                {
                  "number": 1,
                  "score": 0.34
                },
                {
                  "number": 2,
                  "score": 0.41
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "requestId": "gzP3Ix8PB0iWf8EZvbW1j",
  "elapsedMilliseconds": 2034,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed