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

# Export Transcript

> Downloads the transcript as a file named `transcripts.<ext>`, with each segment's speaker, start and end. Times are written as minutes and seconds (`2:05`), and a time of 0 is left empty. `SRT` uses the same `M:SS` times, not standard SRT timecodes, and never includes speakers. `JSON` is a list of `{id, text, startedAt, endAt, createdAt}`, with `transcriptSpeaker` when speakers are included and the times as `M:SS` text. `CSV` has the columns `id`, `speaker` (when included), `text`, `startedAt` and `endAt`.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/transcript-jobs/{jobId}/transcripts/export
openapi: 3.0.1
info:
  title: Hamsa API
  description: >-
    The Hamsa API: voice agents and their calls, phone numbers, batch calls and
    knowledge bases; speech to text, text to speech, voices and AI content.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tryhamsa.com
security: []
paths:
  /v2/transcript-jobs/{jobId}/transcripts/export:
    get:
      tags: []
      summary: Export a transcript
      description: >-
        Downloads the transcript as a file named `transcripts.<ext>`, with each
        segment's speaker, start and end. Times are written as minutes and
        seconds (`2:05`), and a time of 0 is left empty. `SRT` uses the same
        `M:SS` times, not standard SRT timecodes, and never includes speakers.
        `JSON` is a list of `{id, text, startedAt, endAt, createdAt}`, with
        `transcriptSpeaker` when speakers are included and the times as `M:SS`
        text. `CSV` has the columns `id`, `speaker` (when included), `text`,
        `startedAt` and `endAt`.
      parameters:
        - in: path
          name: jobId
          required: true
          description: 'The transcription job: the `jobId` you got when you created it.'
          schema:
            type: string
            format: uuid
            example: 8f0b0a52-3f6e-4a35-9a3a-0b8a6f3c2d11
        - in: query
          name: projectId
          required: true
          description: 'Your project''s ID: the project of your API key.'
          schema:
            type: string
            format: uuid
            example: 48f7656f-098b-4c43-b165-7cfd2cc8ac30
        - in: query
          name: type
          required: true
          description: The file format, in capitals.
          schema:
            type: string
            enum:
              - PDF
              - DOCX
              - TEXT
              - JSON
              - CSV
              - SRT
              - HTML
            example: DOCX
        - in: query
          name: includeSpeakers
          required: false
          description: Whether each segment shows its speaker. Not used by `SRT`.
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'true'
            example: 'true'
      responses:
        '200':
          description: The file, as an attachment named `transcripts.<ext>`.
          content:
            application/pdf:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.wordprocessingml.document:
              schema:
                type: string
                format: binary
            text/plain:
              schema:
                type: string
                format: binary
            application/json:
              schema:
                type: string
                format: binary
            text/csv:
              schema:
                type: string
                format: binary
            application/x-subrip:
              schema:
                type: string
                format: binary
            text/html:
              schema:
                type: string
                format: binary
        '400':
          description: >-
            Missing or wrong `type` ("Invalid export type must be
            PDF,DOCX,TEXT,JSON,CSV,SRT,HTML") or `includeSpeakers`
            ("includeSpeakers must be true or false"). A `projectId` that isn't
            your key's project is refused too.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '403':
          description: The key's scopes don't allow this (it needs `transcription:read`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '404':
          description: >-
            No job with this ID in your project ("Job not found!",
            `JobNotFound`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Server Side Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorSchema:
      type: object
      properties:
        code:
          type: integer
          description: >-
            Service error code: the HTTP status with a service prefix (for
            example `8404`). Missing when the service has no code for that
            status.
          example: 8404
        message:
          type: string
          description: >-
            What went wrong. Some services (calls and recordings) put the error
            key here, for example `CallNotFoundOrUnavailable`, and send no
            `messageKey`.
          example: Policy not found!
        messageKey:
          type: string
          description: >-
            Stable key for the error, safe to match on in code. Not returned by
            every service.
          example: PolicyNotFound
        params:
          type: object
          additionalProperties: true
          description: >-
            Details for some errors (for example `reason`). Not returned by
            every service.
          example:
            reason: NO_DRAFT
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Pass the API key in the Authorization header, You need to put Token
        keyword before the API key. e.g. 'Authorization: Token <api-key>'

````

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