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

# API reference

> Browse the public documentation for Bold API endpoints, models, and interactive tests.

The Bold API reference is published by the Bold service at `https://api.bold-factory.com/docs`. Use it to browse endpoints, parameters, schemas, examples, and interactive tests.

<Card title="Open API documentation" icon="external-link" href="https://api.bold-factory.com/docs">
  Access the documentation published by Bold.
</Card>

## What it contains

* Public version endpoints.
* Path, query, and body parameters.
* Request and response schemas.
* Models and response codes.
* Interactive tests against the API environment.

## Before calling the API

You need a valid API key or session credential. For server-to-server integrations, create a key in **Control panel > Access > API keys** and send it in the `X-Api-Key` header.

<Columns cols={2}>
  <Card title="Authentication" icon="key-round" href="/en/developers/getting-started/authentication">
    Prepare credentials and permissions before testing endpoints.
  </Card>

  <Card title="Pagination" icon="list" href="/en/developers/getting-started/pagination-filters-and-sorting">
    Browse lists with `pageNumber` and `pageSize`.
  </Card>
</Columns>

## OpenAPI specification

This section also includes pages generated from `https://api.bold-factory.com/openapi/v1.json`. Use Bold's published documentation to test the API outside this documentation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.