API reference · Prompts

Add prompts

Add questions (arrive as suggestions; needs a write key).

Needs a write key and a paid plan (Starter, Growth or Agency)

POST/api/v1/domains/{domain}/prompts

New prompts arrive as suggestions: they aren't asked and don't count toward your plan until someone activates them in Manage prompts. Texts shorter than 8 or longer than 500 characters, and duplicates, are skipped silently.

Path parameters

domainstringRequired

The domain's host, like acme.example, or its ID. List them with List domains.

Body

promptsarrayRequired

Question texts, 8 to 500 characters each. Duplicates of existing prompts are skipped.

topicstring

Topic to file them under. Defaults to Custom.

Returns

createdarray

The prompts that were added, as {id, text, status}. Status is always suggested.

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

curl https://getonym.com/api/v1/domains/acme.example/prompts \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"prompts": ["What's the best open-source auth server for a Django app?"], "topic": "Open source"}'

import requests r = requests.post( "https://getonym.com/api/v1/domains/acme.example/prompts", headers={"Authorization": "Bearer YOUR_API_KEY"}, json={"prompts": ["What's the best open-source auth server for a Django app?"], "topic": "Open source"}, ) print(r.json()["created"])

const r = await fetch("https://getonym.com/api/v1/domains/acme.example/prompts", { method: "POST", headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"prompts": ["What's the best open-source auth server for a Django app?"], "topic": "Open source"}), }); console.log((await r.json()).created);

{ "domain": "acme.example", "created": [ { "id": "3f9c2a1e-6b7d-4e8f-9a0b-1c2d3e4f5a6b", "text": "What's the best open-source auth server for a Django app?", "status": "suggested" } ] }