# Komprai

## Docs

- [Create resource config](https://docs.komprai.com/api-reference/admin--billing/create-resource-config.md): Creates a new billing configuration for a resource type, defining the billing model (flat or metered) and rate per unit.
- [Generate invoices](https://docs.komprai.com/api-reference/admin--billing/generate-invoices.md): Triggers invoice generation for a given billing period. Can target a specific owner or generate for all users and organizations in bulk.
- [List all invoices (admin)](https://docs.komprai.com/api-reference/admin--billing/list-all-invoices-admin.md): Returns all invoices across all users and organizations. Supports filtering by owner, period, and status.
- [List resource configs](https://docs.komprai.com/api-reference/admin--billing/list-resource-configs.md): Returns all billing resource configurations defining rates per resource type.
- [Update resource config](https://docs.komprai.com/api-reference/admin--billing/update-resource-config.md): Updates the rate, currency, description, or active status of a billing resource configuration.
- [Void invoice](https://docs.komprai.com/api-reference/admin--billing/void-invoice.md): Marks an invoice as void. Voided invoices are retained for audit purposes but excluded from payment processing.
- [Bootstrap admin](https://docs.komprai.com/api-reference/admin/bootstrap-admin.md): Promotes the authenticated user (or a given userId) to admin role. Dev/staging only — requires a static bootstrap token.
- [Get invoice](https://docs.komprai.com/api-reference/billing/get-invoice.md): Returns a single invoice by ID. The authenticated user must own the invoice or be a member of the owning organization.
- [List invoices](https://docs.komprai.com/api-reference/billing/list-invoices.md): Returns invoices for the authenticated user. Pass `organizationId` to retrieve invoices for an organization you belong to.
- [List usage records](https://docs.komprai.com/api-reference/billing/list-usage-records.md): Returns up to 500 usage records for the authenticated user, sorted by most recent. Pass `organizationId` to retrieve usage for an organization you belong to.
- [Create offer](https://docs.komprai.com/api-reference/catalog/create-offer.md): Publishes a new offer to the catalog in the current region.
- [List offers](https://docs.komprai.com/api-reference/catalog/list-offers.md): Returns all offers available in the current region. The region is determined by which Catalog API instance receives the request.
- [Create dashboard](https://docs.komprai.com/api-reference/dashboards/create-dashboard.md): Creates a new dashboard with an optional initial set of widgets. Each widget references a report and includes a grid layout position.
- [Delete dashboard](https://docs.komprai.com/api-reference/dashboards/delete-dashboard.md): Permanently deletes a dashboard and all its widgets.
- [Get dashboard](https://docs.komprai.com/api-reference/dashboards/get-dashboard.md): Returns a dashboard with fully expanded report data for each widget, ready for rendering.
- [List dashboards](https://docs.komprai.com/api-reference/dashboards/list-dashboards.md): Returns all dashboards owned by the authenticated user. Admins receive all dashboards.
- [Update dashboard](https://docs.komprai.com/api-reference/dashboards/update-dashboard.md): Updates a dashboard's name, description, or widget layout. Replaces the entire widget list when `widgets` is provided.
- [Get apiusersme](https://docs.komprai.com/api-reference/get-apiusersme.md)
- [Get auth](https://docs.komprai.com/api-reference/get-auth.md)
- [Get cataloghealth](https://docs.komprai.com/api-reference/get-cataloghealth.md)
- [Get corehealth](https://docs.komprai.com/api-reference/get-corehealth.md)
- [Get credential metadata](https://docs.komprai.com/api-reference/internal/get-credential-metadata.md): Returns metadata for a ProviderCredential for inter-service validation. The credential must belong to the active organization. Encrypted configuration is never exposed.
- [Introdução à API](https://docs.komprai.com/api-reference/introduction.md): Base URLs, autenticação, regiões e códigos de erro
- [Post auth](https://docs.komprai.com/api-reference/post-auth.md)
- [Create provider credential](https://docs.komprai.com/api-reference/provider-credentials/create-provider-credential.md): Creates encrypted credentials for a provider on a given store. The `configuration` object must satisfy the provider's `configurationSchema`. Only one credential per provider per store is allowed.
- [Delete provider credential](https://docs.komprai.com/api-reference/provider-credentials/delete-provider-credential.md): Permanently deletes a provider credential from a store.
- [Get provider credential](https://docs.komprai.com/api-reference/provider-credentials/get-provider-credential.md): Returns a single provider credential by ID. The configuration is stored encrypted and not exposed in the response.
- [List provider credentials](https://docs.komprai.com/api-reference/provider-credentials/list-provider-credentials.md): Returns all provider credentials associated with a store. Credentials hold encrypted configuration for connecting to an external provider.
- [Update provider credential](https://docs.komprai.com/api-reference/provider-credentials/update-provider-credential.md): Replaces the encrypted configuration for an existing provider credential. The new configuration is validated against the provider's schema before saving.
- [Create provider](https://docs.komprai.com/api-reference/providers/create-provider.md): Registers a new provider with a JSON configuration schema that stores must satisfy when creating credentials. Admin only.
- [Delete provider](https://docs.komprai.com/api-reference/providers/delete-provider.md): Permanently deletes a provider. Admin only.
- [Get provider](https://docs.komprai.com/api-reference/providers/get-provider.md): Returns a single provider by ID, including its configuration schema.
- [List providers](https://docs.komprai.com/api-reference/providers/list-providers.md): Returns active providers available in the current region. Providers define the integration schema that stores use to connect external data sources.
- [Update provider](https://docs.komprai.com/api-reference/providers/update-provider.md): Updates provider metadata, allowed regions, or configuration schema. Admin only.
- [Create region](https://docs.komprai.com/api-reference/regions/create-region.md): Creates a new deployment region. Admin only.
- [Delete region](https://docs.komprai.com/api-reference/regions/delete-region.md): Permanently deletes a region. Admin only.
- [Get region](https://docs.komprai.com/api-reference/regions/get-region.md): Returns a single region by ID.
- [List regions](https://docs.komprai.com/api-reference/regions/list-regions.md): Returns all active deployment regions. Each region has its own Catalog API instance and pricing multiplier.
- [Update region](https://docs.komprai.com/api-reference/regions/update-region.md): Updates a region's flag, location, pricing multiplier, or active status. Admin only.
- [Create report](https://docs.komprai.com/api-reference/reports/create-report.md): Creates a new report with a query definition and visualization config. Reports can be embedded in dashboards.
- [Delete report](https://docs.komprai.com/api-reference/reports/delete-report.md): Permanently deletes a report.
- [Get report](https://docs.komprai.com/api-reference/reports/get-report.md): Returns a single report by ID.
- [List reports](https://docs.komprai.com/api-reference/reports/list-reports.md): Returns all reports owned by the authenticated user. Admins receive all reports.
- [Update report](https://docs.komprai.com/api-reference/reports/update-report.md): Updates a report's name, description, type, query, or visualization config.
- [Add domain](https://docs.komprai.com/api-reference/sso/add-domain.md): Registers a domain for DNS verification. Returns the TXT record name and value that must be published before calling the verify endpoint.
- [Create or update SSO configuration](https://docs.komprai.com/api-reference/sso/create-or-update-sso-configuration.md): Upserts the OIDC provider configuration for an organization. All email domains must be verified before they can be linked. Client secret is encrypted at rest.
- [Delete SSO configuration](https://docs.komprai.com/api-reference/sso/delete-sso-configuration.md): Removes the OIDC configuration for an organization, disabling SSO login for all its members.
- [Get SSO configuration](https://docs.komprai.com/api-reference/sso/get-sso-configuration.md): Returns the OIDC configuration for an organization. Requires org owner or admin role.
- [List verified domains](https://docs.komprai.com/api-reference/sso/list-verified-domains.md): Returns all domain verification records for an organization, including their DNS TXT challenge and current status.
- [Lookup SSO by email](https://docs.komprai.com/api-reference/sso/lookup-sso-by-email.md): Checks whether an email domain requires SSO login. Use this before showing the login form to redirect users to their identity provider.
- [Remove domain](https://docs.komprai.com/api-reference/sso/remove-domain.md): Removes a domain from the organization's verified domain list.
- [SSO callback](https://docs.komprai.com/api-reference/sso/sso-callback.md): OIDC redirect callback. Validates the authorization code, exchanges it for tokens, provisions the user account, and sets a session cookie.
- [Start SSO flow](https://docs.komprai.com/api-reference/sso/start-sso-flow.md): Initiates the OIDC authorization flow for an organization. Redirects the user to the identity provider with a PKCE challenge.
- [Update domain settings](https://docs.komprai.com/api-reference/sso/update-domain-settings.md): Toggles `allowAutoEnroll` on a verified domain. When enabled, users whose email matches this domain are automatically provisioned as org members on first SSO login.
- [Verify domain](https://docs.komprai.com/api-reference/sso/verify-domain.md): Triggers a DNS TXT lookup to verify domain ownership. The domain status becomes `verified` on success or `failed` on DNS mismatch.
- [Create store](https://docs.komprai.com/api-reference/stores/create-store.md): Creates a new store under the session's active organization.
- [Delete store](https://docs.komprai.com/api-reference/stores/delete-store.md): Permanently deletes a store. The store must belong to the session's active organization.
- [Get store](https://docs.komprai.com/api-reference/stores/get-store.md): Returns a single store by ID. The store must belong to the session's active organization.
- [List stores](https://docs.komprai.com/api-reference/stores/list-stores.md): Returns all stores for the session's active organization. Admins receive all stores.
- [Update store](https://docs.komprai.com/api-reference/stores/update-store.md): Updates a store's name, description, or active status. The store must belong to the session's active organization.
- [Set password](https://docs.komprai.com/api-reference/users/set-password.md): Sets a password for users who signed up via social login or magic link and have no credential account yet. Required before enabling TOTP-based two-factor authentication.
- [Komprai](https://docs.komprai.com/index.md): Plataforma de catálogo e comparação de preços com suporte multi-região
- [Quickstart](https://docs.komprai.com/quickstart.md): Autentique e faça sua primeira chamada à API Komprai

## OpenAPI Specs

- [core](https://docs.komprai.com/api-reference/core.json)
- [catalog](https://docs.komprai.com/api-reference/catalog.json)

## Optional

- [Console](https://console.komprai.dev)
- [GitHub](https://github.com/komprai)