Create a new topic

Creates a new topic.

POST /v0/topics

JavaScript

JavaScript

import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

const topic = await client.topics.create({ title: 'Code Quality' });

console.log(topic.data);

201

{
  "data": {
    "id": "789e4567-e89b-12d3-a456-426614174000",
    "orgId": "org_123456",
    "title": "Code Quality",
    "baseline": 0.85,
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "applicationId": "456e4567-e89b-12d3-a456-426614174000"
  }
}

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

Response

201

application/json

Successfully created topic

Successful response containing the topic data

data · Topic · object · required

Details about a single Topic

Show child attributes