Skip to main content
Foil’s public API covers four product surfaces:
  • Sessions - session result readback for backend verification and audit.
  • Fingerprints - visitor fingerprint readback for cross-session correlation.
  • Gate - the Gate registry, agentic signup, agent tokens, and dashboard login sessions.
  • Organizations - organization, membership, and API key lifecycle.

Base URLs

Managed Foil uses separate hosts for the CDN-hosted browser agent and the REST API.
Every public endpoint lives under /v1/. See Versioning for how the API evolves.

Cross-cutting conventions

A handful of concerns apply to every endpoint. They have dedicated pages so they’re easy to link to and easy to keep accurate:

Authentication

Key types, scopes, and lifecycle. Start here.

Errors

Error envelope shape, status codes, retry semantics.

Pagination

Cursor-based pagination on every list endpoint.

Rate limits

Organization defaults, response headers, retry strategy.

Versioning

What’s additive, what’s breaking, and how to pin.

Security and privacy

Crypto, infrastructure, and what you should disclose.

Endpoint groups

Sessions

Read the latest stored session result from your backend with a secret key.

Visitor fingerprints

Inspect visitor fingerprints with a secret key.

Gate

Browse the Gate registry, manage services, create signup sessions, verify agent tokens, consume login codes.

Organizations

Create organizations, provision key pairs, and rotate or revoke keys.