Skip to main content
Create an alert topic

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
agreement_id
string<uuid>
required
title
string
required
Required string length: 1 - 200
description
string | null

Markdown. A new topic has no sources yet, so inline citations such as [1] are rejected.

Maximum string length: 100000
key_questions
string[]

Questions the supplier or reviewer should answer.

Maximum array length: 100
Required string length: 1 - 20000
alert_ids
string<uuid>[]

Alerts of the agreement to move into the topic, out of any other topic. Move more later with POST /v1/alert-topics/{id}/alerts.

Required array length: 1 - 5000 elements

Response

The new topic with its alert counts.

id
string<uuid>
required
agreement
object | null
required
title
string | null
required
description
string | null
required
is_locked
boolean
required
counts
object
required

Alerts by verdict, each split into credited and uncredited alerts.

organization_currency
object
required

Impact in the organization currency. Alerts without a converted impact are counted in missing_amount_count.

created_at
string<date-time>
required
updated_at
string<date-time>
required
key_questions
string[]
required
evidence
object
required