Skip to main content

API Reference

API docs by Redocly

Breadcrumb API (0.1.0)

Download OpenAPI specification:Download

This is the API for Breadcrumb

sources

Manage data sources like database connectors, spreadsheets, and smart connectors

spaces

Manage spaces, which are filtered views of data sources shared with customers

embed

Endpoints for embedded authentication and user management

Generate embed token

Generates a JWT token for embedded authentication.

The token can be used to authenticate users in embedded contexts, such as
iframe integrations. If a user with the provided email doesn't exist,
a new user account will be created.
Authorizations:
APIKeyHeader
Request Body schema: application/json
required
Customer Id (string) or Customer Id (null) (Customer Id)

Existing customer ID to associate with the user

email
required
string (Email)

Email address of the user to generate token for

name
required
string (Name)

Full name of the user

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "email": "user@example.com",
  • "name": "John Doe"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

conversations

AI-powered chat interface for data analysis. Enables natural language interactions with your data sources, generates visualizations, and provides analytical insights. Each conversation maintains context and can perform multi-step analysis tasks.

Send Message

Authorizations:
APIKeyHeader
path Parameters
conversation_id
required
string (Conversation Id)
Request Body schema: application/json
required
text
required
string (Text)

Responses

Request samples

Content type
application/json
{
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "text": "string",
  • "role": "user",
  • "visualization": "string"
}

Get Messages

Authorizations:
APIKeyHeader
path Parameters
conversation_id
required
string (Conversation Id)
query Parameters
limit
integer (Limit)
Default: 100
Next Token (string) or Next Token (null) (Next Token)

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "next_token": "string"
}

Get Conversation

Authorizations:
APIKeyHeader
path Parameters
conversation_id
required
string (Conversation Id)

Responses

Response samples

Content type
application/json
{
  • "conversation_id": "string",
  • "data_sources": [
    ]
}

Delete Conversation

Authorizations:
APIKeyHeader
path Parameters
conversation_id
required
string (Conversation Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}