Bridget API Integration Guide
Overview
The Bridget API provides a conversational interface that enables users to interact with Bridgewise insights through natural language queries. Built on top of the Bridgewise data and AI stack, Bridget allows you to:
- Ask financial questions in plain language
- Receive structured answers enriched with Bridgewise analytics
- Maintain conversation context across multiple questions
- Embed conversational experiences directly into your applications
Bridget is delivered via a RESTful API, ensuring smooth integration and compatibility with modern development practices.
Getting Started
This guide will help you quickly integrate Bridget into your platform.
Authenticate using an access token generated via the Bridgewise Authentication Guide.
Use the /questions endpoint to initiate a new conversation thread and return a structured answer.
Include the session_id in subsequent requests to maintain context and enable multi-turn dialogue.
Retrieve users' questions and Bridget's responses for analytics, compliance, or engagement tracking.
Step 1: Obtain an Access Token
As with other BridgeWise APIs, you must authenticate using an access token. Please follow the instructions in our Authentication Guide to generate your token.
Every Bridget API call requires the header:
Authorization: Bearer <ACCESS_TOKEN>
Step 2: Ask a Question
Use the /questions endpoint to initiate a new conversation with Bridget. This creates a conversation thread and returns a structured answer.
/questionsRequest Example (Shell):
curl -X 'POST' \
'https://rest.bridgewise.com/questions' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Userid: <USER_ID>' \
-H 'Content-Type: application/json' \
-d '{
"message": "What is Tesla’s revenue growth over the last 3 years?",
"session_id": "a7ae38a0-b31c-4221-99ac-3b7199284eb3",
"language": "en-US"
}'Response Example (JSON):
{
"message": "Tesla, Inc. [NasdaqGS:TSLA] operates in the Consumer Discretionary sector, Automobiles & Components industry. The last closing price was 440.4 USD, with a market capitalization of 1.46T USD. Financial statement analysis: Tesla’s Q2 2025 showed revenue and net income both declined year-over-year. Asset growth was strong, but profitability margins and free cash flow fell sharply, lagging industry averages. The company trades at a much higher P/E ratio than peers. BridgeWise's recommendation for Tesla is Hold. News: Elon Musk purchased $1 billion in Tesla shares. The board proposed a $1 trillion compensation package for Musk tied to ambitious milestones. Broadcom’s market cap surpassed Tesla’s, and Korean investors are shifting away from Tesla due to concerns over AI and autonomous driving progress. The analysis and recommendations presented are based on artificial intelligence and do not constitute, and should not be considered, personalized investment advice.",
"message_id": "c9e8f4b6-1234-4a8a-91c3-82fbc0e6d11a"
}Request Parameters
| Parameter | Example Value | Description |
|---|---|---|
Userid (header) | <USER_ID> | Required for all API calls, represents your end-user |
message | "What is Tesla’s revenue growth..." | User’s natural language query |
language | "en-US" | Defines response language (supports multiple locales) |
session_id | "a7ae38a0-b31c..." | Unique identifier for user session (optional) |
Each Userid must uniquely represent an end-user in your platform.
Step 3: Continue the Conversation
To maintain context and enable multi-turn dialogue, include the session_id in subsequent requests.
/questionsRequest Example (Shell):
curl -X 'POST' \
'https://rest.bridgewise.com/questions' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Userid: <USER_ID>' \
-H 'Content-Type: application/json' \
-d '{
"message": "And what about operating margin?",
"language": "en-US",
"session_id": "a7ae38a0-b31c-4221-99ac-3b7199284eb3",
}'Response Example (JSON):
{
"message": "Tesla’s operating margin decreased to 9.4% in Q2 2025, compared to 14.6% a year earlier, driven by pricing pressure and higher production costs.",
"message_id": "b8f2a3e5-5678-42f2-9e11-92cf77f8f31b",
}Responses will include contextual understanding from prior messages.
Step 4: Retrieve User Conversations
Use this endpoint to retrieve your users’ questions and Bridget’s responses for analytics, compliance, or engagement tracking.
/tenants/{tenant_id}/questionsRequest Example (Shell):
curl -X 'GET' \
'https://rest.bridgewise.com/tenants/{tenant_id}/questions?date=2025-11-02&start_date=2025-11-01' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'Query Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
tenant_id | String - Mandatory | Your BridgeWise tenant identifier | bridgewise-1234 |
user_id | String - Optional | Filter by a specific user’s ID | user-abc-789 |
session_id | String - Optional | Filter by a specific session ID | session-abc-789 |
start_date | string (ISO 8601) | Start of date range. Filters questions created after or on this date. Required if date is not provided. Cannot be used with date. | YYYY-MM-DD |
end_date | string (ISO 8601) | End of date range. Filters questions created before or on this date. Required if date is not provided. Cannot be used with date. | YYYY-MM-DD |
date | string (ISO 8601) | Filters questions created on a specific date. Required if from_date and to_date are not provided. Cannot be used with them. | YYYY-MM-DD |
feedback_type | string - Optional | Filters by user feedback on each answer. Accepted values like OR dislike. | - |
Response Example (JSON):
{
"results": [
{
"timestamp": "2025-10-11T11:41:19.158Z",
"tenant_id": "bridgewise-1234",
"question_id": "q-987654321",
"user_id": "user-001",
"session_id": "a7ae38a0-b31c-4221-99ac-3b7199284eb3",
"client_id": "client-tradingapp-001",
"question": "What is Tesla’s revenue growth over the last 3 years?",
"answer": "Tesla’s revenue grew at a 43% CAGR over the past 3 years, driven by strong demand in EV and energy storage segments.",
"feedback_type": "positive",
"feedback_reason": "Accurate and clear answer",
"answer_requested_by_user": true
},
{
"timestamp": "2025-10-11T11:43:05.221Z",
"tenant_id": "bridgewise-1234",
"question_id": "q-987654322",
"user_id": "user-002",
"session_id": "a7ae38a0-b31c-4221-99ac-3b7199284eb3",
"client_id": "client-mobile-002",
"question": "Give me the BridgeWise recommendation for Apple",
"answer": "BridgeWise recommendation for Apple Inc. [NasdaqGS:AAPL] is **Buy**, reflecting consistent earnings growth and strong financial health.",
"feedback_type": null,
"feedback_reason": null,
"answer_requested_by_user": true
}
]
}Returns all questions and answers under your tenant. Data is read-only and cannot be modified.
Best Practices
- Always include a unique
Useridper end-user. - Use
session_idto support contextual, multi-step dialogues. - Use
GET /tenants/{tenant_id}/questionsto analyze usage and improve engagement.
Explore the Bridget API
You are now ready to integrate conversational insights into your platform.
For full reference of endpoints and schemas, visit:
? Bridget Swagger Documentation
For technical support, contact: support@bridgewise.com