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

fetch(`https://api.lume.ai/jobs/${job_id}/workshops`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.catch(err => console.error(err));
{
  "items": [
    {
      "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
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50,
  "pages": 1
}

Gets all workshops for a designated pipeline.

See the Workshop Guide to learn more.

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

fetch(`https://api.lume.ai/jobs/${job_id}/workshops`, {
    method: 'GET',
    headers: headers,
})
.then(response => response.json())
.catch(err => console.error(err));
{
  "items": [
    {
      "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
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50,
  "pages": 1
}

Authorizations

lume-api-key
string
headerrequired

Path Parameters

pipeline_id
string
required

Query Parameters

page
integer
default: 1

Page number

size
integer
default: 50

Page size

Response

200 - application/json
items
object[]
required
total
integer | null
required
page
integer | null
required
size
integer | null
required
pages
integer | null