Skip to content
by Unity Nodes
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.

514pages
synced 37m ago3 sources
This week514pages updated upstreamNewestNEAR AI Cloud: Accept an organization invitationNov 4, 2026Official245pages from the official docs

Recently updated

269 pages
Ecosystemdocs.near.ai · api reference › images › generate images from text prompt
NEAR AI Cloud: Generate images from text prompt
POST /v1/images/generations Generate images from text prompt Generate images using an AI model from a text description. OpenAI-compatible endpoint. Request body (application/json): - model (string, re
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get a single organization by id admin only
NEAR AI Cloud: Get a single organization by id (Admin only)
GET /v1/admin/organizations/{orgid} Get a single organization by id (Admin only) Returns one organization with its spend limit and usage. Only authenticated admins can perform this operation. Returns
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get admin organization staking farm state
NEAR AI Cloud: Get admin organization staking farm state
GET /v1/admin/organizations/{orgid}/staking/farm Get admin organization staking farm state Returns the staking farm source and last synced farm-credit state for any organization. Requires platform adm
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › usage › get api key usage history
NEAR AI Cloud: Get API key usage history
GET /v1/workspaces/{workspaceid}/api-keys/{apikeyid}/usage/history Get API key usage history Returns paginated usage history for a specific API key Parameters: - workspaceid (path, string, required):
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › attestation › get attestation report
NEAR AI Cloud: Get attestation report
GET /v1/attestation/report Get attestation report Get hardware attestation report for TEE verification. Requires an API key (nearai/infra193); report retrieval is non-billable — no usage or billing re
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get complete history for a model admin only
NEAR AI Cloud: Get complete history for a model (Admin only)
GET /v1/admin/models/{modelname}/history Get complete history for a model (Admin only) Returns the complete history for a specific model, showing all changes over time including pricing, context lengt
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › attestation › get completion or responses api signature
NEAR AI Cloud: Get completion or Responses API signature
GET /v1/signature/{chatid} Get completion or Responses API signature Get a cryptographic signature for a chat completion or completed stateless resp response. Returns signature data on success, or an
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › billing › get costs by request ids
NEAR AI Cloud: Get costs by request IDs
POST /v1/billing/costs Get costs by request IDs Returns the cost in nano-USD for each request ID provided. A request ID is the UUID from the inference-id response header of /v1/chat/completions and /v
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › users › get current user
NEAR AI Cloud: Get current user
GET /v1/users/me Get current user Returns the profile of the currently authenticated user, including their organizations and workspaces. Responses: 200: Current user profile - authprovider (string, re
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › users › get current users account eligibility status
NEAR AI Cloud: Get current user's account eligibility status
GET /v1/users/me/status Get current user's account eligibility status Returns a minimal eligibility response for frontend preflight checks. AML/KYT provider details are never exposed in this public re
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › attestation › get intel trust authority attestation token
NEAR AI Cloud: Get Intel Trust Authority attestation token
GET /v1/attestation/ita-token Get Intel Trust Authority attestation token Get Intel Trust Authority signed attestation JWTs for the gateway and, when requested, compatible model provider evidence. Pub
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › invitations › get invitation details by token public endpoint
NEAR AI Cloud: Get invitation details by token (public endpoint)
GET /v1/invitations/{token} Get invitation details by token (public endpoint) Returns invitation details for a specific token. This is a public endpoint that allows users to view invitation details be
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get limits history for an organization admin only
NEAR AI Cloud: Get limits history for an organization (Admin only)
GET /v1/admin/organizations/{orgid}/limits/history Get limits history for an organization (Admin only) Returns the complete limits history for a specific organization, showing all limits changes over
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › models › get model details
NEAR AI Cloud: Get model details
GET /v1/model/{modelname} Get model details Get pricing and metadata for a specific model. URL-encode model names containing slashes. Public endpoint. Parameters: - modelname (path, string, required):
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › usage › get organization balance
NEAR AI Cloud: Get organization balance
GET /v1/organizations/{orgid}/usage/balance Get organization balance Returns the current spending balance for an organization Parameters: - orgid (path, string, required): Organization ID. Responses:
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get organization balance admin only
NEAR AI Cloud: Get organization balance (Admin only)
GET /v1/admin/organizations/{orgid}/usage/balance Get organization balance (Admin only) Returns the current spending balance for an organization without requiring the caller to be a member of that org
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › organizations › get organization by id
NEAR AI Cloud: Get organization by ID
GET /v1/organizations/{orgid} Get organization by ID Returns organization details for a specific organization ID. Parameters: - orgid (path, string, required): Organization ID. Responses: 200: Organiz
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get organization concurrent request limit admin only
NEAR AI Cloud: Get organization concurrent request limit (Admin only)
GET /v1/admin/organizations/{orgid}/concurrent-limit Get organization concurrent request limit (Admin only) Returns the current concurrent request limit for an organization. If no custom limit is set,
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get organization metrics admin only
NEAR AI Cloud: Get organization metrics (Admin only)
GET /v1/admin/organizations/{orgid}/metrics Get organization metrics (Admin only) Returns usage metrics for an organization including summary totals, and breakdowns by workspace, API key, and model. P
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › staking farm › get organization staking farm state
NEAR AI Cloud: Get organization staking farm state
GET /v1/organizations/{orgid}/staking/farm Get organization staking farm state Returns the staking farm source and last synced farm-credit state for an organization. The organization must be the NEAR-
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › usage › get organization usage broken down by model
NEAR AI Cloud: Get organization usage broken down by model.
GET /v1/organizations/{orgid}/usage/by-model Get organization usage broken down by model. Returns one row per model, summed over a rolling window ending now: day = last 24h, week = last 7 days, month
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › usage › get organization usage history
NEAR AI Cloud: Get organization usage history
GET /v1/organizations/{orgid}/usage/history Get organization usage history Returns paginated usage history for an organization Parameters: - orgid (path, string, required): Organization ID. - limit (q
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › services › get platform service by name public no auth
NEAR AI Cloud: Get platform service by name (public, no auth)
GET /v1/services/{servicename} Get platform service by name (public, no auth) Parameters: - servicename (path, string, required): Service name (e.g. websearch). Responses: 200: Service details - costP
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get platform wide metrics for admin dashboards admin only
NEAR AI Cloud: Get platform-wide metrics for admin dashboards (Admin only)
GET /v1/admin/platform/metrics Get platform-wide metrics for admin dashboards (Admin only) Returns aggregated metrics across all organizations including: - Total users and organizations - Total reques
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get platform wide time series for admin dashboards admin only
NEAR AI Cloud: Get platform-wide time series for admin dashboards (Admin only)
GET /v1/admin/platform/metrics/timeseries Get platform-wide time series for admin dashboards (Admin only) Returns per-bucket requests, tokens, cost (paid/granted + verifiable/external splits), active
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › staking farm › get staking farm configuration
NEAR AI Cloud: Get staking farm configuration
GET /v1/staking/farm/config Get staking farm configuration Returns the active House of Stake farm configuration used to convert on-chain staking reward units into NEAR AI Cloud credits. Responses: 200
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get the per model consumption ranking admin only
NEAR AI Cloud: Get the per-model consumption ranking (Admin only)
GET /v1/admin/platform/model-revenue Get the per-model consumption ranking (Admin only) Models for the selected period ranked by consumed cost, with requests, tokens, unique orgs, verifiable flag, pro
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get the per organization consumption ranking admin only
NEAR AI Cloud: Get the per-organization consumption ranking (Admin only)
GET /v1/admin/platform/org-revenue Get the per-organization consumption ranking (Admin only) Organizations with usage in the selected period ranked by consumed cost, with the verifiable/external split
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get the platform billing summary admin only
NEAR AI Cloud: Get the platform billing summary (Admin only)
GET /v1/admin/platform/billing-summary Get the platform billing summary (Admin only) Credit LIMITS (caps) and consumption — NOT payments/cash. Returns active paid/grant credit limits, total consumed,
Nov 4, 2026
Ecosystemdocs.near.ai · api reference › admin › get the platform infrastructure fleet burn summary admin only
NEAR AI Cloud: Get the platform infrastructure / fleet burn summary (Admin only)
GET /v1/admin/platform/infra-summary Get the platform infrastructure / fleet burn summary (Admin only) Fetches the live host list, counts active/idle hosts, and computes the monthly/daily GPU burn rat
Nov 4, 2026
Showing 31 to 60 of 269Search all sources →