Assistant API
Describe assistant
This operation describes an assistant and its metadata.
GET
/
assistant
/
assistants
/
{assistant_name}
This feature is in public beta and is not recommended for production usage. Join the beta waitlist and review the preview terms for more details.
Authorizations
Api-Key
string
headerrequiredPinecone API Key
Path Parameters
assistant_name
string
requiredThe name of the assistant to poll.
Response
200 - application/json
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 '-'.
metadata
object
A dictionary containing metadata for the assistant.
status
enum<string>
requiredDescribes the status of the assistant.
Available options:
Initializing
, Failed
, Ready
, Terminating
created_on
string
When the assistant was created.
updated_on
string
When the assistant was last updated.
Was this page helpful?