> ## Documentation Index
> Fetch the complete documentation index at: https://docs.querying.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Verificar um site

> As páginas que os sitemaps de um site listam, por padrão de caminho, e quanto custa publicá-las.



## OpenAPI

````yaml POST /v1/ai-rendering/site-checks
openapi: 3.1.0
info:
  title: querying.ai
  description: >-
    One API for every AI answer engine. Every task is asynchronous: submit, then
    collect the result via webhook or polling.
  version: 1.0.0
servers:
  - url: https://api.querying.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/ai-rendering/site-checks:
    post:
      tags:
        - AI Rendering
      summary: Check a site
      description: >-
        Reads a site's robots.txt and sitemaps before the site is connected, and
        answers in the same request: the pages the sitemaps list, grouped by the
        parts of the path they share, which AI agents robots.txt lets in, and
        the credits publishing the pages costs. Up to 8 sitemaps are read,
        product sitemaps first, and of an index the first 4 files; the rest is
        estimated from them. Free. It takes up to 25 seconds on a large site.
      operationId: createAiRenderingSiteCheck
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AiRenderingSiteCheckRequest'
            example:
              host: www.example.com
      responses:
        '200':
          description: What the site lists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AiRenderingSiteCheckResponse'
              example:
                success: true
                siteCheck:
                  host: www.example.com
                  robots:
                    url: https://www.example.com/robots.txt
                    found: true
                    agents:
                      - agent: ChatGPT-User
                        allowed: true
                      - agent: GPTBot
                        allowed: false
                  sitemaps:
                    - url: https://www.example.com/sitemap.xml
                      files: 16
                      filesRead: 4
                      error: null
                  pages:
                    listed: 200
                    estimated: 800
                    complete: false
                    ignored: 0
                    productListed: 150
                    productEstimated: 600
                  groups:
                    - pattern: /products/*
                      pages: 150
                      estimated: 600
                      examples:
                        - https://www.example.com/products/down-jacket
                      product: true
                    - pattern: /pages/*
                      pages: 50
                      estimated: 200
                      examples:
                        - https://www.example.com/pages/shipping
                      product: false
                  pricing:
                    pageCredits: 5
                    imageCredits: 5
                    reusedImageCredits: 2
                    imagesPerPage: 12
                  estimate:
                    all:
                      pages: 800
                      firstRenderCredits:
                        min: 4000
                        max: 52000
                      refreshCredits:
                        min: 4000
                        max: 23200
                    products:
                      pages: 600
                      firstRenderCredits:
                        min: 3000
                        max: 39000
                      refreshCredits:
                        min: 3000
                        max: 17400
                  limits:
                    pagesPerSite: 1000
        '400':
          description: >-
            VALIDATION_ERROR: the body is not a JSON object or has a field other
            than host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 'VALIDATION_ERROR: host is not a public host name.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AiRenderingSiteCheckRequest:
      type: object
      required:
        - host
      properties:
        host:
          type: string
          description: >-
            The site's host name or any address on it. A bare domain that
            redirects to its www name, or the reverse, is read there.
    AiRenderingSiteCheckResponse:
      type: object
      required:
        - success
        - siteCheck
      properties:
        success:
          type: boolean
        siteCheck:
          $ref: '#/components/schemas/AiRenderingSiteCheck'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          $ref: '#/components/schemas/ErrorDetail'
    AiRenderingSiteCheck:
      type: object
      required:
        - host
        - robots
        - sitemaps
        - pages
        - groups
        - pricing
        - estimate
        - limits
      properties:
        host:
          type: string
          description: The host that was read, and the host to connect.
        robots:
          type: object
          required:
            - url
            - found
            - agents
          properties:
            url:
              type: string
            found:
              type: boolean
            agents:
              type: array
              description: >-
                Whether robots.txt lets each AI agent open the site's root.
                Empty without a robots.txt.
              items:
                type: object
                required:
                  - agent
                  - allowed
                properties:
                  agent:
                    type: string
                  allowed:
                    type: boolean
        sitemaps:
          type: array
          description: >-
            The sitemaps robots.txt names on the host, up to 8, the ones that
            read like product sitemaps first; /sitemap.xml when it names none.
          items:
            type: object
            required:
              - url
              - files
              - filesRead
              - error
            properties:
              url:
                type: string
              files:
                type: integer
                description: >-
                  Sitemap files the address names: 1 for a plain sitemap, its
                  sitemaps for an index.
              filesRead:
                type: integer
                description: Up to 4 files of an index are read.
              error:
                type:
                  - string
                  - 'null'
        pages:
          type: object
          required:
            - listed
            - estimated
            - complete
            - ignored
            - productListed
            - productEstimated
          properties:
            listed:
              type: integer
              description: Pages of the host in the sitemap files that were read.
            estimated:
              type: integer
              description: >-
                Each sitemap's pages scaled to the files of it that were not
                read; equal to listed when complete.
            complete:
              type: boolean
              description: Every sitemap file was read.
            ignored:
              type: integer
              description: Entries that are not pages of the host.
            productListed:
              type: integer
              description: Pages in the groups marked product.
            productEstimated:
              type: integer
        groups:
          type: array
          description: >-
            The listed pages grouped by the parts of the path they share,
            largest first, up to 20.
          items:
            type: object
            required:
              - pattern
              - pages
              - estimated
              - examples
              - product
            properties:
              pattern:
                type: string
                description: >-
                  "*" stands for one part of the path that differs from page to
                  page, "**" for every deeper part.
              pages:
                type: integer
                description: Pages of the group in the files that were read.
              estimated:
                type: integer
                description: pages scaled to the sitemap files that were not read.
              examples:
                type: array
                items:
                  type: string
                description: >-
                  Up to 3 pages of the group, to check with POST
                  /v1/ai-rendering/checks.
              product:
                type: boolean
                description: The pattern reads like a product page's.
        pricing:
          type: object
          required:
            - pageCredits
            - imageCredits
            - reusedImageCredits
            - imagesPerPage
          properties:
            pageCredits:
              type: number
            imageCredits:
              type: number
            reusedImageCredits:
              type: number
            imagesPerPage:
              type: integer
        estimate:
          type: object
          required:
            - all
            - products
          properties:
            all:
              type: object
              required:
                - pages
                - firstRenderCredits
                - refreshCredits
              description: Every estimated page.
              properties:
                pages:
                  type: integer
                firstRenderCredits:
                  type: object
                  required:
                    - min
                    - max
                  properties:
                    min:
                      type: number
                    max:
                      type: number
                  description: >-
                    Credits to render every page once: min with no image read,
                    max with imagesPerPage images read on every page.
                refreshCredits:
                  type: object
                  required:
                    - min
                    - max
                  properties:
                    min:
                      type: number
                    max:
                      type: number
                  description: >-
                    Credits for one refresh of every page: max reuses
                    imagesPerPage image readings on every page.
            products:
              type: object
              required:
                - pages
                - firstRenderCredits
                - refreshCredits
              description: The estimated product pages.
              properties:
                pages:
                  type: integer
                firstRenderCredits:
                  type: object
                  required:
                    - min
                    - max
                  properties:
                    min:
                      type: number
                    max:
                      type: number
                  description: >-
                    Credits to render every page once: min with no image read,
                    max with imagesPerPage images read on every page.
                refreshCredits:
                  type: object
                  required:
                    - min
                    - max
                  properties:
                    min:
                      type: number
                    max:
                      type: number
                  description: >-
                    Credits for one refresh of every page: max reuses
                    imagesPerPage image readings on every page.
        limits:
          type: object
          required:
            - pagesPerSite
          properties:
            pagesPerSite:
              type: integer
              description: >-
                Pages a site publishes by default. A larger catalogue needs a
                page limit agreed with us.
    ErrorDetail:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable, safe to branch on. See the Errors guide for the full list.
        message:
          type: string
          description: For humans. May change.
        details:
          description: >-
            Context for the error. An array of `{field, message}` on most
            `VALIDATION_ERROR`s; an object elsewhere (for example `{id}` on
            `RESOURCE_NOT_FOUND`, `retryAfterSec` on 429 and 503 codes). Omitted
            when there is nothing to add.
          oneOf:
            - type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
            - type: object
              additionalProperties: true
        timestamp:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key, sent as `Authorization: Bearer <key>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.