API

Every revai.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

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({ id: "Umx5c6F7pH7r" });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`in_progress \| transcribed \| failed`	No	—
`created_on`	`string`	No	—
`completed_on`	`string`	No	—
`name`	`string`	No	—
`type`	`async \| human_tc \| stream`	No	—
`metadata`	`string`	No	—
`media_url`	`string`	No	—
`callback_url`	`string`	No	—
`language`	`string`	No	—
`transcriber`	`string`	No	—
`failure`	`string`	No	—
`failure_detail`	`string`	No	—
`duration_seconds`	`number`	No	—
`stream_duration_seconds`	`number`	No	—
`delete_after_seconds`	`number`	No	—
`skip_diarization`	`boolean`	No	—
`skip_postprocessing`	`boolean`	No	—
`skip_punctuation`	`boolean`	No	—
`remove_disfluencies`	`boolean`	No	—
`remove_atmospherics`	`boolean`	No	—
`filter_profanity`	`boolean`	No	—
`custom_vocabulary_id`	`string`	No	—
`speaker_channels_count`	`number`	No	—
`enable_multilingual`	`boolean`	No	—

getTranscript

jobs.getTranscript Get transcript of a job Risk: read

await corsair.revai.api.jobs.getTranscript({ id: "Umx5c6F7pH7r" });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`accept`	`application/vnd.rev.transcript.v1.0+json \| text/plain`	No	—

Output: object

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({ media_url: "https://www.rev.ai/FTC_Sample_1.mp3" });

Input

Name	Type	Required	Description
`media_url`	`string`	Yes	—
`metadata`	`string`	No	—
`language`	`string`	No	—
`notification_config`	`object`	No	—

notification_config full type

{
  url: string,
  auth_headers?: {
    Authorization: string
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`in_progress \| transcribed \| failed`	No	—
`created_on`	`string`	No	—
`completed_on`	`string`	No	—
`name`	`string`	No	—
`type`	`async \| human_tc \| stream`	No	—
`metadata`	`string`	No	—
`media_url`	`string`	No	—
`callback_url`	`string`	No	—
`language`	`string`	No	—
`transcriber`	`string`	No	—
`failure`	`string`	No	—
`failure_detail`	`string`	No	—
`duration_seconds`	`number`	No	—
`stream_duration_seconds`	`number`	No	—
`delete_after_seconds`	`number`	No	—
`skip_diarization`	`boolean`	No	—
`skip_postprocessing`	`boolean`	No	—
`skip_punctuation`	`boolean`	No	—
`remove_disfluencies`	`boolean`	No	—
`remove_atmospherics`	`boolean`	No	—
`filter_profanity`	`boolean`	No	—
`custom_vocabulary_id`	`string`	No	—
`speaker_channels_count`	`number`	No	—
`enable_multilingual`	`boolean`	No	—

Overview

Plugins

Jobs

getJob

getTranscript

submitJob

​Jobs

​getJob

​getTranscript

​submitJob

Jobs

getJob

getTranscript

submitJob