Grok Imagine 1.0
ID da solicitação grok-imagine-1.0
Protocolos
POST /v1/images/generations· Gerar imagens · exemploGET /v1/images/tasks/{task_id}· Consultar tarefa de imagem · exemplo
Autenticação
Obtenha uma chave em Gerenciar chaves de API. Para requisições JSON, defina Content-Type: application/json.
Authorization: Bearer YOUR_API_KEY
Parâmetros da requisição
POST /v1/images/generations
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
model | string | Obrigatório | Use este ID de modelo grok-imagine-1.0. |
prompt | string | Obrigatório | Descreva a imagem a gerar. |
aspect_ratio | string | Opcional | Proporção da imagem de saída. Valores aceitos 1:1, 16:9, 9:16, 3:2, 2:3. Padrão 1:1. |
n | integer | Opcional | Quantidade de imagens por solicitação. Use 1 para obter um resultado. Padrão 1. |
?async | string | Opcional | Parâmetro de consulta da URL. Use 1, true ou yes para receber 202 e task_id. Omita para aguardar o resultado. |
Exemplos de requisição
Defina a chave de API na variável de ambiente local ICODEEASY_API_KEY e escolha um endpoint que aceite chamadas HTTP diretas. Caso o endpoint exija um cliente específico, siga o guia de configuração desse cliente.
Substitua as URLs e os IDs de mídia dos exemplos por ativos válidos.
Images Generations
curl -sS 'https://api.icodeeasy.cc/v1/images/generations' \
-H "Authorization: Bearer $ICODEEASY_API_KEY" \
-H 'Content-Type: application/json' \
--data '{
"model": "grok-imagine-1.0",
"prompt": "A watercolor illustration of a paper lantern by a lake."
}'
Consultar tarefa de imagem
curl -sS 'https://api.icodeeasy.cc/v1/images/tasks/YOUR_TASK_ID' \
-H "Authorization: Bearer $ICODEEASY_API_KEY"
Respostas e tarefas
HTTP 200 · Sucesso síncrono
Com ?sync=1, leia as URLs geradas em data[].url. created é um timestamp Unix em segundos e id é o ID da tarefa.
{
"id": "d142c93a-de26-40c9-be62-0de840d10960",
"created": 1781599773,
"data": [
{
"url": "https://example.com/generated-image.png"
}
]
}
HTTP 202 · Envio assíncrono
{
"task_id": "d142c93a-de26-40c9-be62-0de840d10960",
"status": "pending"
}
Com ?async=1, consulte GET /v1/images/tasks/{task_id} com a mesma chave de API. status é pending, completed ou failed. Quando a tarefa concluir, leia a URL da imagem em result_url.
HTTP 200 · Consulta de tarefa concluída
{
"task_id": "d142c93a-de26-40c9-be62-0de840d10960",
"status": "completed",
"model": "grok-imagine-1.0",
"result_url": "https://example.com/generated-image.png"
}
Erros comuns
Se a consulta retornar failed, leia error. Se houver error_detail, confira retryable antes de enviar novamente.
Guia completo de integração · Consulte o guia completo da API para ver os campos, estados de tarefas e formatos de resposta.
Recursos e limites
text_to_image· Compatívelimage_to_image· Não publicadoimage_editing· Não compatívelreference_images· Não publicado
Catálogo de recursos dos modelos · Ver preços
Guias relacionados
API de geração de imagens
Gere ou edite imagens com a API compatível com OpenAI. Envie prompts, dimensões e imagens de referência e consulte os resultados ou o status das tarefas assíncronas.
Catálogo de recursos dos modelos
Compare modelos públicos de texto, imagem e vídeo por ID normalizado, protocolos, clientes, ferramentas, recursos de mídia, limites e data de revisão.