> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Rev AI API reference

> API reference for the Rev AI plugin in Corsair: every `revai.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Jobs

### getJob

`jobs.getJob`

Get an async job

**Risk:** `read`

```ts theme={null}
await corsair.revai.api.jobs.getJob({});
```

**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 \| 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`

```ts theme={null}
await corsair.revai.api.jobs.getTranscript({});
```

**Input**

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

**Output:** `object \| string`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   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`

```ts theme={null}
await corsair.revai.api.jobs.submitJob({});
```

**Input**

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

> [accordion] notification\_config full type
>
> ```ts theme={null}
> {
>   url: string,
>   auth_headers?: {
>     Authorization: string
>   }
> }
> ```

**Output**

| 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 | — |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.