Apian Labs
Beta • SLAs Suspended

API reference

Apian Labs Relay exposes a REST API for sending messages, checking status, and retrieving trace timelines. This page links to the OpenAPI specification and summarizes the available endpoints.

API basics

  • Base URL: https://api.apianlabs.com/v1
  • Authentication: Send your API key in the x-api-key header. Create keys in the Relay dashboard.
  • Idempotency: Send Idempotency-Key (or x-idempotency-key) on POST /v1/messages to dedupe retries. idempotencyKey in the request body is also accepted. Keys are deduped for 24 hours.
  • Rate limiting: Requests above your limit return 429 with a Retry-After header. Wait at least that many seconds before retrying.

OpenAPI specification

Download or view the OpenAPI document here: relay.openapi.yaml.

Core endpoints

  • POST /v1/messages: Send a message
  • GET /v1/messages/{messageId}: Fetch message status
  • GET /v1/messages/{messageId}/trace: Fetch trace timeline
  • POST /v1/webhooks: Create a webhook endpoint
  • GET /v1/webhooks: List webhook endpoints

Planned endpoints

  • Policies API for routing policy management (planned)
  • Providers API for provider configuration (planned)

Next steps