👨‍🏫Setup

How to communicate with the Houdin API and more

Note: This feature is reserved to Pro and Enterprise users. You will be provided with a customer account after subscribing.

Create your Houdin API Key

You can connect with your credentials by using the Login button located in the top right of the Houdin WebApp.

Once you are logged in, navigate to your profile page and click on the Generate API Key button

The (extremely simple) profile page showcasing the Generate API Key button.

After waiting for a second or two, your API Key will be generated, activated, and shown to you. You should copy this API Key and store it securely in your password vault of choice, we do not keep plain-text copies of it in our database. If you lose the key you will have to generate another one (invalidating any previous one).

Hovering your key will reveal it. You can also press the copy button to fill your clipboard.

Interact with the API

Authenticate every request with the Houdin API by providing your API Key in the X-API-Key header as such:

{ // This is the header section of a request
    "X-API-Key": "houdin-api-ffcd1f01-83ff-4b5b-84f6-381afeafe296-65663e7e56336a62dd8abe02"
}