Skip to main content

API Overview

warning

Before delving into this section, we recommend reading our Guide pages. They explain crucial aspects that underlie the API.

Spectral offers a full-fledged API for programmatic control: anything you can do in the UI, you can do from code. And the two are fully interchangeable: you can set up targets and knowledge bases in the UI, then launch and poll evaluations from code, or vice versa.

QuickstartAuthenticate and make your first Spectral API request.

Resources​

The REST API is available now and covers every Spectral capability. Python and TypeScript SDKs are in development. Reach out for preview access, or to request another language.

API ReferenceBrowse every endpoint, with request and response schemas and example code.
Python SDKComing soonA fully typed Spectral client for Python.
TypeScript SDKComing soonA fully typed Spectral client for TypeScript.