> For the complete documentation index, see [llms.txt](https://docs.justaname.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.justaname.id/sdk-reference/justaname-core-sdk/interfaces/apikeyheaders.md).

# ApiKeyHeaders

[**@justaname.id/sdk**](/sdk-reference/justaname-core-sdk.md) • **Docs**

***

[@justaname.id/sdk](/sdk-reference/justaname-core-sdk/globals.md) / ApiKeyHeaders

## Interface: ApiKeyHeaders

Defines the headers for API requests that require an API key for authentication. The `xApiKey` header is used to pass the API key associated with the client making the request. This is a common method for controlling access to restricted API endpoints.

ApiKeyHeaders

### Properties

#### xApiKey?

> `optional` **xApiKey**: `string`

The API key provided to the client. This key should be included in API requests to authenticate and authorize the client's access to the API.

**Defined in**

[packages/@justaname.id/sdk/src/lib/types/headers/index.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/dc845c10af242e3ca87d95ef392516ac0bfa8b95/packages/@justaname.id/sdk/src/lib/types/headers/index.ts#L30)


---

# 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:

```
GET https://docs.justaname.id/sdk-reference/justaname-core-sdk/interfaces/apikeyheaders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.