Cortex API

Tasks

Endpoint

Background task management

List background tasks

GET

http://localhost:8000

/api/tasks

List background tasks › Responses

200

Tasks retrieved

object[]

GET/api/tasks

curl --request GET \
  --url http://localhost:8000/api/tasks

shell

Example Responses

{
  "tasks": [
    {
      "task_id": "task_id",
      "status": "pending",
      "progress": 0,
      "message": "message",
      "created_at": "2024-08-25T15:00:00Z",
      "completed_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get task status

GET

http://localhost:8000

/api/tasks/{task_id}

Get task status › path Parameters

task_id

string · required

Get task status › Responses

200

Task status retrieved

task_id

string

status

string · enum

Enum values:

pending

running

completed

failed

progress

integer

message

string

created_at

string · date-time

completed_at

string · date-time

GET/api/tasks/{task_id}

curl --request GET \
  --url http://localhost:8000/api/tasks/:task_id

shell

Example Responses

{
  "task_id": "task_id",
  "status": "pending",
  "progress": 0,
  "message": "message",
  "created_at": "2024-08-25T15:00:00Z",
  "completed_at": "2024-08-25T15:00:00Z"
}

json

application/json

Cancel task

DELETE

http://localhost:8000

/api/tasks/{task_id}

Cancel task › path Parameters

task_id

string · required

Cancel task › Responses

200

Task cancelled

No data returned

DELETE/api/tasks/{task_id}

curl --request DELETE \
  --url http://localhost:8000/api/tasks/:task_id

shell

Example Responses

No example specified for this content type

Get task result

GET

http://localhost:8000

/api/tasks/{task_id}/result

Get task result › path Parameters

task_id

string · required

Get task result › Responses

200

Task result retrieved

No data returned

GET/api/tasks/{task_id}/result

curl --request GET \
  --url http://localhost:8000/api/tasks/:task_id/result

shell

Example Responses

No example specified for this content type

Clean up old tasks

POST

http://localhost:8000

/api/tasks/cleanup

Remove completed tasks older than specified age

Clean up old tasks › Responses

200

Cleanup completed

No data returned

POST/api/tasks/cleanup

curl --request POST \
  --url http://localhost:8000/api/tasks/cleanup

shell

Example Responses

No example specified for this content type

Communities Admin

Cortex API

Tasks

Endpoint

Background task management

List background tasks

GET

http://localhost:8000

/api/tasks

List background tasks › Responses

200

Tasks retrieved

object[]

GET/api/tasks

curl --request GET \
  --url http://localhost:8000/api/tasks

shell

Example Responses

{
  "tasks": [
    {
      "task_id": "task_id",
      "status": "pending",
      "progress": 0,
      "message": "message",
      "created_at": "2024-08-25T15:00:00Z",
      "completed_at": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get task status

GET

http://localhost:8000

/api/tasks/{task_id}

Get task status › path Parameters

task_id

string · required

Get task status › Responses

200

Task status retrieved

task_id

string

status

string · enum

Enum values:

pending

running

completed

failed

progress

integer

message

string

created_at

string · date-time

completed_at

string · date-time

GET/api/tasks/{task_id}

curl --request GET \
  --url http://localhost:8000/api/tasks/:task_id

shell

Example Responses

{
  "task_id": "task_id",
  "status": "pending",
  "progress": 0,
  "message": "message",
  "created_at": "2024-08-25T15:00:00Z",
  "completed_at": "2024-08-25T15:00:00Z"
}

json

application/json

Cancel task

DELETE

http://localhost:8000

/api/tasks/{task_id}

Cancel task › path Parameters

task_id

string · required

Cancel task › Responses

200

Task cancelled

No data returned

DELETE/api/tasks/{task_id}

curl --request DELETE \
  --url http://localhost:8000/api/tasks/:task_id

shell

Example Responses

No example specified for this content type

Get task result

GET

http://localhost:8000

/api/tasks/{task_id}/result

Get task result › path Parameters

task_id

string · required

Get task result › Responses

200

Task result retrieved

No data returned

GET/api/tasks/{task_id}/result

curl --request GET \
  --url http://localhost:8000/api/tasks/:task_id/result

shell

Example Responses

No example specified for this content type

Clean up old tasks

POST

http://localhost:8000

/api/tasks/cleanup

Remove completed tasks older than specified age

Clean up old tasks › Responses

200

Cleanup completed

No data returned

POST/api/tasks/cleanup

curl --request POST \
  --url http://localhost:8000/api/tasks/cleanup

shell

Example Responses

No example specified for this content type

Communities Admin