Flow2 API

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

GitHub OpenAPI

Operations 10

POST /ai/generate-image Generate an image (credits cost 2). #
GET /api/blocks/schema GET /api/blocks/schema #
POST /api/create-flow POST /api/create-flow #
GET /api/credits Check your credit balance. #
GET /api/flows/{id}/versions Latest first. Metadata only — content_json is omitted to keep list responses small. #
GET /api/flows/{id}/versions/{vid} Full content snapshot for one version. #
POST /api/flows/{id}/versions/{vid}/restore Make this version the current state. #
GET /api/job-status/{jobId} Poll for job completion. Returns flow URL when complete. #
GET /api/jobs List your recent API jobs. #
POST /api/signup Programmatic signup (advanced) #

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/flow2-co:flow2-co-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.

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

OpenAPI Specification

flow2-co-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Flow2 API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 10 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Flow2 has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 23
    documentation: -13
    pages-with-code: 2
    pages-read: 2
  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://flow2.co/developers/agent-api
  - https://flow2.co/developers
paths:
  /ai/generate-image:
    post:
      operationId: post_ai_generate_image
      tags:
      - Ai
      summary: Generate an image (credits cost 2).
      x-source: https://flow2.co/developers/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAiGenerateImageRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAiGenerateImageResponse'
      x-evidence:
        kind: documentation
  /api/blocks/schema:
    get:
      operationId: get_api_blocks_schema
      tags:
      - Api
      summary: GET /api/blocks/schema
      x-source: https://flow2.co/developers/agent-api
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiBlocksSchemaResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://flow2.co/api/blocks/schema \n {\n \"rest\": {\n \"GET /api/flows/{id}\": \"Read full flow structure + screen previews\"\
          ,\n \"PATCH /api/flows/{id}\": \"Set theme or title\",\n \"GET /api/flows/{id}/preview/{n}\": \"Preview image URL for screen n\",\n\
          \ \"GET /api/flows/{id}/screens/{n}\": \"Read single screen + its preview\",\n \"POST /api/flows/{id}/screens\": \"Insert a screen\"\
          ,\n \"DELETE /api/flows/{id}/screens/"
  /api/create-flow:
    post:
      operationId: post_api_create_flow
      tags:
      - Api
      summary: POST /api/create-flow
      x-source: https://flow2.co/developers/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCreateFlowRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCreateFlowResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://flow2.co/api/create-flow  -H "Authorization: Bearer fvapi_YOUR_KEY"  -H "Content-Type: application/json"  -d
          ''{"content":"3 wild facts about octopus intelligence"}'''
  /api/credits:
    get:
      operationId: get_api_credits
      tags:
      - Api
      summary: Check your credit balance.
      x-source: https://flow2.co/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCreditsResponse'
      x-evidence:
        kind: documentation
  /api/flows/{id}/versions:
    get:
      operationId: get_api_flows_id_versions
      tags:
      - Api
      summary: Latest first. Metadata only — content_json is omitted to keep list responses small.
      x-source: https://flow2.co/developers/agent-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Page size (default 50, max 200)
      - name: before_id
        in: query
        required: false
        schema:
          type: integer
        description: Cursor for pagination
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFlowsIdVersionsResponse'
      x-evidence:
        kind: documentation
  /api/flows/{id}/versions/{vid}:
    get:
      operationId: get_api_flows_id_versions_vid
      tags:
      - Api
      summary: Full content snapshot for one version.
      x-source: https://flow2.co/developers/agent-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: vid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiFlowsIdVersionsVidResponse'
      x-evidence:
        kind: documentation
  /api/flows/{id}/versions/{vid}/restore:
    post:
      operationId: post_api_flows_id_versions_vid_restore
      tags:
      - Api
      summary: Make this version the current state.
      x-source: https://flow2.co/developers/agent-api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: vid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiFlowsIdVersionsVidRestoreResponse'
      x-evidence:
        kind: documentation
  /api/job-status/{jobId}:
    get:
      operationId: get_api_job_status_jobId
      tags:
      - Api
      summary: Poll for job completion. Returns flow URL when complete.
      x-source: https://flow2.co/developers
      parameters:
      - name: jobId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiJobStatusJobidResponse'
      x-evidence:
        kind: documentation
  /api/jobs:
    get:
      operationId: get_api_jobs
      tags:
      - Api
      summary: List your recent API jobs.
      x-source: https://flow2.co/developers
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/signup:
    post:
      operationId: post_api_signup
      tags:
      - Api
      summary: Programmatic signup (advanced)
      description: Creates a new Flow2 account and returns an API token.
      x-source: https://flow2.co/developers/agent-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiSignupRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiSignupResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostAiGenerateImageRequest:
      type: object
      properties:
        prompt:
          type: string
          description: Text prompt describing the desired image
      required:
      - prompt
    PostAiGenerateImageResponse:
      type: object
      properties:
        imageUrl:
          type: string
          description: URL of the generated image
    GetApiBlocksSchemaResponse:
      type: object
      properties:
        rest:
          type: object
          properties:
            GET /api/flows/{id}:
              type: string
            PATCH /api/flows/{id}:
              type: string
            GET /api/flows/{id}/preview/{n}:
              type: string
            GET /api/flows/{id}/screens/{n}:
              type: string
            POST /api/flows/{id}/screens:
              type: string
            DELETE /api/flows/{id}/screens/{n}:
              type: string
            POST /api/flows/{id}/screens/{n}/blocks:
              type: string
            PATCH /api/flows/{id}/screens/{n}/blocks/{bid}:
              type: string
            DELETE /api/flows/{id}/screens/{n}/blocks/{bid}:
              type: string
        block_kinds:
          type: object
        auth:
          type: object
    PostApiCreateFlowRequest:
      type: object
      properties:
        content:
          type: string
    PostApiCreateFlowResponse:
      type: object
      properties:
        rest:
          type: object
          properties:
            GET /api/flows/{id}:
              type: string
            PATCH /api/flows/{id}:
              type: string
            GET /api/flows/{id}/preview/{n}:
              type: string
            GET /api/flows/{id}/screens/{n}:
              type: string
            POST /api/flows/{id}/screens:
              type: string
            DELETE /api/flows/{id}/screens/{n}:
              type: string
            POST /api/flows/{id}/screens/{n}/blocks:
              type: string
            PATCH /api/flows/{id}/screens/{n}/blocks/{bid}:
              type: string
            DELETE /api/flows/{id}/screens/{n}/blocks/{bid}:
              type: string
        block_kinds:
          type: object
        auth:
          type: object
    GetApiCreditsResponse:
      type: object
      properties:
        success:
          type: boolean
        balance:
          type: integer
        monthly_allowance:
          type: integer
        tier:
          type: string
    GetApiFlowsIdVersionsResponse:
      type: object
      properties:
        success:
          type: boolean
        string_id:
          type: string
        count:
          type: integer
        versions:
          type: array
          description: Array of version metadata objects
        next_before_id:
          type: integer
          description: Cursor for next page
    GetApiFlowsIdVersionsVidResponse:
      type: object
      properties:
        success:
          type: boolean
        version:
          type: object
          description: Version details including full content JSON
    PostApiFlowsIdVersionsVidRestoreResponse:
      type: object
      properties:
        success:
          type: boolean
        version:
          type: object
          description: New version created by the restore
    GetApiJobStatusJobidResponse:
      type: object
      properties:
        job_id:
          type: string
        status:
          type: string
        flow_id:
          type: string
        url:
          type: string
        edit_url:
          type: string
        title:
          type: string
        images_generated:
          type: integer
    PostApiSignupRequest:
      type: object
      properties:
        email:
          type: string
          description: Email address for the new account
      required:
      - email
    PostApiSignupResponse:
      type: object
      properties:
        token:
          type: string
          description: Generated fvapi_* token
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Ai
- name: Api