API docs by Redocly

Momentum API (4.0)

Download OpenAPI specification:

Momentum REST API

auth

Verifies a signed challenge

Returns OK when a signature has been validated

Request Body schema: application/json
required

body params

network
string
signedChallenge
required
string
wallet
required
string

Responses

Request samples

Content type
application/json
{
  • "network": "string",
  • "signedChallenge": "string",
  • "wallet": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Generate auth challenge

Returns a new generated challenge based on params

query Parameters
wallet
required
string

Responses

Response samples

Content type
application/json
{
  • "challenge": "string"
}

Generate jwt guest token

Returns a new generated token for guest users

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "isGuest": true,
  • "name": "string",
  • "profile": {
    },
  • "token": "string",
  • "updatedAt": "string",
  • "userTypeId": "string",
  • "wallet": "string"
}

Generate auth token

Returns a new generated token based on params

Request Body schema: application/json
required

body params

network
string
signedChallenge
required
string
wallet
required
string

Responses

Request samples

Content type
application/json
{
  • "network": "string",
  • "signedChallenge": "string",
  • "wallet": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Remove wallet

Remove wallet

Authorizations:
Bearer
Request Body schema: application/json
required

body params

wallet
required
string

Responses

Request samples

Content type
application/json
{
  • "wallet": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

users

Edit user profile

Edits a user profile

Authorizations:
Bearer
Request Body schema: application/json
required

body params

name
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "user_id": "string"
}

Get latest users

Returns a list of six newest users

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set user user attribute

Sets a user user attribute based on UserID and TargetID

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

target_id
required
string

Target user UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get user based on token

Returns user information based on token

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "isGuest": true,
  • "name": "string",
  • "profile": {
    },
  • "token": "string",
  • "updatedAt": "string",
  • "userTypeId": "string",
  • "wallet": "string"
}

Get user attribute for own user based on token

Returns user attribute

Authorizations:
Bearer
query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get current user's stakes list

Return stakes list

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add pending stake transaction

Add pending transaction

Authorizations:
Bearer
Request Body schema: application/json
required

body params

amount
required
string
comment
required
string
kind
required
string
odyssey_id
required
string
transaction_id
required
string
wallet
required
string

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "comment": "string",
  • "kind": "string",
  • "odyssey_id": "string",
  • "transaction_id": "string",
  • "wallet": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Get current user's wallets list

Return wallets list

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create mutual docks

Creates mutual worlds portals and worlds admin permissions

Request Body schema: application/json
required

body params

walletA
required
string
walletB
required
string

Responses

Request samples

Content type
application/json
{
  • "walletA": "string",
  • "walletB": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Remove mutual docks

Removes mutual worlds portals and worlds admin permissions

Request Body schema: application/json
required

body params

walletA
required
string
walletB
required
string

Responses

Request samples

Content type
application/json
{
  • "walletA": "string",
  • "walletB": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Search available users

Returns user information based on a search query

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "profile": {
    },
  • "wallet": "string"
}

Returns a sorted list of top stakers

Returns user information based amount and amount of times a user has staked

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get user profile based on UserID

Returns user profile based on UserID

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "isGuest": true,
  • "name": "string",
  • "profile": {
    },
  • "token": "string",
  • "updatedAt": "string",
  • "userTypeId": "string",
  • "wallet": "string"
}

Get user attribute

Returns user attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set user attribute

Sets entire user attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete user attribute

Deletes a user attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get user sub attributes

Returns user sub attributes

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set user sub attribute

Sets a user sub attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete user sub attribute

Deletes a user sub attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get the worlds the user has staked in

Returns a list of staked Worlds for a user

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get owned worlds

Returns a list of owned Worlds for a user

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

profile

Edit user profile

Edits a user profile

Authorizations:
Bearer
Request Body schema: application/json
required

body params

name
string
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "profile": {
    }
}

Response samples

Content type
application/json
{
  • "job_id": "string",
  • "user_id": "string"
}

worlds

Get latest worlds

Returns a list of six latest created worlds

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Search available worlds

Returns world information based on a search query and categorizes the results

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get world details

Returns a world by ID and its details

