- API Reference
- Get Started
- Authentication
- Endpoints
- V3 API
- Get Started
- Resources
- POSTCreate Workspace
- POSTWorkspace Usage
- GETGet Workspace By ID
- GETGet Workspaces
- DELDelete Workspace
- PATCHUpdate Workspace
- POSTCreate Agent
- POSTAgent Usage
- GETGet Agent By ID
- GETGet Agents
- DELDelete Agent
- PATCHUpdate Agent
- GETExport Agent Template
- POSTImport Agent Template
- POSTTwilio Call (incoming / outgoing)
- POSTImport a Twilio Number
- POSTBuy a Twilio Number
- POSTCreate Tool
- GETGet Tools
- GETGet Tool By ID
- DELDelete Tool
- PATCHUpdate Tool
- POSTCreate Variable
- GETGet Variables
- GETGet Variable By ID
- DELDelete Variable
- PATCHUpdate Variable
- POSTCreate Lead
- GETGet Leads
- GETGet Lead By ID
- DELDelete Lead
- PATCHUpdate Lead
- POSTCreate KB
- GETGet agent KB docs
- GETGet Single KB Doc
- GETGet KB Stats
- DELDelete KB Doc
- PATCHUpdate KB Doc
- GETGet All Organizations
- GETGet Organization Agents
- GETGet Organization Clients
- POST
- Legacy APIs
Get Variable By ID
Gets a variable, this route must use the new V3 endpoints.
curl --request GET \
--url https://eu-gcp-api.vg-stuff.com/v3/variables/{variableId} \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
A unique identifier for the field, ensuring it is distinct across the system.
Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.
Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.
string, number, boolean, system The current assigned value of the field. This value is optional and supports any type depending on the field's context.
A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.
The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.
A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.
Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.
Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.
Specifies if this field represents an environment variable, typically used for configuration or deployment.
Indicates whether this field is a system-level variable, reserved for core operations or internal use.
If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.
References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.
References the unique identifier of the user associated with this field. Useful for user-specific customizations.
A unique identifier for the field, ensuring it is distinct across the system.
Defines the location or context in which the field is utilized. Common values include 'query', 'body', or 'header'.
Specifies the variable type of the field. Acceptable values include 'string', 'number', 'boolean', and 'system'.
string, number, boolean, system The current assigned value of the field. This value is optional and supports any type depending on the field's context.
A predefined value assigned to the field when no specific value is provided. Useful for ensuring consistent behavior.
The unique key that identifies this tool field or variable. Often used for referencing the field programmatically.
A detailed explanation of the field's purpose and usage. Helps users understand the field's role in the system.
Indicates whether the presence of this field is mandatory for successful operation. Defaults to false if unspecified.
Denotes whether this field can be reused across multiple contexts or tools. Useful for reducing redundancy.
Specifies if this field represents an environment variable, typically used for configuration or deployment.
Indicates whether this field is a system-level variable, reserved for core operations or internal use.
If enabled, this field remains globally accessible to the agent across all operational contexts. Useful for global constants.
References the unique identifier of the agent associated with this field. Helps in mapping fields to specific agents.
References the unique identifier of the user associated with this field. Useful for user-specific customizations.
The response is of type any.
curl --request GET \
--url https://eu-gcp-api.vg-stuff.com/v3/variables/{variableId} \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"in": "<string>",
"type": "string",
"value": "<any>",
"defaultValue": "<any>",
"key": "<string>",
"description": "<string>",
"required": true,
"reusable": true,
"isEnv": true,
"isSystem": true,
"isGlobal": true,
"agentId": "<string>",
"userId": "<string>"
}
}