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

# Retrieve the result

> Available once the transcript is completed.



## OpenAPI

````yaml GET /transcripts/{id}/result
openapi: 3.1.0
info:
  title: Maybloc API
  version: 1.0.0
  description: >-
    Speech-to-text for recorded audio. Upload a recording and get back a
    transcript with every speaker separated, overlapping speech kept, and every
    word timed.
servers:
  - url: https://app.maybloc.com/api/v1
    description: Maybloc v1
security:
  - bearerAuth: []
tags:
  - name: Uploads
    description: Send a recording straight to private storage.
  - name: Transcripts
    description: Transcribe recordings and read the results.
  - name: Account
    description: Your workspace and its balance.
paths:
  /transcripts/{id}/result:
    get:
      tags:
        - Transcripts
      summary: Retrieve the result
      description: Available once the transcript is completed.
      operationId: getTranscriptResult
      parameters:
        - $ref: '#/components/parameters/TranscriptId'
      responses:
        '200':
          description: Speakers, timed turns and words, and overlaps
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptResult'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Transcript not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Not completed yet
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    TranscriptId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    TranscriptResult:
      type: object
      properties:
        id:
          type: string
          format: uuid
        object:
          type: string
          const: transcript.result
        model:
          type: string
        duration_ms:
          type: integer
        language:
          type:
            - string
            - 'null'
          description: The main language (ISO 639-1).
        speakers:
          type: array
          items:
            $ref: '#/components/schemas/Speaker'
        turns:
          type: array
          items:
            $ref: '#/components/schemas/Turn'
        overlaps:
          type: array
          items:
            $ref: '#/components/schemas/Overlap'
        activity:
          type: array
          description: >-
            When each speaker is audible, including short sounds that carry no
            words.
          items:
            $ref: '#/components/schemas/Activity'
        analytics:
          type: object
          description: >-
            Conversation analytics computed from the timing, included with every
            result at no charge.
          properties:
            speech_ms:
              type: integer
            silence_ms:
              type: integer
              description: Total of pauses of 2 seconds or more.
            silences:
              type: array
              items:
                type: object
                properties:
                  start_ms:
                    type: integer
                    description: >-
                      Start, in milliseconds from the beginning of the
                      recording.
                  end_ms:
                    type: integer
                    description: End, in milliseconds from the beginning of the recording.
            overlap_ms:
              type: integer
            switches_per_minute:
              type: number
              description: Speaker changes per minute of speech.
            median_response_ms:
              type:
                - integer
                - 'null'
              description: >-
                Median gap before a different speaker replies; negative when
                they overlap.
            speakers:
              type: array
              items:
                type: object
                properties:
                  speaker_id:
                    type: string
                  talk_ms:
                    type: integer
                  talk_share:
                    type: number
                  turns:
                    type: integer
                  words:
                    type: integer
                  words_per_minute:
                    type:
                      - integer
                      - 'null'
                    description: Null for languages written without spaces.
                  longest_turn_ms:
                    type: integer
                  longest_turn_start_ms:
                    type: integer
                  interruptions:
                    type: integer
                    description: Times this speaker started while another was mid-sentence.
                  questions:
                    type: integer
        addons:
          type: object
          description: >-
            Output of the add-ons in config.addons; only those appear. Generated
            add-ons have a status: pending until the transcript.addons.completed
            webhook, then ready, or failed with their price refunded. With
            redact_pii the result is served only once names and other details
            have been looked for, and its text and words are redacted;
            smart_format makes them punctuated and readable. Speakers in
            generated text appear as {{speaker_1}}: replace them with
            speaker_names.
          properties:
            redact_pii:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
                redactions:
                  type: integer
                types:
                  type: object
                  additionalProperties:
                    type: integer
                  description: >-
                    Redactions by type: person_name, phone_number, email,
                    address, date_of_birth, government_id, credit_card,
                    bank_account, account_number, medical, ip_address, url,
                    username, other.
                audio:
                  type: array
                  items:
                    type: object
                    properties:
                      start_ms:
                        type: integer
                      end_ms:
                        type: integer
                      type:
                        type: string
                  description: Where each redacted value was said, to bleep the audio.
            smart_format:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
            subtitles:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    ready once the text is punctuated; until then the cues use
                    the words as heard.
                cues:
                  type: array
                  items:
                    type: object
                    properties:
                      start_ms:
                        type: integer
                      end_ms:
                        type: integer
                      lines:
                        type: array
                        minItems: 1
                        maxItems: 2
                        description: >-
                          One or two lines. dual lines are two people talking at
                          once: show each with a leading dash. label: name the
                          speaker before this line.
                        items:
                          type: object
                          properties:
                            speaker_id:
                              type: string
                            text:
                              type: string
                            label:
                              type: boolean
                            dual:
                              type: boolean
                report:
                  type: object
                  description: >-
                    How the cues meet the Netflix timed text rules: counts of
                    cues that could not, such as cues_over_reading_speed in fast
                    crosstalk.
                  additionalProperties:
                    type:
                      - integer
                      - number
                      - string
            insights:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
                summary:
                  type: string
                  description: One paragraph.
                chapters:
                  type: array
                  items:
                    type: object
                    properties:
                      start_ms:
                        type: integer
                      end_ms:
                        type: integer
                      title:
                        type: string
                      summary:
                        type: string
                key_points:
                  type: array
                  items:
                    type: object
                    properties:
                      at_ms:
                        type: integer
                      text:
                        type: string
                action_items:
                  type: array
                  items:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - action
                          - decision
                          - question
                      at_ms:
                        type: integer
                      speaker_id:
                        type:
                          - string
                          - 'null'
                        description: Who owns it, when someone does.
                      task:
                        type: string
                      due:
                        type:
                          - string
                          - 'null'
                highlights:
                  type: array
                  items:
                    type: object
                    properties:
                      start_ms:
                        type: integer
                      end_ms:
                        type: integer
                      title:
                        type: string
                      why:
                        type: string
            identify_speakers:
              type: object
              description: >-
                Names and roles the conversation makes clear, with the words
                that show it.
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
                names:
                  type: array
                  items:
                    type: object
                    properties:
                      speaker_id:
                        type: string
                      name:
                        type:
                          - string
                          - 'null'
                      role:
                        type:
                          - string
                          - 'null'
                      at_ms:
                        type: integer
                      evidence:
                        type: string
            sentiment:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
                overall:
                  type: string
                  enum:
                    - positive
                    - neutral
                    - negative
                    - mixed
                speakers:
                  type: array
                  items:
                    type: object
                    properties:
                      speaker_id:
                        type: string
                      tone:
                        type: string
                        enum:
                          - positive
                          - neutral
                          - negative
                          - mixed
                moments:
                  type: array
                  items:
                    type: object
                    properties:
                      at_ms:
                        type: integer
                      tone:
                        type: string
                        enum:
                          - positive
                          - neutral
                          - negative
                          - mixed
                      note:
                        type: string
            topics:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
                topics:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                      relevance:
                        type: number
                entities:
                  type: array
                  items:
                    type: object
                    properties:
                      text:
                        type: string
                      type:
                        type: string
                        enum:
                          - person
                          - organization
                          - location
                          - product
                          - event
                          - date
                          - money
                          - other
                      mentions:
                        type: array
                        items:
                          type: object
                          properties:
                            at_ms:
                              type: integer
                            speaker_id:
                              type: string
            keywords:
              type: object
              properties:
                terms:
                  type: array
                  items:
                    type: object
                    properties:
                      term:
                        type: string
                      count:
                        type: integer
                      mentions:
                        type: array
                        items:
                          type: object
                          properties:
                            at_ms:
                              type: integer
                            speaker_id:
                              type: string
                            turn_id:
                              type: string
                        description: Where it was said, in time order (at most 100).
            custom_fields:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - pending
                    - ready
                    - failed
                  description: >-
                    pending while it is generated; failed if it couldn't be, and
                    its price was refunded.
                answers:
                  type: object
                  additionalProperties: true
                  description: >-
                    Each question's key with its answer in the type asked for,
                    or null when the recording doesn't say.
            translation:
              type: object
              properties:
                languages:
                  type: object
                  description: By language code.
                  additionalProperties:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - pending
                          - ready
                          - failed
                        description: >-
                          pending while it is generated; failed if it couldn't
                          be, and its price was refunded.
                      lines:
                        type: array
                        items:
                          type: object
                          properties:
                            speaker_id:
                              type: string
                            start_ms:
                              type: integer
                            end_ms:
                              type: integer
                            text:
                              type: string
                            translated:
                              type: boolean
                              description: 'false: kept in the original language.'
                            turn_ids:
                              type: array
                              items:
                                type: string
                      subtitles:
                        type: object
                        properties:
                          cues:
                            type: array
                            items:
                              type: object
                              properties:
                                start_ms:
                                  type: integer
                                end_ms:
                                  type: integer
                                lines:
                                  type: array
                                  minItems: 1
                                  maxItems: 2
                                  description: >-
                                    One or two lines. dual lines are two people
                                    talking at once: show each with a leading
                                    dash. label: name the speaker before this
                                    line.
                                  items:
                                    type: object
                                    properties:
                                      speaker_id:
                                        type: string
                                      text:
                                        type: string
                                      label:
                                        type: boolean
                                      dual:
                                        type: boolean
                          report:
                            type: object
                            description: >-
                              How the cues meet the Netflix timed text rules:
                              counts of cues that could not, such as
                              cues_over_reading_speed in fast crosstalk.
                            additionalProperties:
                              type:
                                - integer
                                - number
                                - string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              examples:
                - invalid_request
                - insufficient_credit
                - rate_limited
            message:
              type: string
            request_id:
              type: string
              description: Quote this when contacting support.
    Speaker:
      type: object
      description: Speaker ids are stable within one transcript.
      properties:
        id:
          type: string
        speaking_ms:
          type: integer
    Turn:
      type: object
      description: One speaker talking without a break.
      properties:
        id:
          type: string
        speaker_id:
          type: string
        start_ms:
          type: integer
          description: Start, in milliseconds from the beginning of the recording.
        end_ms:
          type: integer
          description: End, in milliseconds from the beginning of the recording.
        text:
          type: string
        words:
          type: array
          items:
            $ref: '#/components/schemas/Word'
    Overlap:
      type: object
      description: Two or more speakers talking at once.
      properties:
        id:
          type: string
        start_ms:
          type: integer
          description: Start, in milliseconds from the beginning of the recording.
        end_ms:
          type: integer
          description: End, in milliseconds from the beginning of the recording.
        turn_ids:
          type: array
          items:
            type: string
    Activity:
      type: object
      properties:
        speaker_id:
          type: string
        start_ms:
          type: integer
          description: Start, in milliseconds from the beginning of the recording.
        end_ms:
          type: integer
          description: End, in milliseconds from the beginning of the recording.
    Word:
      type: object
      properties:
        text:
          type: string
        start_ms:
          type: integer
          description: Start, in milliseconds from the beginning of the recording.
        end_ms:
          type: integer
          description: End, in milliseconds from the beginning of the recording.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An API key: Authorization: Bearer mbk_live_...'

````

## Related topics

- [Retrieve a transcript](https://docs.maybloc.com/api-reference/retrieve-a-transcript.md)
- [Retrieve the account](https://docs.maybloc.com/api-reference/retrieve-the-account.md)
- [What does a Maybloc transcript result contain?](https://docs.maybloc.com/guides/results.md)
- [Maybloc add-ons: redaction, summaries, sentiment and translation](https://docs.maybloc.com/guides/add-ons.md)
- [Maybloc data retention, deletion and privacy](https://docs.maybloc.com/guides/data-retention.md)


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