API reference · Models

Update models

Change models and frequency (needs a write key).

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

PUT/api/v1/models

Takes effect from the next run. Refused with 409 over_allowance when more prompts are active than the new setup covers: archive some first, or choose fewer models or a lower frequency.

Body

modelsarrayRequired

Model keys, like chatgpt or claude-sonnet-4-5+web+high. See the catalog in GET /models.

frequencystringRequired

daily, 2d (every 2 days), 2w (twice a week) or weekly.

Returns

modelsarray

The models, as {key, label}.

frequencystring

daily, 2d, 2w or weekly; frequency_label has its name.

prompts_coveredinteger

Active prompts the plan covers with these models at this frequency, across all projects.

active_promptsinteger

Active prompts now, across all projects.

fitsboolean

Whether the active prompts fit.

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

curl -X PUT https://getonym.com/api/v1/models \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"models": ["chatgpt", "google-ai-overviews", "perplexity", "claude-sonnet-4-5+web"], "frequency": "daily"}'

import requests r = requests.put( "https://getonym.com/api/v1/models", headers={"Authorization": "Bearer YOUR_API_KEY"}, json={"models": ["chatgpt", "google-ai-overviews", "perplexity", "claude-sonnet-4-5+web"], "frequency": "daily"}, ) print(r.json())

const r = await fetch("https://getonym.com/api/v1/models", { method: "PUT", headers: { Authorization: "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, body: JSON.stringify({"models": ["chatgpt", "google-ai-overviews", "perplexity", "claude-sonnet-4-5+web"], "frequency": "daily"}), }); console.log(await r.json());

{ "models": [ { "key": "chatgpt", "label": "ChatGPT" }, { "key": "google-ai-overviews", "label": "Google AI Overviews" } ], "frequency": "daily", "frequency_label": "Daily", "prompts_covered": 51, "active_prompts": 19, "fits": true }