Flowise variables API

openapi: 3.0.3
info:
  title: Flowise APIs assistants variables 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: variables
paths:
  /variables:
    post:
      tags:
      - variables
      security:
      - bearerAuth: []
      operationId: createVariable
      summary: Create a new variable
      description: Create a new variable
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Variable'
        required: true
      responses:
        '200':
          description: Variable created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Variable'
        '400':
          description: Invalid request body
        '422':
          description: Validation error
        '500':
          description: Internal server error
    get:
      tags:
      - variables
      security:
      - bearerAuth: []
      summary: List all variables
      description: Retrieve a list of all variables
      operationId: getAllVariables
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Variable'
        '500':
          description: Internal server error
  /variables/{id}:
    put:
      tags:
      - variables
      security:
      - bearerAuth: []
      summary: Update a variable by ID
      description: Update a specific variable by ID
      operationId: updateVariable
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: Variable ID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Variable'
        required: true
      responses:
        '200':
          description: Variable updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Variable'
        '400':
          description: Invalid ID or request body provided
        '404':
          description: Variable not found
        '500':
          description: Internal server error
    delete:
      tags:
      - variables
      security:
      - bearerAuth: []
      summary: Delete a variable by ID
      description: Delete a specific variable by ID
      operationId: deleteVariable
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: Variable ID
      responses:
        '200':
          description: Variable deleted successfully
        '400':
          description: Invalid ID provided
        '404':
          description: Variable not found
        '500':
          description: Internal server error
components:
  schemas:
    Variable:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the variable
          example: cfd531e0-82fc-11e9-bc42-526af7764f64
        name:
          type: string
          description: Name of the variable
          example: API_KEY
        value:
          type: string
          description: Value of the variable
          nullable: true
          example: my-secret-key
        type:
          type: string
          description: Type of the variable (e.g., string, number)
          example: string
        createdDate:
          type: string
          format: date-time
          description: Date and time when the variable was created
          example: '2024-08-24T14:15:22Z'
        updatedDate:
          type: string
          format: date-time
          description: Date and time when the variable was last updated
          example: '2024-08-24T14:15:22Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT