Nexscope

POST/api/skill-api/v1/skills/seo-ai-search-citation-sample/run

Run this API

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

Endpoint

Method	`POST`
Path	`/api/skill-api/v1/skills/seo-ai-search-citation-sample/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`prompt`	`string`	required	Prompt value used by this API operation. Minimum length: 1 Maximum length: 2000

Request example

{
  "prompt": "example"
}

Response body

Name	Type	Required	Description
`code`	`integer`	required	0 is a successful envelope; inspect data.status separately. Allowed: 0, 42008, 42009
`cost`	`string`	required	Elapsed processing milliseconds; not price. -1 for non-web context.
`data`	`object`	required	Data value used by this API operation.
`data.callId`	`string \| null`	optional	Call id value used by this API operation.
`data.completedAt`	`integer \| null`	optional	Completed at value used by this API operation.
`data.coverage`	`object`	optional	Coverage value used by this API operation.
`data.coverage.missing`	`array`	optional	Missing value used by this API operation.
`data.coverage.missing[]`	`object`	required	Item in data coverage missing.
`data.coverage.missing[].field`	`string`	optional	Field value used by this API operation.
`data.coverage.missing[].reason`	`string`	optional	Reason value used by this API operation.
`data.coverage.status`	`string`	optional	Status value used by this API operation.
`data.requestedAt`	`integer \| null`	optional	Requested at value used by this API operation.
`data.result`	`object \| null`	required	Result value used by this API operation.
`data.result.answerMarkdown`	`any`	required	Answer markdown value used by this API operation.
`data.result.checkUrl`	`any`	required	Check url value used by this API operation.
`data.result.citations`	`array`	required	Citations value used by this API operation. Maximum items: 50
`data.result.citations[]`	`object`	required	Item in data result citations.
`data.result.citations[].domain`	`any`	required	Domain value used by this API operation.
`data.result.citations[].publishedAt`	`any`	required	Published at value used by this API operation.
`data.result.citations[].snippet`	`any`	required	Snippet value used by this API operation.
`data.result.citations[].sourceName`	`any`	required	Source name value used by this API operation.
`data.result.citations[].title`	`any`	required	Title value used by this API operation.
`data.result.citations[].url`	`any`	required	Url value used by this API operation.
`data.result.meta`	`object`	required	Meta value used by this API operation.
`data.result.meta.market`	`object`	required	Market value used by this API operation.
`data.result.meta.market.country`	`string`	required	Country value used by this API operation. Constant: US
`data.result.meta.market.language`	`string`	required	Language value used by this API operation. Constant: en
`data.result.meta.market.locationCode`	`integer`	required	Location code value used by this API operation. Constant: 2840
`data.result.meta.missing`	`array`	required	Missing value used by this API operation. Maximum items: 100
`data.result.meta.missing[]`	`object`	required	Item in data result meta missing.
`data.result.meta.missing[].path`	`string`	required	Path value used by this API operation.
`data.result.meta.missing[].reason`	`string`	required	Reason value used by this API operation. Allowed: MISSING, NULL, INVALID, UNSUPPORTED, TRUNCATED
`data.result.meta.missingOverflow`	`boolean`	required	Missing overflow value used by this API operation.
`data.result.meta.retrievedAt`	`any`	required	Retrieved at value used by this API operation.
`data.result.meta.sampledAt`	`any`	required	Sampled at value used by this API operation.
`data.result.meta.source`	`string`	required	Source value used by this API operation. Constant: DATAFORSEO_CHATGPT_INTERFACE
`data.result.meta.truncated`	`boolean`	required	Truncated value used by this API operation.
`data.result.model`	`any`	required	Model value used by this API operation.
`data.result.prompt`	`string`	required	Prompt value used by this API operation. Maximum length: 2000
`data.schemaVersion`	`string \| null`	optional	Schema version value used by this API operation.
`data.source`	`string \| null`	optional	Source value used by this API operation.
`data.status`	`string`	optional	Status value used by this API operation. Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED
`data.usage`	`object`	optional	Usage value used by this API operation.
`data.usage.billingStatus`	`string`	optional	Billing status value used by this API operation.
`data.usage.chargedCredits`	`integer \| null`	optional	Charged credits value used by this API operation.
`data.usage.providerCostStatus`	`string`	optional	Provider cost status value used by this API operation.
`data.usage.providerCostUsd`	`string \| null`	optional	Provider cost usd value used by this API operation.
`data.usage.providerRequests`	`integer`	optional	Provider requests value used by this API operation.
`msg`	`string \| null`	required	Msg value used by this API operation.
`time`	`string`	required	yyyy-MM-dd HH:mm:ss
`traceId`	`string \| null`	required	Trace id value used by this API operation.
`ts`	`string`	required	Epoch milliseconds; global long serializer.

Any of option 1

Name	Type	Required	Description
`data.result.answerMarkdown`	`string`	required	Answer markdown value used by this API operation. Maximum length: 65536

Any of option 2

Name	Type	Required	Description
`data.result.answerMarkdown`	`null`	required	Answer markdown value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.checkUrl`	`string`	required	Check url value used by this API operation. Maximum length: 4096

