VEvectorize
Operations

Get operation status

Changed on

Get the status of a specific async operation. Returns 'pending', 'processing', 'completed', 'failed', or 'cancelled'. Completed operations remain queryable with their payload for the configured retention window and are pruned afterward.

get/v1/default/banks/{bank_id}/operations/{operation_id}

Request

Path parameters

bank_idstring required
operation_idstring required

Query parameters

include_payloadboolean

Include the raw task payload (submission params) in the response. May be large.

Headers

authorizationstring nullable

Response

Successful Response

operation_idstring required
status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' | 'not_found' required
operation_typestring nullable
idstring nullable

Same as operation_id; the name the operations list uses.

task_typestring nullable

Same as operation_type; the name the operations list uses.

mental_model_idstring nullable

Mental model this operation acted on (refresh_mental_model); null for other task types.

created_atstring nullable
updated_atstring nullable
completed_atstring nullable
error_messagestring nullable
retry_countinteger nullable

Number of times this operation has been retried after failure.

next_retry_atstring nullable

When the worker will next attempt this operation. For a pending operation, a value in the future indicates the task is parked — a refresh_mental_model held back by min_refresh_interval_seconds, or an extension raising DeferOperation — rather than awaiting immediate pickup.

result_metadataobject nullable

Internal metadata for debugging. Structure may change without notice. Not for production use.

task_payloadobject nullable

Raw task payload (params the operation was submitted with). Only populated when include_payload=true.

Example response

{
  "completed_at": "2024-01-15T10:31:30Z",
  "created_at": "2024-01-15T10:30:00Z",
  "operation_id": "550e8400-e29b-41d4-a716-446655440000",
  "operation_type": "refresh_mental_model",
  "status": "completed",
  "updated_at": "2024-01-15T10:31:30Z"
}

Changes

  • 45e711cd0897Revision changes
    • warning

      added the new candidate_rejected enum value to the /// response property for the response status

    • warning

      added the new refresh_failed_candidate_rejected enum value to the // response property for the response status

  • 4fda98b75f63Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status