Skip to main content
Version: Next

Getting Started

You can interact with the Deckpilot Visualization API through HTTP requests from any language via REST API.

Creating an Account​

In order to utilize Deckpilot API, user must have a registered account with Deckpilot app. You can create an account here.

Authentication​

The Deckpilot API uses API keys for authentication. Reach out to us directly to get access to your API key.

All API requests should include your API key in an Authorization HTTP header, alongside user email as follows:

Authorization: Bearer DECKPILOT_API_KEY
User: ACCOUNT_EMAIL_ADDRESS
Take care

Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.

Validate Authentication​

You can try out if your authentication credentials are valid by sending a POST request to:

GET https://api.deckpilot.io/auth

Request headers​

  • Authorization: API key with Bearer prefix (e.g. Bearer API_KEY)
  • User: E-mail address from registered account used for API calls

Returns​

In case authentication credentials are correct, response will return:

{
  "success": true
}