POST
/
{workspaceId}
/
projects
/
{projectName}
/
jobs

Authorizations

x-api-key
string
headerrequired

API Key used to authenticate your requests. How to create one.

Path Parameters

workspaceId
string
required

Your workspace ID. How to find it?

projectName
string
required

Your project name. It is the name you provide when creating a project.

Body

application/json
authSession
object

Auth session configurations

id
string
required

The ID of the job. Has to be a valid URL slug.

payload
object[]
required

A list of the initial payloads of the job.

schedule
object

Schedule configurations for the job. If set, the job will periodically run according to this configuration. The configurations are used to calculate the closest next run time.

sink
object | null

A sink to send the results to. Can be a webhook or Amazon S3 bucket.

configuration
object
required

The configuration of the job. Configures the retry policy and maximum concurrent requests.

Response

201 - application/json
id
string
message
enum<string>
Available options:
created
Get JobsGet Job