Solia Direct DocsSign In
⌘K
Main siteExplore Sandbox

ReferenceReference

OpenAPI Specification

The canonical, machine-readable OpenAPI 3.1 description of the Partner API, plus generated Postman artifacts.

Machine-readable OpenAPI description
On this page

Canonical contract

The Partner API is described by one OpenAPI 3.1 document generated from the implementation. The human-readable API Reference and every endpoint page are generated from the same contract, so they cannot drift apart.

API ReferenceHuman-readable endpoint reference.OpenAPI JSONOpen or download the machine-readable document./api/public/partner-openapi
  • Public and unauthenticated: a plain GET with no query parameters, headers or API key.
  • Returns application/json, cacheable for five minutes.
  • Contains no keys, tenant data or real identifiers.
  • The servers list includes a Sandbox or Production base URL only when that base URL is configured for the platform; otherwise use the base URL shown in your Control Plane.
bash
curl -s https://docs.soliadirect.com/api/public/partner-openapi -o solia-partner-openapi.json

Postman collection

A Postman Collection v2.1 and a Sandbox environment template are generated from the OpenAPI document and grouped by functional area. Requests use {{base_url}} and authenticate with Authorization: Bearer {{api_key}}.

Postman collectionDownload the generated collection./developer/solia-direct-partner-api.postman_collection.jsonPostman environmentDownload the Sandbox environment template./developer/solia-direct-sandbox.postman_environment.json
  1. Import both files into Postman.
  2. Set base_url to the Partner API base URL shown in your Control Plane.
  3. Set api_key to a Sandbox key. The template ships with empty placeholders only.
  4. Set idempotency_key to a new value before each order creation.

Warning

Never commit or share a filled-in environment: an API key is a credential.

cURL and examples

Every endpoint page in the API Reference includes a cURL example generated from the same endpoint definition. Workflow-level cURL and TypeScript examples live in Examples.

ExamplesCopyable workflow examples.llms.txtIndex of the public docs for AI tools./llms.txt

Limitation

No official Solia SDK is published today. Generate a client from the OpenAPI document if you need one.

Related resources

API ReferenceHealthLaboratory