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

# Add a website

> [Websites](/guides/websites): the people we identify among a site's US visitors arrive as leads. Each is charged once per billing month at intent prices, from your balance, up to `monthly_cap`.

Returns the install snippet once the site is connected (a few seconds).

**Admin key required.** Standard keys get `403 admin_key_required`.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/sites
openapi: 3.1.0
info:
  title: Intent Leads API
  version: '1.0'
  description: >-
    The Intent Leads API finds B2B people actively researching the topics you
    sell into, and exports them with contact details into your own tools.


    **Authentication.** Send an API key as a bearer token: `Authorization:
    Bearer il_live_…`. Standard keys work with everything except billing, team
    and key management, which need an admin key.


    **Organizations and workspaces.** An organization holds the balance,
    invoices and people; lanes, leads, exports, lists, websites and webhooks
    live in its workspaces. A workspace key works in its workspace. An
    organization key manages workspaces, billing and people, and works in any of
    its workspaces with the header `Intent-Leads-Workspace: <workspace id>`.


    **What costs money.** Only `POST /api/v1/exports` with `"dry_run": false`
    spends your [balance](/guides/billing) (and website visitors as they're
    identified). Quotes, counts, checks, estimates, samples and re-downloads are
    free.


    **Errors.** Every error is JSON: `{"error": "code", "message":
    "Plain-English explanation"}`. Codes are stable; messages may change.


    **Conventions.** JSON by default. Dates are `YYYY-MM-DD` and timestamps ISO
    8601, all in UTC. Lane codes (`L1`) are case-insensitive.
servers:
  - url: https://intentleads.si
security:
  - bearerAuth: []
tags:
  - name: Exports
    description: Quote (free) and buy new people from your lanes, then download them.
  - name: Leads
    description: Pull and re-download the leads you've exported, and list deliveries.
  - name: Lanes
    description: >-
      Create, inspect and tune lanes: keywords plus the companies and roles you
      want.
  - name: Topics
    description: >-
      Topics we already track: live at once, with history. Use them before
      adding new keywords.
  - name: Keywords
    description: >-
      Add and remove a lane's keywords: existing topics, or new ones approved as
      their own topic.
  - name: Checks
    description: >-
      Free lane checks that size every filter step over 14 days, plus quick
      topic signals.
  - name: Company list
    description: >-
      The target-company list your lanes can narrow to or use instead of
      industries.
  - name: Exclusions
    description: Companies and people left out of every lane, before anything is bought.
  - name: Suppressions
    description: >-
      People you exported who later asked to be removed, by API or pushed to
      your webhook.
  - name: Webhooks
    description: >-
      Endpoints that receive events as they happen (removals, website visitors),
      signed, each with its own events, tests and delivery log.
  - name: Websites
    description: Identify the people who visit your websites.
  - name: Billing
    description: >-
      Your prepaid balance, prices and cost estimates (any key); top-ups and the
      monthly top-up (admin keys).
  - name: Team
    description: Members and invite links. Admin keys only.
  - name: Workspaces
    description: >-
      One workspace per client, all paid from your balance, with an optional
      monthly budget each; hand one over to the client.
  - name: API keys
    description: Create, rename, rotate and revoke API keys. Admin keys only.
  - name: Account
    description: Check which organization a key belongs to, and rename it.
  - name: Reference
    description: Valid values for lane filters.
  - name: Activity
    description: A feed of changes and events in your organization.
paths:
  /api/v1/sites:
    post:
      tags:
        - Websites
      summary: Add a website
      description: >-
        [Websites](/guides/websites): the people we identify among a site's US
        visitors arrive as leads. Each is charged once per billing month at
        intent prices, from your balance, up to `monthly_cap`.


        Returns the install snippet once the site is connected (a few seconds).


        **Admin key required.** Standard keys get `403 admin_key_required`.
      operationId: createSite
      parameters:
        - $ref: '#/components/parameters/Workspace'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                monthly_cap:
                  type: integer
                  minimum: 1
                  description: Most people identified per billing month. Default 500.
                name:
                  type: string
              required:
                - domain
            example:
              domain: example.com
              monthly_cap: 500
              name: Main site
      responses:
        '201':
          description: Added.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  kind:
                    type: string
                    enum:
                      - visitors
                  name:
                    type: string
                  domain:
                    type: string
                  status:
                    type: string
                    enum:
                      - setup
                      - active
                      - capped
                      - paused
                    description: >-
                      `setup` (not connected yet), `active`, `capped` (paused at
                      the cap or because the plan ran out) or `paused`.
                  monthly_cap:
                    type: integer
                  identified_this_period:
                    type: integer
                  period:
                    type:
                      - object
                      - 'null'
                  install_snippet:
                    type:
                      - string
                      - 'null'
                  setup_error:
                    type:
                      - string
                      - 'null'
                  note:
                    type: string
                required:
                  - code
                  - kind
                  - name
                  - domain
                  - status
                  - monthly_cap
                  - identified_this_period
                  - period
                  - install_snippet
                  - setup_error
                  - note
              example:
                code: V1
                kind: visitors
                name: Main site
                domain: example.com
                status: active
                monthly_cap: 500
                identified_this_period: 137
                period:
                  start: '2026-11-09'
                  end: '2026-12-09'
                install_snippet: <script src="https://…/p.js" async></script>
                setup_error: null
                note: >-
                  Identified visitors arrive as leads on this site's lane (GET
                  /api/v1/leads?lane=V1&since=last). Each person is charged once
                  per billing month on the intent meter of your balance, up to
                  monthly_cap.
        '400':
          description: Bad domain or cap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_domain:
                  value:
                    error: invalid_domain
                    message: domain must be a website address like example.com.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AdminKeyRequired'
        '409':
          description: Already set up.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                site_exists:
                  value:
                    error: site_exists
                    message: example.com is already set up.
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    Workspace:
      name: Intent-Leads-Workspace
      in: header
      required: false
      description: >-
        Only with an **organization** key: the workspace to act in (its id;
        `?workspace=<id>` works too). Lanes, leads, exports, lists, websites and
        webhooks live in workspaces. Without it, an organization key acts in its
        only workspace, or gets `400 workspace_required` (with the list of
        workspaces) when it has several. Workspace keys don't need it. On keys,
        team and activity it switches from the organization's own to that
        workspace's.
      schema:
        type: string
        format: uuid
      example: 0a0e5135-a046-4f8c-8ca9-33de7cf9e54d
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          example: lane_not_found
          description: Stable machine-readable code, e.g. `lane_not_found`.
        message:
          type: string
          example: No lane L9.
          description: Plain-English explanation you can show to a person.
      required:
        - error
        - message
      description: Every error has this shape.
  responses:
    Unauthorized:
      description: Missing, malformed, unknown or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            unauthorized:
              value:
                error: unauthorized
                message: 'Send a valid API key as: Authorization: Bearer il_live_…'
    AdminKeyRequired:
      description: This endpoint needs an admin key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            admin_key_required:
              value:
                error: admin_key_required
                message: >-
                  This needs an admin API key. Owners create one under Settings
                  → API keys.
    InternalError:
      description: >-
        Unexpected server error. Safe to retry reads; retry an export only with
        the same `idempotency_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internal_error:
              value:
                error: internal_error
                message: Something went wrong. Try again.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: il_live_…
      description: >-
        An Intent Leads API key, e.g. `il_live_` followed by 32 letters and
        digits. Create one on the API and CLI page of the dashboard.

````

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