Variables | FlowiseAI

Create a new variable

post

Create a new variable

Authorizations

Body

idstring · uuidOptional

Unique identifier for the variable

Example: cfd531e0-82fc-11e9-bc42-526af7764f64

namestringOptional

Name of the variable

Example: API_KEY

valuestring | nullableOptional

Value of the variable

Example: my-secret-key

typestringOptional

Type of the variable (e.g., string, number)

Example: string

createdDatestring · date-timeOptional

Date and time when the variable was created

Example: 2024-08-24T14:15:22Z

updatedDatestring · date-timeOptional

Date and time when the variable was last updated

Example: 2024-08-24T14:15:22Z

Responses

200

Variable created successfully

application/json

400

Invalid request body

422

Validation error

500

Internal server error

post

POST /variables HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

List all variables

get

Retrieve a list of all variables

Authorizations

Responses

200

Successful operation

application/json

500

Internal server error

get

GET /variables HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
    "name": "API_KEY",
    "value": "my-secret-key",
    "type": "string",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }
]

Update a variable by ID

put

Update a specific variable by ID

Authorizations

Path parameters

idstringRequired

Variable ID

Body

idstring · uuidOptional

Unique identifier for the variable

Example: cfd531e0-82fc-11e9-bc42-526af7764f64

namestringOptional

Name of the variable

Example: API_KEY

valuestring | nullableOptional

Value of the variable

Example: my-secret-key

typestringOptional

Type of the variable (e.g., string, number)

Example: string

createdDatestring · date-timeOptional

Date and time when the variable was created

Example: 2024-08-24T14:15:22Z

updatedDatestring · date-timeOptional

Date and time when the variable was last updated

Example: 2024-08-24T14:15:22Z

Responses

200

Variable updated successfully

application/json

400

Invalid ID or request body provided

404

Variable not found

500

Internal server error

put

PUT /variables/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Delete a variable by ID

delete

Delete a specific variable by ID

Authorizations

Path parameters

idstringRequired

Variable ID

Responses

200

Variable deleted successfully

400

Invalid ID provided

404

Variable not found

500

Internal server error

delete

DELETE /variables/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content