background_jobs

execute_dummy_task

POST

/api/v2/background_jobs/execute_dummy_task

Code
Execute a dummy celery task for testing purposes.

This endpoint allows testing different celery scenarios:
- Normal execution
- Task failure
- Race condition simulation (transaction not committed when worker picks up task)

Parameters
----------
message : str, optional
    Message to pass to the task (default: "Hello from API")
fail_task : bool, optional
    If True, the task will raise an exception (default: False)
hold_transaction_seconds : int, optional
    If > 0, holds the transaction open for this many seconds before committing.
    This simulates the race condition where a task is queued inside atomic_operation
    but the BackgroundJob is not yet visible to the worker. (default: 0)

Returns
-------
dict
    Task ID and execution details

execute_dummy_task › Request Body

Request payload for /api/v2/background_jobs/execute_dummy_task

request-execute_dummy_task

message

string

Message to pass to the task.

Default: Hello from API

fail_task

boolean

If true, the task will raise an exception intentionally.

Default: false

hold_transaction_seconds

integer · min: 0

If > 0, holds the transaction open for this many seconds before committing. This simulates the race condition where a task is queued inside atomic_operation but the BackgroundJob is not yet visible to the worker.

Default: 0

execute_dummy_task › Responses

200

Response payload for /api/v2/background_jobs/execute_dummy_task

response-execute_dummy_task

messages

string[] · required

Any messages or errors related to the request

object · required

success

boolean · required

get_status

POST

/api/v2/background_jobs/get_status

Code
Get status of a background job by task_id.

Parameters
----------
task_id : str
    The task ID to check

Returns
-------
dict
    Background job status information

get_status › Request Body

Request payload for /api/v2/background_jobs/get_status

request-get_status

task_id

string · uuid · required

The ID of the background job to retrieve status for.

get_status › Responses

200

Response payload for /api/v2/background_jobs/get_status

response-get_status

messages

string[] · required

Any messages or errors related to the request

object · required

success

boolean · required

POST/api/v2/background_jobs/get_status

curl --request POST \
  --url /api/v2/background_jobs/get_status \
  --header 'Content-Type: application/json' \
  --data '
{
  "task_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "task_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "messages": [
    "string"
  ],
  "data": {
    "task_id": "00000000-0000-0000-0000-000000000000",
    "found": true,
    "data": {
      "id": "00000000-0000-0000-0000-000000000000",
      "task": "task",
      "complete": true,
      "failed": true,
      "queue_time": "2024-08-25T15:00:00Z",
      "start_time": "2024-08-25T15:00:00Z",
      "end_time": "2024-08-25T15:00:00Z",
      "retries": 0,
      "acknowledged": true
    }
  },
  "success": true
}

json

application/json

search

POST

/api/v2/background_jobs/search

search › Request Body

search › Responses

200

success

boolean

message

string[]

data

object

authority_limits billing