# artfloe-docs

> 

- Documentation: https://artfloe-docs.thally.app
- GitHub: https://github.com/Sohan-spec/artfloe
- Full docs for LLMs: https://artfloe-docs.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://artfloe-docs.thally.app/ai.txt
- Structured docs index (JSON): https://artfloe-docs.thally.app/api/docs-index
- OpenAPI spec: https://artfloe-docs.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://artfloe-docs.thally.app/api/docs/{page-id}
- Search API: https://artfloe-docs.thally.app/api/search?q={query}
- Capability manifest (skill): https://artfloe-docs.thally.app/skill.md
- Agent guidance (editing these docs): https://artfloe-docs.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://artfloe-docs.thally.app/api/mcp
- Agent readiness: https://artfloe-docs.thally.app/api/agent-readiness

### Recommended workflow

1. Use this index, the search API, or `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Documentation

### Get started

- [ArtFloe docs](https://artfloe-docs.thally.app/): Restyle a photo in the look of a painting while keeping people looking like themselves.
- [Quick start](https://artfloe-docs.thally.app/quickstart): By the end of this page you will have a restyled photo on artfloe.fun.

### Guides

- [Generate via HTTP](https://artfloe-docs.thally.app/guides/generate-via-http): Sign in, upload a photo, and stream a generation from POST /predict.
- [Use a custom style](https://artfloe-docs.thally.app/guides/use-a-custom-style): Upload your own style image and use it on POST /predict.
- [Crop an export](https://artfloe-docs.thally.app/guides/crop-an-export): Smart-crop a finished generation to 1:1, 4:5, 2:3, 9:16, or 16:9.
- [Manage billing](https://artfloe-docs.thally.app/guides/manage-billing): Upgrade, downgrade, cancel, and recover checkout for Pro and Max.
- [Run locally](https://artfloe-docs.thally.app/guides/run-locally): Serve the ArtFloe UI on http://localhost:7860.
- [Deploy](https://artfloe-docs.thally.app/guides/deploy): Deploy the Flask WSGI app and A10G GPU worker to Modal.

### Reference

- [HTTP API](https://artfloe-docs.thally.app/reference/http-api): Routes the ArtFloe studio uses. Auth is Bearer JWT unless noted.
- [Error codes](https://artfloe-docs.thally.app/reference/errors): JSON error strings and HTTP statuses ArtFloe returns.
- [Docs MCP](https://artfloe-docs.thally.app/reference/mcp): Read-only MCP tools on the ArtFloe documentation site.

### Concepts

- [Architecture](https://artfloe-docs.thally.app/concepts/architecture): How Flask, Modal GPU, Supabase, and billing fit together.
- [How generation works](https://artfloe-docs.thally.app/concepts/generation): Engine order, person preservation, and what the GPU writes.
- [Auth and billing](https://artfloe-docs.thally.app/concepts/auth-and-billing): Why sessions, quota, and Razorpay vs Dodo work the way they do.

### More

- [Troubleshooting](https://artfloe-docs.thally.app/troubleshooting): Symptom, cause, and fix for failures the ArtFloe server actually returns.
- [Changelog](https://artfloe-docs.thally.app/changelog): User-visible ArtFloe changes, newest first.