# README Generator

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

Generates a comprehensive README.md file from a project description, including installation, usage, API docs, and contributing sections.

## Facts

- Endpoint: GET https://api.strale.io/x402/readme-generate
- Price: $0.054001/call
- Payment: x402
- Status: unknown
- Last checked: 2026-09-14
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/api-strale-io-d3a227b3
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_rj-JyrTiko3B2m2peDFtQ

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 api-strale-io-d3a227b3
```

Example prompt: Generate a comprehensive README.md for my project called 'DataSync', a real-time data synchronization tool — the description is 'A lightweight Node.js library for syncing data between microservices using event-driven architecture', and the tech stack is Node.js, Redis, and RabbitMQ.

## When to prefer this

Choose this endpoint when you need to quickly scaffold a professional README.md for a software project, especially when you have a clear project description and optionally a tech stack and project name. Ideal for automating documentation creation in CI/CD pipelines or bootstrapping new open-source repositories.

## Known failure modes

- Missing required project_description parameter returns 400 error
- Overly vague or empty description may produce generic low-quality output
- Payment failure via x402 protocol returns 402 Payment Required
- Rate limiting may return 429 Too Many Requests
- Network timeout on complex or lengthy descriptions

## How this service works

Generate comprehensive README.md from project description. Includes installation, usage, API docs, contributing sections. SQS: 96/100.

## Output

Returns a fully structured README.md document with sections for installation, usage examples, API reference, contributing guidelines, and project overview — formatted in Markdown and ready for a GitHub repository.

## Request schema (JSON Schema)

```json
{
 "type": "object",
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "required": [
  "input"
 ],
 "properties": {
  "input": {
   "type": "object",
   "required": [
    "type",
    "method"
   ],
   "properties": {
    "type": {
     "type": "string",
     "const": "http"
    },
    "method": {
     "enum": [
      "GET",
      "HEAD",
      "DELETE"
     ],
     "type": "string"
    },
    "queryParams": {
     "type": "object",
     "required": [
      "project_description"
     ],
     "properties": {
      "tech_stack": {
       "type": "string"
      },
      "project_name": {
       "type": "string"
      },
      "project_description": {
       "type": "string"
      }
     }
    }
   },
   "additionalProperties": false
  }
 }
}
```

## More

- Live health (JSON, refreshed every minute): https://www.zero.xyz/c/api-strale-io-d3a227b3/health.json
- [Zero catalog index](https://www.zero.xyz/llms.txt)
- [Other services from api.strale.io](https://www.zero.xyz/host/api.strale.io/llms.txt)