POST /assistants
Create an assistant. This is where you specify the underlying training model, which cloud provider you would like to deploy with, and more.
For guidance and examples, see Create an assistant
Servers
- https://api.pinecone.io/assistant
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Pinecone-Api-Version |
String | Yes |
Required date-based version header Default value: "2025-10" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
region |
String | No |
The region to deploy the assistant in. Our current options are either us or eu. Defaults to us. |
name |
String | Yes |
The name of the assistant. Resource name must be 1-63 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'. |
metadata |
Object | No |
Optional metadata associated with the assistant. Metadata is a JSON object that can store custom organizational data, tags, and attributes. Maximum size is 16KB. |
instructions |
String | No |
Description or directive for the assistant to apply to all responses. Maximum 16 KB. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.