Afroawi APIhalt.afroawi.com ↗
Access halt-rate package documentation via API. List all 29 doc pages or retrieve full content, sections, and code examples for any page by slug.
What is the Afroawi API?
This API provides structured access to the halt-rate package documentation hosted at halt.afroawi.com, exposing 2 endpoints across roughly 29 documentation pages. The list_docs endpoint returns a full catalog of pages with slugs, titles, categories, and URLs in a single call, while get_doc_page retrieves the complete content of any individual page — including structured sections, extracted code examples, and a plain-text body — using a slug like introduction or storage/redis.
No input parameters required.
curl -X GET 'https://api.parse.bot/scraper/66d3898d-a085-45b4-988f-3f2a61059c94/list_docs' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace halt-afroawi-com-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: Halt documentation SDK — browse the catalog and drill into a page."""
from parse_apis.halt_afroawi_com_api import Halt, PageNotFound
client = Halt()
# List documentation pages (capped to 5 items total).
for summary in client.doc_page_summaries.list(limit=5):
print(summary.title, "-", summary.category)
# Drill into the first page's full content via typed navigation.
first = client.doc_page_summaries.list(limit=1).first()
if first is not None:
page = first.details()
print(page.title, page.description)
for section in page.sections:
print(f" [{section.level}] {section.heading}")
for snippet in page.code_examples[:2]:
print(snippet[:80])
# Point lookup by a slug discovered from the catalog.
try:
detail = client.doc_pages.get(slug="algorithms")
print(detail.title, detail.url)
except PageNotFound:
print("Page not found")
print("exercised: doc_page_summaries.list / details / doc_pages.get")
List all available documentation pages for the halt-rate package. Returns each page's slug, title, category, and URL. No pagination — the full catalog is returned in a single call (~29 pages).
No input parameters required.
{
"type": "object",
"fields": {
"pages": "array of documentation page objects with slug, title, category, and url",
"total": "integer count of all documentation pages"
},
"sample": {
"data": {
"pages": [
{
"url": "https://halt.afroawi.com/docs/introduction",
"slug": "introduction",
"title": "Introduction",
"category": "Getting Started"
},
{
"url": "https://halt.afroawi.com/docs/algorithms",
"slug": "algorithms",
"title": "Algorithms",
"category": "Core Concepts"
},
{
"url": "https://halt.afroawi.com/docs/storage/redis",
"slug": "storage/redis",
"title": "Redis",
"category": "Storage"
}
],
"total": 29
},
"status": "success"
}
}About the Afroawi API
Listing Documentation Pages
The list_docs endpoint requires no inputs and returns the complete documentation catalog in one response. Each entry in the pages array includes a slug (used to fetch full content), a title, a category grouping, and a url. The total field gives the integer count of all available pages, currently around 29.
Retrieving Full Page Content
The get_doc_page endpoint accepts a single required slug parameter — for example, algorithms, frameworks/fastapi, or storage/redis — and returns the full page content. The response includes a title, a short description, a content field with full plain-text content, and a sections array where each element carries a heading, level, and section-level content. Code snippets are surfaced separately in the code_examples array, making it straightforward to extract implementation examples without parsing the full text.
Slug Formats and Nesting
Slugs can be flat (e.g., introduction) or path-separated to represent nested pages (e.g., storage/redis, frameworks/fastapi). Valid slugs for a given deployment can be discovered by first calling list_docs and reading the slug field from each returned page object. The url field in both endpoints points to the canonical page on halt.afroawi.com.
The Afroawi API is a managed, monitored endpoint for halt.afroawi.com — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when halt.afroawi.com changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official halt.afroawi.com API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build a searchable offline index of halt-rate documentation using titles, categories, and slugs from
list_docs - Automatically extract code examples from rate-limiting algorithm pages using the
code_examplesfield inget_doc_page - Generate a documentation site mirror by iterating slugs from
list_docsand fetching structured sections viaget_doc_page - Populate a developer chatbot's knowledge base with halt-rate content using the
contentandsectionsfields - Audit which halt-rate documentation topics exist and how they are categorized using the
categoryfield fromlist_docs - Retrieve framework-specific integration guides (e.g.,
frameworks/fastapi) to embed in onboarding tooling
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does halt.afroawi.com have an official developer API?+
What does `get_doc_page` return beyond the page text?+
content, the response includes a sections array (each with heading, level, and section content), a code_examples array of extracted code snippets, a short description, the canonical url, and the slug that was requested.Does `list_docs` support filtering by category or pagination?+
list_docs returns the full catalog of approximately 29 pages in a single response. Each page object includes a category field you can use for client-side filtering. You can fork this API on Parse and revise it to add a server-side category filter endpoint.Does the API expose metadata like page publish dates, authors, or version history?+
How do I know which slugs are valid to pass to `get_doc_page`?+
list_docs first and read the slug field from each object in the pages array. Nested pages use path-separator syntax, such as storage/redis or frameworks/fastapi. Passing an invalid slug will not return useful content.