API

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

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

Chat

completions

chat.completions Generate a Jamba chat completion from a conversation history Risk: write

await corsair.studiobyai21labs.api.chat.completions({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`messages`	`object[]`	Yes	—
`tools`	`object[]`	No	—
`documents`	`object[]`	No	—
`response_format`	`object`	No	—
`max_tokens`	`number`	No	—
`temperature`	`number`	No	—
`top_p`	`number`	No	—
`stop`	`string \| string[]`	No	—
`n`	`number`	No	—

messages full type

{
  role: system | user | assistant | tool,
  content?: string | null,
  tool_calls?: {
    id: string,
    type: string,
    function: {
      name: string,
      arguments: string
    }
  }[],
  tool_call_id?: string
}[]

tools full type

{
  type: function,
  function: {
    name: string,
    description?: string,
    parameters?: {
    }
  }
}[]

documents full type

{
  content: string,
  metadata?: {
  }
}[]

response_format full type

{
  type: text | json_object
}

Output

Name	Type	Required	Description
`id`	`string`	No	—
`choices`	`object[]`	Yes	—
`usage`	`object`	No	—

choices full type

{
  index?: number,
  message?: {
    role?: string,
    content?: string | null,
    tool_calls?: any[]
  },
  finish_reason?: string
}[]

usage full type

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

Library

delete

library.delete Delete a library file Risk: write

await corsair.studiobyai21labs.api.library.delete({});

Input

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

Output: undefined

download

library.download Get a signed download URL for a library file Risk: read

await corsair.studiobyai21labs.api.library.download({});

Input

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

Output: string

get

library.get Get metadata for a library file Risk: read

await corsair.studiobyai21labs.api.library.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`size`	`number`	No	—
`created_at`	`string`	No	—
`labels`	`string[]`	No	—
`errorCode`	`string`	No	—
`errorMessage`	`string`	No	—

list

library.list List workspace library files with optional filters Risk: read

await corsair.studiobyai21labs.api.library.list({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`path`	`string`	No	—
`status`	`DB_RECORD_CREATED \| UPLOADED \| UPLOAD_FAILED \| PROCESSED \| PROCESSING_FAILED`	No	—
`label`	`string \| string[]`	No	—
`offset`	`number`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
  id: string,
  name?: string,
  size?: number,
  created_at?: string,
  labels?: string[],
  errorCode?: string,
  errorMessage?: string
}[]

update

library.update Update a library file public URL or labels Risk: write

await corsair.studiobyai21labs.api.library.update({});

Input

Name	Type	Required	Description
`file_id`	`string`	Yes	—
`publicUrl`	`string`	No	—
`labels`	`string[]`	No	—

Output: undefined

upload

library.upload Upload a file or register a public URL in the library Risk: write

await corsair.studiobyai21labs.api.library.upload({});

Input

Name	Type	Required	Description
`file`	`string \| custom`	No	—
`fileName`	`string`	No	—
`path`	`string`	No	—
`labels`	`string[]`	No	—
`publicUrl`	`string`	No	—

Output

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

Maestro

createRun

maestro.createRun Create an AI21 Maestro run Risk: write

await corsair.studiobyai21labs.api.maestro.createRun({});

Input

Name	Type	Required	Description
`input`	`object[]`	Yes	—
`system_prompt`	`string`	No	—
`requirements`	`object[]`	No	—
`tools`	`object[]`	No	—
`models`	`string[]`	No	—
`budget`	`low \| medium \| high`	No	—
`include`	`data_sources \| requirements_result[]`	No	—
`response_language`	`arabic \| dutch \| english \| french \| german \| hebrew \| italian \| portuguese \| spanish`	No	—

input full type

string | {
  role: user | assistant,
  content: string
}[]

requirements full type

{
  name: string,
  description: string,
  is_mandatory?: boolean
}[]

tools full type

(
  {
    type: mcp,
    server_label: string,
    server_url: string,
    headers?: {
    },
    allowed_tools?: string[]
  } | {
    type: http,
    function: {
      name: string,
      description?: string,
      parameters?: {
      }
    },
    endpoint: {
      url: string,
      headers?: {
      }
    }
  } | {
    type: file_search,
    labels?: string[],
    file_ids?: string[]
  } | {
    type: web_search,
    urls?: string[]
  }
)[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`completed \| failed \| in_progress`	No	—
`result`	`any`	No	—
`requirements_result`	`object`	No	—
`data_sources`	`object`	No	—
`error`	`object`	No	—

requirements_result full type

{
  score?: number,
  finish_reason?: string,
  requirements?: any[]
}

data_sources full type

{
  web_search?: any[],
  file_search?: any[],
  tool_calls?: any[]
}

error full type

{
  message?: string
}

retrieveRun

maestro.retrieveRun Retrieve an AI21 Maestro run by id Risk: read

await corsair.studiobyai21labs.api.maestro.retrieveRun({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`completed \| failed \| in_progress`	No	—
`result`	`any`	No	—
`requirements_result`	`object`	No	—
`data_sources`	`object`	No	—
`error`	`object`	No	—

requirements_result full type

{
  score?: number,
  finish_reason?: string,
  requirements?: any[]
}

data_sources full type

{
  web_search?: any[],
  file_search?: any[],
  tool_calls?: any[]
}

error full type

{
  message?: string
}

Overview

Plugins

Chat

completions

Library

delete

download

get

list

update

upload

Maestro

createRun

retrieveRun

​Chat

​completions

​Library

​delete

​download

​get

​list

​update

​upload

​Maestro

​createRun

​retrieveRun

Chat

completions

Library

delete

download

get

list

update

upload

Maestro

createRun

retrieveRun