Operation availability
Understand versioning, credential support, and deployment capabilities.
The Public API uses the /api/v1/public namespace. The endpoint reference and downloadable OpenAPI specification describe the contract; an operation can also depend on deployment capabilities, authorization, and plan access.
Capability labels
Each endpoint carries an x-neatlogs-operation-gate in OpenAPI and an availability note on its reference page.
| Contract label | Meaning |
|---|---|
always | Standard API surface, subject to authentication and authorization |
public-api-mutations | Managed mutation capability must be enabled |
service-account-token-mint | Token-minting capability must be enabled |
tier-c-compute | Additional compute or external integration capability must be enabled |
project-deletion-scheduling | Project-deletion scheduling requires its dedicated capability and supporting compute capability |
An unavailable operation may return 404 or an operation-specific availability problem. Treat it as a capability result; do not repeatedly retry it as a transient failure. Ask your organization administrator about access to a required workflow.
CLI schema discovery
The CLI reads the contract embedded in its installed release:
neatlogs schema list
neatlogs schema search trace
neatlogs schema show get_api_v1_public_tracesThese commands help discover schemas and capability labels. They do not query live deployment flags. Upgrade the CLI to obtain an updated embedded contract.
Supported deployments
The Public API and CLI support NeatLogs cloud deployments. Use the app origin for the intended environment and credentials issued by that environment. Enterprise self-hosted deployments are currently unsupported for this Public API and CLI surface.
Release checks on October 6, 2026
The US production backend contains the expanded 285-operation contract. Package publication, runtime availability and successful workflow execution are separate checks.
| Surface or workflow | Verified release state |
|---|---|
| US customer app | Public API mutations and managed credential operations are enabled. Current scopes, roles, project membership and entitlements still apply. |
| CLI | 0.2.0 is npm latest, published from the qualified immutable release tag. 0.2.0-team-test.2 remains the published preview. |
| Scheduled future evaluation collection | Final dispatch can omit traces arriving after the last periodic matcher pass. A backend correction requires Dev validation and promotion; independently check the final cohort. |
| Classifier definitions, labels, datasets, training and publication | The entire public classifier workflow, including inventory and label reads, is disabled behind tier-c-compute in production and returns 404 / NOT_FOUND_OR_OPERATION_DISABLED. Provider-job admission is also disabled. |
| Detection suggestions, detection preview and analytics export | These operations also require tier-c-compute, which is disabled in production. Their schemas are available for discovery, but execution is unavailable. |
| Historical detection rescoring | Requires separate compute admission, an explicit budget and bounded job limits. Production execution remains gated. |
| Scheduled physical project deletion | Remains outside this release's accepted scope. Archive/restore and dashboard-equivalent soft deletion are separate operations. |
| EU | The release workflow records backend/worker deployment and the required Public API schema prerequisites. Authenticated EU workflow acceptance remains a separate check; use credentials issued in that region. |
| Keyword Search | Project-specific term-index coverage and query acceptance belong to the separate Search rollout. |
See the new CLI workflows for the difference between configuring a resource, activating it and running a paid job.
Guest review completion uses the retry guidance in API errors. A committed response and a completed review remain separate outcomes until completion processing succeeds.
Use the SDK documentation for trace ingestion. SDK ingest credentials, dashboard sessions, and Public API credentials have separate authorization policies.