get
/List records
Each record carries folder_id and tag_ids. Use ids to poll a batch of records in one read.
| Name | In | Required | Description |
|---|---|---|---|
| workspace_id | path | yes | The workspace (project) id. |
| limit | query | no | Page size. Default 25, max 100. |
| cursor | query | no | The next_cursor of the previous page. Opaque. |
| status | query | no | Filter by status. |
| folder_id | query | no | Only records in this folder. |
| tag_id | query | no | Only records with this tag. |
| ids | query | no | Only these records: 1 to 50 comma-separated record ids. Ids not in the workspace are left out. |
Responses
- 200 A page of records. (RecordList)
- 401 Missing, malformed, unknown or revoked API key. (ErrorResponse)
- 403 The account has no paid plan. (ErrorResponse)
- 404 The workspace does not exist or is not visible to this key's owner. Also: folder_id or tag_id is not in this workspace. (ErrorResponse)
- 422 Invalid limit, cursor, status, folder_id, tag_id or ids, or folder_id is a folder of people. (ErrorResponse)
- 429 Rate limit exceeded. Wait the number of seconds in Retry-After. (ErrorResponse)
- 500 Unexpected error. Retry later and quote request_id if it persists. (ErrorResponse)
200 response schema
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workspace_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"status": {
"type": "string",
"enum": [
"pending",
"processing",
"review",
"confirmed",
"failed"
]
},
"title": {
"type": "string"
},
"original_filename": {
"type": "string"
},
"record_type": {
"type": [
"string",
"null"
]
},
"file_type": {
"type": "string"
},
"transcription": {
"type": "object",
"properties": {
"original": {
"type": [
"string",
"null"
]
},
"translated": {
"type": [
"string",
"null"
]
}
},
"required": [
"original",
"translated"
]
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"folder_id": {
"description": "The folder the record is in (null: none). Returned by GET .../records.",
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
]
},
"tag_ids": {
"description": "Ids of the record's tags. Returned by GET .../records.",
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
}
},
"required": [
"id",
"workspace_id",
"status",
"title",
"original_filename",
"record_type",
"file_type",
"transcription",
"created_at",
"updated_at"
]
}
},
"next_cursor": {
"description": "Pass as ?cursor to get the next page. Null on the last page.",
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"next_cursor"
]
}