Authorizations:
Bearer
path Parameters
object_id
required
string

World UMID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates world data

Returns updates world with new data

Authorizations:
Bearer
path Parameters
object_id
required
string

World UMID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Starts a fly to me session

Initiates a forced fly to me session

Authorizations:
Bearer
path Parameters
object_id
required
string

World UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get world online users

Returns a list of online users for specified world

Authorizations:
Bearer
path Parameters
object_id
required
string

World UMID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Teleports user from token to another world

Teleports user from token to another world

Authorizations:
Bearer
path Parameters
object_id
required
string

World UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Returns objects and one level of children

Returns object information and one level of children based on world_id (used in explore widget)

Authorizations:
Bearer
path Parameters
world_id
required
string

World UMID

query Parameters
objectID
required
string

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "name": "string"
}

objects

Create object

Creates a object base on body

Authorizations:
Bearer
Request Body schema: application/json
required

body params

asset_2d_id
string
asset_3d_id
string
minimap
boolean
object_name
required
string
object_type_id
required
string
parent_id
required
string
object (cmath.Transform)

Responses

Request samples

Content type
application/json
{
  • "asset_2d_id": "string",
  • "asset_3d_id": "string",
  • "minimap": true,
  • "object_name": "string",
  • "object_type_id": "string",
  • "parent_id": "string",
  • "transform": {
    }
}

Response samples

Content type
application/json
{
  • "object_id": "string"
}

Delete member from object

Delete member from object

Authorizations:
Bearer
path Parameters
objectID
required
string

ObjectID UMID

userID
required
string

UserID UMID

Responses

Response samples

Content type
application/json
0
0

Get object by UMID

Returns a object info based on UMID and query

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
effective
boolean

Responses

Response samples

Content type
application/json
{
  • "asset_2d_id": "string",
  • "asset_3d_id": "string",
  • "object_type_id": "string",
  • "owner_id": "string",
  • "parent_id": "string",
  • "transform": {
    }
}

Delete a object by UMID

Deletes a object by UMID

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Update a object by UMID

Updates a object by UMID, 're-parenting' not supported, returns updated object UMID.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

asset_2d_id
string
asset_3d_id
string
object_name
string

Responses

Request samples

Content type
application/json
{
  • "asset_2d_id": "string",
  • "asset_3d_id": "string",
  • "object_name": "string"
}

Response samples

Content type
application/json
{
  • "object_id": "string"
}

Generate Agora token

Returns an Agora token

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json

body params

screenshare
boolean

Responses

Request samples

Content type
application/json
{
  • "screenshare": true
}

Response samples

Content type
application/json
{
  • "channel": "string",
  • "token": "string"
}

Get list of attributes for all users limited by object, plugin and attribute_name

Returns map with key as userID and value as Attribute Value

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get combined list of json entries from all user's values.

Allow showing a combined (sorted) list from all users. The attribute value is assumed to be a JSON (map-like) object, with some ID as key and the value nested JSON object. The fields params allows selecting some fields to directly return in the list. A field name given in the fields param can also be used as a query param to filter on value. The limit and offset params allow pagination. Limit defaults to 10, maximun allowed is 100.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

plugin_id
required
string

Plugin MID

attribute_name
required
string

Name of the plugin attribute

query Parameters
fields[]
Array of strings
limit
integer
offset
integer
order
string
q
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "limit": 0,
  • "offset": 0
}

Get object user attribute count

Returns the number of (non null) object user attributes.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
since
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get object attribute

Returns object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object attribute

Sets entire object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object attribute

Deletes a object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get object and all subobject attributes

Returns object and all subobject attributes

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Makes object attribute available to public

Changes object permissions to be {"write":"user", "read":"any"}

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get object sub attributes

Returns object sub attributes

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
subAttributeKey
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object sub attribute

Sets a object sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object sub attribute

Deletes a object sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Claim and customise object

Claim and customise object

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

image_hash
required
string
text
required
string
title
required
string

Responses

Request samples

