FlowZap

FlowZap API

FlowZap API as documented publicly: 12 operations. Contract generated from the documentation by API Evangelist (2026-11-08); not the provider's own document.

Documentation GitHub OpenAPI

Operations 12

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/flowzap-xyz:flowzap-xyz-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.1.0
info:
  title: FlowZap API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 12 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; FlowZap has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 11
    pages-with-code: 1
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://flowzap.xyz/docs/agent-api
  - https://flowzap.xyz/templates/webhook-integration-workflow
  - https://flowzap.xyz/docs/mcp
  - https://flowzap.xyz/templates/health-check-pattern-architecture
  - https://flowzap.xyz/templates/api-composition-pattern-architecture
  - https://flowzap.xyz/templates/cqrs-task-based-ui-architecture
paths:
  /api/agent/auth:
    post:
      operationId: post_api_agent_auth
      tags:
      - Api
      summary: Authentication
      description: Exchange the API token for a short‑lived JWT.
      x-source: https://flowzap.xyz/docs/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentAuthRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentAuthResponse'
      x-evidence:
        kind: documentation
  /api/agent/diagrams:
    post:
      operationId: post_api_agent_diagrams
      tags:
      - Api
      summary: Create Diagram
      description: Create a diagram in a project; responses include attribution.
      x-source: https://flowzap.xyz/docs/agent-api
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer <jwt-from-auth>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiAgentDiagramsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiAgentDiagramsResponse'
      x-evidence:
        kind: documentation
  /api/agent/register:
    post:
      operationId: post_api_agent_register
      tags:
      - Api
      summary: POST /api/agent/register
      x-source: https://flowzap.xyz/docs/agent-api
      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 Examples 1. Register Agent curl -X POST https://flowzap.xyz/api/agent/register  -H \"Content-Type: application/json\" \
          \ -d '{\n \"name\": \"My AI Assistant\",\n \"email\": \"my-assistant@agents.flowzap.xyz\",\n \"termsAccepted\": true\n }' 2. Authenticate\
          \ curl -X POST https://flowzap.xyz/api/agent/auth  -H \"Content-Type: application/json\"  -d '{\n \"apiToken\": \"your-api-token-here\"\
          \n }' 3. Create Diagram curl -X"
  /api/fix:
    post:
      operationId: post_api_fix
      tags:
      - Api
      summary: POST /api/fix
      description: Deterministic repair pass for FlowZap Code rejected by the validator.
      x-source: https://flowzap.xyz/docs/mcp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiFixRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiFixResponse'
      x-evidence:
        kind: documentation
  /api/playground/create:
    post:
      operationId: post_api_playground_create
      tags:
      - Api
      summary: Playground Session (Public URL)
      description: Obtain a public URL that opens the editor in signed‑out playground mode with prefilled FlowZap Code.
      x-source: https://flowzap.xyz/docs/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPlaygroundCreateRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiPlaygroundCreateResponse'
      x-evidence:
        kind: documentation
  /api/validate:
    post:
      operationId: post_api_validate
      tags:
      - Api
      summary: POST /api/validate
      description: Validate FlowZap Code syntax before creating a diagram.
      x-source: https://flowzap.xyz/docs/mcp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiValidateRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiValidateResponse'
      x-evidence:
        kind: documentation
  /commands:
    post:
      operationId: post_commands
      tags:
      - Commands
      summary: Submit Command
      x-source: https://flowzap.xyz/templates/cqrs-task-based-ui-architecture
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCommandsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCommandsResponse'
      x-evidence:
        kind: documentation
  /health:
    get:
      operationId: get_health
      tags:
      - Health
      summary: Health Check Pattern Architecture
      x-source: https://flowzap.xyz/templates/health-check-pattern-architecture
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /orders:
    get:
      operationId: get_orders
      tags:
      - Orders
      summary: API Composition Pattern Architecture
      x-source: https://flowzap.xyz/templates/api-composition-pattern-architecture
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /products:
    get:
      operationId: get_products
      tags:
      - Products
      summary: API Composition Pattern Architecture
      x-source: https://flowzap.xyz/templates/api-composition-pattern-architecture
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: API Composition Pattern Architecture
      x-source: https://flowzap.xyz/templates/api-composition-pattern-architecture
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /webhook:
    post:
      operationId: post_webhook
      tags:
      - Webhook
      summary: Webhook Integration Workflow
      x-source: https://flowzap.xyz/templates/webhook-integration-workflow
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiAgentAuthRequest:
      type: object
      properties:
        apiToken:
          type: string
      required:
      - apiToken
    PostApiAgentAuthResponse:
      type: object
      properties:
        success:
          type: boolean
        accessToken:
          type: string
        tokenType:
          type: string
        expiresIn:
          type: integer
    PostApiAgentDiagramsRequest:
      type: object
      properties:
        name:
          type: string
        projectId:
          type: string
        colorScheme:
          type: string
      required:
      - name
      - projectId
      - colorScheme
    PostApiAgentDiagramsResponse:
      type: object
      properties:
        success:
          type: boolean
        data.diagram.id:
          type: string
        data.diagram.name:
          type: string
        data.diagram.colorScheme:
          type: string
        data.diagram.createdAt:
          type: string
        data.diagram.project.id:
          type: string
        data.diagram.project.name:
          type: string
        agent.id:
          type: string
        agent.email:
          type: string
        attribution:
          type: string
    PostApiAgentRegisterRequest:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
        termsAccepted:
          type: boolean
    PostApiFixRequest:
      type: object
      properties:
        code:
          type: string
          description: FlowZap Code to fix
        lng:
          type: string
          description: Response language
      required:
      - code
    PostApiFixResponse:
      type: object
      properties:
        repairedCode:
          type: string
          description: The repaired FlowZap Code
        appliedCorrections:
          type: object
          description: Counts of corrections applied
        unfixableErrors:
          type: array
          description: Remaining errors with validator messages
    PostApiPlaygroundCreateRequest:
      type: object
      properties:
        code:
          type: string
        view:
          type: string
          description: 'One of: workflow, sequence, architecture'
      required:
      - code
    PostApiPlaygroundCreateResponse:
      type: object
      properties:
        success:
          type: boolean
        url:
          type: string
        tokenExpiresAt:
          type: string
    PostApiValidateRequest:
      type: object
      properties:
        code:
          type: string
          description: FlowZap Code to validate
      required:
      - code
    PostApiValidateResponse:
      type: object
      properties:
        success:
          type: boolean
        valid:
          type: boolean
        errors:
          type: array
          description: Array of error objects with line, code, severity, message
        warnings:
          type: array
          description: Array of warning objects with line, code, severity, message
        stats:
          type: object
          description: Statistics like lanes, nodes, edges, loops
        attribution:
          type: string
    PostCommandsRequest:
      type: object
      properties:
        commandDto:
          type: object
          description: Command DTO
      required:
      - commandDto
    PostCommandsResponse:
      type: object
      properties:
        '202':
          type: string
          description: Accepted
        '409':
          type: string
          description: Duplicate
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Commands
- name: Health
- name: Orders
- name: Products
- name: Users
- name: Webhook