Skip to content

Datamodels

Info

Documents are currently in BETA and the API interface may change when this is deemed necessary.

The following datamodels are defined

APIResultResponse<_T>

Key Type Description
result _T The object, or list of objects in the result set
count number The number of objects in the response
total_results number The total number of objects available for this type of request

DocumentModel

Key Type Description
id string The document ID
created datetime Datetime in ISO format when the document is created
last_modified datetime Datetime in ISO format when the document is last modified
filename string The provided filename
type Enum[string]: "caption","document" The document type

DocumentModel

{
    "result": {
        "id": "12780b54-5575-44e4-bbca-0a410b432183",
        "created": "2021-01-25T10:31:46.960411+00:00",
        "last_modified": "2021-01-25T10:31:46.960411+00:00",
        "filename": "Example document",
        "type": "caption"
    }
}

ExtendedDocumentModel

Key Type Description
id string The document ID
created datetime Datetime in ISO format when the document is created
last_modified datetime Datetime in ISO format when the document is last modified
filename string The provided filename
type Enum[string]: "caption","document" The document type
document DocumentSegment[] The document itself, list of segments/paragraphs making up the document

ExtendedDocumentModel

{
    "result": {
        "id": "12780b54-5575-44e4-bbca-0a410b432183",
        "created": "2021-01-25T10:31:46.960411+00:00",
        "last_modified": "2021-01-25T10:31:46.960411+00:00",
        "filename": "Example document",
        "type": "caption",
        "document": [
            ...
        ]
    }
}

DocumentSegment

Key Type Description
start number Timestamp of start of segment/paragraph in transcript session. This is formatted as milliseconds since start of media file.
stop number Timestamp of end of segment/paragraph in transcript session. This is formatted as milliseconds since start of media file.
text string The text belonging to the segment/paragraph. May contain newlines.
speaker string | null The speaker belonging to the segment

Example

{
    "start": 513,
    "stop": 6285,
    "text": "The quick brown fox jumps over the lazy dog.",
    "speaker": None
}