GET
/
workshops
/
{WorkShop_id}
const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const workshop_id = '<workshop_id>';

fetch(`https://api.lume.ai/workshops/${workshop_id}`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.catch(err => console.error(err));
{
  "id": "196a1af0-420f-4a33-aa6c-8deb053c3f69",
  "created_at": "2024-02-29T02:30:23.459676Z",
  "job_id": "5b9e1989-2847-4364-88e5-9ff6a1ffa8bf",
  "pipeline_id": "243876bd-5beb-4c71-8b43-a5a8a91b6ec9",
  "status": "created",
  "updated_at": null
}

Gets an existing workshop.

See the Workshop Guide to learn more.

const headers = {'Content-Type': 'application/json', 'API-Key': '<lume_api_key>'};
const workshop_id = '<workshop_id>';

fetch(`https://api.lume.ai/workshops/${workshop_id}`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.catch(err => console.error(err));
{
  "id": "196a1af0-420f-4a33-aa6c-8deb053c3f69",
  "created_at": "2024-02-29T02:30:23.459676Z",
  "job_id": "5b9e1989-2847-4364-88e5-9ff6a1ffa8bf",
  "pipeline_id": "243876bd-5beb-4c71-8b43-a5a8a91b6ec9",
  "status": "created",
  "updated_at": null
}

Authorizations

lume-api-key
string
headerrequired

Path Parameters

WorkShop_id
string
required

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
required

The id of the job the WorkShop is associated with

pipeline_id
string
required

The id of the pipeline the WorkShop is associated with

status
enum<string>
required

The status of the Workshop. This status will be set to 'deployed' if the workshop was most recently deployed. If the workshop has either not yet been deployed or has been run since last deployment, it will reflect the status of the most recent result

Available options:
created,
running,
finished,
failed,
needs review,
deployed
updated_at
string | null
required

The date and time this object was last updated