PromptsGet a prompt

Get a prompt

Returns one prompt from the key's workspace.

Required scope: v2:prompts. Takes no query parameters.

A malformed id, or a prompt in another workspace, returns 404 PROMPT_NOT_FOUND.

curl -X GET "https://api.opttab.com/v1/external/prompts/33333333-3333-4333-8333-333333333333" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "33333333-3333-4333-8333-333333333333",
  "text": "What is the best running shoe for daily training?",
  "topicId": "22222222-2222-4222-8222-222222222222",
  "topicName": "Running shoes",
  "isActive": true,
  "cadence": "daily",
  "visibility": 42,
  "country": "US",
  "language": "en",
  "targetPlatforms": [
    "chatgpt",
    "perplexity"
  ],
  "tags": [
    {
      "name": "Running",
      "subTags": [
        "Daily"
      ]
    }
  ],
  "lastRunAt": "2026-10-18T12:00:00.000Z"
}
GET
/v1/external/prompts/{promptId}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.
path
promptIdstring
Required

The prompt's id, from GET /v1/external/prompts.

Format: uuid
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

Path Parameters

promptIdstring
Required

The prompt's id, from GET /v1/external/prompts.

Example:
33333333-3333-4333-8333-333333333333

Responses

idstring
Required

The prompt id.

textstring
Required

The question Opttab asks the AI engines.

topicIdstring
Required

The id of the prompt's topic.

topicNamestring
Required

The name of the prompt's topic.

isActiveboolean
Required

Whether the prompt is being tracked.

cadencestring
Required

How often the prompt is asked again.

Allowed values:dailyweeklymonthly
visibilitynumber
Required

The brand's visibility on this prompt, 0–100. null until there are results.

countrystring
Required

The target market, as a country code.

languagestring
Required

The prompt's language code.

targetPlatformsstring[]
Required

The AI engines this prompt runs on.

Allowed values:chatgptgrokgeminiclaudeperplexitydeepseekmistralgoogle_ai_modecopilotgoogle_ai_overview
tagsarray
Required

Tags on the prompt. Empty when there are none.

lastRunAtstring
Required

When the prompt last ran. null if it has not run yet.