> ## 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 vídeo

> Cria um trabalho de geração assíncrona de vídeo. Consulte a `polling_url` retornada a cada 20 segundos até o trabalho atingir um status final.

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 /videos
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:
  /videos:
    post:
      tags:
        - Gateway
      summary: Criar vídeo
      description: >-
        Cria um trabalho de geração assíncrona de vídeo. Consulte a
        `polling_url` retornada a cada 20 segundos até o trabalho atingir um
        status final.
      operationId: createVideo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoGenerationRequest'
      responses:
        '202':
          description: Resposta de vídeo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoGenerationResponse'
components:
  schemas:
    VideoGenerationRequest:
      type: object
      required:
        - model
        - prompt
      properties:
        model:
          type: string
        prompt:
          type: string
        duration:
          type: integer
          description: Duração desejada em segundos (depende do provedor/modelo).
        input_video_duration:
          type: number
          format: double
          minimum: 0
          maximum: 3600
          exclusiveMinimum: true
          description: >-
            Duração do vídeo de origem em segundos. Obrigatória quando o
            provedor cobra a duração do vídeo de origem separadamente da saída
            gerada.
        input_audio_duration:
          type: number
          format: double
          minimum: 2
          maximum: 20
          description: >-
            Duração declarada do áudio de origem em segundos, usada para validar
            a faixa do provedor. Provedores que não informam uso definitivo
            podem cobrar pelo teto de duração de entrada suportado.
        size:
          type: string
          description: >-
            Dimensões explícitas (por exemplo, 1280x720). Não pode ser combinado
            com resolution ou aspect_ratio.
        resolution:
          type: string
          description: >-
            480p, 720p, 1080p, 1K, 2K, 4K. Pode ser combinado com aspect_ratio.
            Não pode ser combinado com size.
        aspect_ratio:
          type: string
          description: >-
            Proporção como 16:9, 9:16 ou 1:1. Pode ser combinado com resolution.
            Não pode ser combinado com size.
        seed:
          type: integer
        sample_count:
          type: integer
          minimum: 1
          maximum: 4
        negative_prompt:
          type: string
        generate_audio:
          type: boolean
        enhance_prompt:
          type: boolean
        compression_quality:
          type: integer
        person_generation:
          type: string
        resize_mode:
          type: string
        input_references:
          type: array
          description: >-
            Entradas HTTPS de imagem, áudio ou vídeo que condicionam a geração.
            Tipos, funções, quantidades e combinações suportados dependem do
            modelo selecionado. Consulte GET /videos/models antes de enviar um
            trabalho. O alias singular de compatibilidade input_reference,
            omitido deste esquema, aceita uma imagem multipart ou um objeto com
            exatamente um dos campos file_id ou image_url. O suporte depende do
            provedor.
          items:
            $ref: '#/components/schemas/VideoInputReference'
        frame_images:
          type: array
          minItems: 1
          maxItems: 2
          description: >-
            Imagens HTTPS do primeiro/último quadro. Cada frame_type pode
            aparecer uma vez. Não forneça também input_reference nem funções de
            quadro em input_references.
          items:
            type: object
            additionalProperties: false
            required:
              - type
              - frame_type
              - image_url
            properties:
              type:
                type: string
                enum:
                  - image_url
              frame_type:
                type: string
                enum:
                  - first_frame
                  - last_frame
              image_url:
                type: object
                required:
                  - url
                properties:
                  url:
                    type: string
                    format: uri
        provider_params:
          type: object
          additionalProperties: true
          description: >-
            Somente extensões específicas do provedor. O repasse completo da
            solicitação e campos duplicados de roteamento, prompt, callback ou
            cobrança são rejeitados.
        provider_options:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
          description: >-
            Extensões indexadas pelo ID canônico do provedor (por exemplo,
            atlascloud ou byteplus). Somente as opções do provedor selecionado
            são encaminhadas. Não pode ser combinado com provider_params. Campos
            de roteamento, prompt, callback, duração, resolução e quantidade de
            saídas devem usar campos validados de nível superior.
        output:
          $ref: '#/components/schemas/VideoOutputConfig'
        webhook:
          type: object
          required:
            - endpoint_id
          additionalProperties: false
          properties:
            endpoint_id:
              type: string
              description: >-
                Endpoint de webhook ativo gerenciado pelo espaço de trabalho.
                Seu segredo de assinatura criptografado e rotacionável nunca é
                armazenado nos metadados do trabalho de vídeo.
            events:
              type: array
              description: >-
                Assinaturas opcionais de eventos. Use eventos genéricos job.* ou
                eventos video.* correspondentes, como video.status_changed,
                video.progress ou video.completed. Quando omitidos, são usados
                job.status_changed e eventos finais job.*. Inclua job.progress
                ou video.progress explicitamente para callbacks de progresso.
                Quando fornecidos, pelo menos um evento deve ser válido para
                trabalhos de vídeo; listas malformadas ou somente com eventos de
                outro tipo são rejeitadas.
              items:
                type: string
        provider:
          $ref: '#/components/schemas/ProviderRoutingOptions'
    VideoGenerationResponse:
      type: object
      properties:
        id:
          type: string
        polling_url:
          type: string
        websocket_url:
          type: string
          format: uri
          description: >-
            URL de WebSocket para assinar atualizações normalizadas do ciclo de
            vida de trabalhos assíncronos.
        model:
          type: string
        request_id:
          type: string
        session_id:
          type: string
        status:
          type: string
          enum:
            - queued
            - processing
            - completed
            - failed
            - cancelled
            - expired
        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.
        cancel_url:
          type: string
          format: uri
          nullable: true
          description: Reservado para compatibilidade; atualmente sempre null.
        output_access:
          type: string
          enum:
            - bytes
            - signed_url
            - both
        generation_id:
          type: string
          nullable: true
        native_video_id:
          type: string
          nullable: true
          description: >-
            ID nativo de vídeo/trabalho do provedor quando difere do ID do
            gateway.
        created_at:
          oneOf:
            - type: integer
            - type: string
        started_at:
          nullable: true
          oneOf:
            - type: integer
            - type: string
        completed_at:
          nullable: true
          oneOf:
            - type: integer
            - type: string
        object:
          type: string
          example: video
        poll_after_seconds:
          type: integer
          example: 20
        provider:
          type: string
        seconds:
          type: number
        size:
          type: string
        audio:
          type: boolean
        content_url:
          type: string
          description: Presente quando output_access inclui bytes (endpoint autenticado).
        download_url:
          type: string
          nullable: true
          description: >-
            URL assinada de primeira parte para download direto quando o status
            é completed.
        expires_at:
          type: integer
          nullable: true
          description: Timestamp Unix (segundos) de expiração da download_url assinada.
        progress:
          type: integer
          nullable: true
        progress_source:
          type: string
        asset:
          type: object
          nullable: true
          properties:
            id:
              type: string
            mime_type:
              type: string
            bytes:
              type: integer
            sha256:
              type: string
            width:
              type: integer
            height:
              type: integer
            duration_seconds:
              type: number
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/VideoOutput'
        billing:
          $ref: '#/components/schemas/VideoBillingSummary'
        webhook:
          $ref: '#/components/schemas/AsyncWebhookPublicState'
        next_webhook_retry_at:
          type: string
          nullable: true
          description: >-
            Timestamp ISO da próxima tentativa agendada do webhook do usuário,
            quando enfileirada.
        last_webhook_progress:
          type: number
          nullable: true
          description: >-
            Última faixa aproximada de progresso enviada aos consumidores de
            webhooks.
        last_webhook_progress_at:
          type: string
          nullable: true
          description: >-
            Timestamp ISO do envio da faixa de progresso mais recente do
            webhook.
        last_webhook_dispatched_at:
          type: string
          nullable: true
          description: Timestamp ISO da tentativa de envio do webhook mais recente.
        usage:
          type: object
          properties:
            cost:
              type: number
            is_byok:
              type: boolean
          additionalProperties: true
        error:
          nullable: true
    VideoInputReference:
      description: >-
        Entrada de mídia HTTPS tipada. Use image_url para imagens e media_url
        para áudio ou vídeo. As funções descrevem como o modelo deve usar a
        entrada; o suporte varia por provedor e modelo.
      oneOf:
        - type: object
          required:
            - type
            - image_url
          properties:
            type:
              type: string
              enum:
                - image_url
            role:
              type: string
              description: Uso pretendido desta imagem pelo modelo selecionado.
              enum:
                - first_frame
                - last_frame
                - reference
                - source
                - mask
            reference_type:
              type: string
            image_url:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  description: URL HTTPS de imagem acessível publicamente.
        - type: object
          required:
            - type
            - media_url
          properties:
            type:
              type: string
              enum:
                - video_url
                - audio_url
            role:
              type: string
              description: Uso pretendido deste áudio ou vídeo pelo modelo selecionado.
              enum:
                - first_frame
                - last_frame
                - reference
                - source
                - mask
            reference_type:
              type: string
            media_url:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  description: URL HTTPS de áudio ou vídeo acessível publicamente.
    VideoOutputConfig:
      type: object
      properties:
        access:
          type: string
          enum:
            - bytes
            - signed_url
            - both
          default: both
          description: >-
            bytes=somente content_url autenticada, signed_url=somente links de
            download assinados, both=incluir ambos.
    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
    VideoOutput:
      type: object
      properties:
        index:
          type: integer
        mime_type:
          type: string
        bytes_available:
          type: boolean
        content_url:
          type: string
          description: Presente quando output_access inclui bytes.
        download_url:
          type: string
          description: URL assinada de primeira parte para esta saída.
        expires_at:
          type: integer
          description: Timestamp Unix (segundos) de expiração desta URL de saída.
    VideoBillingSummary:
      type: object
      properties:
        currency:
          type: string
        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
        state:
          type: string
          enum:
            - pending
            - estimated
            - settled
            - void
        billable:
          type: boolean
        total_nanos:
          type: integer
          nullable: true
        estimated_nanos:
          type: integer
          nullable: true
        reserved_nanos:
          type: integer
          nullable: true
        reservation_id:
          type: string
          nullable: true
        reservation_status:
          type: string
          nullable: true
        charge_reason:
          type: string
          nullable: true
        charged:
          type: boolean
          nullable: true
        billed_at:
          type: string
      additionalProperties: true
    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'
    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.