Files
Describe a file upload
The describe_file
endpoint provides the current status and metadata of a file uploaded to an assistant.
GET
/
assistant
/
files
/
{assistant_name}
/
{assistant_file_id}
Authorizations
Api-Key
string
headerrequiredPinecone API Key
Path Parameters
assistant_name
string
requiredThe name of the assistant to upload files to.
assistant_file_id
string
requiredThe 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
Response to a file upload request
name
string
requiredid
string
requiredmetadata
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, available only if include_url is set to true.
Was this page helpful?