# Strale README Generator

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

Generates a structured README file for a software project given its name, description, and tech stack.

## Facts

- Endpoint: GET https://api.strale.io/x402/v2/readme-generate
- Price: $0.054/call
- Payment: x402
- Status: unknown
- Last checked: 2026-09-15
- Activations on Zero: 0
- Tags: x402
- Canonical page: https://www.zero.xyz/c/strale-readme-generator-c3b41c37
- Structured record (JSON): https://api.zero.xyz/v1/capabilities/cap_Yj01wOOMpIyQ-fngDgXip

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 strale-readme-generator-c3b41c37
```

Example prompt: Generate a README for my project called 'NightOwl', a Node.js and React task management app that lets remote teams track async work across time zones.

## When to prefer this

Choose this endpoint when you need a quick, structured README draft for a software project and can supply a project name, description, and tech stack. It is ideal for bootstrapping documentation for new repos, open source releases, or internal tools without manually writing boilerplate markdown. Prefer it over general LLM prompts when you want a consistently structured output with an auditable, cryptographically hashed call record.

## Known failure modes

- Missing required project_description query parameter returns a validation error
- Empty or very short project_description may yield a generic or low-quality README
- Unsupported HTTP method returns an error (only GET, HEAD, DELETE allowed)
- Payment failure or insufficient USDC balance blocks the request via x402 protocol
- Rate limiting or server-side errors may return 429 or 5xx status codes

## How this service works

The trust layer for AI agents — 250+ independently tested data capabilities across 27 countries. Execute capabilities via REST, MCP, A2A, or x402 micropayments. Every call returns an audit record with cryptographic chain hashing.

## Output

Returns a structured markdown README document including sections such as project title, description, features, installation instructions, usage examples, tech stack, and contributing guidelines — tailored to the provided project name, description, and technology stack.

## 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/strale-readme-generator-c3b41c37/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)