Skip to main content
The Solya REST API exposes the platform’s capabilities — catalog browsing, inventory plans, analytics, alerts, tags, workflows, and data-platform operations — to external programs, scripts, and AI agents.

Authentication

The three auth schemes and how to create and use a service-account token.

Making requests

Base URL, pagination, filtering, and introspecting your token.

Error codes

Response envelope, error codes, and HTTP status mapping.

API Reference

The full, always-up-to-date endpoint reference — open the API Reference tab.

Conventions at a glance

  • Base URLhttps://app.solya.app (production). Endpoints live under /api/.
  • Format — JSON request and response bodies.
  • Auth — send Authorization: Bearer <token>. See Authentication.
  • Tenancy — every token and session is scoped to one organization; you only ever read or write that organization’s data.
  • Responses — a consistent envelope with a success flag and, on failure, a stable errorCode you can branch on. See Error codes.
The API Reference tab is generated directly from Solya’s OpenAPI specification, so it always matches the running API. This Developers section adds the cross-cutting concepts the per-endpoint reference doesn’t repeat.