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

# Start a crawl

> The most expensive thing the platform does, so a crawl already in progress is refused rather than duplicated.



## OpenAPI

````yaml https://api.surnex.io/docs/openapi.json post /v1/projects/{projectId}/audits
openapi: 3.1.0
info:
  title: Surnex API
  version: 1.0.0
  description: >-
    The SEO platform's API.


    **The API is the product.** The dashboard is one client and the MCP server
    at `/mcp` is another. If a number needs deriving, a service derives it —
    never a React component, or the two clients drift.


    **Two kinds of auth.** The dashboard sends a Supabase access token as a
    Bearer JWT. MCP agents send `X-API-Key`, and the organization is resolved
    from the key.


    **Two data modes.** SERP results and Google Trends are fetched live on
    request. Everything else is written by the worker and read from Postgres, so
    a freshly-created project returns empty until its jobs complete.
servers:
  - url: https://api.surnex.io
    description: Surnex API
security: []
paths:
  /v1/projects/{projectId}/audits:
    post:
      tags:
        - audits
      summary: Start a crawl
      description: >-
        The most expensive thing the platform does, so a crawl already in
        progress is refused rather than duplicated.
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: projectId
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                target_url:
                  type: string
                  format: uri
                max_pages:
                  type: integer
                  minimum: 1
                  maximum: 10000
                  default: 500
                render_javascript:
                  type: boolean
                  default: false
      responses:
        '202':
          description: Queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    nullable: true
                    properties:
                      job_id:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                          - pending
                      record_id:
                        type: string
                        nullable: true
                        format: uuid
                    required:
                      - job_id
                      - status
                      - record_id
                required:
                  - success
                  - data
        '402':
          description: No site-audit pages left this month, or no active plan
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '409':
          description: A crawl is already running
          content:
            application/json:
              schema:
                type: object
                properties: {}

````

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