> For the complete documentation index, see [llms.txt](https://docs.predicthq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.predicthq.com/api/overview/authenticating.md).

# Authenticating

All PredictHQ API endpoints require authentication. You can authenticate your request by sending a token in the `Authorization` header of your request. If you try to use an API endpoint without a token or that token has insufficient permissions, you will receive a `403 Forbidden` response.

The PredictHQ API is a RESTful API and can be accessed from the `https://api.predicthq.com` URL. All data exchanges are performed using the JSON format by default.

{% tabs %}
{% tab title="curl" %}

```bash
curl -X GET "https://api.predicthq.com/v1/events/" \
     -H "Authorization: Bearer $API_TOKEN" 
```

{% endtab %}

{% tab title="python" %}

```python
import requests

api_token = "$API_TOKEN"

response = requests.get(
    url="https://api.predicthq.com/v1/events/",
    headers={
      "Authorization": f"Bearer {api_token}"
    }
)

print(response.json())
```

{% endtab %}
{% endtabs %}

## Create an API Token

1. Log into the WebApp and visit the [API Tokens](https://control.predicthq.com/tokens) page.
2. Enter a name for the token and click "Create Token".
3. Click "Copy Token" to copy your token to the clipboard. Keep a copy of your new API Token (ideally stored in a password/secrets manager), as it will not be shown again.

Now you can use the new API Token in the `Authorization` header of your API requests.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.predicthq.com/api/overview/authenticating.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.