Skip to main content
GET
/
files
/
{assistant_name}
/
{assistant_file_id}
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"
FILE_ID="3c90c3cc-0d44-4b50-8888-8dd25736052a"

# Describe a file. 
# To get a signed URL in the response, set `include_url` to `true`.
curl -X GET "https://prod-1-data.ke.pinecone.io/assistant/files/$ASSISTANT_NAME/$FILE_ID?include_url=true" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2025-10"

{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "percent_done": 123,
  "signed_url": "https://storage.googleapis.com/bucket/file.pdf?...",
  "error_message": "<string>",
  "multimodal": true
}
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"
FILE_ID="3c90c3cc-0d44-4b50-8888-8dd25736052a"

# Describe a file. 
# To get a signed URL in the response, set `include_url` to `true`.
curl -X GET "https://prod-1-data.ke.pinecone.io/assistant/files/$ASSISTANT_NAME/$FILE_ID?include_url=true" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2025-10"

Authorizations

​
Api-Key
string
header
required

Pinecone API Key

Headers

​
X-Pinecone-Api-Version
string
default:2025-10
required

Required date-based version header

Path Parameters

​
assistant_name
string
required

The name of the assistant to upload files to.

​
assistant_file_id
string
required

The uuid of the file to be described.

Query Parameters

​
include_url
string

Include the signed URL of the file in the response.

Response

Poll request successful.

The response format for a successful file upload request.

​
name
string
required
​
id
string<uuid>
required
​
metadata
object
​
created_on
string<date-time>
​
updated_on
string<date-time>
​
status
string

The 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<double> | null

The percentage of the file that has been processed

​
signed_url
string | null

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.

Example:

"https://storage.googleapis.com/bucket/file.pdf?..."

​
error_message
string | null

A message describing any error during file processing. Provided only if an error occurs.

​
multimodal
boolean

Indicates whether the file was processed as multimodal.