Queue APIs
Append Queue Item
Appends an item to the queue.
POST
/
{workspaceId}
/
projects
/
{projectName}
/
queues
/
{queueId}
/
items
Authorizations
x-api-key
string
headerrequiredAPI Key used to authenticate your requests. How to create one.
Path Parameters
workspaceId
string
requiredYour workspace ID. How to find it?
projectName
string
requiredYour project name. It is the name you provide when creating a project.
queueId
string
requiredYour queue ID. It is the ID of the queue you provided when creating it.
Body
application/json
An item to be appended once to the queue.
apiName
string
requiredThe name of the API to be executed. This is the file path relative to the api
folder inside your project.
parameters
The parameters to be passed to the API.
retry
object
Retry policy configurations
Response
201 - application/json
runId
string
requiredstatus
enum<string>
requiredAvailable options:
queued