Content type
application/json
{
  • "image_hash": "string",
  • "text": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Clones an object by UMID

Clones an object by UMID, 're-parenting' not supported, returns cloned object UMID.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Responses

Response samples

Content type
application/json
{
  • "object_id": "string"
}

Get members belonging to an object

Returns members belonging to the object

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Responses

Response samples

Content type
application/json
{
  • "avatar_hash": "string",
  • "name": "string",
  • "object_id": "string",
  • "role": "string",
  • "user_id": "string"
}

Get object options by object UMID

Returns a object options based on object UMID and query

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
effective
boolean

Responses

Response samples

Content type
application/json
{
  • "allowed_children": [
    ],
  • "asset_2d_options": null,
  • "asset_3d_options": null,
  • "child_limit": 0,
  • "child_placement": {
    },
  • "dashboard_plugins": [
    ],
  • "default_tiles": [
    ],
  • "editable": true,
  • "frame_templates": {
    },
  • "infoui_id": "string",
  • "minimap": true,
  • "private": true,
  • "spawn_point": {
    },
  • "subs": {
    },
  • "visible": 0
}

Set object option by object UMID (use body key options)

Sets a object option by object UMID, returns appended object option.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Responses

Response samples

Content type
application/json
{
  • "allowed_children": [
    ],
  • "asset_2d_options": null,
  • "asset_3d_options": null,
  • "child_limit": 0,
  • "child_placement": {
    },
  • "dashboard_plugins": [
    ],
  • "default_tiles": [
    ],
  • "editable": true,
  • "frame_templates": {
    },
  • "infoui_id": "string",
  • "minimap": true,
  • "private": true,
  • "spawn_point": {
    },
  • "subs": {
    },
  • "visible": 0
}

Get object sub options

Returns a object sub options based on query

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
effective
boolean
sub_option_key
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object sub option by object UMID

Sets a object sub option by object UMID, returns appended object option

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

sub_option_key
required
string
sub_option_value
required
any

Responses

Request samples

Content type
application/json
{
  • "sub_option_key": "string",
  • "sub_option_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object sub option by object UMID

Deletes a object sub option by object UMID

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

sub_option_key
required
string

Responses

Request samples

Content type
application/json
{
  • "sub_option_key": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Spawn an object by user

Spawns an object created by a user

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

object

Mapping of attribute type (e.g. "object_user") to array of attributes to set

object_name
required
string
object_type_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "object_name": "string",
  • "object_type_id": "string"
}

Response samples

Content type
application/json
{
  • "object_id": "string"
}

Get tree of objects with given object as root

Get tree of objects with given object as root

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
max_depth
integer
object_type
string

Responses

Response samples

Content type
application/json
{
  • "children": {
    },
  • "created_at": "string",
  • "id": "string",
  • "max_depth": 0,
  • "name": "string",
  • "object_type_id": "string",
  • "object_type_name": "string",
  • "total_direct_children": 0
}

Unclaim and clear object customisation

Unclaim and clear object customisation

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get object user attribute

Returns object user attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object user attribute

Sets entire object user attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object user attribute

Deletes a object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get object user sub attribute

Returns object user sub attributes

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object sub attribute

Sets a object sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object user sub attribute

Deletes a object user sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

members

Delete member from object

Delete member from object

Authorizations:
Bearer
path Parameters
objectID
required
string

ObjectID UMID

userID
required
string

UserID UMID

Responses

Response samples

Content type
application/json
0
0

Get members belonging to an object

Returns members belonging to the object

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Responses

Response samples

Content type
application/json
{
  • "avatar_hash": "string",
  • "name": "string",
  • "object_id": "string",
  • "role": "string",
  • "user_id": "string"
}

media

Deletes an audio file from the media manager

Deletes an audio file based on the provided filename from the media manager

Authorizations:
Bearer
path Parameters
file
required
string

audio filename

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Gets an image from the (internal) media-manager

Serves a generic image from the (internal) media-manager

Authorizations:
Bearer
path Parameters
file
required
string

image file

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

Gets an image from the (internal) media-manager

Serves a generic image from the (internal) media-manager

Authorizations:
Bearer
path Parameters
file
required
string

image file

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

Gets a texture from the (internal) media-manager

Serves a generic texture from the (internal) media-manager

Authorizations:
Bearer
path Parameters
rsize
required
string

Rendering size parameter. Should be in the format 's' followed by a single digit.

file
required
string

Texture file identifier

Responses

Gets a video from the media manager

Serves a video file from the media manager

Authorizations:
Bearer
path Parameters
file
required
string

video file

Responses

Response samples

Content type
application/json
"string"

Gets a video from the media manager

Serves a video file from the media manager

Authorizations:
Bearer
path Parameters
file
required
string

video file

Responses

Response samples

Content type
application/json
"string"

Uploads an audio file to the media manager

Sends an audio file to the media manager and returns its hash

Authorizations:
Bearer
Request Body schema: multipart/form-data
required
file
required
string <binary>

image file

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

Uploads an image to the media manager

Sends an image file to the media manager and returns a hash

Authorizations:
Bearer
Request Body schema: multipart/form-data
required
file
required
string <binary>

image file

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

Uploads a plugin to the media manager

Sends a plugin file to the media manager and returns a hash (?)

Authorizations:
Bearer
Request Body schema: multipart/form-data
required
file
required
string <binary>

plugin file

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

Uploads a video to the media manager

Sends a video file to the media manager and returns a hash

Authorizations:
Bearer
Request Body schema: multipart/form-data
required
file
required
string <binary>

image file

Responses

Response samples

Content type
application/json
{
  • "hash": "string"
}

assets2d

Get 2d asset

Returns a 2d asset

Authorizations:
Bearer
path Parameters
asset2dID
required
string

Asset2d UMID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

assets3d

Get 3d assets

Returns a filtered list of 3d assets

Authorizations:
Bearer
query Parameters
category
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get 3d assets options

Returns list of 3d assets options

Authorizations:
Bearer
query Parameters
assets3d_ids[]
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Upload a 3D asset to the media manager

This endpoint allows for the uploading of 3D assets.

Authorizations:
Bearer
Request Body schema: multipart/form-data
required
asset
required
string <binary>

The 3D asset file to be uploaded

name
string

Name of the asset

preview_hash
string

Preview hash for the asset

is_private
boolean

Specify if the asset is private

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "is_private": true,
  • "meta": {
    },
  • "name": "string",
  • "updatedAt": "string",
  • "user_id": "string"
}

Delete a 3d asset by its umid

Deletes 3d asset by its umid

Authorizations:
Bearer
path Parameters
asset3dID
required
string

Asset3D UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Update 3d asset meta by its umid

Update 3d asset meta by its umid

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

asset3d_id
required
string

Asset 3D UMID

Request Body schema: application/json
required

body params

is_private
boolean
object (entry.Asset3dMeta)

Responses

Request samples

Content type
application/json
{
  • "is_private": true,
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "is_private": true,
  • "meta": {
    },
  • "name": "string",
  • "updatedAt": "string",
  • "user_id": "string"
}

newsfeed

Get the current newsfeed

Returns a newsfeed, with activities from all timelines

Authorizations:
Bearer
query Parameters
pageSize
required
string
startIndex
required
string

Responses

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

timeline

Get timeline for object

Returns a timeline for an object, collection of activities == timeline

Authorizations:
Bearer
path Parameters
object_id
required
string

World or object UMID

query Parameters
pageSize
required
string
startIndex
required
string

Responses

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

Adds a post to a timeline

Creates a new post for a timeline

Authorizations:
Bearer
path Parameters
object_id
required
string

World or object UMID

Request Body schema: application/json
required

body params

description
string
hash
required
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "hash": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

Get timeline for object by activity id

Returns a timeline for an object, collection of activities == timeline

Authorizations:
Bearer
path Parameters
object_id
required
string

World or object UMID

activity_id
required
string

Activity UMID

query Parameters
pageSize
required
string
startIndex
required
string

Responses

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

Remove an item from a timeline

Removes an item from the timeline of an object

Authorizations:
Bearer
path Parameters
object_id
required
string

World or object UMID

activity_id
required
string

Activity UMID

Responses

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

Edits an activity to a timeline

Edits an existing activity for a timeline

Authorizations:
Bearer
path Parameters
object_id
required
string

World or object UMID

activity_id
required
string

Activity UMID

Request Body schema: application/json
required

body params

description
string
hash
string
type
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "hash": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

Get timeline for user

Returns a timeline for a user

path Parameters
user_id
required
string

User UMID

Responses

Response samples

Content type
application/json
{
  • "activities": [
    ],
  • "pageSize": 0,
  • "startIndex": 0,
  • "totalCount": 0
}

plugins

Activate plugin by hash

Activate plugin by hash

Authorizations:
Bearer
Request Body schema: application/json
required

body params

plugin_hash
required
string

Responses

Request samples

Content type
application/json
{
  • "plugin_hash": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get plugins

Returns a list of plugins filtered by parameters

Authorizations:
Bearer
query Parameters
ids
Array of strings
type
string

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get plugins meta

Returns a list of plugins meta filtered by parameters

Authorizations:
Bearer
query Parameters
ids[]
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get plugins options

Returns a list of plugins options filtered by parameters

Authorizations:
Bearer
query Parameters
ids
required
Array of strings

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Search for plugins

Returns a list of plugins filtered by parameters

Authorizations:
Bearer
query Parameters
description
string
name
string
type
string

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

config

Config for UI client

Returns config for UI client

Responses

Response samples

Content type
application/json
{
  • "AGORA_APP_ID": "string",
  • "AI_PROVIDERS": {
    },
  • "BLOCKCHAIN_ID": "string",
  • "CONTRACT_DAD_ADDRESS": "string",
  • "CONTRACT_FAUCET_ADDRESS": "string",
  • "CONTRACT_MOM_ADDRESS": "string",
  • "CONTRACT_NFT_ADDRESS": "string",
  • "CONTRACT_STAKING_ADDRESS": "string",
  • "FEATURE_FLAGS": {
    },
  • "MINT_NFT_AMOUNT": "string",
  • "MINT_NFT_DEPOSIT_ADDRESS": "string",
  • "NODE_ID": "string",
  • "RENDER_SERVICE_URL": "string",
  • "STREAMCHAT_KEY": "string"
}

Get application version

Returns version of running controller app

Responses

Response samples

Content type
application/json
{
  • "api": {
    },
  • "controller": {
    }
}

app

Application health check

Controller application health check

Responses

Response samples

Content type
application/json
{ }

canvas

Gets user contributions by object id

Returns an object with a nested items array of contributions

Authorizations:
Bearer
path Parameters
object_id
required
string

ObjectID string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "limit": 0,
  • "offset": 0
}

leonardo

Create a Generation of Images

Returns a generation id with which the images can be fetched

Authorizations:
Bearer
Request Body schema: application/json
required

body params

model
required
string
prompt
required
string

Responses

Request samples

Content type
application/json
{
  • "model": "string",
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Get images by generation id

Returns an array of images by generation id

Authorizations:
Bearer
path Parameters
leonardo_id
required
string

LeonardoID string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

nfts

Get NFT metadata.

Returns ERC721 metadata.

path Parameters
nftID
required
string

NFT token ID

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "description": "string",
  • "external_url": "string",
  • "image": "string",
  • "name": "string"
}

attributes

Get node attribute

Returns node attribute

Authorizations:
Bearer
query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set node attribute

Sets entire node attribute

Authorizations:
Bearer
Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete node attribute

Deletes a node attribute

Authorizations:
Bearer
Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get list of attributes for all users limited by object, plugin and attribute_name

Returns map with key as userID and value as Attribute Value

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get combined list of json entries from all user's values.

Allow showing a combined (sorted) list from all users. The attribute value is assumed to be a JSON (map-like) object, with some ID as key and the value nested JSON object. The fields params allows selecting some fields to directly return in the list. A field name given in the fields param can also be used as a query param to filter on value. The limit and offset params allow pagination. Limit defaults to 10, maximun allowed is 100.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

plugin_id
required
string

Plugin MID

attribute_name
required
string

Name of the plugin attribute

query Parameters
fields[]
Array of strings
limit
integer
offset
integer
order
string
q
string

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "limit": 0,
  • "offset": 0
}

