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 21m ago3 sources
This week483pages updated upstreamNewestAccess KeysNov 2, 2026Official245pages from the official docs

Recently updated

483 pages
OfficialNomicon · RuntimeSpec
Refunds
Refunds When execution of a receipt fails or there is some unused amount of prepaid gas left after a function call, the Runtime generates refund receipts. The are 2 types of refunds: • Refunds for the
Nov 2, 2026
OfficialNomicon · RuntimeSpec › Components › BindingsSpec
Registers API
Registers API Registers allow the host function to return the data into a buffer located inside the host oppose to the buffer located on the client. A special operation can be used to copy the content
Nov 2, 2026
OfficialNomicon · NetworkSpec
Routing Table Exchange Algorithm
Routing table exchange algorithm Every node on the network stores its own copy of the Routing Graph . nearcore exchanges this graph in two steps. When a connection is set up, the two nodes do a full s
Nov 2, 2026
OfficialNomicon · RuntimeSpec
Runtime
Runtime Runtime layer is used to execute smart contracts and other actions created by the users and preserve the state between the executions. It can be described from three different angles: going st
Nov 2, 2026
OfficialNomicon · RuntimeSpec › Components
Runtime Crate
Runtime crate Runtime crate encapsulates the logic of how transactions and receipts should be handled. If it encounters a smart contract call within a transaction or a receipt it calls near-vm-runner,
Nov 2, 2026
OfficialNomicon · RuntimeSpec
Runtime Specification
Overview This chapter covers the NEAR Protocol runtime specification. Runtime Specification • Account Receipt Storage • Actions • Applying chunk • Components • Runtime Crate • Bindings Specification •
Nov 2, 2026
OfficialNomicon · GenesisConfig
RuntimeConfig
RuntimeConfig The structure that holds the parameters of the runtime, mostly economics. storagecostbyteperblock type: Balance The cost to store one byte of storage per block. storagecostbyteperblock t
Nov 2, 2026
OfficialNomicon · GenesisConfig
RuntimeFeeConfig
RuntimeFeesConfig Economic parameters for runtime actionreceiptcreationconfig type: Fee Describes the cost of creating an action receipt, ActionReceipt, excluding the actual cost of actions. datarecei
Nov 2, 2026
OfficialNomicon · ChainSpec › SelectingBlockProducers
Selecting Chunk and Block Producers
Selecting Chunk and Block Producers Background Near is intended to be a sharded blockchain. At the time of writing (March 2021), challenges (an important security feature for a sharded network) are no
Nov 2, 2026
OfficialNomicon · GenesisConfig
StateRecord
StateRecord type: Enum Enum that describes one of the records in the state storage. Account type: Unnamed struct Record that contains account information for a given account ID. accountid type: Accoun
Nov 2, 2026
OfficialNomicon · GenesisConfig › RuntimeFeeConfig
StorageUsageConfig
StorageUsageConfig Describes cost of storage per block accountcost type: Gas Base storage usage for an account datarecordcost type: Gas Base cost for a k/v record keycostperbyte type: Gas Cost per byt
Nov 2, 2026
OfficialNomicon · DataStructures
Transaction
Transaction See Transactions documentation in the Runtime Specification section.
Nov 2, 2026
OfficialNomicon · RuntimeSpec
Transactions
Transactions A transaction in Near is a list of actions and additional information. There are two versions of a transaction: ![allow(unused)] fn main() { pub enum Transaction { V0(TransactionV0), V1(T
Nov 2, 2026
OfficialNomicon · ChainSpec › Transactions
Transactions in the Blockchain Layer
Transactions in the Blockchain Layer A client creates a transaction, computes the transaction hash and signs this hash to get a signed transaction. Now this signed transaction can be sent to a node. W
Nov 2, 2026
OfficialNomicon · RuntimeSpec › Components › BindingsSpec
Trie API
Trie API Here we provide a specification of trie API. After this NEP is merged, the cases where our current implementation does not follow the specification are considered to be bugs that need to be f
Nov 2, 2026
OfficialNomicon · ChainSpec
Upgradability
Upgradability This part of specification describes specifics of upgrading the protocol, and touches on few different parts of the system. Three different levels of upgradability are: • Updating withou
Nov 2, 2026
OfficialNomicon · GenesisConfig
VMConfig
VMConfig Config of wasm operations. extcosts type: [ExtCostsConfig] ExtCostsConfig Costs for runtime externals growmemcost type: u32 Gas cost of a growing memory by single page. regularopcost type: u3
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › users › accept an organization invitation
NEAR AI Cloud: Accept an organization invitation
/api-reference/openapi.json post /v1/users/me/invitations/{invitationid}/accept Accepts a pending invitation and adds the user as a member of the organization.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › invitations › accept invitation by token requires authentication
NEAR AI Cloud: Accept invitation by token (requires authentication)
/api-reference/openapi.json post /v1/invitations/{token}/accept Accepts an invitation using its token. The authenticated user's email must match the invitation email.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › organization members › add a member to an organization
NEAR AI Cloud: Add a member to an organization
/api-reference/openapi.json post /v1/organizations/{orgid}/members Adds a new member to the organization. The authenticated user must be an owner or admin.
Nov 2, 2026
Ecosystemdocs.near.ai · … › guides › integrations › aider zed
NEAR AI Cloud: Aider and Zed
Configure Aider and Zed to use NEAR AI Cloud as an OpenAI-compatible provider. NEAR AI Cloud exposes an OpenAI-compatible API, so Aider and Zed can use NEAR AI models with a base URL, an API key, and
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › introduction
NEAR AI Cloud: API Reference
OpenAI-compatible REST API for private, verifiable AI inference on NEAR AI Cloud The NEAR AI Cloud API is a REST API served from a single base URL. Its documented OpenAI-compatible inference surfaces
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › audio › audio transcription endpoint
NEAR AI Cloud: Audio transcription endpoint
/api-reference/openapi.json post /v1/audio/transcriptions Transcribe audio files using Whisper models. Accepts audio file uploads via multipart/form-data. Supports MP3, WAV, WEBM, FLAC, OGG, and M4A f
Nov 2, 2026
Ecosystemdocs.near.ai · cloud › models
NEAR AI Cloud: Available Models
Explore NEAR AI Cloud model catalog NEAR AI Cloud provides access to leading AI models, each optimized for different use cases ranging from advanced reasoning and tool calling to long-context processi
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › admin › batch upsert models metadata admin only
NEAR AI Cloud: Batch upsert models metadata (Admin only)
/api-reference/openapi.json patch /v1/admin/models Upserts (inserts or updates) pricing and metadata for one or more models. Only authenticated admins can perform this operation. The body should be an
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › admin › cancel a pending scheduled pricing change admin only
NEAR AI Cloud: Cancel a pending scheduled pricing change (Admin only).
/api-reference/openapi.json delete /v1/admin/models/pricing-changes/{id}
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › organization members › cancel an organization invitation
NEAR AI Cloud: Cancel an organization invitation
/api-reference/openapi.json delete /v1/organizations/{orgid}/members/invitations/{invitationid} Cancels a pending invitation for the organization. Only owners and admins can cancel invitations.
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › organization members › cancel an organization invitation short path
NEAR AI Cloud: Cancel an organization invitation (short path)
/api-reference/openapi.json delete /v1/organizations/{orgid}/invitations/{invitationid} Cancels a pending invitation for the organization. Only owners and admins can cancel invitations. This endpoint
Nov 2, 2026
Ecosystemdocs.near.ai · api reference › gateway › check api key validity
NEAR AI Cloud: Check API key validity
/api-reference/openapi.json post /v1/checkapikey Validates the provided API key (via Bearer token), checks rate limits, and verifies the organization has sufficient credits. This endpoint is designed
Nov 2, 2026
Ecosystemdocs.near.ai · … › guides › integrations › cline roo kilo
NEAR AI Cloud: Cline, Roo Code, and Kilo Code
Configure Cline, Roo Code, and Kilo Code with NEAR AI Cloud's OpenAI-compatible API. Cline, Roo Code, and Kilo Code can use NEAR AI Cloud through OpenAI-compatible provider settings. They share the sa
Nov 2, 2026
Showing 31 to 60 of 483Search all sources →