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

# Transcription

> Request or read a video transcription

CLI: `adside assets transcription`



## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/workspaces/{workspaceId}/assets/{assetId}/transcription
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/assets/{assetId}/transcription:
    post:
      tags:
        - Assets
      summary: Transcription
      description: |-
        Request or read a video transcription

        CLI: `adside assets transcription`
      operationId: assets.transcription
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: assetId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                oneOf:
                  - type: object
                    properties:
                      kind:
                        type: string
                        const: not_transcribable
                      mimeType:
                        type: string
                    required:
                      - kind
                      - mimeType
                    additionalProperties: false
                  - type: object
                    properties:
                      kind:
                        type: string
                        const: transcription
                      requested:
                        type: boolean
                      transcription:
                        type: object
                        properties:
                          status:
                            type: string
                            enum:
                              - PENDING
                              - SUBMITTING
                              - SUBMITTED
                              - PROCESSING
                              - COMPLETED
                              - NO_AUDIO
                              - FAILED
                          sentences:
                            anyOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    text:
                                      type: string
                                    start:
                                      type: number
                                    end:
                                      type: number
                                  required:
                                    - text
                                    - start
                                    - end
                                  additionalProperties: false
                              - type: 'null'
                          confidence:
                            anyOf:
                              - type: number
                              - type: 'null'
                          durationSeconds:
                            anyOf:
                              - type: number
                              - type: 'null'
                          languageCode:
                            anyOf:
                              - type: string
                              - type: 'null'
                          errorMessage:
                            anyOf:
                              - type: string
                              - type: 'null'
                          updatedAt:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        required:
                          - status
                          - sentences
                          - confidence
                          - durationSeconds
                          - languageCode
                          - errorMessage
                          - updatedAt
                        additionalProperties: false
                    required:
                      - kind
                      - requested
                      - transcription
                    additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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