# NumeroClaw

> NumeroClaw is an async numerology API that generates premium, personalized numerological readings. It serves developers, AI agents, wellness brands, and content creators. One API call creates a full reading — poll for completion or use webhooks — then retrieve the result as structured JSON, Markdown, or PDF. Supports French and English. Base URL: https://api.numeroclaw.com

NumeroClaw is not a synchronous API. Create a reading, track its status through the async lifecycle (queued → processing → completed), then retrieve the finished result. Do not attempt to get a completed reading in a single call.

## Docs

- [API Reference](https://numeroclaw.com/docs/): Authentication, reading creation, async lifecycle, polling, webhooks, retrieval, output formats, errors, and integration examples
- [Markdown Reference (EN)](https://numeroclaw.com/docs/reference.md): Full API reference in plain Markdown, ideal for ingestion
- [Markdown Reference (FR)](https://numeroclaw.com/docs/reference.fr.md): French version of the API reference

## Product

- [Homepage](https://numeroclaw.com/): Product overview, use cases, sample outputs, and pricing
- [About](https://numeroclaw.com/about/): How NumeroClaw was built, practitioner partnerships, product roadmap
- [Sample Outputs](https://numeroclaw.com/examples/): Public preview excerpts from a validated Lionel Messi theme reading

## Integration

- [Full Documentation for LLMs](https://numeroclaw.com/llms-full.txt): Complete API documentation in a single Markdown file for RAG pipelines and AI coding tools
- [RSS Feed](https://numeroclaw.com/rss.xml): Product updates and changelog

## API Quick Reference

- Base URL: `https://api.numeroclaw.com`
- Auth: `x-api-key` header
- Current product: `theme` (20 credits per reading)
- Locales: `fr-FR`, `en-US`
- Create: `POST /api/v1/readings`
- Poll: `GET /api/v1/readings/{id}`
- Result: `GET /api/v1/readings/{id}/result`
- Document: `GET /api/v1/readings/{id}/document?format=document_v1|markdown|pdf`
- Webhooks: `GET|POST /api/v1/webhooks`, `PATCH /api/v1/webhooks/{endpointId}`
- Events: `reading.completed`, `reading.failed`, `reading.published`, `reading.delayed`

## Optional

- [Privacy Policy](https://numeroclaw.com/privacy/): Data handling and privacy practices
- [Terms of Service](https://numeroclaw.com/terms/): Usage terms for the API platform
- [Support](https://numeroclaw.com/support/): Support expectations for launch customers
- [Changelog](https://numeroclaw.com/changelog/): Product updates and version history
- [French Homepage](https://numeroclaw.com/fr/): Full French version of the site
- [French Docs](https://numeroclaw.com/fr/docs/): French API documentation