Stoplight

REST API at api.stoplight.io/v1. Resources: workspaces, projects, branches, nodes (API elements). GET /workspaces/{id}/projects lists projects. GET /projects/{id}/branches lists branches with their OpenAPI specs. POST /projects/{id}/push pushes an OpenAPI spec update to a project. Stoplight Docs hosting: published docs at {org}.stoplight.io. Spectral CLI: npm install -g @stoplight/spectral-cli; `spectral lint openapi.yaml --ruleset .spectral.yaml` runs style guide checks. Mock server: Prism (open-source companion) runs mock servers from OpenAPI specs locally or in CI.

REST API: standard HTTP status codes with JSON errors. 401 for invalid/expired token, 404 for missing project/branch. Spectral CLI: exit 0 (no lint errors), 1 (lint errors found) — suitable for CI gating. Lint results: severity (error/warn/info/hint), path, message, source location in YAML/JSON. Stoplight platform uptime at status.stoplight.io. Mock server (Prism) runs locally; no external dependency for mocking. Rate limits not prominently documented for REST API.

Stoplight is an API design and governance platform — its primary value is in designing APIs (visual OpenAPI editor), enforcing API style guides (Spectral linter), hosting API documentation (Stoplight Docs), and generating mock servers from specs. For agents, the key programmatic surfaces are: (1) Spectral CLI for OpenAPI linting in CI pipelines, (2) Stoplight REST API for workspace and project management, and (3) mock server generation from OpenAPI specs. Not a runtime API testing tool — it's design-time governance. Used by teams managing large API portfolios who want consistency and automated style guide enforcement. Confidence is docs-derived.

REST API: Bearer token auth via Authorization: Bearer {token}. Tokens from Stoplight account settings → API Tokens. Workspace-scoped tokens. HTTPS enforced. Spectral CLI: no auth required for local linting; Stoplight platform connectivity for remote ruleset fetching uses the same API token. RBAC via Stoplight workspace roles: viewer, editor, admin. Projects can be public (external docs visible) or private (workspace members only).

docs.stoplight.io provides Stoplight Studio guide (visual editor), Spectral ruleset documentation (built-in rules + custom rule authoring), REST API reference, mock server (Prism) documentation, and documentation hosting configuration. Getting started requires a Stoplight account (free plan available with limited projects). Spectral is fully open-source (no account needed for CLI linting). GitHub integration for spec sync and CI checks. Community via Stoplight Community forum and Spectral GitHub.