Prompts

Add prompts

Track new questions. Up to 50 per call, and they start active, so the next sweep asks them.

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

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

The plan's prompt limit is counted across the whole workspace (or the whole account, when one plan covers several workspaces) and over the batch as a whole: 41 prompts against a limit of 40 adds none of them.

Add prompts

curl --request POST \
  --url "https://api.vidrys.com/v1/projects/{project_id}/prompts" \
  --header "Authorization: Bearer $VIDRYS_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "prompts": [
    {
      "text": "which invoicing tools support GST e-invoicing",
      "category": "Commercial"
    },
    {
      "text": "cheapest invoicing software for a solo consultant",
      "category": "Commercial"
    }
  ]
}'

201 · success

{
  "prompts": [
    {
      "id": "1f2e3d4c-5b6a-4790-8123-456789abcdef",
      "text": "which invoicing tools support GST e-invoicing",
      "category": "Commercial",
      "status": "active"
    },
    {
      "id": "2a3b4c5d-6e7f-4809-9234-56789abcdef0",
      "text": "cheapest invoicing software for a solo consultant",
      "category": "Commercial",
      "status": "active"
    }
  ],
  "page": {
    "page": 1,
    "page_size": 2,
    "total": 2
  }
}

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.

Body

application/json

promptsobject[]required

Between 1 and 50 prompts.

+Show child attributes

textstringrequired

The question, 1–1000 characters.

categorystring

Free-text grouping, up to 255 characters.

Response · 201

application/json

promptsobject[]

The prompts.

+Show child attributes

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

pageobject

Where these rows sit in the full list.

+Show child attributes

pageinteger

This page's number, from 1.

page_sizeinteger

Rows per page.

totalinteger

Rows across every page.

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.