Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Upload file to assistant

For guidance and examples, see Manage files.

curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"
ENCODED_METADATA="%7B%22published%22%3A%222024-01-01%22%2C%22document_type%22%3A%22script%22%7D" # URL encoded metadata - See w3schools.com/tags/ref_urlencode.ASP
LOCAL_FILE_PATH="/Users/jdoe/Downloads/example_file.txt"

curl -X POST "https://prod-1-data.ke.pinecone.io/assistant/files/$ASSISTANT_NAME?metadata=$ENCODED_METADATA" \
     -H "Api-Key: $PINECONE_API_KEY" \
     -F "file=@$LOCAL_FILE_PATH"
curl
{
  "name": "example-file.txt",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "{ 'published': '2024-01-01', 'document_type': 'manuscript' }",
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z",
  "status": "Processing",
  "percent_done": 50,
  "signed_url": "https://storage.googleapis.com/bucket/file.pdf",
  "error_message": "<string>"
}

POST /files/{assistant_name}

  • X-Pinecone-Api-Version (header, string, required) — Required date-based version header
  • assistant_name (path, string, required) — The name of the assistant to upload files to.
  • metadata (query, string) — Optional JSON-encoded metadata for files.
  • multimodal (query, string) — Optional flag to opt in to multimodal file processing (PDFs only). Can be either true or false. Default is false.
  • 200 — File upload has been accepted.
  • 400 — Bad request. The request body included invalid request parameters.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — Assistant not found.
  • 500 — Internal server error.
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu