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.

483pages
synced 2h ago3 sources
This week483pages updated upstreamNewestAccess KeysNov 2, 2026Official245pages from the official docs

Recently updated

238 pages
Ecosystemdocs.near.ai · api reference › organizations › delete organization owner only
NEAR AI Cloud: Delete organization (owner only)
/api-reference/openapi.json delete /v1/organizations/{orgid} Deletes an organization. Only the organization owner can perform this action.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › workspaces › delete workspace
NEAR AI Cloud: Delete workspace
/api-reference/openapi.json delete /v1/workspaces/{workspaceid} Deletes (deactivates) a workspace. Only the workspace creator or organization admin/owner can delete.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › admin › deprecate a model in favor of another admin only
NEAR AI Cloud: Deprecate a model in favor of another (Admin only)
/api-reference/openapi.json post /v1/admin/models/deprecate Atomically marks modelId as deprecated and routes its traffic to successorModelId: 1. Adds modelId as an alias of successorModelId, so exist
Nov 2, 2026
Ecosystemdocs.near.ai · … › guides › integrations › dify
NEAR AI Cloud: Dify
Configure Dify with NEAR AI Cloud through the OpenAI-API-compatible model provider plugin. Dify can use NEAR AI Cloud through the OpenAI-API-compatible model provider plugin. Configure it as a custom
Nov 2, 2026
Ecosystemdocs.near.ai · cloud › experimental › direct completions
NEAR AI Cloud: Direct Completions
Experimental: send requests straight to one self-hosted model's TEE endpoint, without the NEAR AI Cloud Gateway. [!WARNING] Experimental. Direct completions endpoints are not recommended for new integ
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › rerank › document reranking endpoint
NEAR AI Cloud: Document reranking endpoint
/api-reference/openapi.json post /v1/rerank Ranks documents by relevance to a query using a reranker model. Concurrent Request Limits: Each organization has a per-model concurrent request limit (defau
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › images › edit images from a text prompt and image
NEAR AI Cloud: Edit images from a text prompt and image
/api-reference/openapi.json post /v1/images/edits Edit images using an AI model from an image and text description. OpenAI-compatible endpoint. Request Body (multipart/form-data): All fields should be
Nov 2, 2026
Ecosystemdocs.near.ai · cloud › guides › specialized endpoints
NEAR AI Cloud: Embeddings, Images, Audio & More
Use NEAR AI Cloud for embeddings, reranking, image generation, audio transcription, and PII detection — all inside TEEs NEAR AI Cloud is not limited to chat completions. The NEAR AI Cloud Gateway (clo
Nov 2, 2026
Ecosystemdocs.near.ai · cloud › guides › e2ee chat completions
NEAR AI Cloud: End-to-End Encrypted Chat Completions
How to use end-to-end encryption for chat completions with NEAR AI Cloud NEAR AI Cloud runs both the gateway and model inference inside Trusted Execution Environments (TEEs), providing strong hardware
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › reporting › export organization usage and cost rows
NEAR AI Cloud: Export organization usage and cost rows.
/api-reference/openapi.json get /v1/organizations/{orgid}/usage/export Requires a reporting token scoped to the organization in the path. Results are returned in descending (createdat, source, id) ord
Nov 2, 2026
Ecosystemdocs.near.ai · cloud › guides › fusion
NEAR AI Cloud: Fusion
Use server-side multi-model deliberation from OpenAI-compatible clients Fusion runs a private, server-side deliberation across multiple models and returns one OpenAI-compatible chat completion. Your c
Nov 2, 2026
Ecosystemdocs.near.ai · … › verification › cloud api › gateway attestation
NEAR AI Cloud: Gateway Attestation
Verify the NEAR AI Cloud gateway attestation for requests sent to cloud-api.near.ai. gatewayattestation is evidence for the NEAR AI Cloud gateway. It is not evidence for a model environment. Use model
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › images › generate images from text prompt
NEAR AI Cloud: Generate images from text prompt
/api-reference/openapi.json post /v1/images/generations Generate images using an AI model from a text description. OpenAI-compatible endpoint.
Nov 2, 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)
/api-reference/openapi.json get /v1/admin/organizations/{orgid} Returns one organization with its spend limit and usage. Only authenticated admins can perform this operation. Returns 404 if the organi
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › admin › get admin organization staking farm state
NEAR AI Cloud: Get admin organization staking farm state
/api-reference/openapi.json get /v1/admin/organizations/{orgid}/staking/farm Returns the staking farm source and last synced farm-credit state for any organization. Requires platform admin access.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › usage › get api key usage history
NEAR AI Cloud: Get API key usage history
/api-reference/openapi.json get /v1/workspaces/{workspaceid}/api-keys/{apikeyid}/usage/history Returns paginated usage history for a specific API key
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › attestation › get attestation report
NEAR AI Cloud: Get attestation report
/api-reference/openapi.json get /v1/attestation/report Get hardware attestation report for TEE verification. Requires an API key (nearai/infra193); report retrieval is non-billable — no usage or billi
Nov 2, 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)
/api-reference/openapi.json get /v1/admin/models/{modelname}/history Returns the complete history for a specific model, showing all changes over time including pricing, context length, display name, a
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › attestation › get completion or responses api signature
NEAR AI Cloud: Get completion or Responses API signature
/api-reference/openapi.json get /v1/signature/{chatid} Get a cryptographic signature for a chat completion or completed stateless resp response. Returns signature data on success, or an unavailable re
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › billing › get costs by request ids
NEAR AI Cloud: Get costs by request IDs
/api-reference/openapi.json post /v1/billing/costs 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
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › users › get current user
NEAR AI Cloud: Get current user
/api-reference/openapi.json get /v1/users/me Returns the profile of the currently authenticated user, including their organizations and workspaces.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › users › get current users account eligibility status
NEAR AI Cloud: Get current user's account eligibility status
/api-reference/openapi.json get /v1/users/me/status Returns a minimal eligibility response for frontend preflight checks. AML/KYT provider details are never exposed in this public response.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › attestation › get intel trust authority attestation token
NEAR AI Cloud: Get Intel Trust Authority attestation token
/api-reference/openapi.json get /v1/attestation/ita-token Get Intel Trust Authority signed attestation JWTs for the gateway and, when requested, compatible model provider evidence. Public endpoint — t
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › invitations › get invitation details by token public endpoint
NEAR AI Cloud: Get invitation details by token (public endpoint)
/api-reference/openapi.json get /v1/invitations/{token} Returns invitation details for a specific token. This is a public endpoint that allows users to view invitation details before logging in.
Nov 2, 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)
/api-reference/openapi.json get /v1/admin/organizations/{orgid}/limits/history Returns the complete limits history for a specific organization, showing all limits changes over time. Get limits history
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › models › get model details
NEAR AI Cloud: Get model details
/api-reference/openapi.json get /v1/model/{modelname} Get pricing and metadata for a specific model. URL-encode model names containing slashes. Public endpoint.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › usage › get organization balance
NEAR AI Cloud: Get organization balance
/api-reference/openapi.json get /v1/organizations/{orgid}/usage/balance Returns the current spending balance for an organization
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › admin › get organization balance admin only
NEAR AI Cloud: Get organization balance (Admin only)
/api-reference/openapi.json get /v1/admin/organizations/{orgid}/usage/balance Returns the current spending balance for an organization without requiring the caller to be a member of that organization.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › organizations › get organization by id
NEAR AI Cloud: Get organization by ID
/api-reference/openapi.json get /v1/organizations/{orgid} Returns organization details for a specific organization ID.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › admin › get organization concurrent request limit admin only
NEAR AI Cloud: Get organization concurrent request limit (Admin only)
/api-reference/openapi.json get /v1/admin/organizations/{orgid}/concurrent-limit Returns the current concurrent request limit for an organization. If no custom limit is set, returns null for concurren
Nov 2, 2026
Showing 31 to 60 of 238Search all sources →