Introduction

Welcome to the Steward Public API. This guide walks you through authentication, making your first API call, and understanding the response format.

Base URL

Use the base URL for the environment where your key was issued:

Environment	Base URL	Key prefix
Production	https://api.getsteward.ai/api/v1	stw_live_…
Sandbox	https://api.steward-sandbox.com/api/v1	stw_test_…

Environment: Examples use Production (https://api.getsteward.ai) with an stw_live_… key. For Sandbox, use https://api.steward-sandbox.com with an stw_test_… key.

Authentication

The Steward API uses API keys for authentication. Include your key in the Authorization header of every request:

curl https://api.getsteward.ai/api/v1/applications \
  -H "Authorization: Bearer stw_live_your_api_key_here"

Warning: Keep your API key secret. Do not share it in client-side code, public repositories, or URLs. If your key may be compromised, stop using it and contact your Steward representative immediately to revoke and replace it.

Obtaining an API Key

API keys are provisioned through your Steward account — contact your Steward representative to have one created. Each key has full access to its account’s data, and you can hold multiple keys per account.

The raw key is shown only once at creation - store it securely. See the Authentication guide for key formats, environments, and rotation.

Your First Request

List your account’s applications:

curl https://api.getsteward.ai/api/v1/applications \
  -H "Authorization: Bearer stw_live_your_api_key_here" \
  -H "Content-Type: application/json"

A successful response returns a cursor-paginated list:

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "status": "SUBMITTED",
      "type": "BUSINESS",
      "createdAt": "2026-03-30T12:00:00.000Z"
    }
  ],
  "nextCursor": "ZGVzY3x1cGRhdGVkQXR8MjAyNi0wNS0xM1QxNjowOToxMi4wMDBafDUwN2Yx..."
}

To fetch the next page, pass nextCursor back as a cursor query parameter on your next request. When there are no more pages, nextCursor is null. See the Pagination guide for the full contract.

Generating a client

These docs are generated from an OpenAPI 3 specification, served alongside this site at /openapi.json. Point any OpenAPI client generator (for example openapi-generator or Orval) at that URL to produce a typed client in your language — every endpoint here comes from that one spec.