Referência da API

Enviar imagem de referência

POST/v1/image-assets

A primeira e única parte multipart deve ser file, com nome de arquivo. Apenas JPEG/PNG/WebP não animados, no máximo 10 MiB tanto no upload quanto após recodificação.

Autenticação e permissões

Use sua chave atual do GloopAPI. Modelos, recursos e permissões disponíveis dependem do catálogo da chave e da documentação do endpoint.

Authorization: Bearer $GLOOP_API_KEY

Esquemas de autenticação: BearerAuth

Solicitação

Cabeçalhos da solicitação

  • Idempotency-KeystringObrigatório

    Preserve a intenção original com a mesma chave; após interrupção, consulte a recuperação primeiro. Não reenvie às cegas estados desconhecidos.

    Comprimento mínimo
    1
    Comprimento máximo
    191

Corpo da solicitação · multipart/form-data

Tipo
object
Campos obrigatórios
file
Propriedades adicionais
false

Corpo da solicitação obrigatório

  • filestringObrigatório

    Única parte de imagem com filename; JPEG/PNG/WebP não animado <=10MiB.

    Formato
    "binary"

Respostas e erros

HTTP 200

Imagem de referência enviada com sucesso

application/json

Tipo
object
Campos obrigatórios
idmime_typesize_byteswidthheightexpires_at
  • file_idstringOpcional

    ID público de arquivo gerenciado da mesma conta e chave.

  • idstringObrigatório

    Identificador público do objeto, usado na sua rota de detalhes.

  • mime_typestringObrigatório

    Tipo MIME verificado do arquivo.

  • size_bytesintegerObrigatório

    Tamanho do arquivo em bytes.

  • widthintegerObrigatório

    Largura da imagem em pixels.

  • heightintegerObrigatório

    Altura da imagem em pixels.

  • expires_atintegerObrigatório

    Segundos Unix; 0 indica ausência de expiração fixa. O upload é associado a arquivo gerenciado; leitura exige a mesma conta e chave.

HTTP 400

Campos ou parâmetros de solicitação inválidos.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 401

A chave está ausente, inválida, expirada ou revogada.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 403

Permissões insuficientes de IP, conta, modelo ou ferramenta.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 404

Objeto/recurso indisponível ou função desativada.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 409

Conflito de idempotência/cotação, objeto não pronto ou ainda referenciado.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 429

Limite de solicitações/fila.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 500

Falha interna de autenticação ou armazenamento de dados.

application/json

Tipo
object
Campos obrigatórios
error

HTTP 503

Serviço, preços ou armazenamento indisponíveis.

application/json

Tipo
object
Campos obrigatórios
error
Pronto para criar? Abra console para criar uma chave de API, ou explore recursos.