POST
/
assistant
/
chat
/
{assistant_name}

Authorizations

Api-Key
string
headerrequired

Pinecone API Key

Path Parameters

assistant_name
string
required

The name of the assistant to be described.

Body

application/json

The list of queries / chat's to chat an assistant

messages
object[]
required
stream
boolean
default: false

If false, the assistant will return a single JSON response. If true, the assistant will return a stream of responses.

model
enum<string>
default: gpt-4o

The large language model to use for answer generation

Available options:
gpt-4o,
claude-3-5-sonnet
filter
object

Optionally filter which documents can be used in this query.

Response

200 - application/json

The ChatCompletionCitationModel describes the response format of a chat request from the citation api

id
string
finish_reason
enum<string>
Available options:
stop,
length,
content_filter,
function_call
message
object

The MessageModel describes the format of a message in a chat

model
string
citations
object[]
usage
object

The UsageModel describes the usage of a chat completion