Commonly used Endpoints
Automatically Sync Dot
To keep Dot in sync with your production environment, it is recommended to trigger the following API endpoint
Successful Response
Validation Error
POST /api/sync/{connection_type}/{connection_id} HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Accept: */*
No content
// URL endpoint
https://{region}.getdot.ai/api/sync/{connection_type}/{connection_type}?user_id={user}&api_token={api_token}Region:
app(US) oreu(EU)Connection Type:
postgres,redshift,snowflake,mssql,bigquery,databricks,looker,dbtUser ID: usually email of the user (url encoded)
API Token: can get created (and overwritten) by clicking
Copy API Tokenin Settings/Users/Actions/···
Trigger with curl (CLI)
curl -X "POST" "https://eu.getdot.ai/api/sync/bigquery/my-bg-id?user_id=sync_user%40contoso.com&api_token=dot-42673584be9724a21e1550336d6fe509f4a04207461ec9a926ca2a27cbd27fa0Trigger with dbt webhooks
Call the api endpoint after your dbt run completed.
Import External Assets
Inform Dot about key external knowledge assets, such as BI dashboards or custom data apps, so it can recommend them to users and assist with discovery and understanding. Authentication works similarly to the Sync Connection endpoint.
Successful Response
Validation Error
POST /api/import_and_overwrite_external_asset HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 193
{
"external_asset": {
"id": "text",
"subtype": "text",
"folder": "text",
"name": "text",
"description": "text",
"url": "text",
"active": true,
"view_count": 0,
"last_accessed_at": "text",
"dot_description": "text"
}
}No content
Export Conversation History
Export all conversations together with relevant meta data fields such as number of messages or author.
by default two weeks ago, format YYYY-MM-DD
by default tomorrow, format YYYY-MM-DD
Successful Response
Validation Error
GET /api/export_history HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Accept: */*
No content
Ask Dot Automatically
""falseSuccessful Response
Validation Error
POST /api/ask HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 115
{
"messages": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"chat_id": "text",
"scope": "",
"skip_check": false,
"extra": "text"
}No content
Successful Response
Validation Error
POST /api/ask_with_history HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"new_message": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"chat_id": "text",
"extra": "text"
}No content
Trigger Deep Analysis
falseSuccessful Response
Validation Error
POST /api/agentic HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"messages": [
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"chat_id": "text",
"skip_check": false,
"extra": "text"
}No content
User Administration
Successful Response
Validation Error
POST /api/send_invitations HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"emails": [
"text"
]
}No content
Successful Response
Validation Error
POST /api/delete_user HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"email": "text"
}No content
Successful Response
Validation Error
POST /api/change_user_role HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"email": "text",
"role": "text"
}No content
Successful Response
Validation Error
POST /api/add_user_to_group HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"email": "text",
"group": "text"
}No content
Successful Response
Validation Error
POST /api/remove_user_from_group HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"email": "text",
"group": "text"
}No content
Successful Response
Validation Error
POST /api/create_user HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"email": "text",
"password": "text",
"realname": "text"
}No content
Automatically Authenticate Embedded Users
For embedded use cases that require SSO, where your end users have individual permissions you can use this endpoint to obtain an access token for users that is valid for 24h. Here is an example on how you can use it to embed Dot in your application.
Please make sure that you enabled this flag on settings: "Allow admins to authenticate for users to enable SSO in embeds".
falseSuccessful Response
Validation Error
POST /api/auth/embedded_user_login HTTP/1.1
Host:
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"user_id": "text",
"create_if_not_exists": false,
"groups": [
"text"
]
}No content
Last updated