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

# Get video progress

> Returns how far along a video is. Lighter than Get a video, so use it for polling.

Use this to poll a video you've just created. It returns only the status and progress, so it's lighter than [Get a video](https://docs.olimi.ai/api-reference/endpoint/speech/get-stv.md).

`progress` here is a **number** from `0` to `1`. In Get a video and List videos, it's a **string** such as `"0.45"`.

When `status` is `failed` or `cancelled`, `errorCode` and `errorMessage` say why. Right after creating a video, those two fields may be missing until the first update.

A deleted video, or one that belongs to another company, returns `404` `stv_job_not_found`.


## OpenAPI

````yaml get /api/v2/stv/progress/{id}
openapi: 3.0.1
info:
  title: Customer Management API
  description: API for managing customer lists and customers within those lists
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-eg.olimi.ai
security:
  - bearerAuth: []
paths:
  /api/v2/stv/progress/{id}:
    get:
      tags:
        - Speech to Video
      summary: Get video progress
      description: >-
        Returns how far along a video is. Lighter than Get a video, so use it
        for polling.
      parameters:
        - name: id
          in: path
          required: true
          description: The video's `id`.
          schema:
            type: string
            format: uuid
          example: 7a3e9c12-5d8b-4f61-a2c7-9e0b3d6f1a48
      responses:
        '200':
          description: The video's progress.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StvProgressResponse'
        '400':
          description: '`id` isn''t a valid UUID.'
        '401':
          description: The `X-API-KEY` header is missing or the key isn't valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            `stv_job_not_found`: no video with that `id` belongs to your
            company, or it was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorStv'
      security:
        - apiKeyAuth: []
components:
  schemas:
    StvProgressResponse:
      type: object
      properties:
        message:
          type: string
          example: Job progress retrieved successfully
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
              example: 7a3e9c12-5d8b-4f61-a2c7-9e0b3d6f1a48
            status:
              type: string
              enum:
                - queued
                - processing
                - completed
                - failed
                - cancelled
              description: >-
                See [Status
                values](/api-reference/endpoint/speech/speech-to-video#status-values).
              example: completed
            progress:
              type: number
              description: >-
                How far along it is, from `0` to `1`. A number here, unlike Get
                a video.
              example: 0.45
            errorCode:
              type: string
              nullable: true
              example: null
            errorMessage:
              type: string
              nullable: true
              example: null
    ApiError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        errorCode:
          type: string
          description: Machine-readable error code.
          example: agent_not_found
        message:
          type: string
          description: Human-readable text. May change; don't match on it.
          example: Agent not found
    ApiErrorStv:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        errorCode:
          type: string
          example: stv_job_not_found
        message:
          type: string
          example: Speech-to-video job not found
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````

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