API

Every perplexityai.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 Create a chat completion Risk: read

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

Input

Name	Type	Required	Description
`model`	`string`	Yes	—
`messages`	`object[]`	Yes	—
`max_tokens`	`number`	No	—
`temperature`	`number`	No	—
`top_p`	`number`	No	—
`top_k`	`number`	No	—
`return_citations`	`boolean`	No	—
`return_images`	`boolean`	No	—
`stream`	`boolean`	No	—
`presence_penalty`	`number`	No	—
`frequency_penalty`	`number`	No	—

messages full type

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

Output

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

choices full type

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

usage full type

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

Overview

Plugins

Chat

completions

​Chat

​completions

Chat

completions