> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Gerar uma imagem > Gere uma imagem para a conta conectada. Usa a mesma cota de mídia e as mesmas proteções do aplicativo web. Salve o generationId retornado e use images_download para recuperar a imagem. Reutilize requestId ao tentar novamente a mesma requisição. Gere uma imagem para a conta conectada. Usa a mesma cota de mídia e as mesmas proteções do aplicativo web. Salve o generationId retornado e use images\_download para recuperar a imagem. Reutilize requestId ao tentar novamente a mesma requisição. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/images_generate ``` ## Autenticação e permissões Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são aceitos apenas pelo MCP, não por este endpoint REST. Permissões necessárias: `images:write`. É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano. ## Parâmetros Opcional na camada de transporte: o servidor insere um identificador antes da validação quando ele é omitido. Forneça seu próprio UUID v4 estável para recuperar com segurança uma resposta perdida. Formato: "uuid". Padrão: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`. Valor de texto. Comprimento mínimo: 10. Comprimento máximo: 1200. Valor de texto. Valores aceitos: "square", "landscape", "portrait". Valor padrão: "square". Uma chave de objeto JPG, PNG ou WebP enviado em uploads/\{yourUserId}/. URLs remotas não são aceitas. Comprimento mínimo: 1. Comprimento máximo: 512. O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação. ```json theme={null} { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$", "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries." }, "prompt": { "type": "string", "minLength": 10, "maxLength": 1200 }, "aspectRatio": { "default": "square", "type": "string", "enum": ["square", "landscape", "portrait"] }, "referenceImageKey": { "type": "string", "minLength": 1, "maxLength": 512, "description": "An uploaded JPG, PNG or WebP object key under uploads/{yourUserId}/. Remote URLs are not accepted." } }, "required": ["prompt"], "additionalProperties": false } ``` ## Idempotência Use um UUID v4 em requestId ou no cabeçalho HTTP Idempotency-Key para cada alteração. Reutilize o mesmo identificador e argumentos idênticos após uma falha de rede. Se ambos forem fornecidos, devem ser iguais. Repetir uma requisição salva não repete a operação nem consome outra chamada mensal. Requisições com falha ou interrompidas não são reiniciadas automaticamente. Qualquer alteração pode retornar HTTP 202 quando uma nova tentativa encontra a mesma requisição ainda em execução, mesmo que a primeira execução normalmente seja síncrona. Se a execução foi concluída, mas resultStored é false, uma nova tentativa retorna HTTP 200 com o estado salvo da requisição em vez do resultado original. Recupere a saída pela ação de histórico, resultado ou download do domínio correspondente. ## Exemplos de requisição Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração. ```bash cURL theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/images_generate' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"61becb70-00d6-4de0-9eb1-05829a0d851c","prompt":"A peaceful coastal village at sunrise, with warm natural light.","aspectRatio":"square","referenceImageKey":"uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"}' ``` ```javascript JavaScript theme={null} const input = { requestId: '61becb70-00d6-4de0-9eb1-05829a0d851c', prompt: 'A peaceful coastal village at sunrise, with warm natural light.', aspectRatio: 'square', referenceImageKey: 'uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/images_generate', { method: 'POST', headers: { 'x-api-key': process.env.VOICECHEAP_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify(input), }); const body = await response.json(); if (!response.ok) throw new Error(body.code + ': ' + body.message); console.log(body); ``` ```python Python theme={null} import os import requests response = requests.post( "https://api.voicecheap.ai/v1/actions/images_generate", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c", "prompt": "A peaceful coastal village at sunrise, with warm natural light.", "aspectRatio": "square", "referenceImageKey": "uploads/example-user/2502829e-3fde-4aad-b3c7-ce0f779fa2e6-reference.png"}, timeout=120, ) body = response.json() if not response.ok: raise RuntimeError(f"{body.get('code')}: {body.get('message')}") print(body) ``` ## Resposta Esta operação retorna HTTP 202 enquanto está em execução. Salve requestId e consulte action\_request\_get com esse identificador e o nome da operação original. Os estados de consulta são running, completed, failed e interrupted. Um resultado concluído pode apontar para um processamento de mídia separado; continue com a ação de status ou de saída específica da operação. Metadados finais da geração retornados pelo handler após o término da geração da imagem. Não são incluídos bytes de imagem, previewDataUrl nem URL de download. ```json HTTP 202 theme={null} { "data": { "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c", "status": "running", "pollAction": "action_request_get", "pollAfterSeconds": 5 }, "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c" } ``` ```json HTTP 200 theme={null} { "data": { "generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c", "status": "completed", "aspectRatio": "square", "width": 1024, "height": 1024, "referenceImageCount": 1, "createdAt": 1792144800000, "updatedAt": 1792144820000, "expiresAt": 1792749600000 }, "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c", "operation": "images_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c", "operation": "images_generate", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c" } ``` ## Campos do resultado | Campo | Descrição | | - | - | | `data.generationId` | Identificador a ser passado sem alterações para images\_get ou images\_download. | | `data.status` | pending, completed, failed ou expired. A expiração tem precedência sobre o status armazenado. | | `data.aspectRatio` | square, landscape ou portrait. | | `data.width` | Largura da saída em pixels, ou null antes que as dimensões estejam disponíveis. | | `data.height` | Altura da saída em pixels, ou null antes de as dimensões estarem disponíveis. | | `data.referenceImageCount` | Número de imagens de referência usadas: 0 ou 1. | | `data.createdAt` | Horário de criação em milissegundos Unix. | | `data.updatedAt` | Horário da última atualização em milissegundos Unix. | | `data.expiresAt` | Momento em milissegundos Unix após o qual a imagem gerada não pode ser baixada. | ## Recuperar e consultar esta requisição Use o mesmo identificador mesmo após perder a conexão. Se resultStored for false, recupere a saída pela ação correspondente de histórico, resultado ou download. Nunca inicie uma segunda geração apenas para verificar o progresso. ```bash theme={null} curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"requestId":"61becb70-00d6-4de0-9eb1-05829a0d851c","operation":"images_generate"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "61becb70-00d6-4de0-9eb1-05829a0d851c", "operation": "images_generate", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "generationId": "6224018c7635dcb933ce5c8f7804aea73738dd1c", "status": "completed", "aspectRatio": "square", "width": 1024, "height": 1024, "referenceImageCount": 1, "createdAt": 1792144800000, "updatedAt": 1792144820000, "expiresAt": 1792749600000 } } } ``` ## Notas da operação * Exige images:write. Espaços nas extremidades do prompt são removidos, e ele deve conter 10–1200 caracteres; ele também é normalizado antes da geração. aspectRatio tem square como padrão e também aceita landscape ou portrait. É aceito no máximo um referenceImageKey. * Esta é uma ação de longa duração. A resposta inicial da API/MCP normalmente informa running; consulte periodicamente action\_request\_get com operation images\_generate e o mesmo requestId para obter o resultado final mostrado aqui. * Usa a cota diária normal de geração de imagens da conta. As imagens geradas da conta expiram sete dias após a criação; baixe o resultado antes de expiresAt. * Esta ação usa as criações e os envios do próprio usuário conectado, inclusive quando a credencial está conectada em um contexto de equipe. * As chaves de referência devem apontar para envios concluídos em uploads/\{yourUserId}/ e terminar em .jpg, .jpeg, .png ou .webp. URLs remotas, chaves de outros usuários, segmentos de travessia de diretórios, barras invertidas, escapes percentuais, strings de consulta, fragmentos e caracteres de controle são rejeitados. * Cada referência deve ser não vazia, ter no máximo 8 MiB (8,388,608 bytes), ser decodificada como o tipo de imagem identificado pela extensão e medir 128–4096 pixels de cada lado. A contagem de pixels decodificados também é limitada. Uma referência enviada continua reutilizável; essas ações de geração não consomem nem excluem o arquivo enviado. * Use um requestId UUID v4 ou o cabeçalho HTTP Idempotency-Key e reutilize-o com entradas idênticas ao tentar novamente. A camada de integração registra cada alteração e retorna seu estado ou resultado registrado sem executá-la novamente. Uma requisição com falha ou interrompida não é repetida automaticamente. * Somente uma imagem pode ser gerada por vez para este usuário. Use images\_list e images\_get para inspecionar o estado de criação e images\_download para obter os bytes PNG. O identificador da geração é uma string opaca; não o substitua por requestId. ## Uso Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam. ## Erros | Status HTTP | Código | Significado ou recuperação | | - | - | - | | 400 | `BAD_REQUEST` | O servidor não conseguiu determinar o contexto de rede confiável da requisição. | | 400 | `CREDENTIAL_IN_QUERY` | Foram fornecidas credenciais em um parâmetro de consulta access\_token ou api\_key. Envie as credenciais nos cabeçalhos. | | 400 | `IDEMPOTENCY_CONFLICT` | O cabeçalho Idempotency-Key e o campo requestId do corpo devem ser iguais. | | 400 | `IMAGE_PROMPT_INVALID` | O prompt normalizado está fora do intervalo de 10–1200 caracteres. | | 400 | `IMAGE_REFERENCE_INVALID` | Os bytes de referência não atendem aos requisitos de tipo de imagem compatível, limite de bytes, dimensões ou decodificação. | | 400 | `INVALID_REQUEST_ID` | requestId ou Idempotency-Key não é um UUID v4. | | 400 | `REFERENCE_IMAGE_INVALID` | A chave de referência é insegura, não pertence ao usuário, não é compatível, está indisponível ou excede 8 MiB. | | 400 | `VALIDATION_ERROR` | Um argumento está ausente, tem um valor não compatível, excede seu limite ou não faz parte do esquema estrito de entrada. | | 401 | `API_KEY_EXPIRED` | A chave de API expirou. | | 401 | `INVALID_API_KEY` | Forneça uma chave de API válida e dentro do prazo de validade. | | 401 | `INVALID_CREDENTIAL` | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. | | 401 | `MISSING_CREDENTIAL` | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. | | 401 | `USER_NOT_FOUND` | A conta da credencial não existe mais. | | 403 | `ACCOUNT_UNAVAILABLE` | A conta que executa a ação ou a conta de cobrança está indisponível ou em processo de exclusão. | | 403 | `AMBIGUOUS_TEAM_API_KEY` | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. | | 403 | `INSUFFICIENT_SCOPE` | Conceda todas as permissões necessárias ou escolha outra credencial. | | 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Não foi possível verificar os limites de integração da conta. | | 403 | `SUBSCRIPTION_REQUIRED` | Use uma assinatura paga ativa. | | 403 | `TEAM_OWNER_NOT_FOUND` | Não foi possível encontrar a conta efetiva do proprietário da equipe. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta conta já tem 10 ações de integração em execução. Consulte uma requisição existente antes de iniciar outra. | | 409 | `IDEMPOTENCY_CONFLICT` | O identificador da requisição já foi usado com argumentos diferentes; uma divergência entre o identificador do cabeçalho e o do corpo retorna HTTP 400 com o mesmo código. | | 409 | `IMAGE_GENERATION_IN_PROGRESS` | Esta requisição de imagem ou outra imagem do usuário conectado ainda está em execução. | | 409 | `IMAGE_REQUEST_ID_REUSED` | O identificador da requisição de imagem já está associado a uma entrada diferente. | | 422 | `IMAGE_REQUEST_REJECTED` | A imagem não pode ser gerada a partir deste prompt ou referência. Altere o conteúdo para uma nova requisição. | | 429 | `IMAGE_DAILY_LIMIT_REACHED` | O limite diário de geração de imagens da conta foi esgotado. | | 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Aguarde a renovação do limite mensal ou mude de plano. | | 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. | | 500 | `INTERNAL_ERROR` | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. | | 502 | `INTERNAL_ERROR` | A geração ou a preparação da imagem falhou. Inspecione o estado da requisição antes de decidir iniciar outra geração. | | 503 | `ACTION_RESULT_UNAVAILABLE` | A ação foi executada, mas não foi possível salvar seu resultado. Inspecione o estado salvo da requisição e o histórico do recurso antes de iniciar uma nova geração. | | 503 | `INTERNAL_ERROR` | A geração da imagem ou seu resultado armazenado está temporariamente indisponível. Inspecione o estado da requisição antes de tentar novamente. | | 503 | `SERVER_RESTARTING` | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. | ```json theme={null} { "code": "INSUFFICIENT_SCOPE", "message": "This credential does not permit the requested action.", "status": 403, "details": { "requiredScopes": ["images:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.