OpenAI API reference

New to Corsair? See API access, authentication, and error handling.

Assistants

create

assistants.create Create an assistant Risk: write

await corsair.openai.api.assistants.create({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`name`	`string \| null`	No	—
`description`	`string \| null`	No	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	No	—
`toolResources`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

toolResources full type

{
  code_interpreter?: {
    file_ids: string[]
  },
  file_search?: {
    vector_store_ids: string[]
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`assistant`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string \| null`	Yes	—
`description`	`string \| null`	Yes	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	Yes	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`top_p`	`number \| null`	No	—

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

delete

assistants.delete Delete an assistant Risk: destructive

await corsair.openai.api.assistants.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`assistant.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

assistants.list List assistants Risk: read

await corsair.openai.api.assistants.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: assistant,
  created_at: number,
  name: string | null,
  description: string | null,
  model: string,
  instructions: string | null,
  tools: (
    {
      type: code_interpreter
    } | {
      type: file_search,
      file_search?: {
        max_num_results?: number,
        ranking_options?: {
          ranker?: string,
          score_threshold?: number
        }
      }
    } | {
      type: function,
      function: {
        name: string,
        description?: string,
        parameters?: Record<string, any>,
        strict?: boolean | null
      }
    }
  )[],
  metadata?: Record<string, string> | null,
  temperature?: number | null,
  top_p?: number | null
}[]

modify

assistants.modify Modify an assistant Risk: write

await corsair.openai.api.assistants.modify({});

Input

Name	Type	Required	Description
`assistantId`	`string`	Yes	—
`model`	`string`	No	—
`name`	`string \| null`	No	—
`description`	`string \| null`	No	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	No	—
`toolResources`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

toolResources full type

{
  code_interpreter?: {
    file_ids: string[]
  },
  file_search?: {
    vector_store_ids: string[]
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`assistant`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string \| null`	Yes	—
`description`	`string \| null`	Yes	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	Yes	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`top_p`	`number \| null`	No	—

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

retrieve

assistants.retrieve Retrieve an assistant by id Risk: read

await corsair.openai.api.assistants.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`assistant`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string \| null`	Yes	—
`description`	`string \| null`	Yes	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	Yes	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`top_p`	`number \| null`	No	—

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

Audio

createSpeech

audio.createSpeech Generate spoken audio from text Risk: write

await corsair.openai.api.audio.createSpeech({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`string`	Yes	—
`voice`	`string`	Yes	—
`responseFormat`	`mp3 \| opus \| aac \| flac \| wav \| pcm`	No	—
`speed`	`number`	No	—
`instructions`	`string`	No	—

Output

Name	Type	Required	Description
`audioBase64`	`string`	Yes	—
`format`	`string`	Yes	—

createTranscription

audio.createTranscription Transcribe audio into text Risk: write

await corsair.openai.api.audio.createTranscription({});

Input

Name	Type	Required	Description
`file`	`custom \| string`	Yes	—
`fileName`	`string`	Yes	—
`model`	`string`	Yes	—
`language`	`string`	No	—
`prompt`	`string`	No	—
`responseFormat`	`json \| text \| srt \| verbose_json \| vtt`	No	—
`temperature`	`number`	No	—
`timestampGranularities`	`(word \| segment)[]`	No	—

Output

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

createTranslation

audio.createTranslation Translate audio into English text Risk: write

await corsair.openai.api.audio.createTranslation({});

Input

Name	Type	Required	Description
`file`	`custom \| string`	Yes	—
`fileName`	`string`	Yes	—
`model`	`string`	Yes	—
`prompt`	`string`	No	—
`responseFormat`	`json \| text \| srt \| verbose_json \| vtt`	No	—
`temperature`	`number`	No	—

Output

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

Batches

cancel

batches.cancel Cancel an in-progress batch job Risk: destructive

await corsair.openai.api.batches.cancel({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`batch`	Yes	—
`endpoint`	`string`	Yes	—
`input_file_id`	`string`	Yes	—
`completion_window`	`string`	Yes	—
`status`	`validating \| failed \| in_progress \| finalizing \| completed \| expired \| cancelling \| cancelled`	Yes	—
`output_file_id`	`string`	No	—
`error_file_id`	`string`	No	—
`created_at`	`number`	Yes	—
`in_progress_at`	`number`	No	—
`expires_at`	`number`	No	—
`finalizing_at`	`number`	No	—
`completed_at`	`number`	No	—
`failed_at`	`number`	No	—
`expired_at`	`number`	No	—
`cancelling_at`	`number`	No	—
`cancelled_at`	`number`	No	—
`request_counts`	`object`	No	—
`errors`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

request_counts full type

{
  total: number,
  completed: number,
  failed: number
}

errors full type

{
  data?: {
    code: string,
    message: string,
    param?: string | null,
    line?: number | null
  }[]
}

create

batches.create Create a batch job Risk: write

await corsair.openai.api.batches.create({});

Input

Name	Type	Required	Description
`inputFileId`	`string`	Yes	—
`endpoint`	`/v1/chat/completions \| /v1/completions \| /v1/embeddings \| /v1/responses`	Yes	—
`completionWindow`	`24h`	Yes	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`batch`	Yes	—
`endpoint`	`string`	Yes	—
`input_file_id`	`string`	Yes	—
`completion_window`	`string`	Yes	—
`status`	`validating \| failed \| in_progress \| finalizing \| completed \| expired \| cancelling \| cancelled`	Yes	—
`output_file_id`	`string`	No	—
`error_file_id`	`string`	No	—
`created_at`	`number`	Yes	—
`in_progress_at`	`number`	No	—
`expires_at`	`number`	No	—
`finalizing_at`	`number`	No	—
`completed_at`	`number`	No	—
`failed_at`	`number`	No	—
`expired_at`	`number`	No	—
`cancelling_at`	`number`	No	—
`cancelled_at`	`number`	No	—
`request_counts`	`object`	No	—
`errors`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

request_counts full type

{
  total: number,
  completed: number,
  failed: number
}

errors full type

{
  data?: {
    code: string,
    message: string,
    param?: string | null,
    line?: number | null
  }[]
}

list

batches.list List batch jobs Risk: read

await corsair.openai.api.batches.list({});

Input

Name	Type	Required	Description
`after`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: batch,
  endpoint: string,
  input_file_id: string,
  completion_window: string,
  status: validating | failed | in_progress | finalizing | completed | expired | cancelling | cancelled,
  output_file_id?: string,
  error_file_id?: string,
  created_at: number,
  in_progress_at?: number,
  expires_at?: number,
  finalizing_at?: number,
  completed_at?: number,
  failed_at?: number,
  expired_at?: number,
  cancelling_at?: number,
  cancelled_at?: number,
  request_counts?: {
    total: number,
    completed: number,
    failed: number
  },
  errors?: {
    data?: {
      code: string,
      message: string,
      param?: string | null,
      line?: number | null
    }[]
  },
  metadata?: Record<string, string> | null
}[]

retrieve

batches.retrieve Retrieve a batch job Risk: read

await corsair.openai.api.batches.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`batch`	Yes	—
`endpoint`	`string`	Yes	—
`input_file_id`	`string`	Yes	—
`completion_window`	`string`	Yes	—
`status`	`validating \| failed \| in_progress \| finalizing \| completed \| expired \| cancelling \| cancelled`	Yes	—
`output_file_id`	`string`	No	—
`error_file_id`	`string`	No	—
`created_at`	`number`	Yes	—
`in_progress_at`	`number`	No	—
`expires_at`	`number`	No	—
`finalizing_at`	`number`	No	—
`completed_at`	`number`	No	—
`failed_at`	`number`	No	—
`expired_at`	`number`	No	—
`cancelling_at`	`number`	No	—
`cancelled_at`	`number`	No	—
`request_counts`	`object`	No	—
`errors`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

request_counts full type

{
  total: number,
  completed: number,
  failed: number
}

errors full type

{
  data?: {
    code: string,
    message: string,
    param?: string | null,
    line?: number | null
  }[]
}

Chat

createCompletion

chat.createCompletion Create a chat completion for the given messages Risk: write

await corsair.openai.api.chat.createCompletion({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`messages`	`object[]`	Yes	—
`frequencyPenalty`	`number`	No	—
`logitBias`	`Record<string, number> \| null`	No	—
`logprobs`	`boolean \| null`	No	—
`topLogprobs`	`number \| null`	No	—
`maxCompletionTokens`	`number \| null`	No	—
`n`	`number \| null`	No	—
`presencePenalty`	`number`	No	—
`responseFormat`	`object`	No	—
`seed`	`number \| null`	No	—
`serviceTier`	`auto \| default \| flex \| priority`	No	—
`stop`	`string \| string[] \| null`	No	—
`store`	`boolean \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—
`tools`	`object[]`	No	—
`toolChoice`	`none \| auto \| required \| object`	No	—
`parallelToolCalls`	`boolean`	No	—
`reasoningEffort`	`minimal \| low \| medium \| high`	No	—
`user`	`string`	No	—

messages full type

{
  role: system | developer | user | assistant | tool,
  content?: string | (
    {
      type: text,
      text: string
    } | {
      type: image_url,
      image_url: {
        url: string,
        detail?: auto | low | high
      }
    } | {
      type: input_audio,
      input_audio: {
        data: string,
        format: wav | mp3
      }
    } | {
      type: file,
      file: {
        file_id?: string,
        filename?: string,
        file_data?: string
      }
    }
  )[] | null,
  name?: string,
  tool_calls?: {
    id: string,
    type: function,
    function: {
      name: string,
      arguments: string
    }
  }[],
  tool_call_id?: string,
  refusal?: string | null
}[]

responseFormat full type

{
  type: text
} | {
  type: json_object
} | {
  type: json_schema,
  json_schema: {
    name: string,
    description?: string,
    schema?: Record<string, any>,
    strict?: boolean | null
  }
}

tools full type

{
  type: function,
  function: {
    name: string,
    description?: string,
    parameters?: Record<string, any>,
    strict?: boolean | null
  }
}[]

toolChoice full type

none | auto | required | {
  type: function,
  function: {
    name: string
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`chat.completion`	Yes	—
`created`	`number`	Yes	—
`model`	`string`	Yes	—
`choices`	`object[]`	Yes	—
`system_fingerprint`	`string`	No	—
`service_tier`	`string`	No	—
`usage`	`object`	No	—

choices full type

{
  index: number,
  message: {
    role: assistant,
    content: string | null,
    refusal?: string | null,
    tool_calls?: {
      id: string,
      type: function,
      function: {
        name: string,
        arguments: string
      }
    }[]
  },
  logprobs?: Record<string, any> | null,
  finish_reason: stop | length | tool_calls | content_filter | function_call
}[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
}

Chat Completions

delete

chatCompletions.delete Delete a stored chat completion Risk: destructive

await corsair.openai.api.chatCompletions.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`chat.completion.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

chatCompletions.list List stored chat completions Risk: read

await corsair.openai.api.chatCompletions.list({});

Input

Name	Type	Required	Description
`model`	`string`	No	—
`metadata`	`Record<string, string>`	No	—
`after`	`string`	No	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`Record<string, any>[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

listMessages

chatCompletions.listMessages List messages of a stored chat completion Risk: read

await corsair.openai.api.chatCompletions.listMessages({});

Input

Name	Type	Required	Description
`completionId`	`string`	Yes	—
`after`	`string`	No	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`Record<string, any>[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

retrieve

chatCompletions.retrieve Retrieve a stored chat completion Risk: read

await corsair.openai.api.chatCompletions.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`chat.completion`	Yes	—
`created`	`number`	Yes	—
`model`	`string`	Yes	—

update

chatCompletions.update Update a stored chat completion’s metadata Risk: write

await corsair.openai.api.chatCompletions.update({});

Input

Name	Type	Required	Description
`completionId`	`string`	Yes	—
`metadata`	`Record<string, string> \| null`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`chat.completion`	Yes	—
`created`	`number`	Yes	—
`model`	`string`	Yes	—

Chatkit

getThread

chatkit.getThread Retrieve a ChatKit thread Risk: read

await corsair.openai.api.chatkit.getThread({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`chatkit.thread`	Yes	—
`created_at`	`number`	Yes	—
`status`	`Record<string, any>`	No	—

listThreadItems

chatkit.listThreadItems List items in a ChatKit thread Risk: read

await corsair.openai.api.chatkit.listThreadItems({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`Record<string, any>[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

listThreads

chatkit.listThreads List ChatKit threads Risk: read

await corsair.openai.api.chatkit.listThreads({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—
`user`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: chatkit.thread,
  created_at: number,
  status?: Record<string, any>
}[]

Completions

create

completions.create Create a legacy text completion Risk: write

await corsair.openai.api.completions.create({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`prompt`	`string \| string[]`	Yes	—
`maxTokens`	`number \| null`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—
`n`	`number \| null`	No	—
`stop`	`string \| string[] \| null`	No	—
`presencePenalty`	`number`	No	—
`frequencyPenalty`	`number`	No	—
`logprobs`	`number \| null`	No	—
`echo`	`boolean`	No	—
`bestOf`	`number`	No	—
`logitBias`	`Record<string, number> \| null`	No	—
`user`	`string`	No	—
`suffix`	`string \| null`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`text_completion`	Yes	—
`created`	`number`	Yes	—
`model`	`string`	Yes	—
`choices`	`object[]`	Yes	—
`usage`	`object`	No	—

choices full type

{
  text: string,
  index: number,
  logprobs: Record<string, any> | null,
  finish_reason: string
}[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
}

Container Files

create

containerFiles.create Add a file to a container Risk: write

await corsair.openai.api.containerFiles.create({});

Input

Name	Type	Required	Description
`containerId`	`string`	Yes	—
`file`	`custom \| string`	No	—
`fileName`	`string`	No	—
`fileId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`container.file`	Yes	—
`container_id`	`string`	Yes	—
`created_at`	`number`	Yes	—
`bytes`	`number`	No	—
`path`	`string`	No	—
`source`	`string`	No	—

delete

containerFiles.delete Delete a container file Risk: destructive

await corsair.openai.api.containerFiles.delete({});

Input

Name	Type	Required	Description
`containerId`	`string`	Yes	—
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`container.file.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

containerFiles.list List files in a container Risk: read

await corsair.openai.api.containerFiles.list({});

Input

Name	Type	Required	Description
`containerId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: container.file,
  container_id: string,
  created_at: number,
  bytes?: number,
  path?: string,
  source?: string
}[]

retrieve

containerFiles.retrieve Retrieve a container file Risk: read

await corsair.openai.api.containerFiles.retrieve({});

Input

Name	Type	Required	Description
`containerId`	`string`	Yes	—
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`container.file`	Yes	—
`container_id`	`string`	Yes	—
`created_at`	`number`	Yes	—
`bytes`	`number`	No	—
`path`	`string`	No	—
`source`	`string`	No	—

retrieveContent

containerFiles.retrieveContent Download the contents of a container file Risk: read

await corsair.openai.api.containerFiles.retrieveContent({});

Input

Name	Type	Required	Description
`containerId`	`string`	Yes	—
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`containerId`	`string`	Yes	—
`fileId`	`string`	Yes	—
`contentBase64`	`string`	Yes	—

Containers

create

containers.create Create a code interpreter container Risk: write

await corsair.openai.api.containers.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`fileIds`	`string[]`	No	—
`expiresAfter`	`object`	No	—

expiresAfter full type

{
  anchor: string,
  minutes: number
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`container`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`expires_after`	`object \| null`	No	—

expires_after full type

{
  anchor: string,
  minutes: number
} | null

delete

containers.delete Delete a container Risk: destructive

await corsair.openai.api.containers.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`container.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

containers.list List containers Risk: read

await corsair.openai.api.containers.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: container,
  created_at: number,
  name?: string,
  status?: string,
  expires_after?: {
    anchor: string,
    minutes: number
  } | null
}[]

retrieve

containers.retrieve Retrieve a container Risk: read

await corsair.openai.api.containers.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`container`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—
`expires_after`	`object \| null`	No	—

expires_after full type

{
  anchor: string,
  minutes: number
} | null

Conversations

create

conversations.create Create a conversation Risk: write

await corsair.openai.api.conversations.create({});

Input

Name	Type	Required	Description
`items`	`Record<string, any>[]`	No	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`conversation`	Yes	—
`created_at`	`number`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

createItems

conversations.createItems Add items to a conversation Risk: write

await corsair.openai.api.conversations.createItems({});

Input

Name	Type	Required	Description
`conversationId`	`string`	Yes	—
`items`	`Record<string, any>[]`	Yes	—
`include`	`string[]`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`Record<string, any>[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

delete

conversations.delete Delete a conversation Risk: destructive

await corsair.openai.api.conversations.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`conversation.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

deleteItem

conversations.deleteItem Delete a conversation item Risk: destructive

await corsair.openai.api.conversations.deleteItem({});

Input

Name	Type	Required	Description
`conversationId`	`string`	Yes	—
`itemId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`conversation`	Yes	—
`created_at`	`number`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

getItem

conversations.getItem Retrieve a conversation item Risk: read

await corsair.openai.api.conversations.getItem({});

Input

Name	Type	Required	Description
`conversationId`	`string`	Yes	—
`itemId`	`string`	Yes	—

Output

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

listItems

conversations.listItems List items in a conversation Risk: read

await corsair.openai.api.conversations.listItems({});

Input

Name	Type	Required	Description
`conversationId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`include`	`string[]`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`Record<string, any>[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

update

conversations.update Update a conversation’s metadata Risk: write

await corsair.openai.api.conversations.update({});

Input

Name	Type	Required	Description
`conversationId`	`string`	Yes	—
`metadata`	`Record<string, string>`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`conversation`	Yes	—
`created_at`	`number`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

Embeddings

create

embeddings.create Create embeddings for the given input Risk: write

await corsair.openai.api.embeddings.create({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`string \| string[] \| number[] \| number[][]`	Yes	—
`encodingFormat`	`float \| base64`	No	—
`dimensions`	`number`	No	—
`user`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`model`	`string`	Yes	—
`usage`	`object`	Yes	—

data full type

{
  object: embedding,
  embedding: number[] | string,
  index: number
}[]

usage full type

{
  prompt_tokens: number,
  total_tokens: number
}

Engines

list

engines.list List available engines (legacy, deprecated) Risk: read

await corsair.openai.api.engines.list({});

Input: empty object Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  object: engine,
  owner?: string,
  ready?: boolean
}[]

retrieve

engines.retrieve Retrieve an engine by id (legacy, deprecated) Risk: read

await corsair.openai.api.engines.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`engine`	Yes	—
`owner`	`string`	No	—
`ready`	`boolean`	No	—

Eval Runs

cancel

evalRuns.cancel Cancel an in-progress eval run Risk: destructive

await corsair.openai.api.evalRuns.cancel({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`runId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval.run`	Yes	—
`eval_id`	`string`	Yes	—
`name`	`string \| null`	No	—
`created_at`	`number`	Yes	—
`status`	`string`	Yes	—
`model`	`string`	No	—
`data_source`	`Record<string, any>`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`result_counts`	`Record<string, number>`	No	—

create

evalRuns.create Create an eval run Risk: write

await corsair.openai.api.evalRuns.create({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`name`	`string`	No	—
`dataSource`	`Record<string, any>`	Yes	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval.run`	Yes	—
`eval_id`	`string`	Yes	—
`name`	`string \| null`	No	—
`created_at`	`number`	Yes	—
`status`	`string`	Yes	—
`model`	`string`	No	—
`data_source`	`Record<string, any>`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`result_counts`	`Record<string, number>`	No	—

delete

evalRuns.delete Delete an eval run Risk: destructive

await corsair.openai.api.evalRuns.delete({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`runId`	`string`	Yes	—

Output

Name	Type	Required	Description
`object`	`eval.run.deleted`	Yes	—
`deleted`	`boolean`	Yes	—
`run_id`	`string`	Yes	—

get

evalRuns.get Retrieve an eval run Risk: read

await corsair.openai.api.evalRuns.get({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`runId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval.run`	Yes	—
`eval_id`	`string`	Yes	—
`name`	`string \| null`	No	—
`created_at`	`number`	Yes	—
`status`	`string`	Yes	—
`model`	`string`	No	—
`data_source`	`Record<string, any>`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`result_counts`	`Record<string, number>`	No	—

getOutputItem

evalRuns.getOutputItem Retrieve an eval run output item Risk: read

await corsair.openai.api.evalRuns.getOutputItem({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`runId`	`string`	Yes	—
`outputItemId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval.run.output_item`	Yes	—

list

evalRuns.list List eval runs Risk: read

await corsair.openai.api.evalRuns.list({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`after`	`string`	No	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`status`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: eval.run,
  eval_id: string,
  name?: string | null,
  created_at: number,
  status: string,
  model?: string,
  data_source?: Record<string, any>,
  metadata?: Record<string, string> | null,
  result_counts?: Record<string, number>
}[]

listOutputItems

evalRuns.listOutputItems List output items for an eval run Risk: read

await corsair.openai.api.evalRuns.listOutputItems({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`runId`	`string`	Yes	—
`after`	`string`	No	—
`limit`	`number`	No	—
`status`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string
}[]

Evals

create

evals.create Create an eval Risk: write

await corsair.openai.api.evals.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`dataSourceConfig`	`Record<string, any>`	Yes	—
`testingCriteria`	`Record<string, any>[]`	Yes	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval`	Yes	—
`name`	`string \| null`	No	—
`created_at`	`number`	Yes	—
`data_source_config`	`Record<string, any>`	Yes	—
`testing_criteria`	`Record<string, any>[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

delete

evals.delete Delete an eval Risk: destructive

await corsair.openai.api.evals.delete({});

Input

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

Output

Name	Type	Required	Description
`object`	`eval.deleted`	Yes	—
`deleted`	`boolean`	Yes	—
`eval_id`	`string`	Yes	—

get

evals.get Retrieve an eval Risk: read

await corsair.openai.api.evals.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval`	Yes	—
`name`	`string \| null`	No	—
`created_at`	`number`	Yes	—
`data_source_config`	`Record<string, any>`	Yes	—
`testing_criteria`	`Record<string, any>[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

list

evals.list List evals Risk: read

await corsair.openai.api.evals.list({});

Input

Name	Type	Required	Description
`after`	`string`	No	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`orderBy`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: eval,
  name?: string | null,
  created_at: number,
  data_source_config: Record<string, any>,
  testing_criteria: Record<string, any>[],
  metadata?: Record<string, string> | null
}[]

update

evals.update Update an eval Risk: write

await corsair.openai.api.evals.update({});

Input

Name	Type	Required	Description
`evalId`	`string`	Yes	—
`name`	`string`	No	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`eval`	Yes	—
`name`	`string \| null`	No	—
`created_at`	`number`	Yes	—
`data_source_config`	`Record<string, any>`	Yes	—
`testing_criteria`	`Record<string, any>[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

Files

delete

files.delete Delete a file Risk: destructive

await corsair.openai.api.files.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`file`	Yes	—
`deleted`	`boolean`	Yes	—

downloadContent

files.downloadContent Download the contents of a file Risk: read

await corsair.openai.api.files.downloadContent({});

Input

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

Output

Name	Type	Required	Description
`fileId`	`string`	Yes	—
`contentBase64`	`string`	Yes	—

list

files.list List uploaded files Risk: read

await corsair.openai.api.files.list({});

Input

Name	Type	Required	Description
`purpose`	`assistants \| assistants_output \| batch \| batch_output \| fine-tune \| fine-tune-results \| vision \| user_data \| evals`	No	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	No	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—

data full type

{
  id: string,
  object: file,
  bytes: number,
  created_at: number,
  expires_at?: number,
  filename: string,
  purpose: assistants | assistants_output | batch | batch_output | fine-tune | fine-tune-results | vision | user_data | evals
}[]

retrieve

files.retrieve Retrieve file metadata Risk: read

await corsair.openai.api.files.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`file`	Yes	—
`bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`expires_at`	`number`	No	—
`filename`	`string`	Yes	—
`purpose`	`assistants \| assistants_output \| batch \| batch_output \| fine-tune \| fine-tune-results \| vision \| user_data \| evals`	Yes	—

upload

files.upload Upload a file to OpenAI Risk: write

await corsair.openai.api.files.upload({});

Input

Name	Type	Required	Description
`file`	`custom \| string`	Yes	—
`fileName`	`string`	Yes	—
`purpose`	`assistants \| assistants_output \| batch \| batch_output \| fine-tune \| fine-tune-results \| vision \| user_data \| evals`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`file`	Yes	—
`bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`expires_at`	`number`	No	—
`filename`	`string`	Yes	—
`purpose`	`assistants \| assistants_output \| batch \| batch_output \| fine-tune \| fine-tune-results \| vision \| user_data \| evals`	Yes	—

Fine Tuning

cancelJob

fineTuning.cancelJob Cancel an in-progress fine-tuning job Risk: destructive

await corsair.openai.api.fineTuning.cancelJob({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`fine_tuning.job`	Yes	—
`created_at`	`number`	Yes	—
`model`	`string`	Yes	—
`fine_tuned_model`	`string \| null`	No	—
`status`	`validating_files \| queued \| running \| succeeded \| failed \| cancelled`	Yes	—
`training_file`	`string`	Yes	—
`validation_file`	`string \| null`	No	—
`hyperparameters`	`Record<string, any>`	No	—
`result_files`	`string[]`	No	—
`trained_tokens`	`number \| null`	No	—
`error`	`object \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

error full type

{
  code: string,
  message: string
} | null

createJob

fineTuning.createJob Create a fine-tuning job Risk: write

await corsair.openai.api.fineTuning.createJob({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`trainingFile`	`string`	Yes	—
`validationFile`	`string`	No	—
`hyperparameters`	`Record<string, any>`	No	—
`suffix`	`string`	No	—
`integrations`	`Record<string, any>[]`	No	—
`seed`	`number`	No	—
`method`	`Record<string, any>`	No	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`fine_tuning.job`	Yes	—
`created_at`	`number`	Yes	—
`model`	`string`	Yes	—
`fine_tuned_model`	`string \| null`	No	—
`status`	`validating_files \| queued \| running \| succeeded \| failed \| cancelled`	Yes	—
`training_file`	`string`	Yes	—
`validation_file`	`string \| null`	No	—
`hyperparameters`	`Record<string, any>`	No	—
`result_files`	`string[]`	No	—
`trained_tokens`	`number \| null`	No	—
`error`	`object \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

error full type

{
  code: string,
  message: string
} | null

listCheckpoints

fineTuning.listCheckpoints List checkpoints for a fine-tuning job Risk: read

await corsair.openai.api.fineTuning.listCheckpoints({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—
`after`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: fine_tuning.job.checkpoint,
  created_at: number,
  fine_tuned_model_checkpoint: string,
  step_number: number,
  metrics?: Record<string, number>
}[]

listEvents

fineTuning.listEvents List events for a fine-tuning job Risk: read

await corsair.openai.api.fineTuning.listEvents({});

Input

Name	Type	Required	Description
`jobId`	`string`	Yes	—
`after`	`string`	No	—
`limit`	`number`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: fine_tuning.job.event,
  created_at: number,
  level: string,
  message: string,
  data?: Record<string, any>
}[]

listJobs

fineTuning.listJobs List fine-tuning jobs Risk: read

await corsair.openai.api.fineTuning.listJobs({});

Input

Name	Type	Required	Description
`after`	`string`	No	—
`limit`	`number`	No	—
`metadata`	`Record<string, string>`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: fine_tuning.job,
  created_at: number,
  model: string,
  fine_tuned_model?: string | null,
  status: validating_files | queued | running | succeeded | failed | cancelled,
  training_file: string,
  validation_file?: string | null,
  hyperparameters?: Record<string, any>,
  result_files?: string[],
  trained_tokens?: number | null,
  error?: {
    code: string,
    message: string
  } | null,
  metadata?: Record<string, string> | null
}[]

retrieveJob

fineTuning.retrieveJob Retrieve a fine-tuning job Risk: read

await corsair.openai.api.fineTuning.retrieveJob({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`fine_tuning.job`	Yes	—
`created_at`	`number`	Yes	—
`model`	`string`	Yes	—
`fine_tuned_model`	`string \| null`	No	—
`status`	`validating_files \| queued \| running \| succeeded \| failed \| cancelled`	Yes	—
`training_file`	`string`	Yes	—
`validation_file`	`string \| null`	No	—
`hyperparameters`	`Record<string, any>`	No	—
`result_files`	`string[]`	No	—
`trained_tokens`	`number \| null`	No	—
`error`	`object \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

error full type

{
  code: string,
  message: string
} | null

Graders

run

graders.run Run a grader against a model sample Risk: read

await corsair.openai.api.graders.run({});

Input

Name	Type	Required	Description
`grader`	`Record<string, any>`	Yes	—
`item`	`Record<string, any>`	No	—
`modelSample`	`string`	Yes	—

Output

Name	Type	Required	Description
`reward`	`number`	No	—

validate

graders.validate Validate a grader configuration Risk: read

await corsair.openai.api.graders.validate({});

Input

Name	Type	Required	Description
`grader`	`Record<string, any>`	Yes	—

Output

Name	Type	Required	Description
`grader`	`Record<string, any>`	No	—

Images

create

images.create Generate images from a prompt Risk: write

await corsair.openai.api.images.create({});

Input

Name	Type	Required	Description
`model`	`string`	No	—
`prompt`	`string`	Yes	—
`n`	`number`	No	—
`size`	`string`	No	—
`quality`	`string`	No	—
`style`	`string`	No	—
`responseFormat`	`url \| b64_json`	No	—
`background`	`string`	No	—
`user`	`string`	No	—

Output

Name	Type	Required	Description
`created`	`number`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  url?: string,
  b64_json?: string,
  revised_prompt?: string
}[]

createEdit

images.createEdit Edit an image given a prompt and mask Risk: write

await corsair.openai.api.images.createEdit({});

Input

Name	Type	Required	Description
`image`	`custom \| string`	Yes	—
`imageFileName`	`string`	Yes	—
`mask`	`custom \| string`	No	—
`maskFileName`	`string`	No	—
`prompt`	`string`	Yes	—
`model`	`string`	No	—
`n`	`number`	No	—
`size`	`string`	No	—
`responseFormat`	`url \| b64_json`	No	—

Output

Name	Type	Required	Description
`created`	`number`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  url?: string,
  b64_json?: string,
  revised_prompt?: string
}[]

createVariation

images.createVariation Create variations of an image Risk: write

await corsair.openai.api.images.createVariation({});

Input

Name	Type	Required	Description
`image`	`custom \| string`	Yes	—
`imageFileName`	`string`	Yes	—
`model`	`string`	No	—
`n`	`number`	No	—
`size`	`string`	No	—
`responseFormat`	`url \| b64_json`	No	—

Output

Name	Type	Required	Description
`created`	`number`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  url?: string,
  b64_json?: string,
  revised_prompt?: string
}[]

Messages

create

messages.create Create a message on a thread Risk: write

await corsair.openai.api.messages.create({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`role`	`user \| assistant`	Yes	—
`content`	`string \| object[]`	Yes	—
`attachments`	`object[] \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

content full type

string | (
  {
    type: text,
    text: {
      value: string,
      annotations: Record<string, any>[]
    }
  } | {
    type: image_file,
    image_file: {
      file_id: string,
      detail?: auto | low | high
    }
  } | {
    type: image_url,
    image_url: {
      url: string,
      detail?: auto | low | high
    }
  }
)[]

attachments full type

{
  file_id?: string,
  tools?: (
    {
      type: code_interpreter
    } | {
      type: file_search
    }
  )[]
}[] | null

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.message`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`status`	`in_progress \| incomplete \| completed`	No	—
`role`	`user \| assistant`	Yes	—
`content`	`object[]`	Yes	—
`assistant_id`	`string \| null`	No	—
`run_id`	`string \| null`	No	—
`attachments`	`object[] \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

content full type

(
  {
    type: text,
    text: {
      value: string,
      annotations: Record<string, any>[]
    }
  } | {
    type: image_file,
    image_file: {
      file_id: string,
      detail?: auto | low | high
    }
  } | {
    type: image_url,
    image_url: {
      url: string,
      detail?: auto | low | high
    }
  }
)[]

attachments full type

{
  file_id?: string,
  tools?: (
    {
      type: code_interpreter
    } | {
      type: file_search
    }
  )[]
}[] | null

delete

messages.delete Delete a message Risk: destructive

await corsair.openai.api.messages.delete({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`messageId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.message.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

messages.list List messages on a thread Risk: read

await corsair.openai.api.messages.list({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—
`runId`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: thread.message,
  created_at: number,
  thread_id: string,
  status?: in_progress | incomplete | completed,
  role: user | assistant,
  content: (
    {
      type: text,
      text: {
        value: string,
        annotations: Record<string, any>[]
      }
    } | {
      type: image_file,
      image_file: {
        file_id: string,
        detail?: auto | low | high
      }
    } | {
      type: image_url,
      image_url: {
        url: string,
        detail?: auto | low | high
      }
    }
  )[],
  assistant_id?: string | null,
  run_id?: string | null,
  attachments?: {
    file_id?: string,
    tools?: (
      {
        type: code_interpreter
      } | {
        type: file_search
      }
    )[]
  }[] | null,
  metadata?: Record<string, string> | null
}[]

modify

messages.modify Modify a message Risk: write

await corsair.openai.api.messages.modify({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`messageId`	`string`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.message`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`status`	`in_progress \| incomplete \| completed`	No	—
`role`	`user \| assistant`	Yes	—
`content`	`object[]`	Yes	—
`assistant_id`	`string \| null`	No	—
`run_id`	`string \| null`	No	—
`attachments`	`object[] \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

content full type

(
  {
    type: text,
    text: {
      value: string,
      annotations: Record<string, any>[]
    }
  } | {
    type: image_file,
    image_file: {
      file_id: string,
      detail?: auto | low | high
    }
  } | {
    type: image_url,
    image_url: {
      url: string,
      detail?: auto | low | high
    }
  }
)[]

attachments full type

{
  file_id?: string,
  tools?: (
    {
      type: code_interpreter
    } | {
      type: file_search
    }
  )[]
}[] | null

retrieve

messages.retrieve Retrieve a message Risk: read

await corsair.openai.api.messages.retrieve({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`messageId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.message`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`status`	`in_progress \| incomplete \| completed`	No	—
`role`	`user \| assistant`	Yes	—
`content`	`object[]`	Yes	—
`assistant_id`	`string \| null`	No	—
`run_id`	`string \| null`	No	—
`attachments`	`object[] \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

content full type

(
  {
    type: text,
    text: {
      value: string,
      annotations: Record<string, any>[]
    }
  } | {
    type: image_file,
    image_file: {
      file_id: string,
      detail?: auto | low | high
    }
  } | {
    type: image_url,
    image_url: {
      url: string,
      detail?: auto | low | high
    }
  }
)[]

attachments full type

{
  file_id?: string,
  tools?: (
    {
      type: code_interpreter
    } | {
      type: file_search
    }
  )[]
}[] | null

Models

list

models.list List available models Risk: read

await corsair.openai.api.models.list({});

Input: empty object Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  object: model,
  created: number,
  owned_by: string
}[]

retrieve

models.retrieve Retrieve a model by id Risk: read

await corsair.openai.api.models.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`model`	Yes	—
`created`	`number`	Yes	—
`owned_by`	`string`	Yes	—

Moderation

create

moderation.create Classify text/image input against usage policies Risk: read

await corsair.openai.api.moderation.create({});

Input

Name	Type	Required	Description
`input`	`string \| string[] \| Record<string, any>[]`	Yes	—
`model`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`model`	`string`	Yes	—
`results`	`object[]`	Yes	—

results full type

{
  flagged: boolean,
  categories: Record<string, boolean>,
  category_scores: Record<string, number>,
  category_applied_input_types?: Record<string, string[]>
}[]

Realtime

createCall

realtime.createCall Create a realtime call Risk: write

await corsair.openai.api.realtime.createCall({});

Input

Name	Type	Required	Description
`sdp`	`string`	No	—
`session`	`Record<string, any>`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`sdp`	`string`	No	—

createClientSecret

realtime.createClientSecret Create an ephemeral client secret for the Realtime API Risk: write

await corsair.openai.api.realtime.createClientSecret({});

Input

Name	Type	Required	Description
`session`	`Record<string, any>`	No	—
`expiresAfter`	`object`	No	—

expiresAfter full type

{
  anchor: string,
  seconds: number
}

Output

Name	Type	Required	Description
`value`	`string`	Yes	—
`expires_at`	`number`	Yes	—

createSession

realtime.createSession Create a realtime session Risk: write

await corsair.openai.api.realtime.createSession({});

Input

Name	Type	Required	Description
`model`	`string`	No	—
`voice`	`string`	No	—
`modalities`	`string[]`	No	—
`instructions`	`string`	No	—

Output

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

createTranscriptionSession

realtime.createTranscriptionSession Create a realtime transcription session Risk: write

await corsair.openai.api.realtime.createTranscriptionSession({});

Input

Name	Type	Required	Description
`inputAudioFormat`	`string`	No	—
`inputAudioTranscription`	`Record<string, any>`	No	—

Output

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

Responses

cancel

responses.cancel Cancel an in-progress background response Risk: destructive

await corsair.openai.api.responses.cancel({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`response`	Yes	—
`created_at`	`number`	Yes	—
`status`	`completed \| failed \| in_progress \| cancelled \| queued \| incomplete`	Yes	—
`model`	`string`	Yes	—
`output`	`Record<string, any>[]`	Yes	—
`previous_response_id`	`string \| null`	No	—
`usage`	`object`	No	—

usage full type

{
  input_tokens: number,
  output_tokens: number,
  total_tokens: number
}

compact

responses.compact Compact response input to reduce token usage Risk: write

await corsair.openai.api.responses.compact({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`Record<string, any>[]`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`response.compaction`	Yes	—
`created_at`	`number`	Yes	—
`output`	`Record<string, any>[]`	Yes	—
`usage`	`object`	No	—

usage full type

{
  input_tokens: number,
  output_tokens: number,
  total_tokens: number
}

create

responses.create Create a model response via the Responses API Risk: write

await corsair.openai.api.responses.create({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`string \| Record<string, any>[]`	Yes	—
`instructions`	`string`	No	—
`tools`	`Record<string, any>[]`	No	—
`toolChoice`	`none \| auto \| required \| Record<string, any>`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—
`maxOutputTokens`	`number \| null`	No	—
`previousResponseId`	`string`	No	—
`store`	`boolean`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`truncation`	`auto \| disabled`	No	—
`parallelToolCalls`	`boolean`	No	—
`background`	`boolean`	No	—
`reasoning`	`object`	No	—

reasoning full type

{
  effort?: minimal | low | medium | high
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`response`	Yes	—
`created_at`	`number`	Yes	—
`status`	`completed \| failed \| in_progress \| cancelled \| queued \| incomplete`	Yes	—
`model`	`string`	Yes	—
`output`	`Record<string, any>[]`	Yes	—
`previous_response_id`	`string \| null`	No	—
`usage`	`object`	No	—

usage full type

{
  input_tokens: number,
  output_tokens: number,
  total_tokens: number
}

delete

responses.delete Delete a stored model response Risk: destructive

await corsair.openai.api.responses.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`response.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

listInputItems

responses.listInputItems List input items for a response Risk: read

await corsair.openai.api.responses.listInputItems({});

Input

Name	Type	Required	Description
`responseId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`Record<string, any>[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

retrieve

responses.retrieve Retrieve a model response Risk: read

await corsair.openai.api.responses.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`response`	Yes	—
`created_at`	`number`	Yes	—
`status`	`completed \| failed \| in_progress \| cancelled \| queued \| incomplete`	Yes	—
`model`	`string`	Yes	—
`output`	`Record<string, any>[]`	Yes	—
`previous_response_id`	`string \| null`	No	—
`usage`	`object`	No	—

usage full type

{
  input_tokens: number,
  output_tokens: number,
  total_tokens: number
}

Runs

cancel

runs.cancel Cancel an in-progress run Risk: destructive

await corsair.openai.api.runs.cancel({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`runId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`status`	`queued \| in_progress \| requires_action \| cancelling \| cancelled \| failed \| completed \| incomplete \| expired`	Yes	—
`required_action`	`Record<string, any> \| null`	No	—
`last_error`	`object \| null`	No	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

create

runs.create Create a run on a thread Risk: write

await corsair.openai.api.runs.create({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`assistantId`	`string`	Yes	—
`model`	`string`	No	—
`instructions`	`string \| null`	No	—
`additionalInstructions`	`string \| null`	No	—
`tools`	`object[] \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—
`maxPromptTokens`	`number \| null`	No	—
`maxCompletionTokens`	`number \| null`	No	—
`truncationStrategy`	`object`	No	—
`toolChoice`	`none \| auto \| required \| object`	No	—
`parallelToolCalls`	`boolean`	No	—

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[] | null

truncationStrategy full type

{
  type: auto | last_messages,
  last_messages?: number | null
}

toolChoice full type

none | auto | required | {
  type: function | code_interpreter | file_search,
  function?: {
    name: string
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`status`	`queued \| in_progress \| requires_action \| cancelling \| cancelled \| failed \| completed \| incomplete \| expired`	Yes	—
`required_action`	`Record<string, any> \| null`	No	—
`last_error`	`object \| null`	No	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

list

runs.list List runs on a thread Risk: read

await corsair.openai.api.runs.list({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: thread.run,
  created_at: number,
  thread_id: string,
  assistant_id: string,
  status: queued | in_progress | requires_action | cancelling | cancelled | failed | completed | incomplete | expired,
  required_action?: Record<string, any> | null,
  last_error?: {
    code: string,
    message: string
  } | null,
  model: string,
  instructions?: string | null,
  tools: (
    {
      type: code_interpreter
    } | {
      type: file_search,
      file_search?: {
        max_num_results?: number,
        ranking_options?: {
          ranker?: string,
          score_threshold?: number
        }
      }
    } | {
      type: function,
      function: {
        name: string,
        description?: string,
        parameters?: Record<string, any>,
        strict?: boolean | null
      }
    }
  )[],
  metadata?: Record<string, string> | null,
  usage?: {
    prompt_tokens: number,
    completion_tokens: number,
    total_tokens: number
  } | null
}[]

modify

runs.modify Modify a run Risk: write

await corsair.openai.api.runs.modify({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`runId`	`string`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`status`	`queued \| in_progress \| requires_action \| cancelling \| cancelled \| failed \| completed \| incomplete \| expired`	Yes	—
`required_action`	`Record<string, any> \| null`	No	—
`last_error`	`object \| null`	No	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

retrieve

runs.retrieve Retrieve a run Risk: read

await corsair.openai.api.runs.retrieve({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`runId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`status`	`queued \| in_progress \| requires_action \| cancelling \| cancelled \| failed \| completed \| incomplete \| expired`	Yes	—
`required_action`	`Record<string, any> \| null`	No	—
`last_error`	`object \| null`	No	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

submitToolOutputs

runs.submitToolOutputs Submit tool outputs to a run awaiting action Risk: write

await corsair.openai.api.runs.submitToolOutputs({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`runId`	`string`	Yes	—
`toolOutputs`	`object[]`	Yes	—

toolOutputs full type

{
  toolCallId?: string,
  output?: string
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`status`	`queued \| in_progress \| requires_action \| cancelling \| cancelled \| failed \| completed \| incomplete \| expired`	Yes	—
`required_action`	`Record<string, any> \| null`	No	—
`last_error`	`object \| null`	No	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

Run Steps

list

runSteps.list List steps of a run Risk: read

await corsair.openai.api.runSteps.list({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`runId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: thread.run.step,
  created_at: number,
  run_id: string,
  assistant_id: string,
  thread_id: string,
  type: message_creation | tool_calls,
  status: in_progress | cancelled | failed | completed | expired,
  step_details: Record<string, any>,
  last_error?: {
    code: string,
    message: string
  } | null,
  usage?: {
    prompt_tokens: number,
    completion_tokens: number,
    total_tokens: number
  } | null
}[]

retrieve

runSteps.retrieve Retrieve a run step Risk: read

await corsair.openai.api.runSteps.retrieve({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`runId`	`string`	Yes	—
`stepId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run.step`	Yes	—
`created_at`	`number`	Yes	—
`run_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`thread_id`	`string`	Yes	—
`type`	`message_creation \| tool_calls`	Yes	—
`status`	`in_progress \| cancelled \| failed \| completed \| expired`	Yes	—
`step_details`	`Record<string, any>`	Yes	—
`last_error`	`object \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

Skills

create

skills.create Upload a skill Risk: write

await corsair.openai.api.skills.create({});

Input

Name	Type	Required	Description
`file`	`custom \| string`	Yes	—
`fileName`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`skill`	No	—
`created_at`	`number`	No	—
`default_version`	`number`	No	—
`latest_version`	`number`	No	—
`description`	`string`	No	—
`name`	`string`	No	—

delete

skills.delete Delete a skill Risk: destructive

await corsair.openai.api.skills.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`skill.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

skills.list List skills Risk: read

await corsair.openai.api.skills.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`after`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string
}[]

Threads

create

threads.create Create a thread Risk: write

await corsair.openai.api.threads.create({});

Input

Name	Type	Required	Description
`messages`	`object[]`	No	—
`toolResources`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

messages full type

{
  role: user | assistant,
  content: string,
  metadata?: Record<string, string> | null
}[]

toolResources full type

{
  code_interpreter?: {
    file_ids: string[]
  },
  file_search?: {
    vector_store_ids: string[]
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread`	Yes	—
`created_at`	`number`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

createAndRun

threads.createAndRun Create a thread and run it in one call Risk: write

await corsair.openai.api.threads.createAndRun({});

Input

Name	Type	Required	Description
`assistantId`	`string`	Yes	—
`thread`	`object`	No	—
`model`	`string`	No	—
`instructions`	`string \| null`	No	—
`tools`	`object[] \| null`	No	—
`toolResources`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—
`temperature`	`number \| null`	No	—
`topP`	`number \| null`	No	—
`truncationStrategy`	`object`	No	—
`toolChoice`	`none \| auto \| required \| object`	No	—
`parallelToolCalls`	`boolean`	No	—

thread full type

{
  messages?: {
    role: user | assistant,
    content: string,
    metadata?: Record<string, string> | null
  }[],
  toolResources?: {
    code_interpreter?: {
      file_ids: string[]
    },
    file_search?: {
      vector_store_ids: string[]
    }
  },
  metadata?: Record<string, string> | null
}

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[] | null

toolResources full type

{
  code_interpreter?: {
    file_ids: string[]
  },
  file_search?: {
    vector_store_ids: string[]
  }
}

truncationStrategy full type

{
  type: auto | last_messages,
  last_messages?: number | null
}

toolChoice full type

none | auto | required | {
  type: function | code_interpreter | file_search,
  function?: {
    name: string
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.run`	Yes	—
`created_at`	`number`	Yes	—
`thread_id`	`string`	Yes	—
`assistant_id`	`string`	Yes	—
`status`	`queued \| in_progress \| requires_action \| cancelling \| cancelled \| failed \| completed \| incomplete \| expired`	Yes	—
`required_action`	`Record<string, any> \| null`	No	—
`last_error`	`object \| null`	No	—
`model`	`string`	Yes	—
`instructions`	`string \| null`	No	—
`tools`	`object[]`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—
`usage`	`object \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

tools full type

(
  {
    type: code_interpreter
  } | {
    type: file_search,
    file_search?: {
      max_num_results?: number,
      ranking_options?: {
        ranker?: string,
        score_threshold?: number
      }
    }
  } | {
    type: function,
    function: {
      name: string,
      description?: string,
      parameters?: Record<string, any>,
      strict?: boolean | null
    }
  }
)[]

usage full type

{
  prompt_tokens: number,
  completion_tokens: number,
  total_tokens: number
} | null

delete

threads.delete Delete a thread Risk: destructive

await corsair.openai.api.threads.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

modify

threads.modify Modify a thread Risk: write

await corsair.openai.api.threads.modify({});

Input

Name	Type	Required	Description
`threadId`	`string`	Yes	—
`toolResources`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

toolResources full type

{
  code_interpreter?: {
    file_ids: string[]
  },
  file_search?: {
    vector_store_ids: string[]
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread`	Yes	—
`created_at`	`number`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

retrieve

threads.retrieve Retrieve a thread by id Risk: read

await corsair.openai.api.threads.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`thread`	Yes	—
`created_at`	`number`	Yes	—
`metadata`	`Record<string, string> \| null`	No	—

Tokens

countInput

tokens.countInput Count input tokens for a prospective request Risk: read

await corsair.openai.api.tokens.countInput({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`string \| Record<string, any>[]`	Yes	—
`tools`	`Record<string, any>[]`	No	—

Output

Name	Type	Required	Description
`input_tokens`	`number`	Yes	—

Uploads

addPart

uploads.addPart Add a part of file data to an upload Risk: write

await corsair.openai.api.uploads.addPart({});

Input

Name	Type	Required	Description
`uploadId`	`string`	Yes	—
`data`	`custom \| string`	Yes	—
`fileName`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`upload.part`	Yes	—
`created_at`	`number`	Yes	—
`upload_id`	`string`	Yes	—

cancel

uploads.cancel Cancel an in-progress upload session Risk: destructive

await corsair.openai.api.uploads.cancel({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`upload`	Yes	—
`bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`filename`	`string`	Yes	—
`purpose`	`string`	Yes	—
`status`	`pending \| completed \| cancelled \| expired`	Yes	—
`expires_at`	`number`	Yes	—
`file`	`object \| null`	No	—

file full type

{
  id: string,
  object: file,
  bytes: number,
  created_at: number,
  filename: string,
  purpose: string
} | null

complete

uploads.complete Complete a multipart upload session Risk: write

await corsair.openai.api.uploads.complete({});

Input

Name	Type	Required	Description
`uploadId`	`string`	Yes	—
`partIds`	`string[]`	Yes	—
`md5`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`upload`	Yes	—
`bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`filename`	`string`	Yes	—
`purpose`	`string`	Yes	—
`status`	`pending \| completed \| cancelled \| expired`	Yes	—
`expires_at`	`number`	Yes	—
`file`	`object \| null`	No	—

file full type

{
  id: string,
  object: file,
  bytes: number,
  created_at: number,
  filename: string,
  purpose: string
} | null

create

uploads.create Create a multipart upload session Risk: write

await corsair.openai.api.uploads.create({});

Input

Name	Type	Required	Description
`filename`	`string`	Yes	—
`purpose`	`assistants \| assistants_output \| batch \| batch_output \| fine-tune \| fine-tune-results \| vision \| user_data \| evals`	Yes	—
`bytes`	`number`	Yes	—
`mimeType`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`upload`	Yes	—
`bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`filename`	`string`	Yes	—
`purpose`	`string`	Yes	—
`status`	`pending \| completed \| cancelled \| expired`	Yes	—
`expires_at`	`number`	Yes	—
`file`	`object \| null`	No	—

file full type

{
  id: string,
  object: file,
  bytes: number,
  created_at: number,
  filename: string,
  purpose: string
} | null

Vector Store File Batches

create

vectorStoreFileBatches.create Attach a batch of files to a vector store Risk: write

await corsair.openai.api.vectorStoreFileBatches.create({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`fileIds`	`string[]`	Yes	—
`chunkingStrategy`	`object`	No	—
`attributes`	`Record<string, any> \| null`	No	—

chunkingStrategy full type

{
  type: auto
} | {
  type: static,
  static: {
    max_chunk_size_tokens: number,
    chunk_overlap_tokens: number
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.file_batch`	Yes	—
`created_at`	`number`	Yes	—
`vector_store_id`	`string`	Yes	—
`status`	`in_progress \| completed \| cancelled \| failed`	Yes	—
`file_counts`	`object`	Yes	—

file_counts full type

{
  in_progress: number,
  completed: number,
  failed: number,
  cancelled: number,
  total: number
}

listFiles

vectorStoreFileBatches.listFiles List files in a vector store file batch Risk: read

await corsair.openai.api.vectorStoreFileBatches.listFiles({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`batchId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—
`filter`	`in_progress \| completed \| cancelled \| failed`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: vector_store.file,
  usage_bytes: number,
  created_at: number,
  vector_store_id: string,
  status: in_progress | completed | cancelled | failed,
  last_error?: {
    code: string,
    message: string
  } | null,
  attributes?: Record<string, any> | null
}[]

retrieve

vectorStoreFileBatches.retrieve Retrieve a vector store file batch Risk: read

await corsair.openai.api.vectorStoreFileBatches.retrieve({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`batchId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.file_batch`	Yes	—
`created_at`	`number`	Yes	—
`vector_store_id`	`string`	Yes	—
`status`	`in_progress \| completed \| cancelled \| failed`	Yes	—
`file_counts`	`object`	Yes	—

file_counts full type

{
  in_progress: number,
  completed: number,
  failed: number,
  cancelled: number,
  total: number
}

Vector Store Files

create

vectorStoreFiles.create Attach a file to a vector store Risk: write

await corsair.openai.api.vectorStoreFiles.create({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`fileId`	`string`	Yes	—
`chunkingStrategy`	`object`	No	—
`attributes`	`Record<string, any> \| null`	No	—

chunkingStrategy full type

{
  type: auto
} | {
  type: static,
  static: {
    max_chunk_size_tokens: number,
    chunk_overlap_tokens: number
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.file`	Yes	—
`usage_bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`vector_store_id`	`string`	Yes	—
`status`	`in_progress \| completed \| cancelled \| failed`	Yes	—
`last_error`	`object \| null`	No	—
`attributes`	`Record<string, any> \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

delete

vectorStoreFiles.delete Detach a file from a vector store Risk: destructive

await corsair.openai.api.vectorStoreFiles.delete({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.file.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

vectorStoreFiles.list List files attached to a vector store Risk: read

await corsair.openai.api.vectorStoreFiles.list({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—
`filter`	`in_progress \| completed \| cancelled \| failed`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: vector_store.file,
  usage_bytes: number,
  created_at: number,
  vector_store_id: string,
  status: in_progress | completed | cancelled | failed,
  last_error?: {
    code: string,
    message: string
  } | null,
  attributes?: Record<string, any> | null
}[]

retrieve

vectorStoreFiles.retrieve Retrieve a vector store file Risk: read

await corsair.openai.api.vectorStoreFiles.retrieve({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.file`	Yes	—
`usage_bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`vector_store_id`	`string`	Yes	—
`status`	`in_progress \| completed \| cancelled \| failed`	Yes	—
`last_error`	`object \| null`	No	—
`attributes`	`Record<string, any> \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

retrieveContent

vectorStoreFiles.retrieveContent Retrieve the parsed content of a vector store file Risk: read

await corsair.openai.api.vectorStoreFiles.retrieveContent({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`object`	`vector_store.file_content.page`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—
`next_page`	`string \| null`	No	—

data full type

{
  type: text,
  text: string
}[]

updateAttributes

vectorStoreFiles.updateAttributes Update attributes on a vector store file Risk: write

await corsair.openai.api.vectorStoreFiles.updateAttributes({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`fileId`	`string`	Yes	—
`attributes`	`Record<string, any> \| null`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.file`	Yes	—
`usage_bytes`	`number`	Yes	—
`created_at`	`number`	Yes	—
`vector_store_id`	`string`	Yes	—
`status`	`in_progress \| completed \| cancelled \| failed`	Yes	—
`last_error`	`object \| null`	No	—
`attributes`	`Record<string, any> \| null`	No	—

last_error full type

{
  code: string,
  message: string
} | null

Vector Stores

create

vectorStores.create Create a vector store Risk: write

await corsair.openai.api.vectorStores.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`fileIds`	`string[]`	No	—
`expiresAfter`	`object`	No	—
`chunkingStrategy`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

expiresAfter full type

{
  anchor: last_active_at,
  days: number
}

chunkingStrategy full type

{
  type: auto
} | {
  type: static,
  static: {
    max_chunk_size_tokens: number,
    chunk_overlap_tokens: number
  }
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string \| null`	No	—
`usage_bytes`	`number`	Yes	—
`file_counts`	`object`	Yes	—
`status`	`expired \| in_progress \| completed`	Yes	—
`expires_after`	`object`	No	—
`expires_at`	`number \| null`	No	—
`last_active_at`	`number \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

file_counts full type

{
  in_progress: number,
  completed: number,
  failed: number,
  cancelled: number,
  total: number
}

expires_after full type

{
  anchor: last_active_at,
  days: number
}

delete

vectorStores.delete Delete a vector store Risk: destructive

await corsair.openai.api.vectorStores.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

list

vectorStores.list List vector stores Risk: read

await corsair.openai.api.vectorStores.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—
`before`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: vector_store,
  created_at: number,
  name?: string | null,
  usage_bytes: number,
  file_counts: {
    in_progress: number,
    completed: number,
    failed: number,
    cancelled: number,
    total: number
  },
  status: expired | in_progress | completed,
  expires_after?: {
    anchor: last_active_at,
    days: number
  },
  expires_at?: number | null,
  last_active_at?: number | null,
  metadata?: Record<string, string> | null
}[]

modify

vectorStores.modify Modify a vector store Risk: write

await corsair.openai.api.vectorStores.modify({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`name`	`string \| null`	No	—
`expiresAfter`	`object`	No	—
`metadata`	`Record<string, string> \| null`	No	—

expiresAfter full type

{
  anchor: last_active_at,
  days: number
}

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string \| null`	No	—
`usage_bytes`	`number`	Yes	—
`file_counts`	`object`	Yes	—
`status`	`expired \| in_progress \| completed`	Yes	—
`expires_after`	`object`	No	—
`expires_at`	`number \| null`	No	—
`last_active_at`	`number \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

file_counts full type

{
  in_progress: number,
  completed: number,
  failed: number,
  cancelled: number,
  total: number
}

expires_after full type

{
  anchor: last_active_at,
  days: number
}

retrieve

vectorStores.retrieve Retrieve a vector store Risk: read

await corsair.openai.api.vectorStores.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`vector_store`	Yes	—
`created_at`	`number`	Yes	—
`name`	`string \| null`	No	—
`usage_bytes`	`number`	Yes	—
`file_counts`	`object`	Yes	—
`status`	`expired \| in_progress \| completed`	Yes	—
`expires_after`	`object`	No	—
`expires_at`	`number \| null`	No	—
`last_active_at`	`number \| null`	No	—
`metadata`	`Record<string, string> \| null`	No	—

file_counts full type

{
  in_progress: number,
  completed: number,
  failed: number,
  cancelled: number,
  total: number
}

expires_after full type

{
  anchor: last_active_at,
  days: number
}

search

vectorStores.search Search a vector store for relevant chunks Risk: read

await corsair.openai.api.vectorStores.search({});

Input

Name	Type	Required	Description
`vectorStoreId`	`string`	Yes	—
`query`	`string \| string[]`	Yes	—
`filters`	`Record<string, any>`	No	—
`maxNumResults`	`number`	No	—
`rankingOptions`	`object`	No	—
`rewriteQuery`	`boolean`	No	—

rankingOptions full type

{
  ranker?: string,
  score_threshold?: number
}

Output

Name	Type	Required	Description
`object`	`vector_store.search_results.page`	Yes	—
`search_query`	`string[]`	Yes	—
`data`	`object[]`	Yes	—
`has_more`	`boolean`	Yes	—
`next_page`	`string \| null`	No	—

data full type

{
  file_id: string,
  filename: string,
  score: number,
  attributes?: Record<string, any> | null,
  content: {
    type: text,
    text: string
  }[]
}[]

Videos

create

videos.create Generate a video from a prompt Risk: write

await corsair.openai.api.videos.create({});

Input

Name	Type	Required	Description
`prompt`	`string`	Yes	—
`model`	`string`	No	—
`size`	`string`	No	—
`seconds`	`string`	No	—
`inputReference`	`custom \| string`	No	—
`inputReferenceFileName`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`video`	Yes	—
`created_at`	`number`	Yes	—
`status`	`queued \| in_progress \| completed \| failed`	Yes	—
`model`	`string`	No	—
`progress`	`number`	No	—
`seconds`	`string`	No	—
`size`	`string`	No	—
`remixed_from_video_id`	`string \| null`	No	—
`error`	`object \| null`	No	—

error full type

{
  code: string,
  message: string
} | null

createRemix

videos.createRemix Create a remix of an existing video Risk: write

await corsair.openai.api.videos.createRemix({});

Input

Name	Type	Required	Description
`videoId`	`string`	Yes	—
`prompt`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`video`	Yes	—
`created_at`	`number`	Yes	—
`status`	`queued \| in_progress \| completed \| failed`	Yes	—
`model`	`string`	No	—
`progress`	`number`	No	—
`seconds`	`string`	No	—
`size`	`string`	No	—
`remixed_from_video_id`	`string \| null`	No	—
`error`	`object \| null`	No	—

error full type

{
  code: string,
  message: string
} | null

delete

videos.delete Delete a video Risk: destructive

await corsair.openai.api.videos.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`video.deleted`	Yes	—
`deleted`	`boolean`	Yes	—

download

videos.download Download the rendered content of a video Risk: read

await corsair.openai.api.videos.download({});

Input

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

Output

Name	Type	Required	Description
`videoId`	`string`	Yes	—
`contentBase64`	`string`	Yes	—

list

videos.list List generated videos Risk: read

await corsair.openai.api.videos.list({});

Input

Name	Type	Required	Description
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`after`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`list`	Yes	—
`data`	`object[]`	Yes	—
`first_id`	`string`	No	—
`last_id`	`string`	No	—
`has_more`	`boolean`	Yes	—

data full type

{
  id: string,
  object: video,
  created_at: number,
  status: queued | in_progress | completed | failed,
  model?: string,
  progress?: number,
  seconds?: string,
  size?: string,
  remixed_from_video_id?: string | null,
  error?: {
    code: string,
    message: string
  } | null
}[]

retrieve

videos.retrieve Retrieve a video Risk: read

await corsair.openai.api.videos.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`object`	`video`	Yes	—
`created_at`	`number`	Yes	—
`status`	`queued \| in_progress \| completed \| failed`	Yes	—
`model`	`string`	No	—
`progress`	`number`	No	—
`seconds`	`string`	No	—
`size`	`string`	No	—
`remixed_from_video_id`	`string \| null`	No	—
`error`	`object \| null`	No	—

error full type

{
  code: string,
  message: string
} | null