sketchxflow-com

sketchxflow-com Components API

The Components API from sketchxflow-com — 9 operation(s) for components.

GitHub OpenAPI

Operations 12

GET /api/components List Components #
GET /api/components/{component_id} Get Component #
DELETE /api/components/{component_id} Delete Component #
GET /api/projects/{project_id}/components List Project Components #
GET /api/projects/{project_id}/states List Project States #
POST /api/projects/{project_id}/states/remove Remove Project State #
POST /api/projects/{project_id}/states/generate Generate Project States #
GET /api/projects/{project_id}/colour-styles Get Colour Styles #
POST /api/projects/{project_id}/colour-styles Set Colour Style #
GET /api/projects/{project_id}/app-motion Get App Motion #
POST /api/projects/{project_id}/app-motion Set App Motion #
POST /api/projects/{project_id}/components/sync Sync Project Component #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sketchxflow-com/openapi/sketchxflow-com-components-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sketchxflow-com/json-schema/sketchxflow-com-generate-animation-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/sketchxflow-com/json-schema/sketchxflow-com-generate-html-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/sketchxflow-com/json-schema/sketchxflow-com-model-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/sketchxflow-com/json-schema/sketchxflow-com-mcpanimation-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/sketchxflow-com/json-schema/sketchxflow-com-integrations-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/sketchxflow-com/json-schema/sketchxflow-com-logo-intake-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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-components-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

sketchxflow-com-components-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SketchXFlow Components API
  version: 0.1.0
tags:
- name: Components
paths:
  /api/components:
    get:
      summary: List Components
      description: List blocks owned by the user (and shared with their teams).
      operationId: list_components_api_components_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Components
  /api/components/{component_id}:
    get:
      summary: Get Component
      operationId: get_component_api_components__component_id__get
      parameters:
      - name: component_id
        in: path
        required: true
        schema:
          type: string
          title: Component Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Components
    delete:
      summary: Delete Component
      operationId: delete_component_api_components__component_id__delete
      parameters:
      - name: component_id
        in: path
        required: true
        schema:
          type: string
          title: Component Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Components
  /api/projects/{project_id}/components:
    get:
      tags:
      - Components
      summary: List Project Components
      operationId: list_project_components_api_projects__project_id__components_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/states:
    get:
      tags:
      - Components
      summary: List Project States
      description: Screen states per page (services/states) for the editor's switcher.
      operationId: list_project_states_api_projects__project_id__states_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/states/remove:
    post:
      tags:
      - Components
      summary: Remove Project State
      description: 'Drop one state from a page. A normal saved edit: Undo brings it back.'
      operationId: remove_project_state_api_projects__project_id__states_remove_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveStateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/states/generate:
    post:
      tags:
      - Components
      summary: Generate Project States
      description: '"+ Add states" (owner, 2026-10-13): design the picked states for one

        screen''s whole content area, or design one again. Billed like an AI edit

        for each state made; the automatic ones of a build stay free.'
      operationId: generate_project_states_api_projects__project_id__states_generate_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateStatesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/colour-styles:
    get:
      tags:
      - Components
      summary: Get Colour Styles
      description: 'The Page panel''s names and descriptions for the design''s colours

        (the colour itself is the palette''s; the token key never changes).'
      operationId: get_colour_styles_api_projects__project_id__colour_styles_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Components
      summary: Set Colour Style
      operationId: set_colour_style_api_projects__project_id__colour_styles_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ColourStyleRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/app-motion:
    get:
      tags:
      - Components
      summary: Get App Motion
      description: 'A phone app''s motion (services/app_motion): its feel and each screen''s moment.'
      operationId: get_app_motion_api_projects__project_id__app_motion_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Components
      summary: Set App Motion
      description: 'Calm / Standard / Playful on every screen: a normal saved edit, free.'
      operationId: set_app_motion_api_projects__project_id__app_motion_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppMotionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/components/sync:
    post:
      tags:
      - Components
      summary: Sync Project Component
      description: 'Every copy of a component takes the look of the one the person edited.

        A normal saved edit: live at once, and Undo takes it back.'
      operationId: sync_project_component_api_projects__project_id__components_sync_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/services__components_router__SyncRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RemoveStateRequest:
      properties:
        page:
          type: string
          maxLength: 120
          minLength: 1
          title: Page
        state:
          type: string
          maxLength: 40
          minLength: 1
          pattern: ^[a-z0-9-]+$
          title: State
      type: object
      required:
      - page
      - state
      title: RemoveStateRequest
    ColourStyleRequest:
      properties:
        token:
          type: string
          maxLength: 60
          minLength: 1
          pattern: ^[A-Za-z0-9_/.-]+$
          title: Token
        name:
          type: string
          maxLength: 60
          title: Name
          default: ''
        description:
          type: string
          maxLength: 200
          title: Description
          default: ''
        base:
          anyOf:
          - type: string
            pattern: ^#[0-9A-Fa-f]{6}$
          - type: 'null'
          title: Base
        layers:
          items:
            $ref: '#/components/schemas/FillLayer'
          type: array
          maxItems: 4
          title: Layers
      type: object
      required:
      - token
      title: ColourStyleRequest
    AppMotionRequest:
      properties:
        feel:
          type: string
          pattern: ^(calm|standard|playful)$
          title: Feel
      type: object
      required:
      - feel
      title: AppMotionRequest
    FillLayer:
      properties:
        hex:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          title: Hex
        opacity:
          type: integer
          maximum: 100.0
          minimum: 0.0
          title: Opacity
          default: 100
        hidden:
          type: boolean
          title: Hidden
          default: false
      type: object
      required:
      - hex
      title: FillLayer
    services__components_router__SyncRequest:
      properties:
        component:
          type: string
          maxLength: 48
          minLength: 1
          pattern: ^[a-z0-9-]+$
          title: Component
        variant:
          anyOf:
          - type: string
            maxLength: 48
            pattern: ^[a-z0-9-]+$
          - type: 'null'
          title: Variant
        html:
          type: string
          maxLength: 200000
          minLength: 3
          title: Html
      type: object
      required:
      - component
      - html
      title: SyncRequest
    GenerateStatesRequest:
      properties:
        page:
          type: string
          maxLength: 120
          minLength: 1
          title: Page
        states:
          items:
            type: string
          type: array
          maxItems: 8
          minItems: 1
          title: States
        note:
          type: string
          maxLength: 600
          title: Note
          default: ''
      type: object
      required:
      - page
      - states
      title: GenerateStatesRequest