Felo API PlatformFelo API Platform
v0.3.0
OpenAPI 3.1.0

Poll a video generation task

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

Poll a video generation task

​

Returns the current task status. When status is succeeded, outputs contains signed media URLs (https://openapi.felo.ai/api/v1/media/{file_id}?exp=...&sig=...) that can be downloaded anonymously. Poll at 5-10 second intervals; the task itself continues in the background.

Path Parameters
  • task_id
    Type: string
    required

    Task id returned by POST /api/v1/videos/generations.

Responses
  • 200
    Type: object · VideoGenerationTask

    Current task state

    • kind
      enum
      const:  
      video
      required
      values
      • video
    • outputs
      Type: array string[] Format: uri
      required
    • status
      Type: string enum
      required
      values
      • queued
      • running
      • succeeded
      • failed
      • interrupted
    • task_id
      Type: string
      required
    • error
      Type: object

      Present when the task failed.

      • message
        Type: string
      • type
        Type: string
    application/json
  • 401
    Type: object · GenerationError

    Invalid or missing Felo API key

    OpenAI-compatible error envelope.

    • error
      Type: object
      • message
        Type: string
        required
      • type
        Type: string enum
        required
        values
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 404
    Type: object · GenerationError

    Task not found for this account

    OpenAI-compatible error envelope.

    • error
      Type: object
      • message
        Type: string
        required
      • type
        Type: string enum
        required
        values
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
  • 503
    Type: object · GenerationError

    Generation service temporarily unavailable

    OpenAI-compatible error envelope.

    • error
      Type: object
      • message
        Type: string
        required
      • type
        Type: string enum
        required
        values
        • invalid_request_error
        • server_error
      • code
        Type: string
      • param
        Type: string nullable
    application/json
Request Example for get/api/v1/videos/generations/{task_id}
curl 'https://openapi.felo.ai/api/v1/videos/generations/{task_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "task_id": "string",
  "status": "queued",
  "kind": "video",
  "outputs": [
    "https://example.com"
  ],
  "error": {
    "message": "string",
    "type": "string"
  }
}

Current task state

Poll a video generation task