Upload file to assistant
Upload a file to the specified assistant.
For guidance and examples, see Manage files.
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"{
"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}
Authorizations
Section titled “Authorizations”Api-KeystringrequiredPinecone API Key
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Path Parameters
Section titled “Path Parameters”assistant_namestringrequiredThe name of the assistant to upload files to.
Query Parameters
Section titled “Query Parameters”metadata?stringOptional JSON-encoded metadata for files.
multimodal?stringOptional flag to opt in to multimodal file processing (PDFs only). Can be either true or false. Default is false.
The desired file to be uploaded and processed into the assistant.
filestringrequiredThe file to upload.
Response
Section titled “Response”200 — File upload has been accepted.
The response format for a successful file upload request.
namestringrequiredidstringrequiredmetadata?object | nullcreated_on?stringupdated_on?stringstatus?stringThe current state of the uploaded file. Possible values: - Processing: File is being processed (parsed, chunked, embedded) - Available: Processing completed successfully; file is ready for use - Deleting: Deletion has been initiated but not yet completed - ProcessingFailed: Processing failed with an error Note: Once a file is deleted, the API returns 404 Not Found instead of a file object.
percent_done?number | nullThe percentage of the file that has been processed
signed_url?string | nullExample: https://storage.googleapis.com/bucket/file.pdf?...
A signed URL that provides temporary, read-only access to the underlying file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.
error_message?string | nullA message describing any error during file processing. Provided only if an error occurs.
multimodal?booleanIndicates whether the file was processed as multimodal.