Kreafy API

The public Kreafy API: OpenAPI specification, endpoints, Markdown content negotiation and agent resources. No key, no account.

Kreafy publishes a public, read-only Content API. It exposes everything a developer or an AI agent needs to answer a question about the product: the documentation, the changelog, the use cases, and a full-text search over the documentation.

No API key, no account, no registration. Every endpoint below answers to a plain GET.

Resources at a glance

Resource	URL
OpenAPI 3.1 specification	`/openapi.json` (also `/openapi.yaml`)
API index	`/api/v1`
Agent map	`/llms.txt`
Agent instructions	`/.well-known/agent-instructions.md`
Whole documentation, one file	`/llms-full.txt`
Sitemap	`/sitemap.xml`

Endpoints

Base URL: https://kreafy.lyrad.dev. Every response is JSON, UTF-8.

Operation	Method and path	What it is for
`getApiIndex`	`GET /api/v1`	Discover the surface of the API.
`getServiceHealth`	`GET /api/v1/health`	Check the service answers.
`listDocumentationPages`	`GET /api/v1/docs`	The plan of the documentation.
`getDocumentationPage`	`GET /api/v1/docs/{slug}`	One page, in Markdown.
`searchDocumentation`	`GET /api/v1/search?q=`	Start from a question.
`listChangelogEntries`	`GET /api/v1/changelog`	What shipped, newest first.
`listSolutions`	`GET /api/v1/solutions`	Use cases by profession.

Every operation accepts ?locale=en or ?locale=fr. English is the default.

Example

curl -s "https://kreafy.lyrad.dev/api/v1/search?q=credits&locale=en"
curl -s "https://kreafy.lyrad.dev/api/v1/docs/facturation/credits"
curl -s -H "Accept: text/markdown" "https://kreafy.lyrad.dev/api/v1/docs/facturation/credits"

Errors

Errors are JSON, never HTML, and always take the same shape:

{
  "error": {
    "code": "not_found",
    "message": "Aucune page de documentation à « guides/inexistant ».",
    "hint": "Appelle https://kreafy.lyrad.dev/api/v1/docs pour la liste des chemins valides.",
    "status": 404,
    "documentation": "https://kreafy.lyrad.dev/docs/api",
    "details": { "requested": "guides/inexistant" }
  }
}

Branch on code, not on message: codes are stable, messages are written for humans and can be rewritten. The codes are listed in the OpenAPI specification under the Error schema.

Markdown content negotiation

Every public page of the site answers in Markdown when the request asks for it, following the acceptmarkdown.com convention:

curl -s -H "Accept: text/markdown" https://kreafy.lyrad.dev/

Responses carry Vary: Accept, Accept-Encoding, so a CDN never serves the HTML variant to a client asking for Markdown. A request that accepts neither text/html nor text/markdown gets a 406 with a JSON body listing what is available.

Documentation pages also have a permanent Markdown URL: append .mdx to any doc URL, for example /docs/prise-en-main.mdx.

Rate limits

No key means no quota to register. A soft limit of about 60 requests per minute per IP is applied at the CDN; going past it returns 429 with the code rate_limited. Nothing in the public API writes anything, so a retry is always safe.

What the API does not do

Generating a visual is not part of the public API. It needs a signed-in account, the user's own image library and their credits, so it lives in the studio at kreafy.ai/login. If you are building an agent, send the user there rather than trying to automate the studio.