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/agents/runs/create.mdx
Normal file
7
docs/api-reference/agents/runs/create.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Create Test Run"
|
||||
description: "Execute a workflow without placing a real phone call"
|
||||
openapi: "POST /api/v1/workflow/{workflow_id}/runs"
|
||||
---
|
||||
|
||||
Creates a test execution of the workflow. No outbound call is placed — this is useful for validating agent behavior, checking prompt outputs, and testing tool integrations before going live.
|
||||
7
docs/api-reference/agents/runs/get.mdx
Normal file
7
docs/api-reference/agents/runs/get.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Get Run"
|
||||
description: "Retrieve a single workflow run by ID"
|
||||
openapi: "GET /api/v1/workflow/{workflow_id}/runs/{run_id}"
|
||||
---
|
||||
|
||||
Returns the full run record including status, transcript, recording URL, gathered context, and usage/cost info. Use `recording_url` and `transcript_url` to download artifacts, or use the [Download endpoint](/api-reference/calls/download) for time-limited public URLs.
|
||||
7
docs/api-reference/agents/runs/list.mdx
Normal file
7
docs/api-reference/agents/runs/list.mdx
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "List Runs"
|
||||
description: "Retrieve all runs for a workflow"
|
||||
openapi: "GET /api/v1/workflow/{workflow_id}/runs"
|
||||
---
|
||||
|
||||
Returns all runs for the given workflow, including both test runs and live call runs.
|
||||
Loading…
Add table
Add a link
Reference in a new issue