Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List Files

List all files in an assistant, with an option to filter files with metadata.

For guidance and examples, see Manage files.

curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"

curl -X GET "https://prod-1-data.ke.pinecone.io/assistant/files/$ASSISTANT_NAME" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2026-04"

GET /files/{assistant_name}

200
{
  "files": [
    {
      "name": "<string>",
      "id": "<string>",
      "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",
      "status": "<string>",
      "signed_url": "https://storage.googleapis.com/bucket/file.pdf?...",
      "multimodal": true
    }
  ],
  "pagination": {
    "next": "dXNlcl9pZD11c2VyXzE="
  }
}
401
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}
404
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Assistant \"example-assistant\" not found."
  },
  "status": 404
}
500
{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}
Api-Keystringrequired

Pinecone API Key

Typestring
X-Pinecone-Api-Versionstringrequired

Required date-based version header

Typestring
Default2026-04
assistant_namestringrequired

The name of the assistant to list files for.

Typestring
filter?string

Optional JSON-encoded metadata filter for files.

Typestring
limit?integer

Limit on the number of files to return.

Typeinteger
pagination_token?string

Pagination token to continue a previous listing operation.

Typestring

200 — This operation returns a list of all files that you have previously uploaded, and which are associated with the given assistant name.

files?object[]

The list of files that exist in the assistant.

Typeobject[]
Show child attributes
namestringrequired

The name of the uploaded file.

Typestring
idstringrequired

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

Typestring
size?integer

The size of the uploaded file, in bytes.

Example: 1048576

Typeinteger
metadata?object | null

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.

Typeobject | null
created_on?string

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

Example: 2025-10-01T12:30:00.000Z

Typestring
updated_on?string

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

Example: 2025-10-01T12:45:00.000Z

Typestring
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.

Typestring
signed_url?string | null

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

Typestring | null

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.

multimodal?boolean

Indicates whether the file was processed as multimodal.

Typeboolean
pagination?object

Object that contains the next pagination token to continue a previous listing operation.

Typeobject
Show child attributes
nextstringrequired

The token to use to retrieve the next page of results.

Typestring
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu