Nexscope

AI Search Citation Sample

Check which sources ChatGPT cites when it answers a query. Call the AI Search Citation Sample API via REST or MCP to automate SEO research.

CostRecent 10 credits / call
Try online
POST · https://api.nexscope.ai/seo/aiSearchCitationSampleMCP · nexscope_seo_ai_search_citation_sample
AI Visibility

What this API does

Check which sources ChatGPT cites when it answers a query. The request accepts prompt. Its documented result includes answerMarkdown, checkUrl, citations.domain, citations.publishedAt, citations.snippet, citations.sourceName, citations.title, citations.url. Generation runs as a task: retain the task ID and retrieve the completed result before using the output.

AI Search Citation Sample API use cases

Find products matching a sourcing brief

To find products matching a sourcing brief, a search marketer submits prompt to AI Search Citation Sample. The returned answerMarkdown, checkUrl, citations.domain help identify products matching the requested search criteria.

Compare a product search shortlist

A search marketer uses AI Search Citation Sample with prompt to compare a product search shortlist. The returned answerMarkdown, checkUrl, citations.domain help compare candidates before requesting individual product details.

Collect candidates for a market review

For this workflow, a search marketer calls AI Search Citation Sample with prompt to collect candidates for a market review. The result helps choose products for a supplier or competitor review.

AI Search Citation Sample API FAQ

What does the AI Search Citation Sample API return?

Check which sources ChatGPT cites when it answers a query. The documented output includes answerMarkdown, checkUrl, citations.domain, citations.publishedAt, citations.snippet, citations.sourceName, citations.title, citations.url. It corresponds to the supplied prompt. The initial response can contain a task ID and status; the completed task result contains the generated output. Example values illustrate the response shape, rather than live account results.

How many credits does the AI Search Citation Sample API cost?

The current documented cost is Recent 10 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the AI Search Citation Sample API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/seo/aiSearchCitationSample with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_seo_ai_search_citation_sample. The same documented request parameters apply; use Online test to review a request before adding it to your app.

View plans and creditsConnect this API with MCP

Try this API
Endpoint
https://api.nexscope.ai/seo/aiSearchCitationSample
MCP method
nexscope_seo_ai_search_citation_sample

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx
Missing or invalid API keys return an authentication error. Manage keys from .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/seo/aiSearchCitationSample

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/seo/aiSearchCitationSample' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prompt": "nexscope"
}'

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

CodeDescription
200HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI execution or upstream service failed.
All categories/ AI Visibility
POSThttps://api.nexscope.ai/seo/aiSearchCitationSample

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/seo/aiSearchCitationSample
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
promptstringrequired
Prompt value used by this API operation.
Minimum length: 1
Maximum length: 2000

Code example

{
  "prompt": "nexscope"
}

Response example

Example response envelope from the documented SEO API contract.

{
  "code": 0,
  "cost": "-1",
  "data": {
    "callId": "synthetic-call",
    "completedAt": null,
    "coverage": {
      "missing": [
        {
          "field": "synthetic",
          "reason": "UPSTREAM_FIELD_MISSING"
        }
      ],
      "status": "PARTIAL"
    },
    "requestedAt": "123",
    "result": {
      "answerMarkdown": "synthetic",
      "checkUrl": "synthetic",
      "citations": [
        {
          "domain": "synthetic",
          "publishedAt": 9007199254740992,
          "snippet": "synthetic",
          "sourceName": "synthetic",
          "title": "synthetic",
          "url": "synthetic"
        }
      ],
      "meta": {
        "market": {
          "country": "synthetic",
          "language": "synthetic",
          "locationCode": 1
        },
        "missing": [
          {
            "path": "synthetic",
            "reason": "synthetic"
          }
        ],
        "missingOverflow": false,
        "retrievedAt": 9007199254740992,
        "sampledAt": 9007199254740992,
        "source": "synthetic",
        "truncated": false
      },
      "model": "synthetic",
      "prompt": "synthetic"
    },
    "schemaVersion": "synthetic",
    "source": "synthetic",
    "status": "PARTIAL",
    "usage": {
      "billingStatus": "UNAPPROVED",
      "chargedCredits": "0"
    }
  },
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": "synthetic-trace",
  "ts": "9007199254740993"
}

Response fields

NameTypeRequiredDescription
codeintegerrequired
0 is a successful envelope; inspect data.status separately.
Allowed: 0, 42008, 42009
coststringrequired
Elapsed processing milliseconds; not price. -1 for non-web context.
dataobjectrequired
Data value used by this API operation.
data.callIdstring | nulloptional
Call id value used by this API operation.
data.completedAtstring | integer | nulloptional
Completed at value used by this API operation.
data.coverageobjectoptional
Coverage value used by this API operation.
data.coverage.missingarrayoptional
Missing value used by this API operation.
data.coverage.missing[]objectrequired
Item in data coverage missing.
data.coverage.missing[].fieldstringoptional
Field value used by this API operation.
data.coverage.missing[].reasonstringoptional
Reason value used by this API operation.
data.coverage.statusstringoptional
Status value used by this API operation.
data.requestedAtstring | integer | nulloptional
Requested at value used by this API operation.
data.resultobject | nullrequired
Result value used by this API operation.
data.result.answerMarkdownanyrequired
Answer markdown value used by this API operation.
data.result.checkUrlanyrequired
Check url value used by this API operation.
data.result.citationsarrayrequired
Citations value used by this API operation.
Maximum items: 50
data.result.citations[]objectrequired
Item in data result citations.
data.result.citations[].domainanyrequired
Domain value used by this API operation.
data.result.citations[].publishedAtanyrequired
Published at value used by this API operation.
data.result.citations[].snippetanyrequired
Snippet value used by this API operation.
data.result.citations[].sourceNameanyrequired
Source name value used by this API operation.
data.result.citations[].titleanyrequired
Title value used by this API operation.
data.result.citations[].urlanyrequired
Url value used by this API operation.
data.result.metaobjectrequired
Meta value used by this API operation.
data.result.meta.marketobjectrequired
Market value used by this API operation.
data.result.meta.market.countrystringrequired
Country value used by this API operation.
Constant: US
data.result.meta.market.languagestringrequired
Language value used by this API operation.
Constant: en
data.result.meta.market.locationCodeintegerrequired
Location code value used by this API operation.
Constant: 2840
data.result.meta.missingarrayrequired
Missing value used by this API operation.
Maximum items: 100
data.result.meta.missing[]objectrequired
Item in data result meta missing.
data.result.meta.missing[].pathstringrequired
Path value used by this API operation.
data.result.meta.missing[].reasonstringrequired
Reason value used by this API operation.
Allowed: MISSING, NULL, INVALID, UNSUPPORTED, TRUNCATED
data.result.meta.missingOverflowbooleanrequired
Missing overflow value used by this API operation.
data.result.meta.retrievedAtanyrequired
Retrieved at value used by this API operation.
data.result.meta.sampledAtanyrequired
Sampled at value used by this API operation.
data.result.meta.sourcestringrequired
Source value used by this API operation.
Constant: DATAFORSEO_CHATGPT_INTERFACE
data.result.meta.truncatedbooleanrequired
Truncated value used by this API operation.
data.result.modelanyrequired
Model value used by this API operation.
data.result.promptstringrequired
Prompt value used by this API operation.
Maximum length: 2000
data.schemaVersionstring | nulloptional
Schema version value used by this API operation.
data.sourcestring | nulloptional
Source value used by this API operation.
data.statusstringoptional
Status value used by this API operation.
Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED
data.usageobject | nulloptional
Usage value used by this API operation.
data.usage.billingStatusstring | nulloptional
Billing status value used by this API operation.
data.usage.chargedCreditsstring | integer | nulloptional
Charged credits value used by this API operation.
msgstring | nullrequired
Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
timestringrequired
yyyy-MM-dd HH:mm:ss
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds; global long serializer.

Any of option 1

NameTypeRequiredDescription
data.result.answerMarkdownstringrequired
Answer markdown value used by this API operation.
Maximum length: 65536

Any of option 2

NameTypeRequiredDescription
data.result.answerMarkdownnullrequired
Answer markdown value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.checkUrlstringrequired
Check url value used by this API operation.
Maximum length: 4096

Any of option 2

NameTypeRequiredDescription
data.result.checkUrlnullrequired
Check url value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.citations[].domainstringrequired
Domain value used by this API operation.
Maximum length: 1024

Any of option 2

NameTypeRequiredDescription
data.result.citations[].domainnullrequired
Domain value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.citations[].publishedAtintegerrequired
Published at value used by this API operation.
Minimum: 0
Maximum: 9007199254740991

Any of option 2

NameTypeRequiredDescription
data.result.citations[].publishedAtnullrequired
Published at value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.citations[].snippetstringrequired
Snippet value used by this API operation.
Maximum length: 8192

Any of option 2

NameTypeRequiredDescription
data.result.citations[].snippetnullrequired
Snippet value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.citations[].sourceNamestringrequired
Source name value used by this API operation.
Maximum length: 1024

