API documentation
API reference
Every operation of the API, by module: parameters, body, responses and a curl example, taken from the OpenAPI contract.
Download openapi.json
262 operations
Base URL
https://{your-workspace}.tellmehow.io/api/v1
Modules
- AI 17 Model catalog, AI profiles by usage, workspace connections, price grid, Voice lab.
- Analysis 59 Start the analysis, review processes, findings, evidence, contradictions, opportunities and follow-ups.
- Audit chat 5 Ask sourced questions about an engagement and read the threads.
- Deliverable 20 Draft, recommendations, publication, versions, sponsor comments, exports.
- Engagements 55 Client companies, engagements, populations, participants, plan, email templates, launch.
- Integrations 1 The OpenAPI contract of the workspace.
- Interviews 18 Progress, interviews, chapters and recaps, sessions and transcripts.
- Methods 27 Templates, methods and versions, interview guide at every level.
- Privacy 23 Retention, deletions, purges, raw access log, compliance documents, support access.
- Sources 10 Uploaded documents and external sources in the exchange format.
- AI usage 11 Costs, dashboard, AI call details, alerts and workspace budget.
- Workspace and account 16 Your account, the workspace, its branding, members and invitations.