Ultrahost/ docs

These helpers are not an extra building block. Every other namespace can rely on them.

Paths in the tables are relative to https://api.ultrahost.com/v1/projects/{projectId}. Pagination, idempotency, and errors are described in Conventions.

system.health() is not project-scoped. It is GET /health on the API host.

Project

SDKRESTDescription
projects.get()GET /projects/{projectId}Retrieve project information
projects.getUsage()GET /projects/{projectId}/usageRetrieve usage
projects.getLimits()GET /projects/{projectId}/limitsRetrieve quotas
projects.getCapabilities()GET /projects/{projectId}/capabilitiesDiscover available features

get(), getUsage(), and getLimits() read the project the client was created with. The REST path still carries {projectId} so the HTTP contract is explicit.

What capabilities return

ts
const capabilities = await ultrahost.projects.getCapabilities();
json
{
  "documents": {
    "available": true,
    "features": ["indexes", "batch", "pagination"]
  },
  "vectors": {
    "available": true,
    "features": ["cosine", "metadata-filtering"]
  },
  "graph": {
    "available": true,
    "features": ["neighbors", "traversal"]
  }
}

Call this before depending on a feature that may be missing from a deployment, especially from a coding agent. The SDK does not promise that every infrastructure backend supports every feature in this reference.

Operations

SDKRESTDescription
operations.get(id)GET /operations/{id}Retrieve an asynchronous operation
operations.cancel(id)POST /operations/{id}/cancelCancel a supported operation
operations.wait(id)—Poll until the operation finishes

wait() is a client helper. It has no endpoint of its own. It reads operations.get() until the status settles.

An operation looks like this:

ts
{
  id: "operation-123",
  status: "running",
  progress: 45
}

Reindex, ingestion, and deployment return that shape. Callers use operations.wait() for every one of them.

Health

SDKRESTDescription
system.health()GET /healthCheck service availability

Use health for a status check of the API itself. Use projects.get() when you need to know that a specific project is reachable with the current credential.