Get object user attribute count

Returns the number of (non null) object user attributes.

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
since
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Get object attribute

Returns object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object attribute

Sets entire object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object attribute

Deletes a object attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get object and all subobject attributes

Returns object and all subobject attributes

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Makes object attribute available to public

Changes object permissions to be {"write":"user", "read":"any"}

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get object sub attributes

Returns object sub attributes

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
subAttributeKey
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object sub attribute

Sets a object sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object sub attribute

Deletes a object sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get object user attribute

Returns object user attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object user attribute

Sets entire object user attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get object user sub attribute

Returns object user sub attributes

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set object sub attribute

Sets a object sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete object user sub attribute

Deletes a object user sub attribute

Authorizations:
Bearer
path Parameters
object_id
required
string

Object UMID

user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Set user user attribute

Sets a user user attribute based on UserID and TargetID

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

target_id
required
string

Target user UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get user attribute for own user based on token

Returns user attribute

Authorizations:
Bearer
query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get user attribute

Returns user attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set user attribute

Sets entire user attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Get user sub attributes

Returns user sub attributes

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

query Parameters
attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set user sub attribute

Sets a user sub attribute

Authorizations:
Bearer
path Parameters
user_id
required
string

User UMID

Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string
sub_attribute_key
required
string
sub_attribute_value
required
any

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string",
  • "sub_attribute_key": "string",
  • "sub_attribute_value": null
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

