docs: add developer and api reference tabs (#190)

* docs: add developer and api reference tabs

* fix: remove duplicate image
This commit is contained in:
Sabiha Khan 2026-03-14 16:30:02 +05:30 committed by GitHub
parent 1b03191cf8
commit f075bcb623
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
57 changed files with 1609 additions and 57 deletions

View 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.

View 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.

View 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.