RSX · API · Reference

example v1

Reference/template service: a widgets CRUD resource demonstrating every platform standard.

openapi.json

DeprecatedRequests are refused after 2026-08-15.

Base URL: https://api.rsx.group/example/v1
Self-grantable scopes: example:widgets:listexample:widgets:get
Machine readable: openapi.json

widgets

5 operations under /example/v1/widgets.

POST/example/v1/widgets/add

Create a widget

Scope: example:widgets:add Admin-issued keys only.
Idempotency: Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of addWidget
Field	Type	Description
namerequired	string	1 to 120 characters
quantity	integer	at least 0 · default 0

namerequired
Type
string
Description
1 to 120 characters
quantity
Type
integer
Description
at least 0 · default 0

Response 200Widget created

Response of addWidget
Field	Type	Description
datarequired	Widget
idrequired	string, uuid
namerequired	string	1 to 120 characters
quantityrequired	integer	at least 0
createdAtrequired	string, date-time

datarequired
Type
Widget
Description
idrequired
Type
string, uuid
Description
namerequired
Type
string
Description
1 to 120 characters
quantityrequired
Type
integer
Description
at least 0
createdAtrequired
Type
string, date-time
Description

Example

curl

curl -X POST https://api.rsx.group/example/v1/widgets/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acrylic Panel",
  "quantity": 12
}'

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "name": "Acrylic Panel",
    "quantity": 12,
    "createdAt": "2026-07-12T14:30:00Z"
  }
}

GET/example/v1/widgets/list

List widgets

Scope: example:widgets:list Self-grantable from your RSX ID.

Query parameters

Query parameters of listWidgets
Parameter	Type	Description
cursor	string
limit	integer	1 to 100 · default 20

cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 20

Response 200Widgets

Response of listWidgets
Field	Type	Description
datarequired	array of Widget
idrequired	string, uuid
namerequired	string	1 to 120 characters
quantityrequired	integer	at least 0
createdAtrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of Widget
Description
idrequired
Type
string, uuid
Description
namerequired
Type
string
Description
1 to 120 characters
quantityrequired
Type
integer
Description
at least 0
createdAtrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/example/v1/widgets/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "name": "Acrylic Panel",
      "quantity": 12,
      "createdAt": "2026-07-12T14:30:00Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

GET/example/v1/widgets/get

Fetch one widget

Scope: example:widgets:get Self-grantable from your RSX ID.

Query parameters

Query parameters of getWidget
Parameter	Type	Description
idrequired	string, uuid

idrequired
Type
string, uuid
Description

Response 200Widget

Response of getWidget
Field	Type	Description
datarequired	Widget
idrequired	string, uuid
namerequired	string	1 to 120 characters
quantityrequired	integer	at least 0
createdAtrequired	string, date-time

datarequired
Type
Widget
Description
idrequired
Type
string, uuid
Description
namerequired
Type
string
Description
1 to 120 characters
quantityrequired
Type
integer
Description
at least 0
createdAtrequired
Type
string, date-time
Description

Example

curl

curl "https://api.rsx.group/example/v1/widgets/get?id=0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "name": "Acrylic Panel",
    "quantity": 12,
    "createdAt": "2026-07-12T14:30:00Z"
  }
}

POST/example/v1/widgets/update

Update a widget

Scope: example:widgets:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateWidget
Field	Type	Description
idrequired	string, uuid
name	string	1 to 120 characters
quantity	integer	at least 0

idrequired
Type
string, uuid
Description
name
Type
string
Description
1 to 120 characters
quantity
Type
integer
Description
at least 0

Response 200Widget updated

Response of updateWidget
Field	Type	Description
datarequired	Widget
idrequired	string, uuid
namerequired	string	1 to 120 characters
quantityrequired	integer	at least 0
createdAtrequired	string, date-time

datarequired
Type
Widget
Description
idrequired
Type
string, uuid
Description
namerequired
Type
string
Description
1 to 120 characters
quantityrequired
Type
integer
Description
at least 0
createdAtrequired
Type
string, date-time
Description

Example

curl

curl -X POST https://api.rsx.group/example/v1/widgets/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
  "name": "string",
  "quantity": 1
}'

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "name": "Acrylic Panel",
    "quantity": 12,
    "createdAt": "2026-07-12T14:30:00Z"
  }
}

POST/example/v1/widgets/remove

Remove a widget

Scope: example:widgets:remove Admin-issued keys only.

Request bodyapplication/json

Request body of removeWidget
Field	Type	Description
idrequired	string, uuid

idrequired
Type
string, uuid
Description

Response 200Widget removed

Response of removeWidget
Field	Type	Description
datarequired	object
idrequired	string

datarequired
Type
object
Description
idrequired
Type
string
Description

Example

curl

curl -X POST https://api.rsx.group/example/v1/widgets/remove \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d"
}'

200 response

{
  "data": {
    "id": "string"
  }
}

Schemas

Every named shape in this reference, as the operations above refer to it.

Widget

Widget
Field	Type	Description
idrequired	string, uuid
namerequired	string	1 to 120 characters
quantityrequired	integer	at least 0
createdAtrequired	string, date-time

idrequired
Type
string, uuid
Description
namerequired
Type
string
Description
1 to 120 characters
quantityrequired
Type
integer
Description
at least 0
createdAtrequired
Type
string, date-time
Description

CreateWidget

CreateWidget
Field	Type	Description
namerequired	string	1 to 120 characters
quantity	integer	at least 0 · default 0

namerequired
Type
string
Description
1 to 120 characters
quantity
Type
integer
Description
at least 0 · default 0

UpdateWidget

UpdateWidget
Field	Type	Description
idrequired	string, uuid
name	string	1 to 120 characters
quantity	integer	at least 0

idrequired
Type
string, uuid
Description
name
Type
string
Description
1 to 120 characters
quantity
Type
integer
Description
at least 0

RemoveWidget

RemoveWidget
Field	Type	Description
idrequired	string, uuid

idrequired
Type
string, uuid
Description