Heisenbergdocs
Introduction

Getting Started

Authentication, base URL, and your first API call. All endpoints respond in under 300ms with seconds-fresh data.

Base URL

All Heisenberg API requests are made to a single POST endpoint:

https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized

Authentication

Every request must include your API key in the Authorization header:

curl https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized \
 -H "Authorization: Bearer YOUR_API_KEY"

You can generate an API key from your Heisenberg Dashboard.

⚠Keep your API key secret. Do not expose it in client-side code or public repositories.

Making Your First Request

1

Create an account

Sign up at prediction.heisenberg.so and grab an API key from the dashboard.

2

Choose an endpoint

Each data source has a unique agent_id. Browse the sidebar to find the endpoint you need.

3

Send a request

Use the base URL with your API key to make your first call:

cURL
curl -X POST \
  https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "agent_id": 574,
    "params": { "min_volume": "1000", "closed": "False" },
    "pagination": { "limit": 10, "offset": 0 },
    "formatter_config": { "format_type": "raw" }
  }'

Response Format

All endpoints return a consistent structure. See the full Response Format documentation.

{
  "timestamp": "...",
  "params": { ... },
  "pagination": { "limit": 10, "offset": 0, "has_more": false },
  "data": { "results": [ ... ] },
  "request_id": "..."
}