Get your API key

Your API key lets your own tools and scripts call the useArtemis API on behalf of your account. You create it in Settings › API, then send it with every request in the x-api-key header. The endpoints and examples are in the API documentation linked from the same page.

Create your API key

1. Go to Settings › API (https://app.useartemis.co/settings/api).
2. Click Create API key.

You see API key created, and the key is displayed in full. Your account has one key at a time.

Show and copy your key

The key is hidden by default: only its first and last characters are visible.

• Click the eye icon to show or hide the full key.
• Click Copy to copy it. You see API key copied.

Use the key in your requests

Add the key to the x-api-key header of each request:

x-api-key: YOUR_API_KEY

For the list of endpoints, parameters and examples, click API documentation on the API page.

If a request is refused with a 401 error:

• No API key provided. The x-api-key header is missing.
• Invalid API key. The key is wrong, or it was regenerated since you copied it.

Requests that find data use your account's credits. When your credits run out, the API answers Not enough credits. See Plans and credits.

Regenerate your key

Regenerate the key if it leaked or if someone who had it shouldn't use it anymore.

1. On the API page, click Regenerate.
2. Read the warning Regenerate your API key? and click Regenerate key.

You see New API key generated. The previous key stops working right away, so update every tool or integration that used it.

FAQ

Where is the API documentation?

On the API page in Settings, click API documentation. It opens in a new tab.

Does each teammate need their own key?

The key belongs to the account that created it, and requests made with it act as that account. Each person creates their own key in their own Settings.