mirror of
https://github.com/dograh-hq/dograh.git
synced 2026-06-10 08:05:22 +02:00
chore: return formatted transcript url
- Return formatted transcript and recording URL - Harden campaign dispatcher logic
This commit is contained in:
parent
0716582aa7
commit
7810923bca
30 changed files with 525 additions and 136 deletions
7
docs/api-reference/runs/download.mdx
Normal file
7
docs/api-reference/runs/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/runs/get-run.mdx
Normal file
9
docs/api-reference/runs/get-run.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Retrieve Agent Run Details"
|
||||
description: "Get the details, transcript, and recording for an agent run"
|
||||
openapi: "GET /api/v1/workflow/{workflow_id}/runs/{run_id}"
|
||||
---
|
||||
|
||||
Returns the full run record including run 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/runs/download) to generate time-limited public URLs for sharing.
|
||||
9
docs/api-reference/runs/inbound.mdx
Normal file
9
docs/api-reference/runs/inbound.mdx
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: "Inbound Run Webhook"
|
||||
description: "Webhook endpoint that starts agent runs from inbound calls"
|
||||
openapi: "POST /api/v1/telephony/inbound/{workflow_id}"
|
||||
---
|
||||
|
||||
Configure this URL in your telephony provider's dashboard (Twilio, Vonage, etc.) to start agent runs from 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.
|
||||
11
docs/api-reference/runs/list-runs.mdx
Normal file
11
docs/api-reference/runs/list-runs.mdx
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
title: "List Runs with Usage"
|
||||
description: "Paginated list of workflow runs across the organization with usage and cost"
|
||||
openapi: "GET /api/v1/organizations/usage/runs"
|
||||
---
|
||||
|
||||
Returns a paginated list of runs across all agents in your organization, including duration, cost, and usage details for each run.
|
||||
|
||||
Use `start_date` and `end_date` (ISO 8601) to scope the window, and `page` / `limit` to paginate. Pass `filters` as a JSON-encoded string to narrow results further.
|
||||
|
||||
To fetch the full transcript or recording for a specific run, use [Retrieve Agent Run Details](/api-reference/runs/get-run).
|
||||
25
docs/api-reference/runs/trigger-workflow.mdx
Normal file
25
docs/api-reference/runs/trigger-workflow.mdx
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: "Trigger an Outbound Agent Run by Agent UUID"
|
||||
description: "Start an outbound agent run using a workflow's stable Agent UUID"
|
||||
openapi: "POST /api/v1/public/agent/workflow/{workflow_uuid}"
|
||||
---
|
||||
|
||||
Use this endpoint when you want to start an agent run directly by its stable Agent UUID instead of through an API Trigger node.
|
||||
|
||||
The `workflow_uuid` is the workflow's Agent UUID. It is different from an API Trigger node's `trigger_path`.
|
||||
|
||||
To find and copy the Agent UUID in the UI, see [Agent UUID](/configurations/agent-uuid).
|
||||
|
||||
Use `workflow_run_id` from the response to later [retrieve run details](/api-reference/runs/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/runs#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>
|
||||
This route expects a workflow UUID. Do not pass an API Trigger node UUID here. If you want to execute via an API Trigger node, use [Trigger an outbound agent run](/api-reference/runs/trigger) instead.
|
||||
</Note>
|
||||
|
||||
<Note>
|
||||
Your telephony provider must be configured before outbound calls will connect. See [Telephony](/integrations/telephony/overview) for setup instructions.
|
||||
</Note>
|
||||
23
docs/api-reference/runs/trigger.mdx
Normal file
23
docs/api-reference/runs/trigger.mdx
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: "Trigger an Outbound Agent Run by API Trigger Node"
|
||||
description: "Start an outbound agent run using an API Trigger node UUID"
|
||||
openapi: "POST /api/v1/public/agent/{uuid}"
|
||||
---
|
||||
|
||||
Use this endpoint when you want to start an agent run through an [API Trigger node](/voice-agent/api-trigger).
|
||||
|
||||
The `uuid` comes from the API Trigger node 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 run details](/api-reference/runs/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/runs#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>
|
||||
This route expects an API Trigger node UUID (`trigger_path`). Do not pass a workflow UUID here. If you want to execute by Agent UUID, use [Trigger an outbound agent run by Agent UUID](/api-reference/runs/trigger-workflow) instead.
|
||||
</Note>
|
||||
|
||||
<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