apunkt/dograh
1
0
Fork 0
mirror of https://github.com/dograh-hq/dograh.git synced 2026-06-16 08:25:18 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: updatae documentation for api trigger

Browse source
This commit is contained in:
Abhishek Kumar 2026-05-04 12:46:11 +05:30
parent 5ad5bbd985
commit 0d7b225f76
12 changed files with 120 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/api-reference/calls.mdx
View file

@ -6,7 +6,6 @@ description: "Initiate outbound calls and trigger agents via the API"
| Method | Endpoint | Quick Link |
|---|---|---|
| `POST` | `/public/agent/{uuid}` | [Trigger an outbound call](/api-reference/calls/trigger) |
| `POST` | `/telephony/initiate-call` | [Initiate a call (authenticated)](/api-reference/calls/initiate) |
| `GET` | `/workflow/{workflow_id}/runs/{run_id}` | [Retrieve call details](/api-reference/calls/get-run) |
| `GET` | `/public/download/workflow/{token}/{artifact_type}` | [Download recordings and transcripts](/api-reference/calls/download) |
| `POST` | `/telephony/inbound/{workflow_id}` | [Inbound call webhook](/api-reference/calls/inbound) |

7
docs/api-reference/calls/initiate.mdx
View file

@ -1,7 +0,0 @@
---
title: "Initiate a Call (Authenticated)"
description: "Start an outbound call with more control than the public endpoint"
openapi: "POST /api/v1/telephony/initiate-call"
---
Use this endpoint when you need to specify a `workflow_run_id` to resume context from a previous run, or when you want to use the workflow's integer ID instead of its public UUID.

4
docs/api-reference/calls/trigger.mdx
View file

@ -4,12 +4,14 @@ description: "Initiate an outbound call using an agent's public UUID"
openapi: "POST /api/v1/public/agent/{uuid}"
---
The simplest way to initiate a call programmatically. The `uuid` is visible in the dashboard URL when viewing an agent.
The simplest way to initiate a call programmatically. The `uuid` comes from the [API Trigger node](/voice-agent/api-trigger) in your agent — add the node to your workflow and copy its auto-generated `trigger_path`.
Use `workflow_run_id` from the response to later [retrieve call details](/api-reference/calls/get-run), recordings, and transcripts.
Pass `initial_context` to inject runtime data as template variables into the agent's prompt. See [Using initial context](/api-reference/calls#using-initial-context).
Pass `telephony_configuration_id` to route the call through a specific telephony configuration instead of your organization's default. The id is shown on each row in **Telephony configurations** (`https://app.dograh.com/telephony-configurations` for hosted or `http://localhost:3010/telephony-configurations` for local).
<Note>
Your telephony provider must be configured before outbound calls will connect. See [Telephony](/integrations/telephony/overview) for setup instructions.
</Note>

1
docs/docs.json
View file

@ -202,7 +202,6 @@
"pages": [
"api-reference/calls",
"api-reference/calls/trigger",
"api-reference/calls/initiate",
"api-reference/calls/get-run",
"api-reference/calls/download",
"api-reference/calls/inbound"

15
docs/voice-agent/api-trigger.mdx
View file

@ -36,7 +36,7 @@ The request body, headers, and response shape are identical for both URLs.
## Making a request
Authenticate by passing your API key in the `X-API-Key` header. The request body requires a `phone_number` and accepts an optional `initial_context` object.
Authenticate by passing your API key in the `X-API-Key` header. The request body requires a `phone_number` and accepts optional `initial_context` and `telephony_configuration_id` fields.
```bash
curl -X POST https://your-dograh-instance/api/v1/public/agent/{uuid} \
@ -92,6 +92,19 @@ You can reference the user's name in your prompt as `{{initial_context.user.name
See [Context & Variables](/core-concepts/context-and-variables) for more on how data flows through a call.
## Choosing a telephony configuration
By default, calls are placed through your organization's default outbound [telephony configuration](/integrations/telephony/overview). To route a specific call through a different configuration — for example, to dial out from a regional number — pass `telephony_configuration_id` in the request body.
```json
{
"phone_number": "+14155550100",
"telephony_configuration_id": 42
}
```
The id is shown on each row in **Telephony configurations** (`https://app.dograh.com/telephony-configurations` for hosted or `http://localhost:3010/telephony-configurations` for local). The configuration must belong to the same organization as the API Trigger; otherwise the request returns `404`.
<Note>
For full endpoint details including all parameters and response fields, see the [API reference](/api-reference/calls/trigger).
</Note>