Skip to content
Docs
Download Markdown
In this article

Operation availability and compatibility

Check environment, credential and client support before following an example.

Download Markdown

Check the operation, target environment and credential before copying an example. The table preserves the limits documented with this content baseline; a listed command or OpenAPI operation does not establish a newer server rollout.

OperationProduction boundary in this baselineCredential and client requirement
Delivered-record replayAuthorized subscription and eligible, already-acquired records are required for priced data.Organization Key with Data; HTTP client or a CLI listing campaign records pull.
Campaign reads, authoring and launchCheck the target's granted capabilities and each operation's conditions. Launch requires human confirmation.Appropriate Campaign grants; a browser CLI session cannot propose or execute launch.
Acceptance-check dry runAPI Key route not yet deployed; use the signed-in editor/owner route.Supported CLI command and Campaign/organization membership. Checks can call external models or agents.
Input-dataset listingAPI Key route not yet deployed; use the signed-in route.Command listed by the installed CLI; scope is the organization's eligible datasets.
Submission readssubmission:read Key route not yet enabled; use the signed-in route.Reading a submission is distinct from the Data delivery grant.
Academy authoring and file readsKey routes not yet enabled; use the documented signed-in terminal route.Each action still requires its own role and scope.
Durable audit sample endpointsIn development; not deployed to production. Organization-enabled trial/sample operations need their documented enablement.An API schema alone does not grant access.
Local MCPRequires a CLI build listing mcp serve; the client starts a local process.The same target, credential and grants as the underlying CLI command. No hosted MCP address is supplied.

For staging, use the staging host and credentials issued for that environment. The production restrictions above do not establish that a staging operation is enabled for your organizationThe Developer-side unit that holds Campaigns, data access, and funds. Check its actual capability response and error before proceeding; if the rollout is unclear, contact support with the operation, environment, CLI version and sanitized error.

Check your installed client and target

hbd --version
hbd --help --json
hbd config profiles list --json

These are local checks. After selecting the intended profile and credential, run hbd auth whoami --json and hbd capabilities --json to inspect the target identity and grants. Do not infer endpoint availability solely from local help or a capability name.

The public installation channel is humanbased@beta; this revision targets 0.1.0-beta.3 and awaits verification of that published artifact. An authorized source build uses the separate workspace package @humanbased/cli. Their version numbers are not interchangeable. A trustworthy per-operation minimum CLI version has not been recorded for the operations above: inspect the installed inventory and confirm target support before automating them.

Documentation changes and product releases

The site's documentation version identifies a content baseline, not a platform release, API deployment or CLI compatibility guarantee. API paths identify a contract family; they do not prove every operation is deployed. Keep your CLI version, API origin and sanitized execution evidence with integration tests.

This revision reorganizes onboarding, separates CLI taskA specific item a contributor claims or enters guides, puts availability before affected examples, and adds an offline sample. It does not announce a product rollout. Existing /api/cli/ section links remain entry points to the moved guides. Historical documentation remains available through the version selector; verify its applicability before using old instructions.

The CLI reference and examples target humanbased@0.1.0-beta.3. Verification against a published npm artifact is pending; source checks alone establish neither public package availability nor successful authenticated server operations.