Skip to main content
POST
Python (SDK)

Autorizações

Authorization
string
header
obrigatório

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cabeçalhos

X-On-Behalf-Of
string

Optional external end-user identifier forwarded by the API gateway.

Corpo

application/json

Parâmetros de solicitação para gerar imagens. Cria uma ou mais imagens a partir de um texto de entrada.

prompt
string
obrigatório

Uma descrição em texto da(s) imagem(ns) desejada(s). O comprimento máximo é de 1000 caracteres.

Required string length: 1 - 1000
model
string
padrão:auto

O modelo a ser utilizado para geração de imagens. O padrão é 'auto'.

n
integer
padrão:1

O número de imagens a gerar. Deve estar entre 1 e 10. O padrão é 1.

Intervalo obrigatório: 1 <= x <= 10
quality
enum<string>
padrão:auto

O nível de qualidade da imagem gerada. Níveis mais altos podem resultar em maior latência ou custo. 'auto' permite que o gateway escolha um valor sensato por modelo. 'padrão' e 'hd' são aceitos como aliases legados.

Opções disponíveis:
low,
medium,
high,
auto,
standard,
hd
response_format
enum<string>
padrão:url

O formato em que as imagens geradas são retornadas. 'url' retorna uma URL para a imagem, 'b64_json' retorna a imagem como uma string JSON codificada em base64. O padrão é 'url'.

Opções disponíveis:
url,
b64_json
size
enum<string>
padrão:1024x1024

O tamanho da imagem gerada. 'auto' se refere ao padrão do modelo.

Opções disponíveis:
256x256,
512x512,
1024x1024,
1024x1536,
1536x1024,
1792x1024,
1024x1792,
auto
style
enum<string>
padrão:vivid

O estilo da imagem gerada. 'vivo' tende ao hiper-realista e dramático. 'natural' produz resultados mais naturalistas. Suportado condicionalmente.

Opções disponíveis:
vivid,
natural
output_format
enum<string>

Formato de arquivo de saída. Suportado condicionalmente.

Opções disponíveis:
png,
webp,
jpeg
user
string

Um identificador exclusivo que representa seu usuário final, o que pode ajudar a monitorar e detectar abusos.

Resposta

200 - application/json

OK

Resposta do ponto final de geração de imagens contendo as imagens geradas e metadados.

created
number
obrigatório

O timestamp Unix (em segundos) de quando a geração da imagem foi concluída.

data
object[]
obrigatório

Uma lista de objetos de imagem contendo os dados da imagem gerada.