API Reference

Superposition's public and authenticated APIs.

Superposition has two APIs, and which one you want depends on whether you are reading your own data or publishing someone else's.

Authenticated API

https://app.superposition.ai/api/v1

Your organization's jobs, candidates, pipeline, and agent — reached with an API key. Use this to build internal tooling, sync to a warehouse, or drive the agent from your own systems.

curl https://app.superposition.ai/api/v1/jobs \
  -H "Authorization: Bearer $SUPERPOSITION_API_KEY"

Endpoints

EndpointScope
GET /menone beyond a valid key
GET /scopesnone beyond a valid key
GET /organizationorganization:read
GET /membersmembers:read
GET /jobs, GET /jobs/{id}jobs:read
GET /jobs/{id}/candidatescandidates:read
GET /candidates, GET /candidates/{id}candidates:read
GET /pipeline?jobId=pipeline:read
GET /agent/sessionsagents:read
GET /agent/sessions/{id}agents:history
POST /agent/invokeagents:invoke
GET /billingbilling:read (admin)
GET /auditaudit:read (admin)

Public API

https://app.superposition.ai/api/public/v1

The public API needs no authentication and is CORS-enabled (Access-Control-Allow-Origin: *), so you can call it from a browser. It covers things you have chosen to publish — job descriptions for your own careers page, and public booking.

Do not send an API key to /api/public/v1. It is not needed, and a browser-side call would expose it to anyone reading the page source.

Last updated on

On this page