List the documentation index - Spacefast Docs

List the documentation index

Returns the documentation index bundled with the API: guides, CLI, API reference, recipes, workflows, and error pages. Defaults to the essential tier; pass tier=reference for everything. Narrow with q and category. The CLI ships the same index as sf docs.

GET/v1/docs

Query parameters

qstring

tierstringrequired

default: "essential"

Allowed:essential``full``reference

categorystring

Allowed:guide``cli``api``recipe``workflow``error

Responses

200Response for status 200

$schemastring

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

dataobjectrequired

Show propertiesHide properties

tierstringrequired

Tier the listing used.

Allowed:essential``full``reference

querystring | anyrequired

Trimmed q, or null when no query was sent.

Show propertiesHide properties

Any of:

string

string

any

any

categorystring | anyrequired

Category filter applied, or null.

Show propertiesHide properties

Any of:

string

string

any

any

countintegerrequired

Number of entries in entries.

min -9007199254740991 · max 9007199254740991

entriesobject[]required

Show propertiesHide properties

Array of object

slugstringrequired

Page slug, for example publishing or api/spaces. May contain /.

titlestringrequired

summarystringrequired

categorystringrequired

Allowed:guide``cli``api``recipe``workflow``error

tierstringrequired

Allowed:essential``full``reference

keywordsstring[]required

Extra terms the page matches in q searches.

urlstringrequired

URL of the page on the docs site.

linksobjectrequired

Show propertiesHide properties

docstringrequired

URL of the page on the docs site.

selfstringrequired

API path of this page, /v1/docs/pages/{slug}.

defaultError. Every 4xx and 5xx response is one RFC 9457 problem document served as application/problem+json.

$schemastring

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

typestringrequired

URL of the documentation page for this error. Derived from code.

titlestringrequired

Human-readable name of the error type. Derived from code.

statusintegerrequired

HTTP status of the response, repeated in the body.

min -9007199254740991 · max 9007199254740991

detailstringrequired

What went wrong in this request.

codestringrequired

Stable snake_case error code. Match on this, not on detail.

pointerstring

RFC 6901 JSON Pointer to the request field or batch entry that failed, for example /files/37/path. Present on validation failures.

detailsobject

Machine-readable context keyed by the error code.

suggestionsstring[]

Recovery steps safe to show to a person.

nextstring[]

Commands or API requests to run next, usable as written.

requestIdstringrequired

ID of this request, from the X-Request-Id header or generated. Quote it when contacting support.

Try it

Server

Base URLhttps://api.spacefast.comCustom base URLOverrides the selected server when set.

Parameters

qquerytierquery*essentialfullreferencecategoryquery—guidecliapirecipeworkflowerror

Send

Request

cURL

curl -X GET "https://api.spacefast.com/v1/docs?tier=essential"

JavaScript

const response = await fetch("https://api.spacefast.com/v1/docs?tier=essential", {
  method: "GET"
});

Python

import requests

response = requests.get(
    "https://api.spacefast.com/v1/docs?tier=essential",
)

Response

200default

{
  "$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"
        }
      }
    ]
  }
}

```json

{ "$schema": "http://example.com", "type": "string", "title": "string", "status": -9007199254740991, "detail": "string", "code": "string", "pointer": "string", "details": { "property1": null, "property2": null }, "suggestions": [ "string" ], "next": [ "string" ], "requestId": "string" }