API

automate as much as you like

PreviousPermissions NextEmbed

Last updated 2 months ago

Automatically Sync Dot

To keep Dot in sync with your production environment, it is recommended to trigger the following API endpoint

// URL endpoint
https://{region}.getdot.ai/api/sync/{connection_type}/{connection_type}?user_id={user}&api_token={api_token}

Region: app (US) or eu (EU)
Connection Type: postgres, redshift, snowflake, mssql, bigquery, databricks, looker, dbt
User ID: usually email of the user (url encoded)
API Token: can get created (and overwritten) by clicking Copy API Token in 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=42673584be9724a21e1550336d6fe509f4a04207461ec9a926ca2a27cbd27fa0

Trigger 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.

Export Conversation History

Export all conversations together with relevant meta data fields such as number of messages or author.

Authentication for all other endpoints

For most operations on Dot you first need to login.

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 enabled this flag on settings: "Allow admins to authenticate for users to enable SSO in embeds".

User Administration

Ask questions

Sync Connection

post

/api/sync/{connection_type}//{connection_id}

Path parameters

connection_typeConnection Typerequired

connection_idConnection Idrequired

Query parameters

user_idUser Idrequired

api_tokenApi Tokenrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/sync/{connection_type}/{connection_id}?user_id=text&api_token=text'

200

422

No body

Successful Response

Login For Access Token

post

/api/auth/token

Body

grant_typeGrant Type

Pattern: password

usernameUsernamerequired

passwordPasswordrequired

scopeScope

client_idClient Id

client_secretClient Secret

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/auth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data '{"username":"text","password":"text","scope":""}'

200

422

No body

Successful Response

Sendinvitations

post

/api/send_invitations

Authorizations

Body

emailsEmailsrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/send_invitations' \
  --header 'Content-Type: application/json' \
  --data '{"emails":[null]}'

200

422

No body

Successful Response

Delete User Route

post

/api/delete_user

Authorizations

Body

emailEmailrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/delete_user' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text"}'

200

422

No body

Successful Response

Change User Role

post

/api/change_user_role

Authorizations

Body

emailEmailrequired

roleRolerequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/change_user_role' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","role":"text"}'

200

422

No body

Successful Response

Add User To Group

post

/api/add_user_to_group

Authorizations

Body

emailEmailrequired

groupGrouprequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/add_user_to_group' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","group":"text"}'

200

422

No body

Successful Response

Remove User From Group

post

/api/remove_user_from_group

Authorizations

Body

emailEmailrequired

groupGrouprequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/remove_user_from_group' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","group":"text"}'

200

422

No body

Successful Response

Ask With History

post

/api/ask_with_history

Authorizations

Body

new_messageNew Messagerequired

chat_idChat Idrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/ask_with_history' \
  --header 'Content-Type: application/json' \
  --data '{"new_message":{},"chat_id":"text"}'

200

422

No body

Successful Response

Ask

post

/api/ask

Authorizations

Body

chat_idChat Idrequired

messagesMessagesrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/ask' \
  --header 'Content-Type: application/json' \
  --data '{"chat_id":"text","messages":[{}]}'

200

422

No body

Successful Response

Create User Route

post

/api/create_user

Authorizations

Body

emailEmailrequired

passwordPasswordrequired

realnameRealnamerequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/create_user' \
  --header 'Content-Type: application/json' \
  --data '{"email":"text","password":"text","realname":"text"}'

200

422

No body

Successful Response

Import External Asset

post

/api/import_and_overwrite_external_asset

Query parameters

user_idUser Idrequired

api_tokenApi Tokenrequired

Body

external_assetExternalAssetrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/import_and_overwrite_external_asset?user_id=text&api_token=text' \
  --header 'Content-Type: application/json' \
  --data '{"external_asset":{"id":"text","subtype":"text","active":true,"view_count":0}}'

200

422

No body

Successful Response

Get all historical chat messages.

get

/api/export_history

Query parameters

user_idUser Idrequired

api_tokenApi Tokenrequired

start_dateStart Date

by default two weeks ago, format YYYY-MM-DD

end_dateEnd Date

by default tomorrow, format YYYY-MM-DD

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/export_history?user_id=text&api_token=text'

200

422

No body

Successful Response

Get Embedded User Login Token

post

/api/auth/embedded_user_login

Authorizations

Body

user_idUser Idrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/auth/embedded_user_login' \
  --header 'Content-Type: application/json' \
  --data '{"user_id":"text"}'

200

422

No body

Successful Response