> ## Documentation Index
> Fetch the complete documentation index at: https://phaseo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Criar lote

> Cria um trabalho de lote assíncrono e retorna o objeto de lote do provedor. A criação suporta OpenAI, Anthropic, Google Gemini, Mistral, xAI, Groq e Together AI pelo `model` solicitado. O gateway infere o provedor pelo modelo e também aceita `session_id` e `webhook` para observabilidade e notificações assíncronas. Use `provider` apenas como restrição avançada de roteamento.

Requer acesso à prévia no espaço de trabalho. Consulte [Tarefas de vídeo e processamento em lote](../../guides/async-video-and-batch.mdx) para configuração, webhooks e tratamento de resultados.


## OpenAPI

````yaml pt-BR/openapi/v1/openapi.localized.yaml POST /batches
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: >-
    Uma API de gateway para acessar diversos modelos de IA por meio de endpoints
    compatíveis com OpenAI.
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.app/v1
    description: Roteamento global
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /batches:
    post:
      tags:
        - Gateway
      summary: Criar lote
      description: >-
        Cria um trabalho de lote assíncrono e retorna o objeto de lote do
        provedor. A criação suporta OpenAI, Anthropic, Google Gemini, Mistral,
        xAI, Groq e Together AI pelo `model` solicitado. O gateway infere o
        provedor pelo modelo e também aceita `session_id` e `webhook` para
        observabilidade e notificações assíncronas. Use `provider` apenas como
        restrição avançada de roteamento.
      operationId: createBatch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchRequest'
      responses:
        '200':
          description: Resposta de status do lote
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResponse'
        '401':
          description: Não autorizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    BatchRequest:
      type: object
      properties:
        provider_options:
          type: object
          description: >-
            Extensões delimitadas pelo ID canônico do provedor. OpenAI aceita
            output_expires_after; Mistral aceita metadata. Somente as opções do
            provedor selecionado são aplicadas. Não duplique uma opção no nível
            superior. As opções não podem substituir linhas precificadas,
            modelos ou arquivos.
          additionalProperties:
            type: object
            additionalProperties: true
        model:
          type: string
          description: >-
            ID do modelo usado para inferir o provedor do lote. As linhas de
            solicitação também podem incluir body.model; o modelo de nível
            superior é preferido.
        prompts:
          type: array
          description: >-
            Formato abreviado de prompt simples. Phaseo compila cada prompt em
            uma linha de lote nativa do provedor para o modelo selecionado.
          items:
            type: string
        items:
          type: array
          description: >-
            Formato abreviado de prompt estruturado. Os itens podem incluir
            `id`, `custom_id`, `prompt`, `messages`, `input`, `system`,
            `max_tokens`, `temperature` ou um `body` avançado.
          items:
            type: object
            additionalProperties: true
        system:
          type: string
          description: >-
            Instrução de sistema opcional aplicada às linhas de prompt
            abreviado.
        max_tokens:
          type: integer
          description: >-
            Limite máximo opcional de tokens aplicado às linhas de prompt
            abreviado.
        temperature:
          type: number
          description: >-
            Temperatura de amostragem opcional aplicada às linhas de prompt
            abreviado.
        input_file_id:
          type: string
          description: >-
            ID de arquivo existente no provedor para criar lotes por envio de
            arquivo.
        requests:
          type: array
          description: >-
            Linhas avançadas de solicitação em lote. Forneça exatamente um de
            `prompts`, `items`, `requests` ou `input_file_id`.
          items:
            $ref: '#/components/schemas/BatchRequestItem'
        endpoint:
          type: string
          enum:
            - /v1/chat/completions
            - /v1/responses
            - /v1/messages
            - /v1/embeddings
            - /v1/generateContent
          description: >-
            Formato de solicitação para o cliente. Toda solicitação de um lote
            usa este endpoint. Quando omitido, Phaseo escolhe um padrão nativo
            do provedor pelo modelo.
        completion_window:
          type: string
        metadata:
          type: object
          additionalProperties: true
        session_id:
          type: string
          maxLength: 256
          description: >-
            Identificador exclusivo para agrupar solicitações relacionadas (por
            exemplo, uma conversa ou um fluxo de trabalho de agente) para
            observabilidade.
        webhook:
          type: object
          required:
            - endpoint_id
          additionalProperties: false
          properties:
            endpoint_id:
              type: string
              description: ID do endpoint de webhook gerenciado pelo espaço de trabalho.
            events:
              type: array
              description: >-
                Assinaturas opcionais de eventos. Use eventos genéricos job.* ou
                eventos batch.* correspondentes, como batch.progress ou
                batch.completed. Quando omitidos, são usados eventos finais
                job.*. Inclua job.progress ou batch.progress explicitamente para
                callbacks de progresso da contagem de solicitações. Quando
                fornecidos, pelo menos um evento deve ser válido para trabalhos
                de lote; listas malformadas ou somente com eventos de outro tipo
                são rejeitadas.
              items:
                type: string
        webhook_endpoint_id:
          type: string
          description: Alias de conveniência para webhook.endpoint_id.
        debug:
          $ref: '#/components/schemas/DebugOptions'
        provider:
          allOf:
            - $ref: '#/components/schemas/ProviderRoutingOptions'
          description: >-
            Restrição avançada de roteamento. A maioria das solicitações deve
            usar a inferência do provedor baseada no modelo.
    BatchResponse:
      type: object
      properties:
        id:
          type: string
        native_batch_id:
          type: string
          nullable: true
          description: ID nativo do lote no provedor quando difere do ID do gateway.
        object:
          type: string
        endpoint:
          type: string
        errors:
          type: object
        input_file_id:
          type: string
        completion_window:
          type: string
        status:
          type: string
        lifecycle_status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
            - cancelled
            - expired
          description: >-
            Status normalizado do ciclo de vida assíncrono para consumidores de
            polling, WebSocket e webhooks.
        progress:
          type: integer
          minimum: 0
          maximum: 100
          description: >-
            Porcentagem aproximada de conclusão do lote derivada das contagens
            de solicitações do provedor, quando disponíveis. Lotes concluídos
            informam 100.
        polling_url:
          type: string
          format: uri
        websocket_url:
          type: string
          format: uri
          description: >-
            URL de WebSocket para assinar atualizações normalizadas do ciclo de
            vida de trabalhos assíncronos.
        cancel_url:
          type: string
          format: uri
          nullable: true
          description: Reservado para compatibilidade; atualmente sempre null.
        results_url:
          type: string
          format: uri
          nullable: true
          description: >-
            URL autenticada de download JSONL do Phaseo para lotes suportados em
            status final. Null durante o processamento. Um lote final pode não
            ter saída. Use uma chave de API do espaço de trabalho proprietário;
            aplicam-se os limites de retenção do provedor.
        output_file_id:
          type: string
        error_file_id:
          type: string
        created_at:
          type: integer
        in_progress_at:
          type: integer
        expires_at:
          type: integer
        finalizing_at:
          type: integer
        completed_at:
          type: integer
        failed_at:
          type: integer
        expired_at:
          type: integer
        cancelling_at:
          type: integer
        cancelled_at:
          type: integer
        request_counts:
          $ref: '#/components/schemas/BatchRequestCounts'
        metadata:
          type: object
        request_id:
          type: string
        provider:
          type: string
        session_id:
          type: string
        webhook:
          $ref: '#/components/schemas/AsyncWebhookPublicState'
        next_webhook_retry_at:
          type: string
          nullable: true
        last_webhook_progress:
          type: number
          nullable: true
        last_webhook_progress_at:
          type: string
          nullable: true
        last_webhook_dispatched_at:
          type: string
          nullable: true
        finalized_at:
          type: string
          nullable: true
        pricing_lines:
          type: array
          items:
            type: object
            additionalProperties: true
        usage:
          type: object
          description: Uso e custo agregados normalizados após a finalização.
          properties:
            requests:
              type: integer
              nullable: true
            input_tokens:
              type: integer
              nullable: true
            output_tokens:
              type: integer
              nullable: true
            total_tokens:
              type: integer
              nullable: true
            cost_nanos:
              type: integer
              nullable: true
            cost_usd:
              type: number
              nullable: true
            currency:
              type: string
        billing:
          $ref: '#/components/schemas/BatchBillingSummary'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        ok:
          type: boolean
          example: false
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          example: error_type
        message:
          type: string
          example: Human-readable error message
        description:
          type: string
          example: Additional error details.
        generation_id:
          type: string
          example: G-abc123
        status_code:
          type: integer
          example: 502
        error_type:
          type: string
          enum:
            - user
            - system
          example: system
        error_origin:
          type: string
          enum:
            - user
            - gateway
            - upstream
          example: upstream
        reason:
          type: string
          example: all_candidates_failed
        attempt_count:
          type: integer
          example: 2
        failed_providers:
          type: array
          items:
            type: string
          example:
            - google-ai-studio
            - openai
        failed_statuses:
          type: array
          items:
            type: integer
          example:
            - 403
            - 429
        upstream_error:
          $ref: '#/components/schemas/ErrorUpstreamError'
        failure_sample:
          type: array
          items:
            $ref: '#/components/schemas/ErrorFailureSampleItem'
        provider_failure_diagnostics:
          $ref: '#/components/schemas/ErrorProviderFailureDiagnostics'
        routing_diagnostics:
          $ref: '#/components/schemas/ErrorRoutingDiagnostics'
        provider_candidate_diagnostics:
          $ref: '#/components/schemas/ErrorProviderCandidateDiagnostics'
        provider_enablement:
          $ref: '#/components/schemas/ErrorProviderEnablementDiagnostics'
        missing_pricing_providers:
          type: array
          items:
            type: string
        provider_payment_required_provider:
          type: string
          example: openai
        provider_payment_required_support_notice:
          type: string
          example: >-
            Our upstream provider billing appears to be unavailable. If this
            persists, contact support.
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    BatchRequestItem:
      type: object
      required:
        - body
      properties:
        custom_id:
          type: string
        method:
          type: string
          default: POST
          enum:
            - POST
        url:
          type: string
          description: >-
            Caminho do endpoint desta linha. Quando fornecido, deve corresponder
            ao endpoint do lote pai. O padrão é o endpoint do lote pai.
        body:
          type: object
          additionalProperties: true
    DebugOptions:
      type: object
      description: >-
        Controles de depuração do gateway. Essas opções nunca são encaminhadas
        ao provedor.
      properties:
        enabled:
          type: boolean
        return_upstream_request:
          type: boolean
        return_upstream_response:
          type: boolean
        trace:
          type: boolean
        trace_level:
          type: string
          enum:
            - summary
            - full
    ProviderRoutingOptions:
      type: object
      description: Preferências de roteamento de provedores para seleção pelo gateway.
      properties:
        order:
          type: array
          items:
            type: string
        only:
          type: array
          items:
            type: string
        ignore:
          type: array
          items:
            type: string
        include_alpha:
          type: boolean
          description: Incluir provedores alpha no roteamento (desativado por padrão).
        allow_fallbacks:
          type: boolean
          nullable: true
          description: Permitir fallback para outro provedor elegível após uma falha.
        require_parameters:
          type: boolean
          nullable: true
          description: >-
            Exigir suporte do provedor aos parâmetros solicitados antes do
            roteamento.
        required_execution_region:
          type: string
          nullable: true
          description: >-
            Restringir o roteamento a provedores com a região de execução
            solicitada.
        required_data_region:
          type: string
          nullable: true
          description: >-
            Restringir o roteamento a provedores com a região de dados
            solicitada.
        require_zero_data_retention:
          type: boolean
          nullable: true
          description: >-
            Restringir o roteamento a provedores que oferecem retenção zero de
            dados.
        data_collection:
          type: string
          nullable: true
          enum:
            - allow
            - deny
        zdr:
          type: boolean
          nullable: true
        enforce_distillable_text:
          type: boolean
          nullable: true
        quantizations:
          type: array
          nullable: true
          items:
            type: string
        sort:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          description: >-
            Classificar os provedores para esta solicitação, por exemplo, por
            preço, latência ou throughput.
        max_price:
          type: object
          properties:
            prompt:
              oneOf:
                - type: number
                - type: string
            completion:
              oneOf:
                - type: number
                - type: string
            image:
              oneOf:
                - type: number
                - type: string
            audio:
              oneOf:
                - type: number
                - type: string
            request:
              oneOf:
                - type: number
                - type: string
        preferred_min_throughput:
          oneOf:
            - type: number
            - type: object
              additionalProperties:
                type: number
        preferred_max_latency:
          oneOf:
            - type: number
            - type: object
              additionalProperties:
                type: number
    BatchRequestCounts:
      type: object
      properties:
        total:
          type: integer
        completed:
          type: integer
        failed:
          type: integer
    AsyncWebhookPublicState:
      type: object
      description: >-
        Configuração sanitizada do webhook assíncrono e estado de entrega.
        Segredos nunca são retornados; `has_secret` indica se entregas assinadas
        estão habilitadas. Entregas assinadas incluem os cabeçalhos
        x-phaseo-signature, x-phaseo-timestamp, x-phaseo-event-id,
        x-phaseo-event-type, x-phaseo-delivery-key, x-phaseo-attempt e
        x-phaseo-max-attempts.
      properties:
        url:
          type: string
          format: uri
          nullable: true
        events:
          type: array
          items:
            type: string
        has_secret:
          type: boolean
        delivery:
          $ref: '#/components/schemas/AsyncWebhookDeliverySummary'
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/AsyncWebhookDeliveryAttempt'
    BatchBillingSummary:
      type: object
      properties:
        currency:
          type: string
        billed:
          type: boolean
        charged:
          type: boolean
        reason:
          type: string
        state:
          type: string
          enum:
            - pending
            - estimated
            - settled
            - void
        reservation_id:
          type: string
          nullable: true
        reservation_status:
          type: string
          nullable: true
        estimated_provider_cost:
          type: string
          nullable: true
        estimated_user_cost:
          type: string
          nullable: true
        settled_provider_cost:
          type: string
          nullable: true
        settled_user_cost:
          type: string
          nullable: true
        estimated_nanos:
          type: integer
          nullable: true
        reserved_nanos:
          type: integer
          nullable: true
        estimation_truncated:
          type: boolean
          nullable: true
          description: >-
            True quando a estimativa de reserva foi extrapolada de uma amostra
            limitada de um arquivo de entrada de lote maior.
        estimation_sample_size:
          type: integer
          nullable: true
          description: >-
            Número de linhas de entrada precificadas diretamente para a
            estimativa de reserva.
        estimation_total_rows:
          type: integer
          nullable: true
          description: Total de linhas de entrada representadas pela estimativa de reserva.
        total_nanos:
          type: integer
          nullable: true
        cost_nanos:
          type: integer
          nullable: true
        cost_usd:
          type: number
          nullable: true
        finalized_at:
          type: string
          nullable: true
        pricing_breakdown:
          type: object
          additionalProperties: true
    ErrorUpstreamError:
      type: object
      properties:
        code:
          type: string
          nullable: true
          example: PERMISSION_DENIED
        message:
          type: string
          nullable: true
          example: The caller does not have permission.
        description:
          type: string
          nullable: true
        param:
          type: string
          nullable: true
    ErrorFailureSampleItem:
      type: object
      properties:
        provider:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        status:
          type: integer
          nullable: true
        upstream_error_code:
          type: string
          nullable: true
        upstream_error_message:
          type: string
          nullable: true
        upstream_error_description:
          type: string
          nullable: true
        upstream_error_param:
          type: string
          nullable: true
        upstream_payload_preview:
          type: string
          nullable: true
        retryable:
          type: boolean
          nullable: true
      additionalProperties: true
    ErrorProviderFailureDiagnostics:
      type: object
      properties:
        category:
          type: string
          enum:
            - credentials_not_configured
            - credentials_invalid_or_forbidden
            - provider_access_missing
            - region_or_project_restriction
            - model_unavailable_for_endpoint
            - rate_limited
            - server_error
        hint:
          type: string
        provider:
          type: string
          nullable: true
    ErrorRoutingDiagnostics:
      type: object
      properties:
        filterStages:
          type: array
          items:
            type: object
            properties:
              stage:
                type: string
              beforeCount:
                type: integer
              afterCount:
                type: integer
              droppedProviders:
                type: array
                items:
                  type: object
                  properties:
                    providerId:
                      type: string
                      nullable: true
                    reason:
                      type: string
                      nullable: true
                  additionalProperties: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderCandidateDiagnostics:
      type: object
      properties:
        totalProviders:
          type: integer
        supportsEndpointCount:
          type: integer
        candidateCount:
          type: integer
        droppedUnsupportedEndpoint:
          type: array
          items:
            type: string
        droppedMissingAdapter:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              endpoint:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderEnablementDiagnostics:
      type: object
      properties:
        capability:
          type: string
        providersBefore:
          type: array
          items:
            type: string
        providersAfter:
          type: array
          items:
            type: string
        dropped:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              reason:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    AsyncWebhookDeliverySummary:
      type: object
      description: >-
        Resumo público de entrega de webhooks assíncronos gerenciados pelo
        gateway. Use-o para distinguir o estado de execução do trabalho da saúde
        da entrega do webhook.
      properties:
        total_attempts:
          type: integer
          description: Total de tentativas de entrega registradas para este trabalho.
        delivered_events:
          type: integer
          description: Número de chaves de entrega que alcançaram o estado entregue.
        delivered_event_types:
          type: array
          description: Chaves de entrega entregues pelo menos uma vez.
          items:
            type: string
          example:
            - video.completed
        pending_retries:
          type: integer
          description: >-
            Número de chaves de entrega com uma nova tentativa agendada
            atualmente.
        next_retry_at:
          type: string
          nullable: true
          description: Timestamp ISO da próxima tentativa agendada, quando houver.
        last_attempt_at:
          type: string
          nullable: true
          description: Timestamp ISO da tentativa de entrega mais recente.
        last_attempt_status:
          type: string
          nullable: true
          enum:
            - delivered
            - scheduled_retry
            - failed_permanently
          description: Resultado da tentativa de entrega mais recente.
        last_response_status:
          type: integer
          nullable: true
          description: Status HTTP retornado pelo destino do webhook, quando disponível.
        last_delivered_at:
          type: string
          nullable: true
          description: Timestamp ISO da entrega bem-sucedida mais recente.
        last_failure_at:
          type: string
          nullable: true
          description: Timestamp ISO da tentativa com falha ou em repetição mais recente.
        last_error_message:
          type: string
          nullable: true
          description: Mensagem de erro de entrega mais recente, quando disponível.
    AsyncWebhookDeliveryAttempt:
      type: object
      description: >-
        Tentativa recente de entrega de webhook assíncrono gerenciado pelo
        gateway.
      properties:
        id:
          type: string
          description: Identificador estável da tentativa para auditoria e depuração.
        delivery_key:
          type: string
          description: Chave de idempotência para a entrega deste evento.
          example: video.completed
        event_type:
          type: string
          description: Tipo de evento entregue ao destino do webhook.
          example: video.completed
        status:
          type: string
          enum:
            - delivered
            - scheduled_retry
            - failed_permanently
        attempt_number:
          type: integer
          description: Número da tentativa para esta chave de entrega, começando em um.
        max_attempts:
          type: integer
          description: >-
            Máximo de tentativas antes de marcar a entrega como falha
            permanente.
        tried_at:
          type: string
          description: Timestamp ISO desta tentativa.
        delivered_at:
          type: string
          nullable: true
          description: Timestamp ISO da entrega bem-sucedida desta tentativa.
        next_retry_at:
          type: string
          nullable: true
          description: Timestamp ISO da próxima tentativa após esta, quando agendada.
        response_status:
          type: integer
          nullable: true
          description: Status HTTP retornado pelo destino do webhook, quando disponível.
        error_message:
          type: string
          nullable: true
          description: Mensagem de erro de entrega, quando disponível.
        response_body_preview:
          type: string
          nullable: true
          description: >-
            Prévia do corpo da resposta do destino do webhook com dados
            sensíveis ocultos.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Autenticação com token Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.