Get credential guidance for a provider

What the provider calls its key, where to mint it, and any setup notes — rendered inline next to the field asking for it. Served from the registry cache; empty when the registry knows nothing.

GET/v1/connectors/catalog/{domain}/guidance

Authorization

AuthorizationBearer token · header required

`Authorization: Bearer ` with an API key (`sfa_` prefix), an OAuth access token, a session token, or a Space machine credential (`sfm_` prefix).

or

AuthorizationOAuth2 access token · header required

OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.

Scopes: connectors:read

Path parameters

domain string required

min length 1 · max length 255

Query parameters

team string

min length 1 · max length 255

Responses

200

Per-provider credential guidance for the connect modal; empty when the registry knows none.

{
  "$schema": "string<uri>",
  "data": [
    {
      "label": "string | any",
      "mintUrl": "string | any",
      "docsUrl": "string | any",
      "notes": "string | any",
      "steps": ["string"]
    }
  ]
}

Error Response

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

{
  "$schema": "string<uri>",
  "type": "string",
  "title": "string",
  "status": integer,
  "detail": "string",
  "code": "string",
  "pointer": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "suggestions": ["string"],
  "next": ["string"],
  "requestId": "string"
}

Try it

Server

Base URL: https://api.spacefast.com

Request Example

curl -X GET "https://api.spacefast.com/v1/connectors/catalog/string/guidance" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.spacefast.com/v1/connectors/catalog/string/guidance", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.spacefast.com/v1/connectors/catalog/string/guidance",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)