Step By Step Crochet
EN
BlogDownload

Step By Step Crochet developers

Public API and agent interfaces

Search and read the site's published crochet guides through a versioned REST API, MCP Streamable HTTP, A2A, Markdown representations, or WebMCP. Every interface on this page is anonymous, read-only, and free to call; no account, API key, OAuth flow, or access token is required.

OpenAPI 3.1 specificationRFC 9727 API catalog

REST API

The production base URL is https://stepbystepcrochet.com. Responses use JSON and include canonical HTML and Markdown URLs. Supported locale values are en, es, de, fr, and pt.

GET/api/v1/guides

Search titles and excerpts. Query parameters: locale, optional q up to 200 characters, and optional limit from 1 to 20.

curl "https://stepbystepcrochet.com/api/v1/guides?locale=es&q=granny&limit=5"
GET/api/v1/guides/{slug}

Retrieve a complete guide as Markdown. Reuse a slug and locale returned by the collection endpoint.

curl "https://stepbystepcrochet.com/api/v1/guides/how-to-make-a-granny-square?locale=en"
POST/api/v1/guides/search

Run the same read-only search with a JSON body. Agents may include an Idempotency-Key header for safe retries; a valid key is echoed in the response and the operation never creates or changes content.

curl -X POST "https://stepbystepcrochet.com/api/v1/guides/search" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 8b7668ca-55b1-4872-912e-7c9d0474545d" \
  -d '{"locale":"es","query":"granny square","limit":5}'

Errors and responsible use

Errors use an error object with a stable code, human-readable message, a corrective hint, and optional details. Invalid parameters return HTTP 400, missing guides and unknown API paths return HTTP 404, and unsupported methods return HTTP 405 with an Allow header. These responses remain JSON rather than falling back to an HTML error page. Successful GET responses may be cached. There is no published request quota; callers should cache results, avoid unnecessary polling, and back off if the service returns HTTP 429 or 5xx.

{
  "error": {
    "code": "INVALID_LOCALE",
    "message": "Unsupported locale: it",
    "hint": "Use one of: en, es, de, fr, pt.",
    "details": { "parameter": "locale" }
  }
}

MCP and MCP Apps

Connect an MCP client to https://stepbystepcrochet.com/api/mcp using Streamable HTTP. The server exposes find_crochet_guides and read_crochet_guide. Search results include an MCP App ui:// resource for interactive guide cards plus a textual fallback.

Other machine-readable surfaces