Flowise

Flowise ping API

The ping API from Flowise — 1 operation(s) for ping.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.flowiseai.com/api-reference
📖
Authentication
https://docs.flowiseai.com/using-flowise/api-keys

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/flowise/refs/heads/main/openapi/flowise-ping-api-openapi.yml

Other Resources

🔗
SwaggerUI
https://github.com/FlowiseAI/Flowise/tree/main/packages/api-documentation
🔗
Prediction
https://docs.flowiseai.com/api-reference/prediction

OpenAPI Specification

flowise-ping-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Flowise APIs assistants ping API
  version: 1.0.0
  description: 'Flowise REST API for managing AI agent flows, chatflows, assistants, document stores, tools, variables, and predictions.

    Bearer token authentication uses an API key generated in the Flowise admin UI. The default server is your local or hosted Flowise instance at /api/v1.

    '
  license:
    name: Apache 2.0
    url: https://github.com/FlowiseAI/Flowise/blob/main/LICENSE.md
  contact:
    name: FlowiseAI
    email: support@flowiseai.com
servers:
- url: http://localhost:3000/api/v1
  description: Local Flowise server
- url: https://{instance}.flowiseai.com/api/v1
  description: Flowise Cloud instance
  variables:
    instance:
      default: app
tags:
- name: ping
paths:
  /ping:
    get:
      tags:
      - ping
      summary: Ping the server
      description: Ping the server to check if it is running
      operationId: pingServer
      responses:
        '200':
          description: Server is running
          content:
            text/plain:
              schema:
                type: string
                example: pong
        '500':
          description: Internal server error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT