Prompts

add_prompts

Track new buyer questions (up to 50 per call, within the plan's prompt limit). Scale and Custom plans.

writeChanges your workspace. Needs a read-and-write credential.

Plan: Scale and Custom
Rate cost: 1 unit
REST: POST /projects/{project_id}/prompts

Try asking

“Track these three questions our sales team keeps hearing.”

add_prompts

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_prompts",
    "arguments": {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompts": [
        {
          "text": "which invoicing tools support GST e-invoicing",
          "category": "Commercial"
        }
      ]
    }
  }
}

structuredContent

{
  "content": [
    {
      "type": "text",
      "text": "…the same JSON, as text…"
    }
  ],
  "structuredContent": {
    "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
    }
  },
  "isError": false
}

Arguments

Passed as the tool call's arguments.

project_idstringrequired

The project to read, from list_projects.

promptsobject[]required

1–50 questions.

+Show child attributes

textstringrequired

The question, 1–1000 characters.

categorystring

Free-text grouping.

Result

The same object as Add prompts, returned as structured output.

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.

Failures arrive as a tool error — isError: true with code: message as text. See Using the tools.