Skip to main content

Components

This page outlines the purpose and design of each component at a medium level of detail. For more implementation details, refer to each component's own docs.

Authentication​

See Authentication Flows on Notion.

Users, Accounts, and Memberships​

See Multi-account Design Doc on Notion.

Indexes​

API Keys​

Integrations​

Billing​

Console BFF​

Handle requests from the Console web client.

Delegates all requests to the appropriate services, sometimes orchestrating multiple calls, and formats the results for users.

Public BFF​

Handle requests from other public clients, primarily py-marqo and the Terraform provider.

Only supports the Indexes API, so delegates all requests to the Indexes service.

Service Utils​

A shared library of functionality needed by multiple services.