API Documentation
Versioned Prompts
Phone Numbers
Models
curl --request GET \
--url https://api.vogent.ai/api/agents/{agentId}/versioned_prompts \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"agentType": "STANDARD",
"prompt": "<string>",
"flowDefinition": {
"nodes": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"transitionRules": [
{
"conditionType": "always",
"transitionNodeId": "<string>",
"arrayConditionType": "any",
"field": "<string>",
"value": "<string>",
"values": [
"<string>"
]
}
],
"nodeData": {},
"outputSchema": "<string>"
}
],
"globalContext": "<string>",
"aiOpen": true,
"openingLineType": "INBOUND_ONLY"
},
"aiModelId": "<string>",
"modelOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
]
}
],
"cursor": "<string>"
}List versioned prompts
Lists versioned prompts for a given agent.
curl --request GET \
--url https://api.vogent.ai/api/agents/{agentId}/versioned_prompts \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"agentType": "STANDARD",
"prompt": "<string>",
"flowDefinition": {
"nodes": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"transitionRules": [
{
"conditionType": "always",
"transitionNodeId": "<string>",
"arrayConditionType": "any",
"field": "<string>",
"value": "<string>",
"values": [
"<string>"
]
}
],
"nodeData": {},
"outputSchema": "<string>"
}
],
"globalContext": "<string>",
"aiOpen": true,
"openingLineType": "INBOUND_ONLY"
},
"aiModelId": "<string>",
"modelOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
]
}
],
"cursor": "<string>"
}Authorizations
In the form Bearer <api_key_here>. You can find your api key in your dashboard.
Path Parameters
ID of the agent.
Query Parameters
The maximum number of prompts to list.
The pagination cursor returned by the previous request. Feed the result provided by vogent verbatim.
Response
Successful operation
Show child attributes
Show child attributes
Unique identifier for the versioned prompt
Human-readable name for the versioned prompt
The type of agent this prompt is designed for (STANDARD or CUSTOM_FLOW)
STANDARD, CUSTOM_FLOW The actual prompt content that will be used by the agent. Can be null for CUSTOM_FLOW agent types
The flow definition for the agent. Only defined for CUSTOM_FLOW agent types.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The node type. View the available types at https://docs.vogent.ai/flow.
Show child attributes
Show child attributes
The condition used to evaluate the transition rule. If language, the value will be used as a natural language condition to describe when to execute a transition.
always, equal, in, greater, less, language The type of array condition to apply. 'any' means at least one element must match, 'all' means all elements must match.
any, all The node-specific configuration. View the schemas by type at https://docs.vogent.ai/flow.
The JSON schema describing the output of this node. This is generated automatically from the node type and node data.
Deprecated, use openingLineType instead.
INBOUND_ONLY, INBOUND_OUTBOUND, NONE The AI model ID to use for the agent.
A cursor you can pass to fetch the next page. If no next page exists, the cursor will be null.