API

Every writer.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.

Applications

list

applications.list List no-code applications Risk: read

await corsair.writer.api.applications.list({});

Input

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

Output

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

data full type

{
  id: string,
  name?: string
}[]

Chat

create

chat.create Generate chat completions Risk: write

await corsair.writer.api.chat.create({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`messages`	`object[]`	Yes	—
`temperature`	`number`	No	—
`stream`	`false`	No	—

messages full type

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

Output

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

choices full type

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

usage full type

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

Completions

create

completions.create Generate text completions Risk: write

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

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`prompt`	`string`	Yes	—
`max_tokens`	`number`	No	—
`temperature`	`number`	No	—
`top_p`	`number`	No	—
`stop`	`string \| string[]`	No	—
`best_of`	`number`	No	—
`random_seed`	`number`	No	—
`stream`	`false`	No	—

Output

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

choices full type

{
  text: string,
  log_probs?: any | null
}[]

Files

delete

files.delete Delete file Risk: destructive

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

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`deleted`	`boolean`	No	—

download

files.download Download file contents Risk: read

await corsair.writer.api.files.download({});

Input

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

Output: any

get

files.get Get file details Risk: read

await corsair.writer.api.files.get({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—

list

files.list List uploaded files Risk: read

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

Input

Name	Type	Required	Description
`before`	`string`	No	—
`after`	`string`	No	—
`limit`	`number`	No	—
`order`	`asc \| desc`	No	—
`graph_id`	`string`	No	—
`status`	`in_progress \| completed \| failed`	No	—
`file_types`	`string`	No	—

Output

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

data full type

{
  id: string,
  name?: string,
  status?: string
}[]

upload

files.upload Upload file Risk: write

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

Input

Name	Type	Required	Description
`content`	`string`	Yes	—
`contentType`	`string`	Yes	—
`filename`	`string`	Yes	—
`graphId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—

Knowledge Graphs

addFile

knowledgeGraphs.addFile Add file to graph Risk: write

await corsair.writer.api.knowledgeGraphs.addFile({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`status`	`string`	No	—

askQuestion

knowledgeGraphs.askQuestion Ask question to knowledge graph Risk: read

await corsair.writer.api.knowledgeGraphs.askQuestion({});

Input

Name	Type	Required	Description
`graph_ids`	`string[]`	Yes	—
`question`	`string`	Yes	—
`stream`	`false`	No	—

Output

Name	Type	Required	Description
`question`	`string`	Yes	—
`answer`	`string`	Yes	—
`sources`	`any[]`	No	—

create

knowledgeGraphs.create Create knowledge graph Risk: write

await corsair.writer.api.knowledgeGraphs.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`description`	`string`	No	—
`team_ids`	`number[]`	No	—
`urls`	`any[]`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—

delete

knowledgeGraphs.delete Delete knowledge graph Risk: destructive

await corsair.writer.api.knowledgeGraphs.delete({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`deleted`	`boolean`	No	—

list

knowledgeGraphs.list List knowledge graphs Risk: read

await corsair.writer.api.knowledgeGraphs.list({});

Input

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

Output

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

data full type

{
  id: string,
  name: string,
  description?: string | null
}[]

removeFile

knowledgeGraphs.removeFile Remove file from graph Risk: destructive

await corsair.writer.api.knowledgeGraphs.removeFile({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`deleted`	`boolean`	No	—

retrieve

knowledgeGraphs.retrieve Retrieve knowledge graph Risk: read

await corsair.writer.api.knowledgeGraphs.retrieve({});

Input

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

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—

update

knowledgeGraphs.update Update knowledge graph Risk: write

await corsair.writer.api.knowledgeGraphs.update({});

Input

Name	Type	Required	Description
`graph_id`	`string`	Yes	—
`name`	`string`	No	—
`description`	`string`	No	—
`team_ids`	`number[]`	No	—
`urls`	`any[]`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—

Models

list

models.list List available models Risk: read

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

Input: empty object Output

Name	Type	Required	Description
`models`	`object[]`	Yes	—

models full type

{
  id: string,
  name: string
}[]

Tools

analyzeImages

tools.analyzeImages Analyze images with vision models Risk: write

await corsair.writer.api.tools.analyzeImages({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`any[]`	Yes	—
`stream`	`false`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`choices`	`any[]`	No	—

detectAiContent

tools.detectAiContent Detect AI-generated content likelihood Risk: read

await corsair.writer.api.tools.detectAiContent({});

Input

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

Output: object

Output full type

{
  label?: string,
  confidence?: number
}[] | any

medicalComprehend

tools.medicalComprehend Extract structured medical entities from text Risk: write

await corsair.writer.api.tools.medicalComprehend({});

Input

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

Output: any

parsePdf

tools.parsePdf Parse PDF file Risk: read

await corsair.writer.api.tools.parsePdf({});

Input

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

Output

Name	Type	Required	Description
`content`	`string`	No	—
`markdown`	`string`	No	—

translateText

tools.translateText Translate text between languages Risk: write

await corsair.writer.api.tools.translateText({});

Input

Name	Type	Required	Description
`text`	`string`	Yes	—
`target_language`	`string`	Yes	—
`source_language`	`string`	No	—
`formality`	`string`	No	—
`mask_profanity`	`boolean`	No	—

Output

Name	Type	Required	Description
`translation`	`string`	No	—
`translated_text`	`string`	No	—

webSearch

tools.webSearch Search the web Risk: read

await corsair.writer.api.tools.webSearch({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	—
`count`	`number`	No	—
`country`	`string`	No	—

Output

Name	Type	Required	Description
`results`	`any[]`	No	—

Overview

Plugins

Applications

list

Chat

create

Completions

create

Files

delete

download

get

list

upload

Knowledge Graphs

addFile

askQuestion

create

delete

list

removeFile

retrieve

update

Models

list

Tools

analyzeImages

detectAiContent

medicalComprehend

parsePdf

translateText

webSearch

​Applications

​list

​Chat

​create

​Completions

​create

​Files

​delete

​download

​get

​list

​upload

​Knowledge Graphs

​addFile

​askQuestion

​create

​delete

​list

​removeFile

​retrieve

​update

​Models

​list

​Tools

​analyzeImages

​detectAiContent

​medicalComprehend

​parsePdf

​translateText

​webSearch

Applications

list

Chat

create

Completions

create

Files

delete

download

get

list

upload

Knowledge Graphs

addFile

askQuestion

create

delete

list

removeFile

retrieve

update

Models

list

Tools

analyzeImages

detectAiContent

medicalComprehend

parsePdf

translateText

webSearch