API & Docs

Integrate DreamCoach's powerful Jungian analysis engine into your own applications, and learn how to master our tools.

menu_book

Product Tutorial

Learn how to use DreamCoach effectively.

 api

API Reference

Endpoints, authentication, and examples.
menu_book

Product Tutorial

Welcome to DreamCoach! Whether you are seeking personal growth, attempting to decipher recurring dreams, or just exploring the depths of your subconscious, our platform is designed to guide you.

1. Recording Your Dream

On the homepage, you'll find the primary Dream Entry form. The best time to record a dream is immediately upon waking. Even fragments of a dream can be incredibly revealing. Try to include emotions, colors, and specific people or objects you saw.

2. Reviewing the Analysis

Once analyzed, you will receive a comprehensive breakdown based on Jungian and Freudian frameworks. Look specifically for the Archetypes section, which maps characters in your dream to universal symbols like the Shadow or the Anima.

3. Tracking Trends (Pro)

If you are on the Pro plan, head to the Analysis page. Here, you can select a date range and ask our AI to identify recurring themes across multiple dreams, helping you spot long-term psychological patterns.

api

API Reference

Integrate DreamCoach analysis into your own applications. Our REST API allows you to submit dream descriptions and receive structured Jungian analyses.

Authentication

All API requests require a Developer API Key. You can generate or retrieve your key in your Profile Settings. Pass the key in the headers of your request as x-api-key.

Header: x-api-key: dc_live_xxxxxxxxxxxx

Analyze Dream Endpoint

POST

https://us-central1-dreamanalysis-39322.cloudfunctions.net/api/analyze

Request Body (JSON)

{ "dreamText": "I was flying over a city made of glass...", "context": "Felt very anxious upon waking up." }

Success Response (200 OK)

{ "status": "success", "data": { "summary": "A dream representing a desire for clarity and transcendence...", "archetypes": ["The Explorer", "The Glass City"], "emotions": ["Freedom", "Anxiety"] } }