> ## 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.

# Run lyrics sync for a project



## OpenAPI

````yaml /openapi.json post /projects/{projectId}/tasks/lyrics-sync
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:
  /projects/{projectId}/tasks/lyrics-sync:
    post:
      tags:
        - Tasks
      summary: Run lyrics sync for a project
      operationId: createLyricsSyncTask
      parameters:
        - in: path
          name: projectId
          required: true
          schema:
            type: string
        - in: header
          name: Idempotency-Key
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLyricsSyncRequest'
      responses:
        '202':
          description: Lyrics sync task accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskActionResponse'
components:
  schemas:
    CreateLyricsSyncRequest:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        lyricsSource:
          oneOf:
            - type: object
              properties:
                type:
                  type: string
                  const: transcribe
                language:
                  type: string
                  enum:
                    - af
                    - ar
                    - hy
                    - az
                    - be
                    - bn
                    - bs
                    - bg
                    - ca
                    - zh
                    - hr
                    - cs
                    - da
                    - dv
                    - nl
                    - en
                    - et
                    - tl
                    - fi
                    - fr
                    - gl
                    - de
                    - el
                    - he
                    - hi
                    - hu
                    - is
                    - id
                    - it
                    - ja
                    - kn
                    - kk
                    - ko
                    - lv
                    - lt
                    - mk
                    - mi
                    - ms
                    - mr
                    - ne
                    - 'no'
                    - fa
                    - pl
                    - pt
                    - ro
                    - ru
                    - sr
                    - sk
                    - sl
                    - es
                    - sw
                    - sv
                    - ta
                    - th
                    - tr
                    - uk
                    - ur
                    - vi
                    - cy
                syncModel:
                  type: string
                  enum:
                    - audioshake-transcription
                    - musicai-transcription
                    - whisper
              required:
                - type
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  const: align
                lyrics:
                  type: string
                  minLength: 10
                language:
                  type: string
                  enum:
                    - af
                    - ar
                    - hy
                    - az
                    - be
                    - bn
                    - bs
                    - bg
                    - ca
                    - zh
                    - hr
                    - cs
                    - da
                    - dv
                    - nl
                    - en
                    - et
                    - tl
                    - fi
                    - fr
                    - gl
                    - de
                    - el
                    - he
                    - hi
                    - hu
                    - is
                    - id
                    - it
                    - ja
                    - kn
                    - kk
                    - ko
                    - lv
                    - lt
                    - mk
                    - mi
                    - ms
                    - mr
                    - ne
                    - 'no'
                    - fa
                    - pl
                    - pt
                    - ro
                    - ru
                    - sr
                    - sk
                    - sl
                    - es
                    - sw
                    - sv
                    - ta
                    - th
                    - tr
                    - uk
                    - ur
                    - vi
                    - cy
                syncModel:
                  type: string
                  enum:
                    - audioshake-alignment
                    - musicai-alignment
                    - musicai-alignment-subword
                    - wav2vec2
              required:
                - type
                - lyrics
              additionalProperties: false
      additionalProperties: false
    TaskActionResponse:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        projectId:
          type: string
        taskId:
          type: string
        projectUrl:
          type: string
          format: uri
        taskUrl:
          type: string
          format: uri
      required:
        - projectId
        - taskId
        - projectUrl
        - taskUrl
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````