norbix_api library
Project-scoped Norbix API (https://api.norbix.ai).
Resources are exposed directly on NorbixApi:
final api = NorbixApi();
await api.users.getUsers();
await api.auth.authenticate();
Classes
- AiChatResource
- End-user AI chat for a signed-in project user.
- ApiKeysResource
- API keys for the current project / environment.
- AuthResource
- Authentication: API keys, access tokens, OAuth providers.
- DatabaseResource
- Project database: collection CRUD, aggregates, schemas and taxonomy terms.
- ExpandedReference
-
A reference value as the gateway returns it when a record is read with
expandReferences: true(find,findOne,findOwnon the API client;findRecords,findOneRecordon the Hub client). - FilesResource
- Project file storage: upload URLs, commit, sign, download, info, list and delete.
- HttpClientDriver
-
Default driver, backed by
package:http. - HttpDriver
-
Pluggable HTTP driver. Default is the standard
package:httpclient. Tests injectMockClient; Flutter apps can swap indioor a custom pinned-cert client by implementing this interface. - HttpDriverRequest
- HttpDriverResponse
- NorbixApi
- Norbix Api client.
- NorbixConfig
- Base configuration for any Norbix SDK client.
- NorbixErrorItem
-
One error inside the gateway's
responseStatus.errorslist. - PaymentsResource
- Project payment orders: create an order, read one or a list, and start a provider checkout for it.
- PublicProjectsResource
-
Public project routes on the API host — no sign-in needed. The admin
portal reads them before anyone signs in; safety is the answer's shape and
the project's own opt-in flags, not the caller's credentials. Like the
public file link, these calls go out with no credentials at all
(
authenticated: false), even when the client has a key. - Resource
-
Base class for every resource module (e.g.
UsersResource,ProjectsResource). Holds the shared Transport so resources can be constructed lazily by the client. - Transport
-
Internal HTTP transport used by every resource. You should not construct
this directly — the per-host clients (
NorbixApi,NorbixHub) own one. - UserAuthResource
- End-user authentication: passkeys, email verification, recovery and tokens.
- UsersResource
- Project membership users (create, list, block, invite, register variants).
Constants
- kNorbixApiDefaultBaseUrl → const String
- Default base URL for the public Norbix Api host.
-
kNorbixRegionalDefaultBaseUrls
→ const Set<
String> -
SDK default hosts eligible for regional base-URL composition. A region
only rewrites these well-known hosts (
kNorbixApiDefaultBaseUrl,kNorbixHubDefaultBaseUrl); user-supplied base URLs are never touched.
Functions
-
composeRegionalBaseUrl(
String baseUrl, String region) → String -
Compose the regional base URL for
baseUrl: whenbaseUrlis one of the SDK defaults theregioncode becomes a subdomain prefix (e.g.https://nb-eu-germany.api.norbix.ai); any other base URL is returned unchanged. -
norbixBodySaysItFailed(
Object? body) → bool -
truewhen the body carriesresponseStatus.isSuccess == false.
Exceptions / Errors
- NorbixAuthError
- 401 / 403 — invalid or missing credentials.
- NorbixClientError
- 4xx other than 401/403/404/429.
- NorbixError
- Base exception thrown by every Norbix call.
- NorbixNotFoundError
- 404 — resource does not exist.
- NorbixRateLimitError
-
429 — rate limited.
Retry-After(seconds) is in details when present. - NorbixServerError
- 5xx — server-side failure.
- NorbixTransportError
- Network or timeout failure (no HTTP status).