ScrepyDocs

AI Visibility

Get AI Visibility options

GET/projects/{project_uid}/ai-visibility/options

Returns public provider and locale options, project settings, and prompt usage.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/options"
{  "data": {}}

Get the AI Visibility overview

GET/projects/{project_uid}/ai-visibility/overview

Returns stored trends, recent mentions, top sources, competitor ranking, and share of voice. This does not run a new analysis.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/overview"
{  "data": {}}

List stored AI Visibility mentions

GET/projects/{project_uid}/ai-visibility/mentions

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

search?string
Lengthlength <= 250
platform?string
brand_id?integer
Range1 <= value
limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/mentions"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

Get a stored AI Visibility answer

GET/projects/{project_uid}/ai-visibility/answers/{answer_id}

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

answer_id*integer
Range1 <= value
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/answers/1"
{  "data": {}}

List citations for an AI Visibility answer

GET/projects/{project_uid}/ai-visibility/answers/{answer_id}/citations

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

answer_id*integer
Range1 <= value
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/answers/1/citations"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

List tracked AI Visibility prompts

GET/projects/{project_uid}/ai-visibility/prompts

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

search?string
Lengthlength <= 250
country_code?string
Length2 <= length <= 2
language_code?string
Length2 <= length <= 10
brand_id?integer
Range1 <= value
limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/prompts"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

Add AI Visibility prompts

POST/projects/{project_uid}/ai-visibility/prompts

Adds 1 to 20 unique prompts for one country and language. Analysis follows the project's normal schedule.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/projects/string/ai-visibility/prompts" \  -H "Content-Type: application/json" \  -d '{    "prompts": [      "string"    ],    "country_code": "st",    "language_code": "string"  }'
{  "data": [    {      "id": 0,      "prompt": "string",      "country_code": "string",      "language_code": "string",      "status": "pending"    }  ]}

List stored answers for an AI Visibility prompt

GET/projects/{project_uid}/ai-visibility/prompts/{prompt_id}/answers

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

prompt_id*integer
Range1 <= value
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/prompts/1/answers"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

List stored citations for an AI Visibility prompt

GET/projects/{project_uid}/ai-visibility/prompts/{prompt_id}/citations

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

prompt_id*integer
Range1 <= value
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/prompts/1/citations"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

Delete an AI Visibility prompt

DELETE/projects/{project_uid}/ai-visibility/prompts/{prompt_id}

Soft-deletes a project-scoped prompt.

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$
prompt_id*integer
Range1 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/projects/string/ai-visibility/prompts/1"
Empty

List AI Visibility citation sources

GET/projects/{project_uid}/ai-visibility/sources

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

view?string
Default"domain"

Value in

  • "domain"
  • "page"
search?string
Lengthlength <= 255
limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/sources"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

List citations from an AI Visibility source domain

GET/projects/{project_uid}/ai-visibility/sources/domains/{domain}/citations

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

domain*string
Lengthlength <= 255
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/sources/domains/string/citations"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

List prompts cited by an AI Visibility source domain

GET/projects/{project_uid}/ai-visibility/sources/domains/{domain}/prompts

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

domain*string
Lengthlength <= 255
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/sources/domains/string/prompts"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

List citations from an AI Visibility source page

GET/projects/{project_uid}/ai-visibility/sources/urls/{url_hash}/citations

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

url_hash*string
Match^[A-Fa-f0-9]{64}$
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/sources/urls/string/citations"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

List prompts cited by an AI Visibility source page

GET/projects/{project_uid}/ai-visibility/sources/urls/{url_hash}/prompts

Authorization

bearerApiKey
AuthorizationBearer <token>

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

url_hash*string
Match^[A-Fa-f0-9]{64}$
project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Query Parameters

limit?integer

Maximum records to return. Defaults to 50.

Range1 <= value <= 100
Default50
cursor?string

Opaque cursor returned by the prior response. Do not construct or alter it.

Lengthlength <= 512

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/ai-visibility/sources/urls/string/prompts"
{  "data": [    {}  ],  "links": {    "first": "http://example.com",    "last": "http://example.com",    "prev": "http://example.com",    "next": "http://example.com"  },  "meta": {    "path": "http://example.com",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

Rank Tracker

Read ranking visibility and stored results, then manage tracked keywords and URL-based segments with the Screpy REST API.