PATCH
Update Topic

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Headers

Idempotency-Key
string | null

Any unique string, such as a UUID. Send the same key again to get the first answer and not a second write. The API keeps an answer for 24 hours.

Path Parameters

topic_id
integer
required

A topic of the brand.

brand_id
integer
required

Body

application/json

Only the fields that the request sends change.

answer_engines
enum<string>[] | null

The answer engines of the topic. With no list, the topic uses the engines of the brand. [] goes back to the engines of the brand.

The answer engines that the public API names.

The platform also runs models of the API of OpenAI for its own work, such as gpt-4o. A customer does not choose them, thus the public API does not name them. Each value is a value of dtos.simulation.LlmModel.

Available options:
chatgpt.com,
google-ai-overview,
perplexity,
claude,
google-ai-mode,
google-gemini,
copilot,
deepseek,
grok,
gpt-5.4
language
string | null
Required string length: 1 - 64
name
string | null
Required string length: 1 - 255
persona_id
integer | null

A persona of the brand.

status
enum<string> | null
Available options:
active,
pause

Response

Successful Response

created_at
string<date-time>
required
id
integer
required
language
string
required
name
string
required
status
string
required
type
string
required
answer_engines
string[] | null

The answer engines that run the topic.

persona_id
integer | null

The persona whose questions the scenarios ask.

scenarios
PublicScenario · object[]
tags
PublicTag · object[]