API

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

createCompletion

chat.createCompletion Generate a chat completion using an APIpie model, with optional provider routing and memory. Risk: write

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

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`messages`	`object[]`	Yes	—
`provider`	`string`	No	—
`routing`	`price \| perf \| perf_avg`	No	—
`maxTokens`	`number`	No	—
`temperature`	`number`	No	—
`topP`	`number`	No	—
`topK`	`number`	No	—
`frequencyPenalty`	`number`	No	—
`presencePenalty`	`number`	No	—
`stop`	`string \| string[]`	No	—
`n`	`number`	No	—
`memory`	`number`	No	—
`memSession`	`string`	No	—
`memExpire`	`number`	No	—
`memClear`	`number`	No	—
`integrity`	`number`	No	—
`integrityModel`	`string`	No	—

messages full type

{
  role: string,
  content: string
}[]

Output

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

choices full type

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

usage full type

{
}

Embeddings

create

embeddings.create Create embeddings for the given input text(s). Risk: write

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

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`input`	`string \| string[]`	Yes	—
`user`	`string`	No	—

Output

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

data full type

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

usage full type

{
}

Images

generate

images.generate Generate image(s) from a text prompt. Risk: write

await corsair.apipie.api.images.generate({});

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`prompt`	`string`	Yes	—
`n`	`number`	No	—
`size`	`string`	No	—
`quality`	`string`	No	—
`style`	`string`	No	—
`responseFormat`	`string`	No	—
`user`	`string`	No	—

Output

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

data full type

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

usage full type

{
}

Models

list

models.list List APIpie models available to the account, filterable by type, subtype, provider, and model. Risk: read

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

Input

Name	Type	Required	Description
`type`	`string`	No	—
`subtype`	`string`	No	—
`provider`	`string`	No	—
`model`	`string`	No	—
`enabled`	`number`	No	—

Output: object

Output full type

{
  id: string,
  model?: string | null,
  provider?: string | null,
  type?: string | null,
  subtype?: string | null,
  route?: string | null,
  description?: string | null,
  enabled?: boolean | number | null,
  available?: boolean | number | null,
  avg_cost?: string | null,
  input_cost?: string | null,
  output_cost?: string | null,
  price_type?: string | null,
  img_price?: any | null,
  img_json?: {
  } | null,
  latency?: string | null,
  query_count?: string | null,
  max_tokens?: number | null,
  max_response_tokens?: number | null
}[] | {
  object?: string,
  data: {
    id: string,
    model?: string | null,
    provider?: string | null,
    type?: string | null,
    subtype?: string | null,
    route?: string | null,
    description?: string | null,
    enabled?: boolean | number | null,
    available?: boolean | number | null,
    avg_cost?: string | null,
    input_cost?: string | null,
    output_cost?: string | null,
    price_type?: string | null,
    img_price?: any | null,
    img_json?: {
    } | null,
    latency?: string | null,
    query_count?: string | null,
    max_tokens?: number | null,
    max_response_tokens?: number | null
  }[]
}

listDetailed

models.listDetailed List APIpie models with detailed metadata including capabilities, limits, and pricing. Risk: read

await corsair.apipie.api.models.listDetailed({});

Input

Name	Type	Required	Description
`type`	`string`	No	—
`provider`	`string`	No	—
`model`	`string`	No	—

Output

Name	Type	Required	Description
`object`	`string`	No	—
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  model?: string | null,
  provider?: string | null,
  type?: string | null,
  subtype?: string | null,
  route?: string | null,
  description?: string | null,
  enabled?: boolean | number | null,
  available?: boolean | number | null,
  abortable?: boolean | null,
  moderationRequired?: boolean | null,
  supports_multipart?: boolean | null,
  input_modalities?: string[] | null,
  output_modalities?: string[] | null,
  instruct_type?: string | null,
  quantization?: string | null,
  pool?: string | null,
  mmlu?: number | null,
  output_vector_size?: number | null,
  max_tokens?: number | null,
  max_response_tokens?: number | null,
  max_images_per_prompt?: number | null,
  max_audio_per_prompt?: number | null,
  max_audio_length_hours?: number | null,
  max_videos_per_prompt?: number | null,
  max_video_length?: number | null,
  max_pdf_size_mb?: number | null,
  latency?: string | null,
  query_count?: string | null,
  pricing?: {
  } | null,
  supported_input_parameters?: {
  } | null
}[]

Overview

Plugins

Chat

createCompletion

Embeddings

create

Images

generate

Models

list

listDetailed

​Chat

​createCompletion

​Embeddings

​create

​Images

​generate

​Models

​list

​listDetailed

Chat

createCompletion

Embeddings

create

Images

generate

Models

list

listDetailed