Skip to content
Spacefast Docs
Esc
↑↓navigate↵open⌘Jpreview

List the documentation index

Returns the machine-readable documentation index as JSON, including guides, CLI, API reference, and recipes. The default tier is essential; pass tier=reference to get everything. Filter with q (free-text) and category (guide|cli|api|recipe). The response comes from an in-memory index built from the same catalog as the CLI sf docs, so the two never drift.

GET/v1/docs
Query parameters
qstring
tierstringrequired
default: "essential"
Allowed:essentialfullreference
categorystring
Allowed:guidecliapirecipeworkflowerror
Responses
200

Response for status 200

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

dataobjectrequired
Show properties
tierstringrequired

The tier the listing ran at.

Allowed:essentialfullreference
querystring | nullrequired

The trimmed q query, or null when listing.

categorystring | nullrequired

The applied category filter, or null.

Show properties
Any of:
string
string
null
null
countintegerrequired

Number of entries returned.

min -9007199254740991 · max 9007199254740991
entriesobject[]required
Show properties
Array of object
slugstringrequired

Stable topic id, for example publishing or api/spaces.

titlestringrequired
summarystringrequired
categorystringrequired
Allowed:guidecliapirecipeworkflowerror
tierstringrequired
Allowed:essentialfullreference
keywordsstring[]required

Extra search terms that match this page.

urlstring<uri>required

Canonical docs URL: the docs site page, or the docs API page for topics the docs site does not publish, such as recipes.

linksobjectrequired
Show properties
docstring<uri>required

Canonical docs URL: the docs site page, or the docs API page for topics the docs site does not publish, such as recipes.

selfstringrequired

API-relative link to this entry's JSON (/v1/docs/pages/{slug}).

default

Problem details (RFC 9457). Any 4xx/5xx response is one application/problem+json document.

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

typestringrequired

Problem type URI resolving to the error docs page. The server derives it mechanically from code against the docs origin.

titlestringrequired

Short human-readable summary of the problem type. The server derives it mechanically from code.

statusintegerrequired

HTTP status code of this response, repeated in the body.

min -9007199254740991 · max 9007199254740991
detailstringrequired

Human-readable failure explanation for this occurrence.

codestringrequired

Stable snake_case error code naming the failed public contract.

pointerstring

RFC 6901 JSON Pointer into the failing request field, for example "/files/37/path", on validation failures.

detailsobject

Machine-readable context for the error code.

suggestionsstring[]

Actionable recovery steps safe to show in dashboards, SDKs, and CLI output.

nextstring[]

Copy-pasteable commands or API requests an agent can run next.

requestIdstringrequired

The request id to quote when contacting support.

Try it
Server
Parameters
Request
curl -X GET 'https://api.spacefast.com/v1/docs?tier=essential'
Response
{
  "$schema": "http://example.com",
  "data": {
    "tier": "essential",
    "query": "string",
    "category": "guide",
    "count": -9007199254740991,
    "entries": [
      {
        "slug": "string",
        "title": "string",
        "summary": "string",
        "category": "guide",
        "tier": "essential",
        "keywords": [
          "string"
        ],
        "url": "http://example.com",
        "links": {
          "doc": "http://example.com",
          "self": "string"
        }
      }
    ]
  }
}