Docs Sign inGet started
API reference · Prompts

Fill prompts

Fill open prompt slots toward a mix: library questions, then questions written for the brand (needs a write key).

Needs a write key. Questions written for the brand are on paid plans
POST/api/v1/projects/{project}/prompts/fill

Open slots are shared by every project in the workspace, so filling one project can use them all. Activated prompts are asked from the next run.

Path parameters

projectstringRequired

The project's id, from List projects. Its main website, like acme.example, also works when only one project has it.

Body

splitarray

The mix to aim for, in percent, as {unbranded, competitor, yours}. Counts the project's active prompts. Default 70 / 20 / 10.

topicsarray

Topics to draw from, by name. Default: all, the project's own topics first.

Returns

activated.libraryinteger

Library questions activated, balanced across the topics.

activated.writteninteger

Questions written for the brand and activated (paid plans, where the library runs short of the mix).

activated.unbrandedinteger

Of all those, how many name no brand; competitor and yours count the rest.

open_slotsinteger

Prompts the workspace's plan still covers after filling.

Every response includes the project and the filters that were applied. Errors use the standard error object.