Image Properties [multipart/form-data]

Requisição

Parâmetros Header

Authorization

string

requerido

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

Exemplo:

Bearer {{bearer_token}}

Parâmetros Bodymultipart/form-data

file

opcional

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

fileUrl

string

opcional

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

filePassword

string <base64>

opcional

🔸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.

Exemplos de Requisição

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 ' \
--form 'file=@""' \
--form 'fileUrl=""' \
--form 'filePassword=""'

Respostas

🟢200OK

application/json

Body

result

array [object {1}]

requerido

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

extractions

array [object {2}]

opcional

requestId

string

requerido

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

elapsedMilliseconds

integer

requerido

Tempo de duração do processamento em milissegundos.

status

object

requerido

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

message

string | null

requerido

code

string

requerido

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

errors

array [object {2}] | null

requerido

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

Exemplo

{
    "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