Skip to main content
Pinecone Docs
current

Search documentation

Type to search this documentation.

Describe an operation

Get the status of an operation.

curl
PINECONE_API_KEY="YOUR_API_KEY"
ASSISTANT_NAME="example-assistant"
OPERATION_ID="op-1234-abcd-5678"

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

GET /operations/{assistant_name}/{operation_id}

200
{
  "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"
}
401
{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}
404
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Operation 1234-abcd-5678 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.

Typestring
operation_idstringrequired

The identifier of the operation to be described.

Typestring

200 — Current information and status of the operation.

Describes the status of an ongoing or completed server operation.

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
Suggest an edit

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

Export
Documentation menu