# userjourneys.ai

## Docs

- [Authentication](https://docs.userjourneys.ai/api/authentication.md): Authenticate API requests with a project API key.
- [Chat Messages](https://docs.userjourneys.ai/api/chat-messages.md): List the visible transcript of a chat — text, thinking, tool calls, and tool results, in chronological order.
- [Chats](https://docs.userjourneys.ai/api/chats.md): List and retrieve chats — access customer-visible chat metadata and message counts.
- [Experiments (Deprecated)](https://docs.userjourneys.ai/api/experiments.md): This endpoint is deprecated. Use /v1/studies instead.
- [API Overview](https://docs.userjourneys.ai/api/index.md): Programmatic access to your userjourneys.ai project — manage studies, fetch interviews, inspect releases and chats, and configure webhooks.
- [Interviews](https://docs.userjourneys.ai/api/interviews.md): List and retrieve individual interviews — access transcripts, summaries, and structured question answers.
- [Releases](https://docs.userjourneys.ai/api/releases.md): List and retrieve releases — access merged pull request metadata and the linked chat for each release.
- [Studies](https://docs.userjourneys.ai/api/studies.md): List and retrieve your interview studies — check capacity, limits, and whether a study is accepting responses.
- [Webhooks](https://docs.userjourneys.ai/api/webhooks.md): Receive real-time notifications when interviews complete, with duration, quality score, and respondent data.
- [AI Agent](https://docs.userjourneys.ai/chat/index.md): Ask product questions in natural language and get answers backed by your data.
- [Success metrics](https://docs.userjourneys.ai/experiments/metrics.md): Configure success metrics to measure whether an experiment's treatment moved user behavior in the direction you intended.
- [Mixpanel Setup](https://docs.userjourneys.ai/funnels/mixpanel.md): Follow these steps to create a Mixpanel Service Account for userjourneys.ai
- [PostHog Setup](https://docs.userjourneys.ai/funnels/posthog.md): Follow these steps to create and configure your PostHog API key with userjourneys.ai
- [Guides](https://docs.userjourneys.ai/guides/index.md): Step-by-step walkthroughs for common userjourneys.ai integrations.
- [Track Interview Completions](https://docs.userjourneys.ai/guides/track-completions.md): Detect when users complete an interview via webhook, fetch the transcript, and update your product in real time.
- [Getting Started](https://docs.userjourneys.ai/index.md): Get started with userjourneys.ai
- [Creating and Managing Experiments](https://docs.userjourneys.ai/interviews/experiments.md): Set up interview experiments using a 6-step wizard with AI-powered prefill, custom questions, voice settings, and more.
- [Interviews Overview](https://docs.userjourneys.ai/interviews/index.md): Collect user feedback through AI-powered voice conversations that feel natural and extract deeper insights.
- [Understanding Themes & Results](https://docs.userjourneys.ai/interviews/insights.md): Learn how themes are extracted from interviews and how to use them to improve your product.
- [Multi-Language Support](https://docs.userjourneys.ai/interviews/languages.md): Run interviews in 32 languages and view translated results in English.
- [Quality Evaluation](https://docs.userjourneys.ai/interviews/quality.md): How interview quality is automatically evaluated across three tiers and what it means for your insights.
- [Writing Good Interview Questions](https://docs.userjourneys.ai/interviews/questions.md): Learn how to write effective interview questions that the AI can use to guide meaningful conversations.
- [Troubleshooting](https://docs.userjourneys.ai/interviews/troubleshooting.md): Solutions for common issues with interviews, microphone access, and audio playback.
- [Support & Contact](https://docs.userjourneys.ai/support.md): How to reach userjourneys.ai — product help, security disclosures, privacy requests, and abuse reports — with response targets and what to include.