find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/sketchxflow-com:sketchxflow-com-audit-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: SketchXFlow Audit API
  version: 0.1.0
tags:
- name: Audit
paths:
  /api/audit/site:
    post:
      summary: Audit Site
      description: 'Run a full audit on a public URL. Returns SSE stream with progress

        + a final `audit_ready` event with the saved audit_id.'
      operationId: audit_site_api_audit_site_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuditSiteRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Audit
  /api/audit/{audit_id}:
    get:
      summary: Get Audit Endpoint
      description: Return a saved audit owned by the current user.
      operationId: get_audit_endpoint_api_audit__audit_id__get
      parameters:
      - name: audit_id
        in: path
        required: true
        schema:
          type: string
          title: Audit Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Audit
    delete:
      summary: Delete Audit Endpoint
      operationId: delete_audit_endpoint_api_audit__audit_id__delete
      parameters:
      - name: audit_id
        in: path
        required: true
        schema:
          type: string
          title: Audit Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Audit
  /api/audit/share/{share_token}:
    get:
      summary: Get Audit Share
      description: Public read-only audit by share token. No auth required.
      operationId: get_audit_share_api_audit_share__share_token__get
      parameters:
      - name: share_token
        in: path
        required: true
        schema:
          type: string
          title: Share Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Audit
components:
  schemas:
    AuditAuthRequest:
      properties:
        login_url:
          type: string
          title: Login Url
        email:
          type: string
          title: Email
        password:
          type: string
          title: Password
        email_selector:
          anyOf:
          - type: string
          - type: 'null'
          title: Email Selector
        password_selector:
          anyOf:
          - type: string
          - type: 'null'
          title: Password Selector
        submit_selector:
          anyOf:
          - type: string
          - type: 'null'
          title: Submit Selector
      type: object
      required:
      - login_url
      - email
      - password
      title: AuditAuthRequest
      description: Optional login pre-step for auth-gated sites (Tier 2+).
    AuditAINavRequest:
      properties:
        enabled:
          type: boolean
          title: Enabled
          default: false
        max_steps_per_page:
          anyOf:
          - type: integer
            maximum: 12.0
            minimum: 1.0
          - type: 'null'
          title: Max Steps Per Page
          default: 4
        allow_form_submits:
          type: boolean
          title: Allow Form Submits
          default: false
        demo_persona:
          anyOf:
          - type: string
          - type: 'null'
          title: Demo Persona
      type: object
      title: AuditAINavRequest
      description: Optional AI navigation block (Tier 3 / advanced).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AuditSiteRequest:
      properties:
        url:
          type: string
          maxLength: 2048
          minLength: 4
          title: Url
        tier:
          type: string
          title: Tier
          default: basic
        viewport_w:
          anyOf:
          - type: integer
            maximum: 4096.0
            minimum: 320.0
          - type: 'null'
          title: Viewport W
          default: 1440
        viewport_h:
          anyOf:
          - type: integer
            maximum: 4096.0
            minimum: 320.0
          - type: 'null'
          title: Viewport H
          default: 900
        max_pages:
          anyOf:
          - type: integer
            maximum: 20.0
            minimum: 1.0
          - type: 'null'
          title: Max Pages
          default: 1
        max_depth:
          anyOf:
          - type: integer
            maximum: 4.0
            minimum: 0.0
          - type: 'null'
          title: Max Depth
          default: 0
        auth:
          anyOf:
          - $ref: '#/components/schemas/AuditAuthRequest'
          - type: 'null'
        ai_nav:
          anyOf:
          - $ref: '#/components/schemas/AuditAINavRequest'
          - type: 'null'
        confirmed_advanced_cost:
          type: boolean
          title: Confirmed Advanced Cost
          default: false
      type: object
      required:
      - url
      title: AuditSiteRequest
      description: Body for POST /api/audit/site. See lib/audit-api.ts:submitAudit.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError