API

API Key Setup

Auth: Personal API key

The API requests are authorized with a personal API key. This API key gives you the same rights as if you were logged in at typeflowai.com - don't share it around!

How to generate an API key

Go to your settings on dashboard.typeflowai.com.
Go to page “API keys”
Create a key for the development or production environment.
Copy the key immediately. You won’t be able to see it again.

Store API key safely Anyone who has your API key has full control over your account. For security

reasons, you cannot view the API key again.

Test your API Key

Hit the below request to verify that you are authenticated with your API Key and the server is responding.

GET/api/v1/me

Get My Profile

Get the product details and environment type of your account.

Mandatory Headers

Name
x-Api-Key
Type
string
Description
Your TypeflowAI API key.

Request

GET

/api/v1/me

curl --location \
'https://dashboard.typeflowai.com/api/v1/me' \
--header \
'x-api-key: <your-api-key>'

Response

{
  "id": "cll2m30r70004mx0huqkitgqv",
  "createdAt": "2023-08-08T18:04:59.922Z",
  "updatedAt": "2023-08-08T18:04:59.922Z",
  "type": "production",
  "product": {
      "id": "cll2m30r60003mx0hnemjfckr",
      "name": "My Product"
  },
  "widgetSetupCompleted": false
}

Delete a personal API key

Go to settings on dashboard.typeflowai.com.
Go to page “API keys”.
Find the key you wish to revoke and select “Delete”.
Your API key will stop working immediately.