API V1
Operations
Monitor and manage asynchronous background processing jobs.
Overview
What are operations?
Operations represent background processing tasks in Cension. When you start an enrichment (Horizontal) or discovery (Vertical) process, the API immediately returns an operationId. Because these operations can process thousands of items and run for several minutes or hours, you must use the Operations API to poll their status or cancel them if needed.
Get operation status
"Check progress of a running job."
Use this endpoint to retrieve the current status, progress metrics, and execution details of a specific background operation.
- Endpoint: GET /api/operations/{operationId}
- Method: GET
- Description: Retrieves status details for a specific operation.
Parameters
- operationId (Required): The unique ID of the operation to query.
Response Fields
- status: The state of the operation. Can be running, completed, failed, or cancelled.
- processedItems: The number of items successfully processed so far.
- totalItems: The total number of items to process.
- errorMessage: Contains the failure reason if the status is failed, otherwise null.
Response Example
1{
2 "success": true,
3 "operation": {
4 "operationId": 4836,
5 "feedId": 123,
6 "projectId": 456,
7 "operationType": "horizontal",
8 "status": "completed",
9 "processedItems": 50,
10 "totalItems": 50,
11 "startedAt": "2026-06-01T05:23:00.000Z",
12 "completedAt": "2026-06-01T05:24:15.000Z",
13 "errorMessage": null
14 }
15}Cancel operation
"Stop a running job."
Use this endpoint to abort a running vertical or horizontal background operation. This stops any further AI processing and marks the operation as cancelled.
- Endpoint: DELETE /api/operations/{operationId}/cancel
- Method: DELETE
- Description: Aborts a running operation by its ID.
Parameters
- operationId (Required): The unique ID of the operation to cancel.
Response Example
1{
2 "success": true
3}