Skip to main content
Get a topic proposal

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.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as topics.ref. id is always returned. Fields: id, agreement_id, operation, topic_ids, instructions, topics, groups, warnings, created_at, applied_at.

citation_context
enum<string>

true adds context_before and context_after to document citations: the text around each quote, used to locate it in the document.

Available options:
true,
false

Response

The topic proposal.

id
string<uuid>
required
agreement_id
string<uuid>
required
operation
enum<string>
required
Available options:
merge,
split
topic_ids
string<uuid>[]
required

The topics the proposal replaces.

instructions
string | null
required
topics
object[]
required

The topics applying creates.

groups
object[]
required

Alerts that move together. Every alert of the selected topics is in one group.

warnings
string[]
required
created_at
string<date-time>
required
applied_at
string<date-time> | null
required