Prompt Research

curl --request POST \
  --url https://api.querying.ai/v1/prompt-research \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "seed": "선크림",
  "country": "KR",
  "limit": 20,
  "brand": "MyBrand"
}
'

{
  "success": true,
  "task": {
    "id": "4299622a-1321-43a9-b780-809a0116f1b5",
    "taskType": "PROMPT_RESEARCH",
    "status": "QUEUED",
    "priority": 1,
    "createdAt": "2026-09-28T13:03:26.092Z"
  },
  "credits": {
    "creditsToCharge": 0,
    "creditsCharged": 0
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

POST

prompt-research

curl --request POST \
  --url https://api.querying.ai/v1/prompt-research \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "seed": "선크림",
  "country": "KR",
  "limit": 20,
  "brand": "MyBrand"
}
'

{
  "success": true,
  "task": {
    "id": "4299622a-1321-43a9-b780-809a0116f1b5",
    "taskType": "PROMPT_RESEARCH",
    "status": "QUEUED",
    "priority": 1,
    "createdAt": "2026-09-28T13:03:26.092Z"
  },
  "credits": {
    "creditsToCharge": 0,
    "creditsCharged": 0
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>"
      }
    ],
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Autorisierungen

Authorization

string

header

erforderlich

Your API key, sent as Authorization: Bearer <key>.

Body

application/json

seed

string

erforderlich

The topic: letters, digits and single spaces, such as 선크림. A short product or category term works best; a sentence finds nothing.

Required string length: 1 - 30

country

enum<string>

erforderlich

Market: KR (South Korea) or US (United States). Any other value is a 422 REGION_UNSUPPORTED.

Verfügbare Optionen:

KR,

US

limit

integer

Standard:20

Prompts to return.

Erforderlicher Bereich: 1 <= x <= 50

exclude

string[]

Terms to leave out, such as a subtopic you do not want. A prompt containing one is left out. Put your own brand in brand.

Maximum array length: 20

Required string length: 1 - 30

monitorSize

integer

Standard:20

Prompts in monitorSet.

Erforderlicher Bereich: 1 <= x <= 50

monitorEngines

enum<string>[]

The engines your monitor will run. A monitor runs at most 200 prompt × engine tasks at a time, so monitorSize × the number of engines above 200 is a 422 VALIDATION_ERROR on monitorSize. It does not change the result.

Required array length: 1 - 12 elements

An engine a monitor can schedule: the prompt surfaces sold to customers plus the deprecated NAVER alias. GOOGLE_AIO and GOOGLE_AIMODE are accepted as input aliases and echoed as GOOGLE and AIMODE. SOURCE_INFLUENCE is an analysis task, not a prompt surface, and cannot be scheduled on a monitor.

Verfügbare Optionen:

CHATGPT,

GEMINI,

PERPLEXITY,

GOOGLE,

AIMODE,

NAVER_AI_BRIEF,

NAVER_AI_TAB,

NAVER

brand

string

Your brand, with at least two letters or digits; punctuation is allowed. Prompts containing it are left out, as with exclude.

Required string length: 1 - 80

brandAliases

string[]

Other names or spellings of your brand, left out the same way. Requires brand.

Maximum array length: 10

Required string length: 1 - 80

brandDescription

string

What your brand sells and to whom. Requires brand. Adds fit to every prompt, which monitorSet weighs.

Maximum string length: 500

idempotencyKey

string

Optional. Deduplicates submissions; a duplicate is a 409.

webhook

object

Optional. Omit to collect the result by polling instead.

Show child attributes

Antwort

Queued; poll /v1/async/task/{id}. Its response follows PromptResearchResult.

success

boolean

erforderlich

task

object

erforderlich

Show child attributes

credits

object

erforderlich

Submit and polling envelopes preserve zero values. With billing enabled, account settlement uses the engine pricing policy; webhooks report the persisted charge. SOURCE_INFLUENCE is metered by actual usage.

Show child attributes

Tasks

Betrieb

Autorisierungen

Body

Antwort