Get Conductor walkthrough

Get the built-in step-by-step walkthrough for a topic.

GEThttps://api.tried.com.au/conductor/walkthrough

Returns a built-in walkthrough: a list of dashboard steps with the page path and the element to highlight. It does not use an LLM or credits.

Request#

Field	Type	Required	Description
`topic`	string	No	Free text, matched by keyword: phone numbers, knowledge base, batch calls, QA, alerts, webhooks, call history, analytics or workspace settings. Anything else, or no topic, returns the "Build and launch an agent" walkthrough.

topic is a query parameter.

Example request#

curl "https://api.tried.com.au/conductor/walkthrough?topic=alert" \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/conductor/walkthrough?topic=alert", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const walkthrough = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/conductor/walkthrough",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    params={
        "topic": "alert",
    },
)
walkthrough = res.json()

Response#

200 OK

{
  "match": {},
  "title": "Create an alert",
  "steps": [
    {
      "title": "Open Alerting",
      "path": "/alerting",
      "detail": "In the sidebar under MONITOR.",
      "selector": "nav-alerting"
    },
    {
      "title": "Choose a metric and threshold",
      "path": "/alerting",
      "detail": "For example e2e latency p90 above 1500 ms over the last hour.",
      "selector": "alert-create"
    },
    {
      "title": "Add email or webhook",
      "path": "/alerting",
      "detail": "Send a test notification to check it arrives.",
      "selector": "alert-test"
    }
  ]
}

Field	Type	Description
`title`	string	Walkthrough name.
`steps[].path`	string	Dashboard path to open for the step.
`steps[].selector`	string	`data-tour` or `data-testid` value of the element to highlight.
`match`	object	Always an empty object, present on topic walkthroughs. Ignore it.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell's public API reference has no Conductor endpoints, so this route has no Retell SDK equivalent.