API

automate as much as you like

Everything starts with a token of trust

All API endpoints can be accessed via an API token that is tied to the permissions of a user account. You can also let them expire after some time.

How to get a token?

1. Go to Settings / Users

2. Click Create New Token

1. Enter a name, description, and expiration period

2. Copy the token (it's only shown once)

How to use the token?

You have two ways. You either pass the token as a header with API-KEY or you pass it as a url parameter in api_token . As a header is usually more secure because automated loggers don't store them, but in some places you can't set headers (e.g. dbt webhooks) and then you can use the URL parameter.

Via Headers

Call the user endpoint via command line interface.

# Basic API request with token
curl -H "API-KEY: dot-your_token_here" <https://[app or eu].getdot.ai/api/auth/me>

Call the user endpoint via Python.

import requests
headers = {"API-KEY": "dot-your_token_here"}
response = requests.get("https://[app or eu].getdot.ai/api/auth/me", headers=headers)

Via URL - Parameters

For the following endpoints you can also use a URL based authentication:

• Sync connection

• Import external asserts

• Export conversation history

Call the endpoint only via url:

curl "https://{region}.getdot.ai/api/sync/{connection_type}/{connection_type}" \
     "?user_id={user}&api_token={api_token}"

Learn More

Commonly used EndpointsUse Cases and ScriptsAll API Endpoints