Skip to main content
POST
JavaScript

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating a new topic

title
string
required

Title of the topic

Minimum string length: 1
Example:

"Code Quality"

baseline
number · null · null

Optional baseline score for this topic

Example:

0.85

status
enum<string>

Status of the topic (defaults to ACTIVE if not provided)

Available options:
DRAFT,
ACTIVE
Example:

"ACTIVE"

quickstartId
string<uuid>

Optional quickstart ID to link this topic to

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Successfully created topic

Successful response containing the topic data

data
Topic · object
required

Details about a single Topic