Skip to content

Live phase of the in-flight Priority Orbit derivation

GET
/projects/{id}/prioritization/progress
curl --request GET \
--url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/prioritization/progress \
--cookie sb-access-token=<sb-access-token>

What the derive pass is doing right now, so the portal button can name the real backend phase instead of guessing from a timer. Polled every 2s while a derivation runs. phase: null means the project has no run on record. stale: true means the run stopped moving for more than three minutes and is abandoned — the page stops waiting on it rather than spinning forever. Plain polling, not a realtime channel: one row, one reader, ~two minutes.

id
required
string format: uuid

Project UUID

The project’s current derivation run, or an all-null shape when there is none

Media type application/json

One project’s current derivation run. Every field is null when the project has no run on record.

object
run_id
required

Identifies one derivation attempt, so a poller can tell its own run from someone else’s.

string | null format: uuid
phase
required

What the server is doing. done and failed are terminal — the page stops polling. null means no run has ever been recorded for this project.

string | null
Allowed values: starting loading_tickets grouping saving done failed
detail
required

Human-facing specific for the phase, rendered into the button label: the open-ticket count (loading_tickets), the model name (grouping), the topic count (saving), or the typed error’s name (failed).

string | null
started_at
required
string | null format: date-time
updated_at
required
string | null format: date-time
stale
required

updated_at is more than three minutes old on a non-terminal phase — the run died between phases and should not be waited on.

boolean

Not authenticated

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number
reconnect

True if re-linking GitHub may fix the issue

boolean

Forbidden

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number

Rate limited

Media type application/json
object
error
required

Human-readable error message

string
code

Stable machine-readable error code for client branching

string
fieldErrors

First validation message per field path

object
key
additional properties
string
issues

Structured validation issues (Zod)

Array<object>
object
path
required
string
message
required
string
retryAfter

Seconds until rate limit resets (429 responses)

number
retryAfter

Seconds until the rate limit resets

number
Retry-After
string