canonical: https://jentic.com/apis/stoplight.io/stoplight

# Stoplight

stoplight.io/stoplight version api-v1. The API exposes 5 endpoints secured with apiKey authentication.

## For AI agents

Programmatically publish anonymous, export. Covers 5 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Publish Anonymous
- Export
- Import
- Unpublish
- Monitor Stoplight operational status and events

## Use cases

### Developer Tools Operations

Use the Stoplight to perform developer tools operations programmatically. The API provides 5 endpoints covering core functionality including publish anonymous, export, import.

Example prompt: Call POST `/versions/publish/anon` to publish anonymous

### Automated Versions Management

Automate versions operations by combining multiple Stoplight endpoints. Agents can export and then import in a single workflow.

Example prompt: Call GET `/versions/{versionId}/export/{format}` to export, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Stoplight endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'publish anonymous', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/versions/publish/anon` | Publish Anonymous |
| GET | `/versions/{versionId}/export/{format}` | Export |
| PUT | `/versions/{versionId}/import` | Import |
| POST | `/versions/{versionId}/publish` | Publish |
| PUT | `/versions/{versionId}/unpublish` | Unpublish |

## Key resources

- **Versions** — Operations for versions

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 34 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 80 / 100
  - Developer Experience & Jentic Compatibility: 46 / 100
  - AI-Readiness & Agent Experience: 14 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/stoplight.io/stoplight/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Stoplight by hand means sending its API key in the Authorization header on every call to api.stoplight.io/v1 and coordinating the export, import, and publish steps for each version yourself. Through Jentic you install once, import Stoplight from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** Stoplight puts the version id in the URL path (`/versions/{versionId}/...`), so a rule can pin your agent to one version: it can export or import that version and nothing else. You choose the operations it may call, so publish and unpublish are not included unless you add them.
- **Credential handling:** Your Stoplight API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'export an API version' or 'publish a documentation version', and Jentic returns the matching Stoplight operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Stoplight use?

The Stoplight uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I publish anonymous with the Stoplight?

Yes. Use the POST `/versions/publish/anon` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Stoplight?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I publish anonymous through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'publish anonymous'. Jentic returns the matching Stoplight operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Stoplight have?

The Stoplight exposes 5 endpoints covering versions operations.

### Can I limit what my agent is allowed to do with the Stoplight API?

Yes. Because you run Jentic One yourself, your own rules decide which Stoplight operations and credentials the agent may use. Stoplight puts the version id in the URL path (`/versions/{versionId}/...`), so you can pin the agent to a single version and let it only export or import that version. You choose the operations it can call, so publish and unpublish stay off unless you explicitly grant them.