Create a variable

Create a new key-value variable. Keys must be unique within the team/user scope. Variables can be referenced in workflow prompts using @variableKey syntax.

POST /v4/variables

Create a variable

cURL

curl --request POST \
  --url https://api.kadoa.com/v4/variables/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "<string>",
  "value": "<string>",
  "dataType": "STRING"
}
'

200

{
  "variable": {
    "id": "<string>",
    "key": "<string>",
    "value": "<string>",
    "createdAt": "<string>",
    "dataType": "STRING",
    "updatedAt": "<string>"
  },
  "error": "<string>"
}

Authorizations

x-api-key · string · header · required

API key for authentication

Body

application/json

Body

Request body for creating a variable

key · string · required

Variable key (must be unique within scope)

Minimum string length: 1

value · string · required

Variable value

dataType · enum<string> · default: STRING

The data type of the variable value

Available options: STRING, SECRET, OBJECT, ARRAY

Response

200

application/json

200

Response containing a single variable

variable · Variable · object · required

A key-value variable scoped to a team or user

Show child attributes

error · string | null · required