POST
/
jobs
/
{job_id}
/
run
const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const job_id = '<job_id>'; // Replace <job_id> with the actual job ID

fetch(`https://api.lume.ai/jobs/${job_id}/run`, {
    method: 'POST',
    headers: headers,
})
.then(response => {
    if (!response.ok) {
        throw new Error('Network response was not ok');
    }
    return response.json();
})
.then(data => console.log(data))
.catch(err => console.error('Error:', err));
{
    "id": "17f8a2fd-ea3e-45e2-b91f-a00177ff7505",
    "created_at": "2024-02-29T02:27:39.962961Z",
    "job_id": "5b9e1989-2847-4364-88e5-9ff6a1ffa8bf",
    "workshop_id": null,
    "pipeline_id": "243876bd-5beb-4c71-8b43-a5a8a91b6ec9",
    "status": "finished",
    "updated_at": "2024-02-29T02:27:45.899559Z"
}

Runs a job.

See the Job Guide to learn more.

const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const job_id = '<job_id>'; // Replace <job_id> with the actual job ID

fetch(`https://api.lume.ai/jobs/${job_id}/run`, {
    method: 'POST',
    headers: headers,
})
.then(response => {
    if (!response.ok) {
        throw new Error('Network response was not ok');
    }
    return response.json();
})
.then(data => console.log(data))
.catch(err => console.error('Error:', err));
{
    "id": "17f8a2fd-ea3e-45e2-b91f-a00177ff7505",
    "created_at": "2024-02-29T02:27:39.962961Z",
    "job_id": "5b9e1989-2847-4364-88e5-9ff6a1ffa8bf",
    "workshop_id": null,
    "pipeline_id": "243876bd-5beb-4c71-8b43-a5a8a91b6ec9",
    "status": "finished",
    "updated_at": "2024-02-29T02:27:45.899559Z"
}

Authorizations

lume-api-key
string
headerrequired

Path Parameters

job_id
string
required

Body

application/json
immediate_return
boolean | null

Response

200 - application/json
id
string
required

The unique identifier of this object

created_at
string
required

The date and time this object was created

job_id
string | null
required

The id of the job the result is associated with

workshop_id
string | null
required

The id of the workshop the result is associated with

pipeline_id
string
required

The id of the pipeline the result is associated with

status
enum<string>
required

The status of the mapping task

Available options:
created,
running,
finished,
failed,
needs review
spec
object | null

The spec of the data to be transformed

updated_at
string | null
required

The date and time this object was last updated