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

# Get task status



## OpenAPI

````yaml /openapi.json get /tasks/{taskId}
openapi: 3.1.0
info:
  title: Youka REST API
  version: v1
  description: REST API for project-based karaoke creation, styling, media, and exports.
servers:
  - url: https://api.youka.io/api/v1
    description: Production
  - url: http://localhost:3003/api/v1
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Inspect the API key's account identity.
  - name: Uploads
    description: Upload source audio or video before creating a project.
  - name: Credits
    description: Inspect available credit balance.
  - name: Billing
    description: Create checkout sessions and manage billing.
  - name: Projects
    description: Create projects and read the long-lived project state.
  - name: Tasks
    description: Poll async task progress until it reaches a terminal state.
  - name: Exports
    description: Create exports and fetch fresh download URLs.
  - name: Presets
    description: Manage reusable karaoke styling presets.
  - name: Media
    description: Manage uploaded reusable media.
  - name: Project Settings
    description: Read and update a project's active settings.
paths:
  /tasks/{taskId}:
    get:
      tags:
        - Tasks
      summary: Get task status
      operationId: getTask
      parameters:
        - in: path
          name: taskId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Task status and hydrated output
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
components:
  schemas:
    Task:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - create-karaoke
            - sync-lyrics
            - stem-separation
            - generate-video
            - generate-chords
            - export-stem-audio
            - export-project
        status:
          type: string
          enum:
            - created
            - queued
            - in-progress
            - completed
            - failed
            - cancelled
            - timed-out
            - finalized
        error:
          anyOf:
            - type: string
            - type: 'null'
        output:
          anyOf:
            - type: object
              properties:
                projectId:
                  type: string
              required:
                - projectId
              additionalProperties: false
            - type: object
              properties:
                stemIds:
                  type: array
                  items:
                    type: string
                stems:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        enum:
                          - original
                          - vocals
                          - instrumental
                          - backing_vocals
                      model:
                        type: string
                      url:
                        type: string
                        format: uri
                      duration:
                        anyOf:
                          - type: number
                          - type: 'null'
                    required:
                      - id
                      - type
                      - model
                      - url
                    additionalProperties: false
              additionalProperties: false
            - type: object
              properties:
                alignmentId:
                  type: string
                alignment:
                  type: object
                  properties:
                    id:
                      type: string
                    model:
                      type: string
                    alignment: {}
                    createdAt:
                      type: string
                  required:
                    - id
                    - model
                    - alignment
                    - createdAt
                  additionalProperties: false
              additionalProperties: false
            - type: object
              properties:
                exportId:
                  type: string
                fileId:
                  type: string
              required:
                - exportId
              additionalProperties: false
      required:
        - id
        - type
        - status
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````