Skip to main content

List Transcriptions

GET 
/v2/transcriptions

List Conversation Transcriptions

Request​

Query Parameters

    created_at[lt] string

    Returns all matching records that are less than to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[lte] string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[gt] string

    Returns all matching records that are greater than to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    created_at[gte] string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lt] string

    Returns all matching records that are less than to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[lte] string

    Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gt] string

    Returns all matching records that are greater than to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    updated_at[gte] string

    Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.

    language_code string

    Possible values: [en-AU, en-AB, en-GB, en-IN, en-IE, en-NZ, en-ZA, en-US, en-WL, es-ES, es-US, nl-NL, it-IT, fr-FR, fr-CA, de-DE, de-CH]

    Filter transcriptions by language code of the transcription, this is the language of the conversation

    ids[] string[]

    Filter transcriptions by identifiers. This parameter can be use to get multiple transcriptions by their identifiers

    sort_by string

    Possible values: [created_at, updated_at]

    Sort by field, this is the field that the results will be sorted by. Defaults to created_at

    per_page integer

    How many records to show per page in the range [1, 100]. Defaults to 25

    page integer

    The current page to fetch results from. Defaults to 1

    include_paging_counts boolean

    Whether to include total_pages and total_count in the metadata. Defaults to false

Responses​

Success

Schema
  • Array [
    • id uuidrequired

    Transcription Id

    language_code string

    Possible values: [en-AU, en-AB, en-GB, en-IN, en-IE, en-NZ, en-ZA, en-US, en-WL, es-ES, es-US, nl-NL, it-IT, fr-FR, fr-CA, de-DE, de-CH]

    The text's BCP-47 language code, such as "en-US" or "sr-Latn".

    Reference: http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

    created_at date-time

    Date transcription was created

    updated_at date-time

    Date transcription was last updated

    conversation object

    Reference to the Conversation

    id string
    _href uri
    transcription_sentences object

    Reference to the transcription sentences

    id string
    _href uri
    transcription_artifact object

    Reference to the transcription artifact

    id string
    _href uri
  • ]
Loading...