POST
/
assistant
/
assistants
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="YOUR_ASSISTANT_NAME"

curl --request POST \
  --url https://api.pinecone.io/assistant/assistants \
  --header 'Api-Key: $PINECONE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "$ASSISTANT_NAME",
  "metadata": {}
}'
{
  "name": "example-assistant",
  "metadata": {},
  "status": "Initializing",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z"
}

This feature is in public beta and is not recommended for production usage. Join the beta waitlist and review the review the preview terms for more details

PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="YOUR_ASSISTANT_NAME"

curl --request POST \
  --url https://api.pinecone.io/assistant/assistants \
  --header 'Api-Key: $PINECONE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "$ASSISTANT_NAME",
  "metadata": {}
}'

Authorizations

Api-Key
string
headerrequired

Pinecone API Key

Body

application/json
name
string
required

The 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.

Response

200 - application/json
name
string
required

The 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>
required

Describes 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.