Any of option 2

Name	Type	Required	Description
`data.result.checkUrl`	`null`	required	Check url value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.citations[].domain`	`string`	required	Domain value used by this API operation. Maximum length: 1024

Any of option 2

Name	Type	Required	Description
`data.result.citations[].domain`	`null`	required	Domain value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.citations[].publishedAt`	`integer`	required	Published at value used by this API operation. Minimum: 0 Maximum: 9007199254740991

Any of option 2

Name	Type	Required	Description
`data.result.citations[].publishedAt`	`null`	required	Published at value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.citations[].snippet`	`string`	required	Snippet value used by this API operation. Maximum length: 8192

Any of option 2

Name	Type	Required	Description
`data.result.citations[].snippet`	`null`	required	Snippet value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.citations[].sourceName`	`string`	required	Source name value used by this API operation. Maximum length: 1024

Any of option 2

Name	Type	Required	Description
`data.result.citations[].sourceName`	`null`	required	Source name value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.citations[].title`	`string`	required	Title value used by this API operation. Maximum length: 1024

Any of option 2

Name	Type	Required	Description
`data.result.citations[].title`	`null`	required	Title value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.citations[].url`	`string`	required	Url value used by this API operation. Maximum length: 4096

Any of option 2

Name	Type	Required	Description
`data.result.citations[].url`	`null`	required	Url value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.meta.retrievedAt`	`integer`	required	Retrieved at value used by this API operation. Minimum: 0 Maximum: 9007199254740991

Any of option 2

Name	Type	Required	Description
`data.result.meta.retrievedAt`	`null`	required	Retrieved at value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.meta.sampledAt`	`integer`	required	Sampled at value used by this API operation. Minimum: 0 Maximum: 9007199254740991

Any of option 2

Name	Type	Required	Description
`data.result.meta.sampledAt`	`null`	required	Sampled at value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.result.model`	`string`	required	Model value used by this API operation. Maximum length: 1024

Any of option 2

Name	Type	Required	Description
`data.result.model`	`null`	required	Model value used by this API operation.

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,
      "providerCostStatus": "UNAPPROVED",
      "providerCostUsd": null,
      "providerRequests": 0
    }
  },
  "msg": null,
  "time": "2026-01-01 00:00:00",
  "traceId": null,
  "ts": "9007199254740993"
}

Responses

Code	Description
200	API executed successfully. Body is the direct response payload.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API 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.

Slug	`seo-ai-search-citation-sample`
Headers	`Authorization: Bearer nk_...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Complete HTTP envelope, including code and data.

ChatGPT Search Responses API

API overview

Authentication

Run an API

Status codes

Example request

Run this API

Endpoint

Request body

Request example

Response body

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Any of option 1

Any of option 2

Response example

Responses

Data source, freshness, and limitations

MCP

Call a tool

Online test

Try it