Skip to main content
POST
/
{workspaceId}
/
projects
/
{projectName}
/
jobs
Python (SDK)
from intuned_client import IntunedClient
import os


with IntunedClient(
    workspace_id="123e4567-e89b-12d3-a456-426614174000",
    api_key=os.getenv("INTUNED_API_KEY", ""),
) as ic_client:

    res = ic_client.project.jobs.create(project_name="my-project", id="my-awesome-job", payload=[
        {
            "parameters": {
                "param1": "value1",
                "param2": 42,
                "param3": True,
            },
            "api_name": "my-awesome-api",
        },
    ], configuration={
        "retry": {},
    }, sink={
        "type": "s3",
        "bucket": "my-s3-bucket",
        "access_key_id": "AKIAIOSFODNN7EXSSPLE",
        "secret_access_key": "wJalrXUtnFFFI/K7MDENG/bPxRfiCYEXAMPLEKEY",
        "region": "us-west-2",
        "prefix": "my-prefix/",
        "skip_on_fail": False,
        "apis_to_send": [
            "api1",
            "api2",
        ],
        "endpoint": "https://s3.custom-endpoint.com",
        "force_path_style": True,
    }, proxy="http://username:password@proxy.example.com:8080", auth_session={
        "id": "<id>",
    })

    # Handle response
    print(res)
{
  "id": "<string>",
  "message": "created"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
workspaceId
string<uuid>
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

Job creation input schema

​
id
string
required

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

Minimum length: 7
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
payload
object[]
required

Array of API calls to be executed

​
configuration
object
required

Job configuration settings

​
schedule
object | null

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

Optional sink configuration for the job. Can be a webhook or S3 Compatible sink. Configuration for the webhook sink.

  • Webhook Sink Configuration
  • S3 Sink Configuration
​
proxy
string | null

Proxy configuration for the job

Example:

"http://username:password@proxy.example.com:8080"

​
auth_session
object | null

Response

Job created successfully.

​
id
string
required

The ID of the created job.

​
message
enum<string>
required
Available options:
created