Back to Dashboard

API Documentation

Complete reference for the PlatPhorm Keys API. Keys issued here are future PLATPHORM_API_KEY values for protected PlatPhormNews actions.

OpenAPI Spec

Authentication

Protected endpoints accept the shared PlatPhorm platform key. Public-safe provisioning remains bounded and rate-limited.

Authorization: Bearer $PLATPHORM_API_KEY
or
X-PlatPhorm-API-Key: $PLATPHORM_API_KEY

Endpoints

POST/api/v1/keys/provisionPublic

Self-service key provisioning (no auth required)

GET/api/v1/keysAuth Required

List all API keys

POST/api/v1/keysAuth Required

Create a new API key

GET/api/v1/keys/{id}Auth Required

Get API key details

DELETE/api/v1/keys/{id}Auth Required

Revoke an API key

GET/api/v1/healthPublic

System health check

GET/api/v1/telemetryPublic

Public-safe telemetry summary; sensitive spans require PLATPHORM_API_KEY

GET/api/docsPublic

OpenAPI 3.0 specification (JSON)

Quick Start

Provision a new API key
Public-safe first-key creation is bounded to 5/hour and generated secrets are shown once
curl -X POST https://keys.platphormnews.com/api/v1/keys/provision \
  -H "Content-Type: application/json" \
  -d '{"name": "My First Key", "scopes": ["read"]}'

Response Headers

All API responses include OpenTelemetry headers for observability:

X-Request-IdUnique request identifier
X-Trace-IdOpenTelemetry trace ID
X-Client-UUIDYour client identifier
X-FingerprintDevice fingerprint