Inclusify API

openapi: 3.1.0
info:
  title: Inclusify API
  version: '2026-11-12'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-12: 9 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Inclusify has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 6
    pages-with-code: 2
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-12'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://inclusifyapp.com/docs/agents
  - https://inclusifyapp.com/docs/installation
  - https://inclusifyapp.com/docs/ai
servers:
- url: https://app.inclusifyapp.com
paths:
  /api/agent/login:
    get:
      operationId: get_api_agent_login
      tags:
      - Api
      summary: 'Step 1: emails a fresh credential to the address.'
      x-source: https://inclusifyapp.com/docs/agents
      parameters:
      - name: email
        in: query
        required: true
        schema:
          type: string
        description: User email address
      - name: source
        in: query
        required: false
        schema:
          type: string
        description: Assistant name
      - name: code
        in: query
        required: false
        schema:
          type: string
        description: 6‑digit verification code (second call)
      - name: org
        in: query
        required: false
        schema:
          type: string
        description: Workspace ID when multiple workspaces
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAgentLoginResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_agent_login
      tags:
      - Api
      summary: POST /api/agent/login
      x-source: https://inclusifyapp.com/docs/agents
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentLoginRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://inclusifyapp.com/api/agent/login ?email=owner@example.com &code=123456 &source=your-assistant-name" It creates
          nothing, ever: no user, no workspace, no website. An address with no account is told so and pointed back at /api/agent/register , because
          an endpoint that silently creates what you asked to sign in to is how somebody ends up with a second account they never wanted. It takes '
  /api/agent/register:
    get:
      operationId: get_api_agent_register
      tags:
      - Api
      summary: GET /api/agent/register
      x-source: https://inclusifyapp.com/docs/agents
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl "https://inclusifyapp.com/api/agent/register ?email=owner@example.com &code=123456 &source=your-assistant-name" Keep the
          domain out of both calls or in both. A pending signup is keyed on the email and the domain together, so adding a domain to the second
          call looks for a signup that was never started, and is refused rather than finishing the one you began. Anything that is not a website
          domai
    post:
      operationId: post_api_agent_register
      tags:
      - Api
      summary: POST /api/agent/register
      x-source: https://inclusifyapp.com/docs/agents
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentRegisterRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://inclusifyapp.com/api/agent/register  -H ''Content-Type: application/json''  -d ''{"email":"owner@example.com","domain":"example.com","source":"Claude"}''
          Registering and signing in are two calls each, with the user''s mailbox in between: the first emails a code, the second carries it back.
          Section 3 below has both in full. Machine-readable summary: https://inclusifyapp.com/llms.txt'
  /api/agent/scan:
    get:
      operationId: get_api_agent_scan
      tags:
      - Api
      summary: Starts a free accessibility scan of the domain's homepage and emails the full report to the address given.
      x-source: https://inclusifyapp.com/docs/agents
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
        description: Domain to scan
      - name: email
        in: query
        required: true
        schema:
          type: string
        description: Email address to receive the report
      - name: source
        in: query
        required: false
        schema:
          type: string
        description: Assistant name
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiAgentScanResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_agent_scan
      tags:
      - Api
      summary: Starts a free accessibility scan of the domain's homepage and emails the full report to the address given.
      x-source: https://inclusifyapp.com/docs/agents
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
        description: Domain to scan
      - name: email
        in: query
        required: true
        schema:
          type: string
        description: Email address to receive the report
      - name: source
        in: query
        required: false
        schema:
          type: string
        description: Assistant name
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentScanResponse'
      x-evidence:
        kind: documentation
  /api/public/scan:
    get:
      operationId: get_api_public_scan
      tags:
      - Api
      summary: Poll until "status" is "scanned".
      x-source: https://inclusifyapp.com/docs/agents
      parameters:
      - name: domain
        in: query
        required: true
        schema:
          type: string
        description: Domain to read the cached scan result for
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicScanResponse'
      x-evidence:
        kind: documentation
  /api/v1:
    get:
      operationId: get_api_v1
      tags:
      - Api
      summary: Unauthenticated list of every tool with the verb it needs and its input schema.
      x-source: https://inclusifyapp.com/docs/agents
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/site_overview:
    get:
      operationId: get_api_v1_site_overview
      tags:
      - Api
      summary: Reads the site overview for a given website (requires Authorization header).
      x-source: https://inclusifyapp.com/docs/agents
      parameters:
      - name: website
        in: query
        required: true
        schema:
          type: string
        description: Website domain
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiAgentLoginResponse:
      type: object
      properties:
        status:
          type: string
          description: '"verification_sent", "resent", "choose_organization", or "refused"'
        next:
          type: string
        organizations:
          type: array
          description: When multiple workspaces
        message:
          type: string
    PostApiAgentLoginRequest:
      type: object
      properties:
        website:
          type: string
        urls:
          type: array
          items:
            type: string
    PostApiAgentRegisterRequest:
      type: object
      properties:
        email:
          type: string
        domain:
          type: string
        source:
          type: string
    GetApiAgentScanResponse:
      type: object
      properties:
        status:
          type: string
          description: e.g., "queued"
        domain:
          type: string
        next:
          type: string
        resultUrl:
          type: string
    PostApiAgentScanResponse:
      type: object
      properties:
        status:
          type: string
          description: e.g., "queued"
        domain:
          type: string
        next:
          type: string
        resultUrl:
          type: string
    GetApiPublicScanResponse:
      type: object
      properties:
        status:
          type: string
          description: e.g., "scanned" or "not_scanned"
        domain:
          type: string
        url:
          type: string
          description: Original site URL (when scanned)
        score:
          type: integer
          description: Accessibility score
        band:
          type: string
        bandLabel:
          type: string
        issues:
          type: integer
        severity:
          type: object
        topRules:
          type: array
        scannedAt:
          type: string
          description: ISO timestamp
        message:
          type: string
          description: When not_scanned
        scanUrl:
          type: string
          description: URL to start a scan
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api