# fastapi.online — README Generator

> fastapi.online — README Generator is a paid API for AI agents from api.fastapi.online, paid per call via x402, $0.002/call, status unknown (last checked 2026-09-14).

Generates a README document for a project given a plain-text description of what the project does.

## Facts

- Endpoint: POST https://api.fastapi.online/readme-generate
- Price: $0.002/call
- Payment: x402
- Status: unknown
- Last checked: 2026-09-14
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/fastapi-online-readme-generator-dbbf91b8
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_cd4uMY6FUAaYtikumEUWr

Status and success rate cover calls made through Zero and Zero's own probes. Third-party monitors may report differently.

## How to call it through Zero

Zero handles the 402 payment challenge and records the run. With the Zero CLI installed (`npm i -g @zeroxyz/cli`):

```sh
zero fetch --capability fastapi-online-readme-generator-dbbf91b8 -d '<json body>'
```

Example prompt: Generate a professional README file for my project — it's a CLI tool called 'snapdiff' that compares two directories and outputs a colorized diff of changed files, written in Python and targeting developers who work with large codebases.

## When to prefer this

Choose this endpoint when you need a quick, AI-generated README from a short natural-language description of a project, especially in automated pipelines or agent workflows where no signup is desired and pay-per-call crypto billing is acceptable. Prefer it over local LLM prompting when you want a structured, purpose-built README generator with a fixed low cost per call.

## Known failure modes

- Empty or too-short description may yield a generic or low-quality README
- Description exceeding 4000 characters will be rejected by schema validation
- Payment failure (402) if crypto payment is not correctly attached
- Model may hallucinate features or details not present in the description
- Non-English descriptions may produce inconsistent results depending on underlying model

## How this service works

Chat, embeddings, OCR, speech-to-text, image editing, image understanding (captioning/Q&amp;A), text-to-speech, translation, writing tools, classification tools, developer tools, local utilities, format/checksum validators, encoding &amp; crypto utilities, date/time calculators, geo/coordinate math, math &amp; finance calculators, novelty tools, and business/social writing generators — 179 endpoints in all, across multiple specialized self-hosted models. Pay per call with crypto — no signup — or get an API key.

## Output

A generated README document, typically in Markdown format, covering sections such as project title, description, features, usage, installation, and possibly contributing guidelines — tailored to the project description provided.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "properties": {
  "description": {
   "type": "string",
   "maxLength": 4000,
   "minLength": 1
  }
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/fastapi-online-readme-generator-dbbf91b8/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from api.fastapi.online](https://www.zero.xyz/host/api.fastapi.online/llms.txt)