Prompts

Update a prompt

Edit a prompt's text or category, or pause, resume or archive it. Send only the fields you're changing.

PATCHhttps://api.vidrys.com/v1/projects/{project_id}/prompts/{prompt_id}

Plan: Scale and Custom
Key: read-and-write
Rate cost: 1 unit
MCP tool: update_prompt

Archiving frees the prompt's slot and keeps its history. Bringing an archived prompt back claims a slot again, so it fails with invalid_request when the plan's limit is already used up.

There is no delete: deleting a prompt would take its measurement history with it.

Update a prompt

curl --request PATCH \
  --url "https://api.vidrys.com/v1/projects/{project_id}/prompts/{prompt_id}" \
  --header "Authorization: Bearer $VIDRYS_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "status": "archived"
}'

200 · success

{
  "id": "0e9a7c55-2b3d-4c1e-8f6a-9d0b1c2e3f4a",
  "text": "best invoicing software for freelancers in India",
  "category": "Commercial",
  "status": "archived"
}

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. This call changes data, so the key must be read-and-write. See Authentication.

Path parameters

project_idstringrequired

The project's id, from List projects.

prompt_idstringrequired

The prompt to change.

Body

application/json

textstring

New wording, 1–1000 characters.

categorystring

New grouping.

statusenum<string>

active is asked every sweep, inactive is paused but still holds a slot, archived frees it.

Values:activeinactivearchived

Response · 200

application/json

idstring

Prompt id.

textstring

The question, as engines are asked it.

categorystringnullable

Free-text grouping, e.g. Comparison.

statusstring

active prompts are asked on every sweep. inactive ones are paused but still hold a slot in the plan's prompt limit. archived ones keep their history and free the slot.

Values:activeinactivearchived

Errors

403 write_not_allowed	The key is read-only. Writes need a read-and-write key, and read-and-write keys need Scale or Custom.
404 not_found	The project or item doesn't exist in this workspace. A project from another workspace also returns 404, never 403.
422 invalid_request	A parameter or body field is missing or has the wrong type or value. The message names the field. Also returned when a write would pass the plan's prompt limit.
401 unauthorized	No key was sent, or the key is unknown, revoked or expired, or the member who created it has left the workspace or been deactivated.
402 plan_required	The workspace's plan doesn't include API access. It's included on Grow, Scale and Custom.
403 workspace_not_approved	The workspace is still waiting for approval, or wasn't approved.
429 rate_limited	Too many requests this minute. Wait for the number of seconds in the `Retry-After` header, then retry.

Every code, and what to retry, is in Errors.