Skip to main content
GET
/
files
/
{assistant_name}
/
{assistant_file_id}
from pinecone import Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")

# Get an assistant.
assistant = pc.assistant.Assistant(
    assistant_name="example-assistant", 
)

# Describe a file. 
# To get a signed URL in the response, set `include_url` to `True`.
file = assistant.describe_file(file_id="3c90c3cc-0d44-4b50-8888-8dd25736052a", include_url=True)

{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "created_on": "2023-11-07T05:31:56Z",
  "updated_on": "2023-11-07T05:31:56Z",
  "status": "Processing",
  "percent_done": 123,
  "signed_url": "https://storage.googleapis.com/bucket/file.pdf?...",
  "error_message": "<string>"
}
from pinecone import Pinecone
pc = Pinecone(api_key="YOUR_API_KEY")

# Get an assistant.
assistant = pc.assistant.Assistant(
    assistant_name="example-assistant", 
)

# Describe a file. 
# To get a signed URL in the response, set `include_url` to `True`.
file = assistant.describe_file(file_id="3c90c3cc-0d44-4b50-8888-8dd25736052a", include_url=True)

Authorizations

​
Api-Key
string
header
required

Pinecone API Key

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
enum<string>

Include the signed URL of the file in the response.

Available options:
true,
false

Response

Poll request successful.

AssistantFileModel is the response format to 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
enum<string>
Available options:
Processing,
Available,
Deleting,
ProcessingFailed
​
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.