Commonly used Endpoints

Automatically Sync Dot

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

Sync connection with an API token.

post

Authorizations

X-API-KEYstringRequired

Path parameters

connection_typestringRequired

connection_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

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

POST /api/sync/{connection_type}/{connection_id} HTTP/1.1
X-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) 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=dot-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.

Import and overwrite an external asset with an API token.

post

Authorizations

X-API-KEYstringRequired

Body

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/import_and_overwrite_external_asset

POST /api/import_and_overwrite_external_asset HTTP/1.1
X-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.

Get all historical chat messages.

get

Authorizations

X-API-KEYstringRequired

Query parameters

start_datestringOptional

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

end_datestringOptional

by default tomorrow, format YYYY-MM-DD

include_all_workspacesbooleanOptional

Include history from all workspaces (main workspace only)

Default: false

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/api/export_history

GET /api/export_history HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Ask Dot Automatically

Ask

post

Authorizations

X-API-KEYstringRequired

Body

chat_idstringRequired

scopestringOptionalDefault: ""

skip_checkbooleanOptionalDefault: false

extraany ofOptional

stringOptional

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/ask

POST /api/ask HTTP/1.1
X-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

Ask With History

post

Authorizations

X-API-KEYstringRequired

Body

chat_idstringRequired

extraany ofOptional

stringOptional

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/ask_with_history

POST /api/ask_with_history HTTP/1.1
X-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

Agentic

post

Authorizations

X-API-KEYstringRequired

Body

chat_idstringRequired

skip_checkbooleanOptionalDefault: false

extraany ofOptional

stringOptional

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/agentic

POST /api/agentic HTTP/1.1
X-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

Get All Users

get

Authorizations

X-API-KEYstringRequired

Responses

200

Successful Response

application/json

Responseany

get

/api/get_users

GET /api/get_users HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Successful Response

No content

Sendinvitations

post

Authorizations

X-API-KEYstringRequired

Body

emailsstring[]Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/send_invitations

POST /api/send_invitations HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "emails": [
    "text"
  ]
}

No content

Delete User Route

post

Authorizations

X-API-KEYstringRequired

Body

emailstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/delete_user

POST /api/delete_user HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "email": "text"
}

No content

Change User Role

post

Authorizations

X-API-KEYstringRequired

Body

emailstringRequired

rolestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/change_user_role

POST /api/change_user_role HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "email": "text",
  "role": "text"
}

No content

Add User To Group

post

Authorizations

X-API-KEYstringRequired

Body

emailstringRequired

groupstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/add_user_to_group

POST /api/add_user_to_group HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "email": "text",
  "group": "text"
}

No content

Remove User From Group

post

Authorizations

X-API-KEYstringRequired

Body

emailstringRequired

groupstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/remove_user_from_group

POST /api/remove_user_from_group HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "email": "text",
  "group": "text"
}

No content

Create User Route

post

Authorizations

X-API-KEYstringRequired

Body

emailstringRequired

passwordstringRequired

realnamestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/create_user

POST /api/create_user HTTP/1.1
X-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".

Get Embedded User Login Token

post

Authorizations

X-API-KEYstringRequired

Body

user_idstringRequired

create_if_not_existsbooleanOptionalDefault: false

groupsany ofOptional

string[]Optional

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/api/auth/embedded_user_login

POST /api/auth/embedded_user_login HTTP/1.1
X-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

PreviousAPI NextUse Cases and Scripts

Last updated 21 days ago

hashtagAutomatically Sync Dot

hashtagSync connection with an API token.

hashtagImport External Assets

hashtagImport and overwrite an external asset with an API token.

hashtagExport Conversation History

hashtagGet all historical chat messages.

hashtagAsk Dot Automatically

hashtagAsk

hashtagAsk With History

hashtagAgentic

hashtagUser Administration

hashtagGet All Users

hashtagSendinvitations

hashtagDelete User Route

hashtagChange User Role

hashtagAdd User To Group

hashtagRemove User From Group

hashtagCreate User Route

hashtagAutomatically Authenticate Embedded Users

hashtagGet Embedded User Login Token

Automatically Sync Dot

Sync connection with an API token.

Import External Assets

Import and overwrite an external asset with an API token.

Export Conversation History

Get all historical chat messages.

Ask Dot Automatically

Ask

Ask With History

Agentic

User Administration

Get All Users

Sendinvitations

Delete User Route

Change User Role

Add User To Group

Remove User From Group

Create User Route

Automatically Authenticate Embedded Users

Get Embedded User Login Token