Quick Start

Use this flow to get a basic integration running for an agent or service.

Before you start

  • Token credentials or an authentication method for your environment.
  • Target api/v1 host URL.
  • Persistent store for IDs and cursors.

Base URL

Use your host URL and append API routes with /api/v1.

Minimal setup sequence

  1. Authenticate.
  2. Choose the account and inbox.
  3. Read inbox messages.
  4. Apply one deterministic action (label/reply/forward/send).
  5. Persist progress markers.
curl -X POST "https://api.inboxlayer.dev/api/v1/auth" \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"***"}'

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.inboxlayer.dev/api/v1/inboxes?page=1&per_page=20"

curl -H "Authorization: Bearer $TOKEN" \
  "https://api.inboxlayer.dev/api/v1/emails?inbox_id=<inbox-id>&page=1&per_page=20"

Streaming and webhooks

Use GET /api/v1/inboxes/{id}/stream for near-real-time updates and webhook subscriptions for distributed delivery.

For reliability, combine both:

  • stream for low-latency updates,
  • webhook for fan-out,
  • periodic polling for reconciliation.

Next actions

results matching ""

    No results matching ""