Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication. Your API key should start with brb_.

Example: Authorization: Bearer brb_1234567890abcdef

Path Parameters

subnet_id
string
required

The unique identifier of the subnet (ULID format)

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
event_type
enum<string>
required

The type of event

Available options:
register_resource
resource_name
string
required

The name of the resource to register

Example:

"bot_001"

resource_subtype
string
required

The subtype of the resource (e.g., 'frodobot', 'delivery-drone', etc.)

Example:

"frodobot"

owner
string
required

The Solana wallet address of the resource owner. Used to create a wallet record in the system and associate it with the resource for reward tracking. Required.

Example:

"HN7cABqLq46Es1jh92dQQisAq662SmxELLLsHHe4YWrH"

resource_type
enum<string>
default:ent

The type of resource to register. Use 'ent' (default) for full ENT NFT resources, or 'resource' for lightweight non-NFT participants that still earn rewards.

Available options:
ent,
resource
ent_metadata
object

Metadata for the ENT (Entity NFT) that represents this resource on-chain, following the Metaplex token standard. Provide this alongside ent_owner (on task_start) or owner (on register_resource) to mint a named, attributed NFT. If omitted, a placeholder metadata URI is used.

Example:

Response

Event created successfully. The response data contains different fields depending on the event type - see examples for details.

status
enum<string>
required
Available options:
success
Example:

"success"

data
object
required