# Get current user information Source: https://albus.mintlify.app/api-reference/auth/get-current-user-information /openapi/openapi.yaml get /whoami Returns the authenticated user along with every organization they belong to and their roles in each. # Health check endpoint Source: https://albus.mintlify.app/api-reference/health/health-check-endpoint /openapi/openapi.yaml get /health Returns 200 OK if the service is healthy # Invite a user by email Source: https://albus.mintlify.app/api-reference/invites/invite-a-user-by-email /openapi/openapi.yaml post /invites Creates a pending invitation for an email address. Omit organization_id to invite the user as the founder of a new organization that is created on their first sign-in; provide it to invite them into an existing organization. The invitation is redeemed automatically the first time the invitee signs in with that email. # Create a secret Source: https://albus.mintlify.app/api-reference/secrets/create-a-secret /openapi/openapi.yaml post /secrets # Delete a secret by name Source: https://albus.mintlify.app/api-reference/secrets/delete-a-secret-by-name /openapi/openapi.yaml delete /secrets/{name} # Get a secret by name Source: https://albus.mintlify.app/api-reference/secrets/get-a-secret-by-name /openapi/openapi.yaml get /secrets/{name} # List all secrets Source: https://albus.mintlify.app/api-reference/secrets/list-all-secrets /openapi/openapi.yaml get /secrets # Update a secret by name Source: https://albus.mintlify.app/api-reference/secrets/update-a-secret-by-name /openapi/openapi.yaml put /secrets/{name} # Delete a session Source: https://albus.mintlify.app/api-reference/sessions/delete-a-session /openapi/openapi.yaml delete /sessions/{id} # Get a session with its messages Source: https://albus.mintlify.app/api-reference/sessions/get-a-session-with-its-messages /openapi/openapi.yaml get /sessions/{id} Returns the session's metadata and a page of its messages ordered by cursor ascending. Use `after` and `limit` to page through messages. # List a session's audit log Source: https://albus.mintlify.app/api-reference/sessions/list-a-sessions-audit-log /openapi/openapi.yaml get /sessions/{id}/audit Returns the session's audit log — an immutable, time-ordered record of what happened during its agent runs (LLM calls, tool results, and run outcomes). Events are ordered by the time they occurred. Use `after` and `limit` to page through them; pass the response's `next_cursor` as the next request's `after` to fetch the following page. # List all sessions Source: https://albus.mintlify.app/api-reference/sessions/list-all-sessions /openapi/openapi.yaml get /sessions # Run or resume a session Source: https://albus.mintlify.app/api-reference/sessions/run-or-resume-a-session /openapi/openapi.yaml post /sessions/{id} Runs the session with the given ID, creating it if it does not exist and resuming it otherwise. Each call is a single invocation, optionally identified by the Idempotency-Key header. Supplying a key makes the call safe to retry: retrying with the same key and an identical body re-attaches to the in-flight invocation and returns its current state; a differing body for the same key returns 409; a new key while another invocation is still running returns 423. Omitting the header starts a fresh, non-idempotent invocation each time; the server generates a key and returns it in the Idempotency-Key response header. With `wait=true` the request long-polls: it blocks until the invocation's assistant response is available and returns it in `messages`. `wait_timeout` bounds the wait in seconds; when omitted the request waits indefinitely (until the response arrives or the client disconnects). If the timeout elapses first, the request fails with 504 and a JSON body, letting the client distinguish an expected server-side timeout from a transport error; the client may retry. # Create an API token. The token value is returned only in this response. Source: https://albus.mintlify.app/api-reference/tokens/create-an-api-token-the-token-value-is-returned-only-in-this-response /openapi/openapi.yaml post /tokens # Get token metadata by ID. Never returns the token value. Source: https://albus.mintlify.app/api-reference/tokens/get-token-metadata-by-id-never-returns-the-token-value /openapi/openapi.yaml get /tokens/{id} # List all API tokens. Never returns token values, only metadata. Source: https://albus.mintlify.app/api-reference/tokens/list-all-api-tokens-never-returns-token-values-only-metadata /openapi/openapi.yaml get /tokens # Revoke an API token by ID Source: https://albus.mintlify.app/api-reference/tokens/revoke-an-api-token-by-id /openapi/openapi.yaml delete /tokens/{id} # Call the API Source: https://albus.mintlify.app/getting-started/api Authenticate an HTTP request to Albus. Set an API key in your shell. Keep the value secret and never commit it. ```bash theme={null} export ALBUS_API_KEY="your-api-key" ``` Call the health endpoint: ```bash theme={null} curl --fail-with-body \ --header "Authorization: Bearer $ALBUS_API_KEY" \ https://albus.sh/api/health ``` See the [API reference](/reference/overview) for authentication and every available operation. # Use the Python SDK Source: https://albus.mintlify.app/getting-started/python Install and configure the Albus Python SDK. Install the public SDK: ```bash theme={null} pip install albus-sdk ``` Set credentials through environment variables or pass them when constructing the client. The exact package API and supported versions are documented in the [albus-python repository](https://github.com/albusgroup/albus-python). The Python SDK and API reference are released together only after the API is deployed. # Use Albus from an agent Source: https://albus.mintlify.app/guides/agents Give coding agents stable, complete instructions for an Albus integration. Albus publishes machine-readable documentation alongside the rendered site: * `/llms.txt` is a concise index of available pages. * `/llms-full.txt` is the complete documentation corpus. * `/openapi/openapi.yaml` is the versioned HTTP contract. For reliable agent execution, give the agent a specific goal, a least-privilege credential, and a link to the relevant walkthrough or API operation. Tell it which API or SDK version it must target. Every integration should handle failed requests and avoid logging credentials. Use the generated API reference as the authority for request and response shapes rather than inferring them from examples. # Documentation release policy Source: https://albus.mintlify.app/guides/releases How the public documentation stays aligned with deployed Albus releases. API reference is generated from an immutable OpenAPI snapshot. A snapshot is promoted only when its matching backend revision is deployed to production. The release record identifies: * the deployed API commit; * the OpenAPI snapshot used to generate the reference; and * the released `albus-sdk` version. This means `latest` documents the public production API, not a feature that is merely merged to the private source repository. # Albus documentation Source: https://albus.mintlify.app/index Build, run, and integrate AI agents with Albus. Albus provides an HTTP API and the `albus-sdk` Python package for building and running agents. Authenticate and call the API with cURL. Install `albus-sdk` and make your first request. ## Reference material * [API reference](/reference/overview) is generated from the OpenAPI contract. * [Agent integrations](/guides/agents) explains the stable documents and conventions available to coding agents. * [Release policy](/guides/releases) explains how published documentation maps to deployed API and SDK versions. # API reference Source: https://albus.mintlify.app/reference/overview The authoritative HTTP API contract for the current Albus production release. The pages in this section are generated from the current production OpenAPI snapshot. They include request and response schemas and runnable examples. For an agent or code generator, download the [OpenAPI document](/openapi/openapi.yaml) directly.