Pulsar Docs

Introduction

Everything you need to integrate with the Pulsar backend API.

Pulsar's backend exposes a single REST API that powers production tracking, work orders, machines, alerts, reporting, and everything else in the platform. This site is generated directly from our OpenAPI spec, so it always reflects what's actually deployed.

Getting started

Authentication

Requests are authenticated with a JWT. Get one by logging in:

curl --location 'https://api.dev.pulsarml.com/identity/login' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "email": "you@example.com",
    "password": "your-password"
  }'

Swap api.dev for api.stage or api.pulsarml.com (production) depending on the environment. The response body's data.jwt.token is your access token — send it as-is, with no Bearer prefix:

Authorization: <token>

Try it in the docs

Open Login, the first page under API Reference, and send your email + password from there once — the token is applied to every endpoint's playground and code samples on this site automatically (stored in your browser only). Once you're logged in, a Log out button appears at the top of the docs to clear it. You can also paste a token directly into an endpoint's Authorization field if you already have one.

Making a request

Every endpoint page includes a live request builder plus generated code samples (cURL, JavaScript, Python, Go, and more) so you can try a call directly from the docs.

On this page