Create AI visibility audits for Query Fan-Out

POST 
/ai-visibility-audits

Create AI visibility audits for Query Fan-Out

Request

Header Parameters

authorization any

application/json

Body

required

url urirequired

Possible values: non-empty and <= 2083 characters

The URL to analyze

num_queries Num Queries (integer)

Possible values: >= 1 and <= 20

Default value: 10

Number of synthetic queries to generate

coverage_threshold Coverage Threshold (number)

Possible values: <= 1

Default value: 0.65

The threshold for answering synthetic queries

Responses

200

Successful Response

application/json

Schema

Schema

url Url (string)required
num_queries_requested Num Queries Requested (integer)required
coverage_threshold Coverage Threshold (number)required
entity_name Entity Name (string)required
query_reasoning Query Reasoning (string)required
covered_count Covered Count (integer)required
total_queries Total Queries (integer)required

query_details

object[]

required

Array [

query Query (string)required

is_covered Is Covered (boolean)required

similarity Similarity (number)required

]

content_chunks_count Content Chunks Count (integer)required
coverage_score Coverage Score (number)required

Example (from schema)

{
  "url": "string",
  "num_queries_requested": 0,
  "coverage_threshold": 0,
  "entity_name": "string",
  "query_reasoning": "string",
  "covered_count": 0,
  "total_queries": 0,
  "query_details": [
    {
      "query": "string",
      "is_covered": true,
      "similarity": 0
    }
  ],
  "content_chunks_count": 0,
  "coverage_score": 0
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}