Prompts

List prompts

The buyer questions this project tracks.

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

Plan: Grow and above
Key: read
Rate cost: 1 unit
MCP tool: list_prompts

List prompts

curl --request GET \
  --url "https://api.vidrys.com/v1/projects/{project_id}/prompts?status=active&page_size=50" \
  --header "Authorization: Bearer $VIDRYS_API_KEY"

200 · success

{
  "prompts": [
    {
      "id": "0e9a7c55-2b3d-4c1e-8f6a-9d0b1c2e3f4a",
      "text": "best invoicing software for freelancers in India",
      "category": "Commercial",
      "status": "active"
    },
    {
      "id": "b7c3d1e9-4a52-4f8b-91c6-3e5d7a9f2b10",
      "text": "Acme Invoicing vs Northwind Billing",
      "category": "Comparison",
      "status": "active"
    }
  ],
  "page": {
    "page": 1,
    "page_size": 50,
    "total": 2
  }
}

Authorization

Sent as a header on every request.

Authorizationstringrequired

A Vidrys API key, sent as Bearer vidrys_sk_…. A read key is enough. See Authentication.

Path parameters

project_idstringrequired

The project's id, from List projects.

Query parameters

statusenum<string>

Keep only prompts in this state.

Values:activeinactivearchived

pageintegerdefault 1

Page number, from 1.

page_sizeintegerdefault 50

Rows per page, 1–100.

Response · 200

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

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.