API

automate as much as you like

Automatically Sync Dot

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

Sync Connection

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

Path parameters

connection_type*Connection Type

connection_id*Connection Id

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/sync/{connection_type}/{connection_id}?user_id=text&api_token=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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

Webhooks for your jobs | dbt Developer Hub

Documentation how to setup a dbt webhooks

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.

Import External Asset

POST/api/import_and_overwrite_external_asset

Query parameters

Body

application/json

external_asset*ExternalAsset

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/import_and_overwrite_external_asset?user_id=text&api_token=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "external_asset": {
        "id": "text",
        "subtype": "text"
      }
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Export Conversation History

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

Get all historical chat messages.

GET/api/export_history

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/export_history?user_id=text&api_token=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Authentication for all other endpoints

For most operations on Dot you first need to login.

Login For Access Token

POST/api/auth/token

Body

application/x-www-form-urlencoded

grant_typeGrant Type

Pattern: password

username*Username

password*Password

scopeScope

client_idClient Id

client_secretClient Secret

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/auth/token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({
      "username": "text",
      "password": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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

Get Embedded User Login Token

POST/api/auth/embedded_user_login

Authorization

OAuth2PasswordBearer

Body

application/json

user_id*User Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/auth/embedded_user_login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_id": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

User Administration

Get All Users

GET/api/get_users

Authorization

OAuth2PasswordBearer

Response

200

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/get_users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Sendinvitations

POST/api/send_invitations

Authorization

OAuth2PasswordBearer

Body

application/json

emails*Emails

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/send_invitations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "emails": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Delete User Route

POST/api/delete_user

Authorization

OAuth2PasswordBearer

Body

application/json

email*Email

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/delete_user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Change User Role

POST/api/change_user_role

Authorization

OAuth2PasswordBearer

Body

application/json

email*Email

role*Role

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/change_user_role', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "role": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Add User To Group

POST/api/add_user_to_group

Authorization

OAuth2PasswordBearer

Body

application/json

email*Email

group*Group

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/add_user_to_group', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "group": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Remove User From Group

POST/api/remove_user_from_group

Authorization

OAuth2PasswordBearer

Body

application/json

email*Email

group*Group

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/remove_user_from_group', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "group": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Create User Route

POST/api/create_user

Authorization

OAuth2PasswordBearer

Body

application/json

email*Email

password*Password

realname*Realname

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/create_user', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "password": "text",
      "realname": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Ask questions

Ask With History

POST/api/ask_with_history

Authorization

OAuth2PasswordBearer

Body

application/json

new_message*New Message

chat_id*Chat Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/ask_with_history', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "chat_id": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Ask

POST/api/ask

Authorization

OAuth2PasswordBearer

Body

application/json

messages*Messages

chat_id*Chat Id

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/api/ask', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "messages": [],
      "chat_id": "text"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}