LLM Integration
Flint Pay publishes a machine-readable API reference at /SKILL.md, a single plain-text file designed to be pasted into an AI assistant's context window (CLAUDE.md, .cursorrules, system prompts, etc.).
If you need a structured schema instead of prose, Flint also publishes the public OpenAPI spec at /v1/openapi.json.
What's in SKILL.md#
The file is a self-contained markdown document covering:
- Auth & base URL: the public API host plus test/live auth conventions
- Public HTTP API surface: every documented
/v1endpoint, field, enum, and response shape - Conventions: money fields, ID prefixes, pagination, sparse updates and patch objects, metadata limits
- State machines: order, payment, invoice, and subscription lifecycles
- Error codes: structured error format with all domain-specific codes
- Quick start examples: 5 curl commands covering the most common flows
It's a single plain-text reference that stays under 2k lines and still fits comfortably in a modern coding agent context window.
How to use it#
Add a WebFetch instruction to your project's CLAUDE.md:
# Flint Pay API
When working with the Flint Pay API, fetch the reference:
https://developers.withflintpay.com/SKILL.md
Claude Code will fetch and read the file when it needs API context.
Add to your project's AGENTS.md for OpenAI Codex:
# Flint Pay API
When working with the Flint Pay API, fetch the reference from:
https://developers.withflintpay.com/SKILL.md
Codex will use this as context when generating code against the Flint Pay API.
Add to your .cursorrules file:
# Flint Pay API
@https://developers.withflintpay.com/SKILL.md
Fetch the file and include it in your system prompt:
curl -s https://developers.withflintpay.com/SKILL.md
The full text can be appended to any system prompt or tool description.
Copy the contents directly:
- Open /SKILL.md in your browser
- Copy the full text
- Paste it into your AI assistant's context
Why SKILL.md#
Traditional API docs are designed for humans browsing a website. LLMs work better with a single, dense, plain-text reference that covers everything in one pass: no navigation, no JavaScript rendering, no pagination.
The SKILL.md file gives AI agents:
- Complete coverage: every endpoint, field, and enum in one file
- Correct field names: avoids hallucinated field names (a common failure mode)
- State machine context: knows which mutations are valid in which states
- Working examples: can adapt real curl commands instead of guessing syntax
The SKILL.md file tracks the same API surface as these docs. When new endpoints or fields ship, both are updated together.
Direct link#
https://developers.withflintpay.com/SKILL.md