LLM Docs

Use AIOZ Pin API reference as context for AI coding assistants to ensure every code suggestion aligns perfectly with official API logic and endpoint paths.

What is llms.txt?

llms.txt is a plain-text roadmap designed for AI coding assistants to easily read and understand the AIOZ Pin API reference in a standardized format. By providing this file as context enables tools like Claude, Cursor, GitHub Copilot, and ChatGPT to generate code using real endpoint paths, correct parameters, and proper authentication patterns.

Downloads

Choose the file that fits your use case:

Index file: Links to all section files. LLMs can pick only the sections they need — best for context-length-sensitive tools.

curl -o aioz-pin-llms.txt https://aiozpin.network/docs/llms.txt

Full reference: Every endpoint and example in one file. Best for one-shot context injection or tools with large context windows.

curl -o aioz-pin-llms-full.txt https://aiozpin.network/docs/llms-full.txt

Individual section files

Download only the sections you need. Each file contains code examples for that API area.

How to use it

Claude (claude.ai or Claude Code)

I've attached the AIOZ Pin API reference.
Help me write a function that pins a file to IPFS and returns the CID and gateway URL.

Cursor

@pinning.txt

Create a TypeScript class that wraps AIOZ Pin file uploads with progress
reporting and returns the IPFS gateway URL on completion.

ChatGPT

Step 1: Download the file above.

Step 2: Open chatgpt.com (opens in a new tab), start a conversation, and attach the file.

Step 3: Ask:

I've attached the AIOZ Pin API reference.
Generate a complete Node.js script that:
1. Generates a pinning API key
2. Pins a local file to IPFS
3. Returns the CID and public gateway URL

GitHub Copilot / VS Code

Step 1: Download the section file(s) relevant to what you're building.

Step 2: Open the file in your editor so it's part of the workspace context.

Step 3: Reference it in Copilot Chat using #:

#pinning.txt

Write a TypeScript function that accepts a file path, pins it to AIOZ Pin,
and returns the IPFS CID and a public gateway URL.

Example prompts

Copy these prompts after loading the docs as context:

Using the AIOZ Pin API reference, write a Node.js Express endpoint that:
- Accepts a file upload via multipart/form-data
- Pins the file to IPFS using the pinning API
- Returns the CID and public gateway URL

Using the AIOZ Pin API reference, create a TypeScript function that:
- Accepts an image file path and target dimensions
- Pins the image to IPFS
- Returns an optimized gateway URL with img-width and img-height params

Using the AIOZ Pin API reference, write a script that:
- Reads all .png files from a folder
- Pins each file to IPFS
- Prints a table of filenames, CIDs, and gateway URLs

Using the AIOZ Pin API reference, implement an NFT minting helper that:
- Accepts an asset file and a metadata object
- Creates the metadata JSON and saves it to disk
- Pins both files to IPFS via the NFT endpoint
- Returns { assetCid, metadataCid, nftId }

What's in the files

All files are plain text — no HTML, no MDX — readable by any AI in a single pass.

llms.txt — index file following the llmstxt.org (opens in a new tab) standard:

• Behavioral instructions for AI assistants
• Links to each section file
• Link to the full combined reference

llms-full.txt — complete reference in one file:

• All sections concatenated
• Same examples as individual files

Section files (llms/*.md) — one per API area:

• TypeScript fetch examples for every endpoint
• Full end-to-end usage patterns (auth → request → response)
• Endpoint path, method, parameters, and response shape