API reference

Every request is scoped to one organization — whichever one your key belongs to. Read the machine-readable spec at https://stageb.learninclusive.co.uk/v1/openapi.json.

Authentication

Create a key from Dashboard → API & webhooks, then send it as a bearer token on every request:

Authorization: Bearer ad_live_...

get/repositories

List repositories

Every repository the organization's GitHub App installation(s) can see, as a flat list. Returns { "repositories": [{ "id", "fullName", "defaultBranch", "accountLogin" }, ...] } — an empty array means no GitHub App installation is connected for this organization yet, not an error.

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories

get/repositories/{id}

Get a repository

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories/:id

post/repositories/{id}/generate

Start a generation run

Analyzes the repository's default branch (or the commit/branch you pass) and generates the requested artifacts.

curl \
  -X POST \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories/:id/generate

get/repositories/{id}/runs

List generation runs for a repository

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories/:id/runs

get/runs/{runId}

Get a generation run

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/runs/:runId

get/files/{fileId}

Get a generated file's content

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/files/:fileId

get/repositories/{id}/deploy-target

Get a repository's deploy target

Configuring a deploy target is dashboard-only for now — this is read-only via the API.

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories/:id/deploy-target

post/repositories/{id}/deploy

Trigger a deployment

Deploys the given commit to the repository's configured deploy target.

curl \
  -X POST \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories/:id/deploy

get/repositories/{id}/deployments

List deployment runs for a repository

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/repositories/:id/deployments

get/entitlements

Get the organization's plan and limits

curl \
  -H "Authorization: Bearer ad_live_..." \
  https://stageb.learninclusive.co.uk/v1/entitlements