Sageox Guidance API
AI-generated guidance content and statistics. Provides contextual recommendations, best practices, and insights derived from team context and recording analysis.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/sageox-guidance-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: SageOx Guidance API
version: 1.0.0
description: '# API Reference
## Overview
SageOx is a platform that captures team knowledge from discussions, decisions, and work context into a Ledger (per-repo historical record) and Team Context (team-wide shared knowledge).'
contact:
name: SageOx Team
license:
name: MIT
servers:
- url: http://localhost:3000
description: Devcontainer
- url: https://test.sageox.ai
description: Test
- url: https://sageox.ai
description: Production
security:
- bearerAuth: []
tags:
- name: Guidance
description: AI-generated guidance content and statistics. Provides contextual recommendations, best practices, and insights derived from team context and recording analysis.
paths:
/api/v1/guidance/:
get:
operationId: getRootGuidance
summary: Get root guidance content
description: 'Returns guidance content for the root path.
Used to bootstrap guided experiences and progressive disclosure.
**Progressive disclosure:** Guidance is tiered based on user context:
- Unauthenticated: Limited guidance, 60 req/min
- Authenticated: Full guidance, 300 req/min
**Authentication:** Optional (tiered rate limiting based on auth status)
**Rate limit:** Tiered (60 req/min unauthenticated, 300 req/min authenticated)'
tags:
- Guidance
security:
- BearerAuth: []
- {}
responses:
'200':
description: Root guidance content
content:
application/json:
schema:
type: object
properties:
title:
type: string
example: Getting Started
content:
type: string
description: Markdown content
example: '# Getting Started\n\nWelcome to SageOx...'
sections:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
href:
type: string
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/guidance/{path}:
get:
operationId: getPathGuidance
summary: Get path-based guidance
description: 'Returns guidance content for a specific path (wildcard route).
Supports nested paths for progressive disclosure.
**Path examples:**
- `/api/v1/guidance/getting-started`
- `/api/v1/guidance/repos/setup`
- `/api/v1/guidance/teams/collaboration`
**Progressive disclosure:** Content adjusted based on user tier and context
**Authentication:** Optional (tiered rate limiting)
**Rate limit:** Tiered (60 req/min unauthenticated, 300 req/min authenticated)'
tags:
- Guidance
security:
- BearerAuth: []
- {}
parameters:
- in: path
name: path
required: true
schema:
type: string
description: Guidance path (supports nested paths with slashes)
example: getting-started/setup
responses:
'200':
description: Guidance content for path
content:
application/json:
schema:
type: object
properties:
path:
type: string
example: getting-started
title:
type: string
example: Getting Started
content:
type: string
description: Markdown content
example: '# Getting Started\n\nStep by step guide...'
next:
type: array
description: Suggested next topics
items:
type: object
properties:
path:
type: string
title:
type: string
'404':
description: Guidance not found for path
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: Rate limit exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/v1/guidance/my-stats:
get:
operationId: getGuidanceStats
summary: Get user guidance statistics
description: 'Returns guidance-related statistics for the authenticated user.
Tracks progress, visited topics, and engagement metrics.
**Statistics tracked:**
- Topics visited
- Guidance completion percentage
- Recommended next steps based on usage
**Authentication:** Bearer token required'
tags:
- Guidance
security:
- BearerAuth: []
responses:
'200':
description: Guidance statistics for user
content:
application/json:
schema:
type: object
properties:
total_topics:
type: integer
example: 15
visited_topics:
type: integer
example: 8
completion_percentage:
type: integer
description: Percentage of guidance completed
example: 53
last_visited:
type: string
format: date-time
example: '2025-12-18T10:30:00Z'
recommended:
type: array
description: Recommended topics based on usage
items:
type: object
properties:
path:
type: string
title:
type: string
reason:
type: string
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
type: object
description: Standard error response returned by all endpoints on failure.
required:
- success
- error
properties:
success:
type: boolean
description: Always `false` for error responses.
enum:
- false
error:
type: string
description: Human-readable error message describing what went wrong. Do not parse this programmatically — use HTTP status codes for control flow.
example: Invalid request parameters
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'JWT token obtained from the auth service (/api/auth/token).
Token is validated using JWKS from the auth service.
Required claims: sub (user_id), email, name, tier.
'