mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-10 08:05:22 +02:00
docs: add developer and api reference tabs (#190)
* docs: add developer and api reference tabs * fix: remove duplicate image
This commit is contained in:
parent
1b03191cf8
commit
f075bcb623
57 changed files with 1609 additions and 57 deletions
7
docs/api-reference/calls/download.mdx
Normal file
7
docs/api-reference/calls/download.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Download Recordings and Transcripts"
|
||||
description: "Download a recording or transcript using a time-limited public URL"
|
||||
openapi: "GET /api/v1/public/download/workflow/{token}/{artifact_type}"
|
||||
---
|
||||
|
||||
`artifact_type` is either `recording` or `transcript`. The `token` is a time-limited download token — generate one from the run details before calling this endpoint.
|
||||
9
docs/api-reference/calls/get-run.mdx
Normal file
9
docs/api-reference/calls/get-run.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Retrieve Call Details"
|
||||
description: "Get the details, transcript, and recording for a call"
|
||||
openapi: "GET /api/v1/workflow/{workflow_id}/runs/{run_id}"
|
||||
---
|
||||
|
||||
Returns the full run record including call status, duration, transcript URL, recording URL, gathered context, and usage/cost info.
|
||||
|
||||
Use the `recording_url` and `transcript_url` directly, or use the [Download endpoint](/api-reference/calls/download) to generate time-limited public URLs for sharing.
|
||||
9
docs/api-reference/calls/inbound.mdx
Normal file
9
docs/api-reference/calls/inbound.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Inbound Call Webhook"
|
||||
description: "Webhook endpoint that routes inbound calls to a specific agent"
|
||||
openapi: "POST /api/v1/telephony/inbound/{workflow_id}"
|
||||
---
|
||||
|
||||
Configure this URL in your telephony provider's dashboard (Twilio, Vonage, etc.) to route inbound calls to a specific agent. The `workflow_id` determines which agent handles the call.
|
||||
|
||||
See [Inbound Calls](/integrations/telephony/inbound) for full setup instructions per provider.
|
||||
7
docs/api-reference/calls/initiate.mdx
Normal file
7
docs/api-reference/calls/initiate.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
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.
|
||||
15
docs/api-reference/calls/trigger.mdx
Normal file
15
docs/api-reference/calls/trigger.mdx
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
title: "Trigger an Outbound Call"
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
<Note>
|
||||
Your telephony provider must be configured before outbound calls will connect. See [Telephony](/integrations/telephony/overview) for setup instructions.
|
||||
</Note>
|
||||
Loading…
Add table
Add a link
Reference in a new issue