Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Manage Assistants

Describe a file

Get the current status and metadata of a file uploaded to an assistant.

get/files/{assistant_name}/{assistant_file_id}

Path parameters

assistant_namestring required

The name of the assistant that contains the file.

assistant_file_idstring required

The identifier of the file to be described.

Query parameters

include_urlstring

Include the signed URL of the file in the response.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

Poll request successful.

namestring required

The name of the uploaded file.

idstring required

The unique identifier for the uploaded file. This may be a user-provided identifier or a system-generated ID.

sizeinteger

The size of the uploaded file, in bytes.

metadataobject nullable

Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.

created_onstring date-time

The timestamp when the file was uploaded, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

updated_onstring date-time

The timestamp of the most recent update to the file, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

statusstring

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.

signed_urlstring nullable

A signed URL that provides temporary, read-only access to the file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.

multimodalboolean

Indicates whether the file was processed as multimodal.

Example response

{
  "size": 1048576,
  "metadata": {
    "created_by": "Jane Doe",
    "published": "2025-10-01T00:00:00.000Z",
    "tags": [
      "report",
      "Q4",
      "analytics"
    ]
  },
  "created_on": "2025-10-01T12:30:00.000Z",
  "updated_on": "2025-10-01T12:45:00.000Z",
  "signed_url": "https://storage.googleapis.com/bucket/file.pdf?..."
}