API & DEVELOPERS

OrigamiFlow Developer Portal

Public API for accessing OrigamiFlow blog content, system status, and machine-readable metadata. All endpoints are unauthenticated and free to use.

OpenAPI Spec (JSON)llms.txtSitemap XMLBlog API (live)

Base URL

https://www.origamiflow.com.br

Versioning & Deprecation Policy

REST API endpoints are versioned with a /v1/ URL prefix. The current stable version is v1.

When a new version is released, the previous version will be supported for a minimum of 12 months. Deprecated endpoints return a Deprecation header and a Sunset header with the removal date.

Deprecation: true
Sunset: Sat, 10 Sep 2027 00:00:00 GMT
Link: <https://www.origamiflow.com.br/developers>; rel="deprecation"

Rate Limits

All API endpoints are rate-limited to 60 requests per 60-second window per IP. Rate limit status is returned in standard RFC headers:

RateLimit-Limit: 60
RateLimit-Policy: 60;w=60
RateLimit-Remaining: 59
Retry-After: 60  # only on HTTP 429

Error Responses

All errors return JSON with a consistent schema:

{
  "error": "Human-readable message",
  "code": "MACHINE_READABLE_CODE",
  "hint": "Suggested resolution"
}

Common codes: NOT_FOUND, DATABASE_ERROR, MISSING_PARAM, SERVICE_UNAVAILABLE

Endpoints

GET/api/v1/blog

List published blog posts

Params

page (int, default 1), limit (int, 1–100, default 20)

Response

{ data: Post[], meta: { total, page, limit, pages, hasNextPage, hasPrevPage } }

Auth

None

GET/api/v1/blog/{slug}

Get single blog post by slug

Params

slug (string, path param)

Response

{ data: Post } — includes full content field

Auth

None

GET/api/health

Health check

Params

None

Response

{ status, version, timestamp, latencyMs, services }

Auth

None

GET/llms.txt

LLMs.txt — agent instruction file

Params

None

Response

text/plain — machine-readable site description with when-to-use guidance

Auth

None

GET/llms-full.txt

Full LLM context — all blog content

Params

None

Response

text/plain — all published blog posts in markdown for bulk AI ingestion

Auth

None

GET/openapi.json

OpenAPI 3.0 specification

Params

None

Response

application/json — full OpenAPI spec with typed schemas

Auth

None

Quick Start

List all blog posts:

curl https://www.origamiflow.com.br/api/v1/blog

Get a single post:

curl https://www.origamiflow.com.br/api/v1/blog/como-fazer-rrt-cau-guia-pratico

Request markdown content (content negotiation):

curl -H "Accept: text/markdown" https://www.origamiflow.com.br/

Health check:

curl https://www.origamiflow.com.br/api/health

For AI Agents

OrigamiFlow is fully agent-ready. Machine-readable files are available at:

Questions? [email protected]