Getting started

This guide takes you from zero to your first authenticated request against any Simwood service.

1. Get an API key

Generate a key in the Customer Portal. Each key carries a set of scopes that control what it can do — see Authentication & authorization for the full details.

The full key is shown once, at creation. Store it securely — Simwood keeps only a hash and cannot show it to you again.

2. Make your first request

Send your key as a Bearer token in the Authorization header. Every service is reached at the same gateway, so the only things that change between services are the path and the payload:

# Replace {service}/{version} with the service you're calling, e.g. intelligence/v1
curl https://api.simwood.com/{service}/{version}/... \
  -H "Authorization: Bearer sk_live_..."

3. Explore a service

Each service documents its own endpoints, concepts, and workflows. Browse the available services and open the one you need to see its overview and API reference.

Introduction

Authentication