Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1372170520.1 KB
Manage Assistants

Describe an operation

Get the status of an operation.

get/operations/{assistant_name}/{operation_id}

Path parameters

assistant_namestring required

The name of the assistant.

operation_idstring required

The identifier of the operation to be described.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

Current information and status of the operation.

idstring required

The unique identifier for the operation.

operation_typestring required

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

file_idstring nullable

The identifier of the file being operated on.

statusstring required

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.
created_onstring date-time required

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

completed_onstring date-time nullable

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

percent_completeinteger

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

error_messagestring nullable

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

ingestion_unitsnumber double nullable

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

Example response

{
  "id": "op-1234-abcd-5678",
  "operation_type": "upload_file",
  "file_id": "my-file-id-123",
  "status": "Processing",
  "created_on": "2025-10-01T12:30:00Z",
  "completed_on": "2025-10-01T12:35:00Z",
  "percent_complete": 42,
  "error_message": "File processing failed: unsupported file format.",
  "ingestion_units": 50
}