Authentication

Create a free account if you haven't already. You will immediately get an API key that works for test data.

If you would like to use your own data, fill out this form.

API key

Requests to Faraday are authenticated with an API Key. You can retrieve your key on the account page.

Formatting requests

The API key can be sent either as an Authorization header or as a query parameter. Authorization headers are the preferred method.

Header example

curl --request POST https://api.faraday.ai/v1/endpoint \
     --header "Authorization: Bearer YOUR_API_TOKEN"

Query parameter example

curl --request POST https://api.faraday.ai/v1/endpoint?key=YOUR_API_TOKEN