New to Corsair? See API access, authentication, and error handling.
Jobs
getJob
jobs.getJob
Get an async job
Risk: read
await corsair.revai.api.jobs.getJob({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
status | in_progress | transcribed | failed | No | — |
created_on | string | null | No | — |
completed_on | string | null | No | — |
name | string | null | No | — |
type | async | human_tc | stream | No | — |
metadata | string | null | No | — |
media_url | string | null | No | — |
callback_url | string | null | No | — |
language | string | null | No | — |
transcriber | string | null | No | — |
failure | string | null | No | — |
failure_detail | string | null | No | — |
duration_seconds | number | null | No | — |
stream_duration_seconds | number | null | No | — |
delete_after_seconds | number | null | No | — |
skip_diarization | boolean | null | No | — |
skip_postprocessing | boolean | null | No | — |
skip_punctuation | boolean | null | No | — |
remove_disfluencies | boolean | null | No | — |
remove_atmospherics | boolean | null | No | — |
filter_profanity | boolean | null | No | — |
custom_vocabulary_id | string | null | No | — |
speaker_channels_count | number | null | No | — |
enable_multilingual | boolean | null | No | — |
getTranscript
jobs.getTranscript
Get transcript of a job
Risk: read
await corsair.revai.api.jobs.getTranscript({});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
accept | application/vnd.rev.transcript.v1.0+json | text/plain | No | — |
object \| string
Output full type
Output full type
{
monologues: {
speaker?: number,
elements: {
type: string,
value: string,
ts?: number | null,
end_ts?: number | null,
confidence?: number | null
}[]
}[]
} | string
submitJob
jobs.submitJob
Submit an async job
Risk: write
await corsair.revai.api.jobs.submitJob({});
| Name | Type | Required | Description |
|---|---|---|---|
media_url | string | Yes | — |
metadata | string | No | — |
language | string | No | — |
notification_config | object | No | — |
notification_config full type
notification_config full type
{
url: string,
auth_headers?: {
Authorization: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
status | in_progress | transcribed | failed | No | — |
created_on | string | null | No | — |
completed_on | string | null | No | — |
name | string | null | No | — |
type | async | human_tc | stream | No | — |
metadata | string | null | No | — |
media_url | string | null | No | — |
callback_url | string | null | No | — |
language | string | null | No | — |
transcriber | string | null | No | — |
failure | string | null | No | — |
failure_detail | string | null | No | — |
duration_seconds | number | null | No | — |
stream_duration_seconds | number | null | No | — |
delete_after_seconds | number | null | No | — |
skip_diarization | boolean | null | No | — |
skip_postprocessing | boolean | null | No | — |
skip_punctuation | boolean | null | No | — |
remove_disfluencies | boolean | null | No | — |
remove_atmospherics | boolean | null | No | — |
filter_profanity | boolean | null | No | — |
custom_vocabulary_id | string | null | No | — |
speaker_channels_count | number | null | No | — |
enable_multilingual | boolean | null | No | — |