Skip to main contentOverview
Here’s a concise, in-place explanation of each API endpoint:
Authentication
/auth/core/anonymous – Allows anonymous user sign-in without credentials.
/auth/core/refresh – Refreshes an expired authentication token.
/auth/google/signin – Authenticates a user via Google sign-in.
Users
/users/:id – Retrieves information for a specific user by their ID.
/users/:id/orgs – Lists all organizations associated with a specific user.
/users/:id/limits – Fetches usage limits or quotas assigned to a specific user.
Organizations
/orgs – Lists all organizations.
/orgs/:id – Retrieves details for a specific organization by ID.
/orgs/:id/blobs – Lists all blobs belonging to a specific organization.
/orgs/:id/limits – Retrieves usage limits for a specific organization.
Blobs
/blobs/:org_id/:blob_id – Retrieves details of a specific blob within an organization.
/blobs/:org_id/:blob_id/limits – Retrieves usage limits for a specific blob.
/blobs/:org_id/:blob_id/revisions – Lists revision history for a specific blob.
/blobs/:org_id/:blob_id/metadata/:alias – Retrieves metadata for a blob using a specific alias.
/blobs/metadata/:id – Retrieves metadata for a blob using the metadata ID.
Revisions
/revisions/:id - Retrieves a specific revision by ID.
/revisions/:id/commit - Commits changes to a specific revision by ID.
/revisions/:id/metadata/:alias - Retrieves metadata for a specific revision using an alias.
/revisions/metadata/:id - Retrieves metadata directly by metadata ID.
Revision Data
/revisions/:id/data/query - Queries data associated with a specific revision.
/revisions/:id/data/command - Executes a command modifying data for a specific revision.
Shared
API Keys
/api-keys/target/:target/:target_id – Lists API keys for the specified target and target ID.
/api-keys/:id – Retrieves details of a specific API key by ID.
Members
/members/target/:target/:target_id – Lists members associated with a specific target and target ID.
/members/:id – Retrieves details of a specific member by ID.
Credentials
/credentials/manifest – Provides a manifest describing the supported credential types and formats.
/credentials/target/:target/:target_id – Retrieves all credentials belonging to a specific target and target ID.
/credentials/:id – Manages a single credential identified by credential ID.
Operations
/operations/:id - Retrieves the status or details of a specific operation by ID.