# OpenAPI file

The whole API in one OpenAPI 3.1 file. Generate a client, import it into your tools, or give it to an AI agent.

## Get the file

**foxentry-api-reference.yaml** OpenAPI 3.1 · API 2.1 · 12 endpoints

[Download YAML](assets/openapi/foxentry-api-reference.yaml) [Download JSON](assets/openapi/foxentry-api-reference.json) [View on GitHub ↗](https://github.com/Foxentry/OAS)

## What you can do with it

- **Import** it into Postman, Insomnia or Bruno and every endpoint is ready to call.
- **Generate** a client for a language we have no SDK for, with [OpenAPI Generator](https://openapi-generator.tech).
- **Give it to an AI agent.** It describes every field, so the agent calls the API correctly.

**Generate a TypeScript client**

```bash
npx @openapitools/openapi-generator-cli generate \
  -i https://foxentry.dev/assets/openapi/foxentry-api-reference.yaml \
  -g typescript-fetch -o ./foxentry-client
```