Skip to content
Yagra

Launch a background analysis job (operator+).

POST
/api/v1/analysis/jobs
curl --request POST \
  --url https://example.com/api/v1/analysis/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "baseline_secs": 1, "depth": "example", "family": "example", "notify": true, "scope_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope_kind": "example", "scope_label": "example", "sensitivity": 1, "tool": "example", "window_secs": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Request body to launch an analysis (launch drawer / report config bar).

object
baseline_secs
integer | null format: int64
depth
string | null
family
string | null
notify
boolean | null
scope_id
string | null format: uuid
scope_kind
required
string
scope_label
required
string
sensitivity
number | null format: double
tool
required
string
window_secs
required
integer format: int64
Examplegenerated
{
  "baseline_secs": 1,
  "depth": "example",
  "family": "example",
  "notify": true,
  "scope_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "scope_kind": "example",
  "scope_label": "example",
  "sensitivity": 1,
  "tool": "example",
  "window_secs": 1
}

Responses

Section titled “Responses”

200

Section titled “200”

The queued job row; it progresses over /api/v1/stream/analysis

Media typeapplication/json

A job row, as served to the API / SSE. Timestamps are epoch-millis so the WebUI formats relative times without a date dependency.

object
created_ms
required
integer format: int64
error
string | null
finding_count
required
integer format: int32
finished_ms
integer | null format: int64
id
required
string format: uuid
params
required
pct
required
integer format: int32
phase
string | null
scope_id
string | null format: uuid
scope_kind
required
string
scope_label
required
string
started_ms
integer | null format: int64
state
required
string
summary
string | null
tool
required
string
Examplegenerated
{
  "created_ms": 1,
  "error": "example",
  "finding_count": 1,
  "finished_ms": 1,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "params": "example",
  "pct": 1,
  "phase": "example",
  "scope_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "scope_kind": "example",
  "scope_label": "example",
  "started_ms": 1,
  "state": "example",
  "summary": "example",
  "tool": "example"
}

400

Section titled “400”

Unknown tool, unknown scope kind, or a group/node scope with no scope_id

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role below Operator

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429”

The runner is at its concurrency or rate limit — retryable

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Section titled “503”

This deployment has no runner

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}