node

Get node attribute

Returns node attribute

Authorizations:
Bearer
query Parameters
attribute_name
required
string
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Set node attribute

Sets entire node attribute

Authorizations:
Bearer
Request Body schema: application/json
required

body params

attribute_name
required
string
required
object
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "attribute_value": {
    },
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Delete node attribute

Deletes a node attribute

Authorizations:
Bearer
Request Body schema: application/json
required

body params

attribute_name
required
string
plugin_id
required
string

Responses

Request samples

Content type
application/json
{
  • "attribute_name": "string",
  • "plugin_id": "string"
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get node hosting allow list users

Returns node hosting allow list users with resolved details

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

hosting

Get node hosting allow list users

Returns node hosting allow list users with resolved details

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

skybox

Start skybox generation

Start skybox generation

Authorizations:
Bearer
Request Body schema: application/json
required

body params

prompt
required
string
skybox_style_id
required
integer
world_id
required
string

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "skybox_style_id": 0,
  • "world_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true
}

Get lists the known blockadelabs art styles

Return blockadelabs art styles

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get skybox image by ID

Return Get skybox image by ID

Authorizations:
Bearer
path Parameters
skyboxID
required
string

SkyboxID int

Responses

Response samples

Content type
No sample

Delete skybox by ID

Delete skybox by ID

