xpna

Appearance

API Reference ​

Notes:

Public API v1 is currently in feature preview and as such documentation for this feature is still work in progress

The Public API v1 is documented in this section. Current endpoints and response formats that are available in this preview are covered.

Base URL ​

  • The base URL for all Public API v1 requests is https://xpna.app/api/public/v1.
  • All endpoint paths in this section are relative to the base URL.

Authentication ​

  • Authentication is required for access.
  • API keys are managed in the xpna task pane. See API Keys.
  • Supported authentication headers are documented in Authentication.

Response format ​

  • All successful responses are wrapped in a standard envelope.
  • The response payload is returned under data.
  • Response metadata is returned under meta.
  • The full envelope shape is documented in Response Envelope.

Errors ​

  • Error responses are returned as RFC 9457 problem details.
  • The response content type is application/problem+json.
  • The error format is documented in Errors.

Rate limits ​

  • Rate limits are enforced per API key.
  • 429 responses include rate limit headers and retry guidance.
  • Rate limit behavior is documented in Rate Limits.

Endpoints ​

Copyright © 2025 xpna