> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eazyowl.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Common Information

> Common information about the APIs

## The "baseUrl" and other placeholder variables

The documentation shall refer to the beginning of the address as `baseUrl`. This is the domain name (with any subdomains). The `baseUrl` shall remain the same across all APIs for the given context (production or staging).

**The** `baseUrl `**for Production is** `https://eazyowl.com `**.**

The expression `{{baseUrl}}` in the API documentation shall denote that the actual URL be placed there.

Similarly, other placeholder variables shall also be denoted per API and are intended to be replaced with actual values e.g. `{{baseUrl}}/api/v1/customers/{{externalUserId}}/status` would require you to replace both `baseUrl` and `externalUserId` placeholders with real values. For example, a possible valid URL upon replacement of both the placeholders could be: `https://eazyowl.com/api/v1/customers/vaibkaus/status` .

**NOTE**: The placeholders might also show up in the request and response bodies in this documentation. However, you should not expect to see them in real API responses and should never use them in your requests.

## Common Headers in all Requests

There are some common headers that you must supply in all your API calls. They are not individually mentioned in the API documentation. We assume that they will be present in the request though.

1. The `Content-Type` for all APIs is `application/json`. This is true for both the requests and the responses. For responses, you might also get the value set to `application/json;charset=utf-8` . For requests, we always process the content with UTF-8 encoding.
2. All APIs expect a `X-API-Key` header key with the API key string as the value. The information about obtaining the same is in the [API Authentication](/api-authentication) page.
3. **We expect you to supply the** `Host `**header containing the value of the *domain name* from the** `{{baseUrl}} `**value.** e.g. `eazyowl.com`.
4. Responses can carry an `x-request-id` header which should be unique for every request made. This can later be used for debugging purposes.
5. Responses can also carry [headers that control caching on the client side](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/Caching).