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

# List Transcript Segments

> A transcription job's text is a list of segments, each with a speaker and start and end times. These endpoints read and edit them. Edits are free and show everywhere the transcript is read or exported; AI content you generate afterwards uses the edited text.

Returns every segment of the job, in time order. This is how you read a finished transcription's text.



## OpenAPI

````yaml /api-reference/openapi.json get /v2/transcript-jobs/{jobId}/transcripts
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:
    get:
      tags: []
      summary: List transcript segments
      description: >-
        A transcription job's text is a list of segments, each with a speaker
        and start and end times. These endpoints read and edit them. Edits are
        free and show everywhere the transcript is read or exported; AI content
        you generate afterwards uses the edited text.


        Returns every segment of the job, in time order. This is how you read a
        finished transcription's text.
      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: search
          required: false
          description: Only segments whose text contains this. 1 to 1000 characters.
          schema:
            type: string
            minLength: 1
            maxLength: 1000
            example: welcome
      responses:
        '200':
          description: The segments.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      transcripts:
                        type: array
                        items:
                          $ref: '#/components/schemas/TranscriptSegment'
        '400':
          description: >-
            Invalid `jobId`, `projectId` or `search`, for example "Search (q)
            cannot be empty". 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:
    TranscriptSegment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 0186333b-6469-4c33-8b8f-b29ef9db0c99
        text:
          type: string
          example: Hello and welcome to the show.
        startedAt:
          type: number
          nullable: true
          description: >-
            Start, in seconds from the start of the media. `null` when `endAt`
            is `null`.
          example: 0.52
        endAt:
          type: number
          nullable: true
          description: End, in seconds. `null` for a segment you added after the last one.
          example: 2.91
        words:
          type: array
          items:
            $ref: '#/components/schemas/TranscriptWord'
        transcriptSpeaker:
          $ref: '#/components/schemas/TranscriptSegmentSpeaker'
    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
    TranscriptWord:
      type: object
      description: >-
        One word of a segment. `start` and `end` are missing for words added or
        rewritten through an edit.
      properties:
        word:
          type: string
          example: Hello
        start:
          type: number
          description: Seconds from the start of the media.
          example: 0.52
        end:
          type: number
          description: Seconds from the start of the media.
          example: 0.8
    TranscriptSegmentSpeaker:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: cc3c21c5-e8bc-436a-a9a9-b0385c2b81b0
        speaker:
          type: string
          description: >-
            The speaker's name: the label the transcription gave it, or a name
            you gave it.
          example: speaker_0
        color:
          type: string
          description: Hex color used for the speaker in Hamsa Media.
          example: '#1F77B4'
  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.