Any of option 2

NameTypeRequiredDescription
data.result.citations[].sourceNamenullrequired
Source name value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.citations[].titlestringrequired
Title value used by this API operation.
Maximum length: 1024

Any of option 2

NameTypeRequiredDescription
data.result.citations[].titlenullrequired
Title value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.citations[].urlstringrequired
Url value used by this API operation.
Maximum length: 4096

Any of option 2

NameTypeRequiredDescription
data.result.citations[].urlnullrequired
Url value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.meta.retrievedAtintegerrequired
Retrieved at value used by this API operation.
Minimum: 0
Maximum: 9007199254740991

Any of option 2

NameTypeRequiredDescription
data.result.meta.retrievedAtnullrequired
Retrieved at value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.meta.sampledAtintegerrequired
Sampled at value used by this API operation.
Minimum: 0
Maximum: 9007199254740991

Any of option 2

NameTypeRequiredDescription
data.result.meta.sampledAtnullrequired
Sampled at value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.result.modelstringrequired
Model value used by this API operation.
Maximum length: 1024

Any of option 2

NameTypeRequiredDescription
data.result.modelnullrequired
Model value used by this API operation.

Accepted processing response

code 0 confirms acceptance. Use data.callId to query the same request; processing is not completion.

NameTypeRequiredDescription
codeintegerrequired
0 is a successful envelope; inspect data.status separately.
Constant: 0
coststringrequired
Elapsed processing milliseconds; not price. -1 for non-web context.
dataobjectrequired
Data value used by this API operation.
data.callIdstring | nullrequired
Call id value used by this API operation.
data.reasonstringrequired
Reason value used by this API operation.
Constant: IN_PROGRESS
data.retryablebooleanoptional
Retryable value used by this API operation.
data.statusstringrequired
Status value used by this API operation.
Constant: PROCESSING
data.taskIdstring | nulloptional
Task id value used by this API operation.
msgstring | nullrequired
Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
timestringrequired
yyyy-MM-dd HH:mm:ss
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds; global long serializer.

Error response

NameTypeRequiredDescription
codeintegerrequired
0 is a successful envelope; inspect data.status separately.
coststringrequired
Elapsed processing milliseconds; not price. -1 for non-web context.
dataobjectrequired
Data value used by this API operation.
data.callIdstring | nullrequired
Call id value used by this API operation.
data.reasonstring | nullrequired
Reason value used by this API operation.
data.retryablebooleanoptional
Retryable value used by this API operation.
data.statusstring | nullrequired
Status value used by this API operation.
data.taskIdstring | nulloptional
Task id value used by this API operation.
msgstring | nullrequired
Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry.
timestringrequired
yyyy-MM-dd HH:mm:ss
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds; global long serializer.

Retrieve a processing result

A response with PROCESSING and a callId means the result is still being prepared. Use the result query below with the returned identifier. This lookup reads the stored result and does not spend credits.

curl -X GET https://api.nexscope.ai/seo/aiSearchCitationSample/calls/{callId} \
  -H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"

Responses

CodeDescription
200HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI execution or upstream service failed.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json
Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_seo_ai_search_citation_sample",
    "arguments": {
      "prompt": "nexscope"
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /mcp/legacy

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

Uses your signed-in Nexscope session
SEO API Lab

AI Search Citation Sample

Check which sources ChatGPT cites when it answers a query. Call the AI Search Citation Sample API via REST or MCP to automate SEO research.

Live request
Estimated 152 credits / callAPI usage records
*
Value sent as the “prompt” request parameter.

Up to 2000 characters

Live calls may use Data credits.

Processing result

If a request is still processing, use the returned identifier to retrieve its stored result. The tester recognizes the identifier automatically, and result queries do not spend credits.

Live response

Results

Your live result will appear here.

Complete the request fields above and run the API. No sample response is substituted.

Test with an API key or MCP
Estimated 152 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint
/seo/aiSearchCitationSample
Processing result endpoint
https://api.nexscope.ai/seo/aiSearchCitationSample/calls/{resultId}
MCP method
nexscope_seo_ai_search_citation_sample
cURL
curl -X POST \
  https://api.nexscope.ai/seo/aiSearchCitationSample \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "prompt": "nexscope" }'
Response
No response yet. Run the request to see the response here.
Processing result

Use the identifier returned by Run request. The tester selects the correct result query automatically, and result queries do not spend credits.

Result response
No task result yet. Query the task to see the generated output here.

Related APIs