> For the complete documentation index, see [llms.txt](https://cityweft.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cityweft.gitbook.io/docs/basics/authentification.md).

# Authentification

#### Authentication

Authentication is mandatory for all API requests:

* Requests must include an API key provided during registration.
* The API key should be included in the request header as shown below:

  ```
  Authorization: Bearer YOUR_API_KEY
  ```

#### Security

To ensure the integrity and security of our service, the API implements various security protocols:

* **Requests Monitoring**: Requests are monitored continuously for unusual patterns to prevent abuse.
* **API Key Confidentiality**: Ensure API keys are safeguarded and never exposed in client-side code.
* **HTTPS Usage**: All API requests must use HTTPS to secure data in transit and prevent interception.

#### Versioning

The API adheres to semantic versioning for structured and predictable release of changes:

* The current stable version is `v1`.
* Any breaking changes will be introduced in new versions, ensuring backward compatibility for existing implementations.

By adhering to these guidelines and practices, the API guarantees a robust, secure, and reliable means of accessing our services.


---

# 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://cityweft.gitbook.io/docs/basics/authentification.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.
