Verify Processing

Check the current processing status of your uploaded content.

This endpoint allows you to monitor the progress of documents, text, or other content you’ve uploaded. Simply provide the file ID to see whether processing is complete, still in progress, or if any errors occurred.

Use this to determine when your content is ready for search and retrieval, or to troubleshoot any processing issues.

POST /ingestion/verify-processing

Error

A valid request URL is required to generate request examples

200

{
  "file_id": "CortexDoc1234",
  "indexing_status": "<indexing_status>",
  "error_code": "<error_code>",
  "success": true,
  "message": "Processing status retrieved successfully"
}

Hit the Try it button to try this API now in our playground. It’s the best way to check the full request and response in one place, customize your parameters, and generate ready-to-use code snippets.

Examples

API Request

curl -X 'POST' \
'https://api.usecortex.ai/ingestion/verify-processing?file_id=file_123' \
-H 'accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

TypeScript

const status = await client.upload.verifyProcessing({
  file_id: "CortexDoc1234",
  tenant_id: "tenant_1234",
  sub_tenant_id: "sub_tenant_4567"
});

Python (Sync)

# Async usage is similar, just use async_client and await
status = client.upload.verify_processing(
    file_id="CortexDoc1234",
    tenant_id="tenant_1234",
    sub_tenant_id="sub_tenant_4567"
)

Error Responses

All endpoints return consistent error responses following the standard format. For detailed error information, see our Error Responses documentation.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

file_id · string · required

The file ID to check processing status for

Example:

"CortexDoc1234"

tenant_id · string · default: ""

Unique identifier for the tenant/organization

Example:

"tenant_1234"

sub_tenant_id · string | null

Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used.

Example:

"sub_tenant_4567"

Response

200

application/json

Successful Response

file_id · string · required

Identifier for the file whose status is being retrieved

Example:

"CortexDoc1234"

indexing_status · enum<string> · required

Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored', 'graph_creation', 'success'. 'graph_creation' indicates the file is indexed but the knowledge graph is still being created. 'success' is an alias for 'completed'.

Available options: queued, processing, completed, errored, graph_creation, success

Example:

"<indexing_status>"

error_code · string · default: ""

Error code for the file. You may share this code with us to help us diagnose and resolve the issue.

Example:

"<error_code>"

success · boolean · default: true

Example:

true

message · string · default: Processing status retrieved successfully

Detailed status message about the processing operation