LEARN · DOCUMENTATION
Documentation
Pages from 3 sources, kept in sync: the official NEAR documentation, documentation from teams building on NEAR, and readmes from their code. Search all of it, or start from a path below.
483pages
synced 3h ago3 sources
Showingapi.agentsonintents.com
Ecosystem
NEAR AI Cloud: Get organization metrics (Admin only)
/api-reference/openapi.json get /v1/admin/organizations/{orgid}/metrics Returns usage metrics for an organization including summary totals, and breakdowns by workspace, API key, and model.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get organization staking farm state
/api-reference/openapi.json get /v1/organizations/{orgid}/staking/farm Returns the staking farm source and last synced farm-credit state for an organization. The organization must be the NEAR-authenti
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get organization usage broken down by model.
/api-reference/openapi.json get /v1/organizations/{orgid}/usage/by-model Returns one row per model, summed over a rolling window ending now: day = last 24h, week = last 7 days, month = last 30 days (N
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get organization usage history
/api-reference/openapi.json get /v1/organizations/{orgid}/usage/history Returns paginated usage history for an organization
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get platform service by name (public, no auth)
/api-reference/openapi.json get /v1/services/{servicename}
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get platform-wide metrics for admin dashboards (Admin only)
/api-reference/openapi.json get /v1/admin/platform/metrics Returns aggregated metrics across all organizations including: - Total users and organizations - Total requests and revenue - Top models by u
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get platform-wide time series for admin dashboards (Admin only)
/api-reference/openapi.json get /v1/admin/platform/metrics/timeseries Returns per-bucket requests, tokens, cost (paid/granted + verifiable/external splits), active organizations, and new signups for g
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get staking farm configuration
/api-reference/openapi.json get /v1/staking/farm/config Returns the active House of Stake farm configuration used to convert on-chain staking reward units into NEAR AI Cloud credits.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get the per-model consumption ranking (Admin only)
/api-reference/openapi.json get /v1/admin/platform/model-revenue Models for the selected period ranked by consumed cost, with requests, tokens, unique orgs, verifiable flag, provider type, and latency
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get the per-organization consumption ranking (Admin only)
/api-reference/openapi.json get /v1/admin/platform/org-revenue Organizations with usage in the selected period ranked by consumed cost, with the verifiable/external split, requests, tokens, models use
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get the platform billing summary (Admin only)
/api-reference/openapi.json get /v1/admin/platform/billing-summary Credit LIMITS (caps) and consumption — NOT payments/cash. Returns active paid/grant credit limits, total consumed, paying/granted org
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get the platform infrastructure / fleet burn summary (Admin only)
/api-reference/openapi.json get /v1/admin/platform/infra-summary Fetches the live host list, counts active/idle hosts, and computes the monthly/daily GPU burn rate from the configured cost-per-host. D
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get time series metrics for an organization (Admin only)
/api-reference/openapi.json get /v1/admin/organizations/{orgid}/metrics/timeseries Returns daily/weekly/hourly aggregations for charting: requests, tokens, and cost per time period.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get user's refresh tokens
/api-reference/openapi.json get /v1/users/me/refresh-tokens Returns all active refresh tokens for the currently authenticated user.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get v1organizations usagemetrics
/api-reference/openapi.json get /v1/organizations/{orgid}/usage/metrics
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get v1organizations usagetimeseries
/api-reference/openapi.json get /v1/organizations/{orgid}/usage/timeseries
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Get workspace by ID
/api-reference/openapi.json get /v1/workspaces/{workspaceid} Returns workspace details for a specific workspace ID.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Go
Use the Go SDK for verified, encrypted Chat Completions. Install Requires Go 1.25.8 or later. Install the published SDK in your application: bash theme={"dark"} go mod init example.com/my-app If your
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Goose
Configure Goose to use NEAR AI Cloud as an OpenAI-compatible provider. Goose is an open-source AI agent from Block that runs as a desktop app and a CLI. It ships a first-class NEAR AI Cloud provider,
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Health check
/api-reference/openapi.json get /v1/health Check service health status. No authentication required.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Image Provenance
Apply an image-provenance policy to configurations measured in NEAR AI Cloud gateway and model attestations. Image provenance is separate from hardware attestation. A verified quote can bind a configu
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Integrations
Use NEAR AI Cloud with third-party software that supports OpenAI-compatible providers. Use these guides to connect third-party software to NEAR AI Cloud through its OpenAI-compatible API. Most clients
Nov 2, 2026
Ecosystem
NEAR AI Cloud: Invite users to an organization by email
/api-reference/openapi.json post /v1/organizations/{orgid}/members/invite-by-email Invites multiple users to the organization by their email addresses. The authenticated user must be an owner or admin
Nov 2, 2026
Ecosystem
NEAR AI Cloud: JavaScript
Use the JavaScript SDK for verified, end-to-end encrypted Chat Completions. Install The SDK is available on npm. It requires Node.js 24 or later for Node usage. bash theme={"dark"} npm install @nearai
Nov 2, 2026
Ecosystem
NEAR AI Cloud: LibreChat
Configure LibreChat to use NEAR AI Cloud as an OpenAI-compatible custom endpoint. LibreChat can use NEAR AI Cloud through a custom OpenAI-compatible endpoint in librechat.yaml. Keep the endpoint name
Nov 2, 2026
Ecosystem
NEAR AI Cloud: List active reporting tokens for an organization.
/api-reference/openapi.json get /v1/organizations/{orgid}/reporting-tokens The response includes non-secret prefixes and audit timestamps. It never includes raw reporting tokens or stored hashes.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: List admin access tokens (Admin only)
/api-reference/openapi.json get /v1/admin/access-tokens Retrieves a paginated list of all admin access tokens in the system. Only authenticated admins can access this endpoint.
Nov 2, 2026
Ecosystem
NEAR AI Cloud: List aggregated feature requests for admins.
/api-reference/openapi.json get /v1/admin/feature-requests
Nov 2, 2026
Ecosystem
NEAR AI Cloud: List all models (Admin only)
/api-reference/openapi.json get /v1/admin/models Returns a paginated list of all models in the system. By default, only active models are returned. Use includeinactive=true to also include disabled mo
Nov 2, 2026
Ecosystem
NEAR AI Cloud: List all registered users with pagination (Admin only)
/api-reference/openapi.json get /v1/admin/users Returns a paginated list of all users in the system. Only authenticated admins can perform this operation.
Nov 2, 2026
Showing 61 to 90 of 238Search all sources →