Assistants
Check assistant status
The describe_assistant
endpoint gets the status of an assistant.
GET
/
assistant
/
assistants
/
{assistant_name}
Authorizations
Api-Key
string
headerrequiredPinecone API Key
Path Parameters
assistant_name
string
requiredThe name of the assistant to get a status on.
Response
200 - application/json
The AssistantModel describes the configuration and status of a Pinecone Assistant.
name
string
requiredThe name of the assistant. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
Required string length:
1 - 45
status
enum<string>
requiredAvailable options:
Initializing
, Failed
, Ready
, Terminating
instructions
string | null
Description or directive for the assistant to apply to all responses.
metadata
object | null
created_at
string
updated_at
string
Was this page helpful?