Create a topic

POST/v1/topics

Body Parameters

namestringrequired
At most 60 characters.
descriptionstring
At most 200 characters. Nullable.

Responses

201Topic
The topic
400Error
Invalid request, or the topic limit is reached
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
409Error
A topic with that name exists
429Error
Rate limit or quota exceeded

Response Fields

idstring
Example: tp_marketing.
objecttopic
namestring
descriptionstring
Nullable.
builtinboolean
created_atstring (date-time)
updated_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

400
Invalid request, or the topic limit is reached
401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
409
A topic with that name exists
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/topics', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example"
  }),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 201

{
  "id": "tp_marketing",
  "object": "topic"
}