Skip to main content

Generations

SDK methods for the Generations module, accessed via soat.generations. See the Generations module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.generations.listGenerations()

List generations

  • Method: GET
  • Path: /api/v1/generations
await soat.generations.listGenerations({
query: { /* + optional */ },
});

Request & response schema

soat.generations.getGeneration()

Get a generation

  • Method: GET
  • Path: /api/v1/generations/{generation_id}
await soat.generations.getGeneration({
path: { generation_id },
});

Request & response schema

soat.generations.updateGeneration()

Update generation metadata

  • Method: PATCH
  • Path: /api/v1/generations/{generation_id}
await soat.generations.updateGeneration({
path: { generation_id },
body: { metadata },
});

Request & response schema