Authorizations:
Bearer
path Parameters
skyboxID
required
string

SkyboxID int

Request Body schema: application/json
required

body params

world_id
required
string

Responses

Request samples

Content type
application/json
{
  • "world_id": "string"
}

Response samples

Content type
application/json
0
0

chat

Join a chat channel.

Join the chat channel (as a member) for the given world or object UMID.

Authorizations:
Bearer
path Parameters
objectID
required
string

World or object UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Leave a chat channel.

Leave the chat channel (as a member) for the given world or object UMID.

Authorizations:
Bearer
path Parameters
objectID
required
string

World or object UMID

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get a authorization token

Request a chat authorization token for current user and given object (world or object) The user is required to be connected to the world/object. This also automatically joins the user as a member to the channel, so the join endpoint does not have to be called.

Authorizations:
Bearer
path Parameters
objectID
required
string

World or object UMID

Responses

Response samples

Content type
application/json
{
  • "channel": "string",
  • "channel_type": "string",
  • "token": "string"
}

stakes

Get current user's stakes list

Return stakes list

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add pending stake transaction

Add pending transaction

Authorizations:
Bearer
Request Body schema: application/json
required

body params

amount
required
string
comment
required
string
kind
required
string
odyssey_id
required
string
transaction_id
required
string
wallet
required
string

Responses

Request samples

Content type
application/json
{
  • "amount": "string",
  • "comment": "string",
  • "kind": "string",
  • "odyssey_id": "string",
  • "transaction_id": "string",
  • "wallet": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Get current user's wallets list

Return wallets list

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]