mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-22 08:38:13 +02:00
chore: add and improve documentation
This commit is contained in:
parent
96f8aaf325
commit
8b820c6d8a
23 changed files with 395 additions and 54 deletions
23
docs/voice-agent/api-trigger.mdx
Normal file
23
docs/voice-agent/api-trigger.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: "API Trigger"
|
||||
description: "API Trigger helps you trigger your Voice Agent using external systems, like N8n or Zapier"
|
||||
---
|
||||
|
||||
### API Payload
|
||||
The API Trigger is a POST request, which requires an [API Key](configurations/api-keys). It expects a valid JSON with `phone_number` and `initial_context`.
|
||||
|
||||
### Initial Context
|
||||
`initial_context` is a valid JSON object, which contains any contextual information that you would want your voice agent to access. You can refer to these values in your prompts using **Handle Bars**, which are values enclosed in `{{` and `}}`.
|
||||
|
||||
Example: If you have below JSON as your `initial_context`
|
||||
```
|
||||
{
|
||||
"initial_context": {
|
||||
"user": {
|
||||
"name": "John"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
you can refer to the user name in your prompts as `{{initial_context.user.name}}`.
|
||||
Loading…
Add table
Add a link
Reference in a new issue