Tasks

Task execution management

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

Execute a task asynchronously via QStash

POST/api/v1/tasks/execute

Request body

Field	Type	Description
bridgeId	string
taskName	string
input	object

{
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "taskName": "string",
  "input": {}
}

Responses

202 Task queued

POST/api/v1/tasks/execute

Execute a task asynchronously via QStash

API key (Bearer token)

Request body (JSON){ "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "taskName": "string", "input": {} }

https://api-test.orderly-hub.com/api/v1/tasks/execute

Execute a task synchronously

POST/api/v1/tasks/execute-sync

Request body

Field	Type	Description
bridgeId	string
taskName	string
input	object

{
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "taskName": "string",
  "input": {}
}

Responses

200 Task result

POST/api/v1/tasks/execute-sync

Execute a task synchronously

API key (Bearer token)

Request body (JSON){ "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "taskName": "string", "input": {} }

https://api-test.orderly-hub.com/api/v1/tasks/execute-sync

List task executions

GET/api/v1/tasks/executions

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
bridgeId	query	no	string
status	query	no	string
taskName	query	no	string

Responses

200 Paginated execution list

GET/api/v1/tasks/executions

List task executions

API key (Bearer token)

page (query)

limit (query)

bridgeId (query)

status (query)

taskName (query)

https://api-test.orderly-hub.com/api/v1/tasks/executions

Get task execution details

GET/api/v1/tasks/executions/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Execution details

404 Execution not found

GET/api/v1/tasks/executions/{id}

Get task execution details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/tasks/executions/

Cancel a running task execution

POST/api/v1/tasks/executions/{id}/cancel

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Execution cancelled

POST/api/v1/tasks/executions/{id}/cancel

Cancel a running task execution

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/tasks/executions//cancel

Retry a failed task execution

POST/api/v1/tasks/executions/{id}/retry

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

202 Retry queued

POST/api/v1/tasks/executions/{id}/retry

Retry a failed task execution

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/tasks/executions//retry