Skip to content

index.md

Latest commit

 

History

History
78 lines (57 loc) · 2.85 KB

index.md

File metadata and controls

78 lines (57 loc) · 2.85 KB
Raw

API

This walkthrough gives application developers the shortest path from a running service to a useful read. It demonstrates only the stable core flow. The full API reference owns the exact authentication and correlation headers, endpoint inventory, parameters, request limits, response fields, status codes, and operational or admin surfaces. Use the generated OpenAPI document when a machine-readable core contract is required.

Before you start

Complete the quickstart and start the API. The commands below use the local URL http://localhost:8000 and send demo-key so they also work in keyed demo profiles; the local-only quickstart accepts them without a key. Use values from the deployment walkthrough in other environments. See the reference's base URL and headers section for the complete authentication contract.

1. Check the service

Confirm that the API can answer before issuing a data request:

curl http://localhost:8000/v1/health

The detailed response and error contract belongs to the health reference.

2. Discover available data

Read the catalog before hard-coding an entity or metric name:

curl -H "X-API-Key: demo-key" http://localhost:8000/v1/catalog

Choose an entity type and identifier from the catalog for the next request.

3. Read an entity

Fetch the current state through the semantic entity boundary:

curl -H "X-API-Key: demo-key" \
  http://localhost:8000/v1/entity/order/ORD-20260404-1001

For historical reads, response fields, and failure cases, continue in the entity lookup reference.

4. Ask a constrained question

curl -X POST http://localhost:8000/v1/query \
  -H "Content-Type: application/json" \
  -H "X-API-Key: demo-key" \
  -d '{"question":"top products by revenue today","limit":5}'

The query and pagination reference defines the complete request and response shape. Inspect a query before running it when the reference calls for the explain workflow.

Continue by task

Goal Detailed owner
Historical reads and pagination Query and pagination model
Contracts, search, and lineage Discovery and governance
Streaming and operator workflows Streaming and operational workflows
Platform administration Admin API

For typed client setup and language-specific calls, continue with the SDK guide. The full reference remains authoritative when a client helper and the HTTP surface differ.