GET
/
files
/
{assistant_name}
/
{assistant_file_id}
# To use the Python SDK, install the plugin:
# pip install --upgrade pinecone pinecone-plugin-assistant

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.
file = assistant.describe_file(file_id="070513b3-022f-4966-b583-a9b12e0290ff")

{
  "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": 90,
  "signed_url": "https://storage.googleapis.com...",
  "error_message": null,
  "size": 1073470
}

# To use the Python SDK, install the plugin:
# pip install --upgrade pinecone pinecone-plugin-assistant

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.
file = assistant.describe_file(file_id="070513b3-022f-4966-b583-a9b12e0290ff")

{
  "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": 90,
  "signed_url": "https://storage.googleapis.com...",
  "error_message": null,
  "size": 1073470
}

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

200
application/json
Poll request successful.

AssistantFileModel is the response format to a successful file upload request.

​
name
string
required
​
id
string
required
​
metadata
object | null
​
created_on
string
​
updated_on
string
​
status
enum<string>
Available options:
Processing,
Available,
Deleting,
ProcessingFailed
​
percent_done
number | null

The percentage of the file that has been processed

​
signed_url
string | null

A signed url that gives you access to the underlying file

​
error_message
string | null

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

Was this page helpful?

Upload file to assistantDelete an uploaded file