Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

On this pageOverview

Describe a file upload

For guidance and examples, see Manage files.

Python
# 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")
JavaScript
import { Pinecone } from '@pinecone-database/pinecone'

const pc = new Pinecone({ apiKey: 'YOUR_API_KEY' });

const assistantName = 'example-assistant';
const assistant = pc.Assistant(assistantName);

const file = await assistant.describeFile("070513b3-022f-4966-b583-a9b12e0290ff")
curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"
FILE_ID="070513b3-022f-4966-b583-a9b12e0290ff"

curl -X GET "https://prod-1-data.ke.pinecone.io/assistant/files/$ASSISTANT_NAME/$FILE_ID" \
  -H "Api-Key: $PINECONE_API_KEY" \
  -H "X-Pinecone-Api-Version: 2025-01"  
curl
{
  "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
}

GET /files/{assistant_name}/{assistant_file_id}

  • assistant_name (path, string, required) — The name of the assistant to upload files to.
  • assistant_file_id (path, string, required) — The uuid of the file to be described.
  • include_url (query, string) — Include the signed URL of the file in the response.
  • 200 — Poll request successful.
  • 401 — Unauthorized. Possible causes: Invalid API key.
  • 404 — File not found.
  • 500 — Internal server error.
Suggest an edit

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

Export
Documentation menu