Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

List operations

List all operations for an assistant. Returns operations that are in progress, as well as recently completed or failed operations.

Both successful and failed operations are retained for 30 days after completion. Use the operation_type and status query parameters to filter results.

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

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

# Filter by status
# curl -X GET "https://prod-1-data.ke.pinecone.io/assistant/operations/$ASSISTANT_NAME?status=Processing" \
#   -H "Api-Key: $PINECONE_API_KEY" \
#   -H "X-Pinecone-Api-Version: 2026-04"

GET /operations/{assistant_name}

200
{
  "operations": [
    {
      "created_on": "2025-10-01T12:30:00.000Z",
      "file_id": "my-report-2025",
      "id": "op-1234-abcd-5678",
      "operation_type": "upload_file",
      "percent_complete": 42,
      "status": "Processing"
    },
    {
      "completed_on": "2025-10-01T12:05:00.000Z",
      "created_on": "2025-10-01T12:00:00.000Z",
      "file_id": "quarterly-analysis",
      "id": "op-8765-dcba-4321",
      "operation_type": "upload_file",
      "percent_complete": 100,
      "status": "Completed"
    },
    {
      "completed_on": "2025-10-01T11:32:00.000Z",
      "created_on": "2025-10-01T11:30:00.000Z",
      "error_message": "File processing failed: unsupported file format.",
      "file_id": "invalid-file",
      "id": "op-5555-eeee-9999",
      "operation_type": "upload_file",
      "percent_complete": 15,
      "status": "Failed"
    },
    {
      "completed_on": "2025-10-01T11:02:00.000Z",
      "created_on": "2025-10-01T11:00:00.000Z",
      "file_id": "old-report",
      "id": "op-7777-ffff-0000",
      "operation_type": "delete_file",
      "percent_complete": 100,
      "status": "Completed"
    }
  ],
  "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 operations for.

Typestring
operation_type?string

Filter operations by type.

Typestring
status?string

Filter operations by status.

Typestring
limit?integer

Limit on the number of operations to return.

Required range: 1 <= x <= 100

Typeinteger
pagination_token?string

Pagination token to continue a previous listing operation.

Typestring

200 — Successful response.

A list of operations.

operations?object[]

The list of operations for the assistant.

Typeobject[]
Show child attributes
idstringrequired

The unique identifier for the operation.

Example: op-1234-abcd-5678

Typestring
operation_typestringrequired

The kind of action represented by this operation, such as uploading or deleting a file.

Example: upload_file

Typestring
file_id?string | null

The identifier of the file being operated on.

Example: my-file-id-123

Typestring | null
statusstringrequired

The status of the operation. - Processing: The operation is in progress. - Completed: The operation finished successfully. - Failed: The operation failed. See error_message for details.

Example: Processing

Typestring
created_onstringrequired

The timestamp when the operation was created, in ISO 8601 format.

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

Typestring
completed_on?string | null

The timestamp when the operation completed or failed, in ISO 8601 format. Present only when status is Completed or Failed.

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

Typestring | null
percent_complete?integer

The progress made by the operation, as a percentage (0-100).

Required range: 0 <= x <= 100. Example: 42

Typeinteger
error_message?string | null

A message describing the error that caused the operation to fail. Present only when status is Failed.

Example: File processing failed: unsupported file format.

Typestring | null
ingestion_units?number | null

The number of ingestion units consumed by this operation. Present only when status is Completed for file ingestion operations.

Example: 50

Typenumber | null
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