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-public-scope-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 Public Scope API
  version: 0.1.0
tags:
- name: public-scope
paths:
  /api/public/scope/quota:
    get:
      tags:
      - public-scope
      summary: Scope Quota
      operationId: scope_quota_api_public_scope_quota_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/public/scope:
    post:
      tags:
      - public-scope
      summary: Run Scope
      description: 'SSE: agent_start / agent_done progress, then ``spec_ready`` {token,

        remaining, cached} or ``error`` {code, message}; ``done`` last. Refusals

        before the run are plain JSON: 422 ``invalid_idea``, 429

        ``public_scope_limit`` / ``public_scope_daily_cap``.'
      operationId: run_scope_api_public_scope_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/scope/{token}:
    get:
      tags:
      - public-scope
      summary: Get Spec
      operationId: get_spec_api_public_scope__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/scope/{token}/email:
    post:
      tags:
      - public-scope
      summary: Email Spec
      description: '``{sent, email, already_sent}``; 422 ``invalid_email``, 429

        ``spec_email_limit``, 502 ``spec_email_failed``, 404.'
      operationId: email_spec_api_public_scope__token__email_post
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScopeEmailRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/scope/{token}/build:
    post:
      tags:
      - public-scope
      summary: Build Spec
      description: 'Start a services engagement pre-filled from the spec. 401

        ``sign_in_required`` for a visitor without an account.'
      operationId: build_spec_api_public_scope__token__build_post
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/services__idea_scope_router__BuildRequest'
              - type: 'null'
              title: Body
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/scope/claim:
    post:
      tags:
      - public-scope
      summary: Claim Specs
      description: 'Signed in: this browser''s earlier specs now belong to the account (a

        lead is not lost when they sign up after generating).'
      operationId: claim_specs_api_public_scope_claim_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
components:
  schemas:
    ScopeEmailRequest:
      properties:
        email:
          type: string
          maxLength: 320
          title: Email
        updates_opt_in:
          type: boolean
          title: Updates Opt In
          default: false
      type: object
      required:
      - email
      title: ScopeEmailRequest
    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
    services__idea_scope_router__BuildRequest:
      properties:
        attribution:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Attribution
      type: object
      title: BuildRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ScopeRequest:
      properties:
        idea:
          type: string
          maxLength: 4000
          minLength: 1
          title: Idea
        platform:
          type: string
          maxLength: 20
          title: Platform
          default: unsure
      type: object
      required:
      - idea
      title: ScopeRequest