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

# OpenAPI specification

> Download AMLOK's OpenAPI 3.1 specification to explore API v1.4.2, generate a client, and validate requests for your workspace and environment.

Use the AMLOK OpenAPI specification to explore endpoints, generate a client for your backend, and validate request and response formats.

> [card] [Download OpenAPI JSON](https://docs.amlok.io/openapi/amlok-v1.json)
>
> OpenAPI 3.1.0 specification for AMLOK API v1.4.2.

> [card] [Browse the API reference](https://docs.amlok.io/api-reference/overview.md)
>
> Read endpoint descriptions, required scopes, and worked examples.

## What the specification includes

* Endpoint paths, methods, and stable operation IDs.
* Request parameters, bodies, resource schemas, and response examples.
* Bearer authentication and operation-specific permissions.
* Pagination, asynchronous processing, error responses, and webhook schemas.
* Insights, Signal, shared data capabilities, and credit and consumption reporting.

API version `1.4.2` identifies the documented API release. `3.1.0` identifies the OpenAPI format. Endpoint paths use the `/v1` prefix.

## Use it in your integration

1. Download the JSON file and save a copy with your integration.
2. Import it into an OpenAPI-compatible tool or generate a client for your language.
3. Set `AMLOK_API_BASE_URL` to the environment origin supplied by your account manager, without a trailing `/v1`.
4. Load `AMLOK_API_KEY` from your server's secret manager. An authorized administrator creates the key in the client portal for one workspace and environment.
5. Implement the [product workflows](https://docs.amlok.io/api-reference/products-and-endpoints.md), [request recovery](https://docs.amlok.io/api-reference/request-recovery.md), and [webhook handling](https://docs.amlok.io/api-reference/webhooks.md) around your client.
6. Run the [sandbox journeys](https://docs.amlok.io/api-reference/sandbox-journeys.md) before using your integration in production.

The specification's server entry is a configuration placeholder. Replace it with your issued origin. Example IDs and responses are synthetic; use identifiers returned by your own environment.

## Keep the integration aligned

A generated client provides request and response types. Your application still needs to obtain consent, select enabled providers, persist idempotency keys, handle asynchronous outcomes, and enforce your institution's access controls.

Read [environment configuration](https://docs.amlok.io/api-reference/configuration.md) for approved workflow versions and runtime limits. Read your workspace's [consumption reports and rate cards](https://docs.amlok.io/api-reference/consumption-reporting.md) for applicable rates. Do not treat example quotas, identifiers, or prices as your workspace configuration.

> [card] [Integration prompt](https://docs.amlok.io/overview/integration-prompt.md)
>
> Give your coding agent a complete AMLOK implementation brief.

> [card] [Examples and downloads](https://docs.amlok.io/api-reference/downloads.md)
>
> Use Postman collections, language examples, and webhook verification helpers.


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