sketchxflow-com

sketchxflow-com Partner V1 API

The partner-v1 API from sketchxflow-com — 10 operation(s) for partner-v1.

GitHub OpenAPI

Operations 12

POST /api/v1/designs Create Design #
GET /api/v1/designs List Designs #
GET /api/v1/designs/{design_id}/previews Get Previews #
GET /api/v1/designs/{design_id}/code Get Design Code #
POST /api/v1/designs/{design_id}/render Render Design #
GET /api/v1/designs/{design_id} Get Design #
POST /api/v1/designs/{design_id}/edit-session Edit Session #
GET /api/v1/designs/{design_id}/export/{fmt} Export Design #
POST /api/v1/logos Create Logo #
GET /api/v1/logos List Logos #
GET /api/v1/logos/{logo_id} Get Logo #
GET /api/v1/health Health #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sketchxflow-com/openapi/sketchxflow-com-partner-v1-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-partner-v1-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-partner-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SketchXFlow Partner V1 API
  version: 0.1.0
tags:
- name: partner-v1
paths:
  /api/v1/designs:
    post:
      tags:
      - partner-v1
      summary: Create Design
      operationId: create_design_api_v1_designs_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DesignRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - partner-v1
      summary: List Designs
      operationId: list_designs_api_v1_designs_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/designs/{design_id}/previews:
    get:
      tags:
      - partner-v1
      summary: Get Previews
      description: The image-gen screen previews (mockups + layout) for a design.
      operationId: get_previews_api_v1_designs__design_id__previews_get
      parameters:
      - name: design_id
        in: path
        required: true
        schema:
          type: string
          title: Design Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/designs/{design_id}/code:
    get:
      tags:
      - partner-v1
      summary: Get Design Code
      description: 'The actual generated HTML CODE for THIS story''s screen(s) — a story may

        be several pages, each returned separately, all sharing the workspace''s

        design tokens + navbar/footer. Returns the CURRENT code (chrome up to date).'
      operationId: get_design_code_api_v1_designs__design_id__code_get
      parameters:
      - name: design_id
        in: path
        required: true
        schema:
          type: string
          title: Design Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/designs/{design_id}/render:
    post:
      tags:
      - partner-v1
      summary: Render Design
      description: Promote a previewed design to the full, editable HTML render + publish.
      operationId: render_design_api_v1_designs__design_id__render_post
      parameters:
      - name: design_id
        in: path
        required: true
        schema:
          type: string
          title: Design Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/designs/{design_id}:
    get:
      tags:
      - partner-v1
      summary: Get Design
      operationId: get_design_api_v1_designs__design_id__get
      parameters:
      - name: design_id
        in: path
        required: true
        schema:
          type: string
          title: Design Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/designs/{design_id}/edit-session:
    post:
      tags:
      - partner-v1
      summary: Edit Session
      description: 'Mint a short-lived access token for the shadow owner so BigXFlow (or your

        internal team) can open the editable design in SketchxFlow — the customer

        never authenticates to SketchxFlow.'
      operationId: edit_session_api_v1_designs__design_id__edit_session_post
      parameters:
      - name: design_id
        in: path
        required: true
        schema:
          type: string
          title: Design Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/designs/{design_id}/export/{fmt}:
    get:
      tags:
      - partner-v1
      summary: Export Design
      description: Stream an export of the design (html | nextjs | figma | pdf | png).
      operationId: export_design_api_v1_designs__design_id__export__fmt__get
      parameters:
      - name: design_id
        in: path
        required: true
        schema:
          type: string
          title: Design Id
      - name: fmt
        in: path
        required: true
        schema:
          type: string
          title: Fmt
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/logos:
    post:
      tags:
      - partner-v1
      summary: Create Logo
      operationId: create_logo_api_v1_logos_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogoRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - partner-v1
      summary: List Logos
      operationId: list_logos_api_v1_logos_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/logos/{logo_id}:
    get:
      tags:
      - partner-v1
      summary: Get Logo
      operationId: get_logo_api_v1_logos__logo_id__get
      parameters:
      - name: logo_id
        in: path
        required: true
        schema:
          type: string
          title: Logo Id
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/health:
    get:
      tags:
      - partner-v1
      summary: Health
      description: Cheap call BigXFlow can use to validate its key + see its shadow id.
      operationId: health_api_v1_health_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: Authorization
      - name: x-bigxflow-user-id
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-User-Id
      - name: x-bigxflow-subscription
        in: header
        required: false
        schema:
          type: string
          default: ''
          title: X-Bigxflow-Subscription
      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
    DesignRequest:
      properties:
        workspace_ref:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Ref
        story_ref:
          anyOf:
          - type: string
          - type: 'null'
          title: Story Ref
        brief:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Brief
        screens:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Screens
        platform:
          type: string
          title: Platform
          default: web
        chat:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Chat
        mode:
          type: string
          title: Mode
          default: preview
      type: object
      title: DesignRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LogoRequest:
      properties:
        brief:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Brief
        chat:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Chat
      type: object
      title: LogoRequest