openapi: 3.0.3
info:
title: dddice
description: ''
version: 1.0.0
servers:
-
url: 'https://dddice.com'
paths:
/api/1.0/theme:
get:
summary: 'List Themes'
operationId: listThemes
description: "Fetch a list of themes. Only the most recent version of each theme is returned\nwhere the \"most recent\" is determined by [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html)"
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'theme[]'
data:
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: consequatur_sapiente
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Blanditiis numquam ea ut incidunt adipisci non et assumenda. Velit consequuntur ut necessitatibus quisquam rem expedita ducimus. Vero quisquam a fuga ullam ratione quo.'
user:
username: sed_iure
uuid: 0f4c9bbf-c7de-11ed-9829-00224849bf5e
name: 'Arden Bergnaum'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: voluptas_ad
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Ipsa molestias itaque dolorem nostrum qui quidem. Illo vel ipsam et et non sapiente alias. Quia quos saepe sit blanditiis voluptatem et voluptatem. Quis ea eligendi doloribus iste tempore quisquam dolorem.'
user:
username: culpa_laborum
uuid: 0f4dfbf1-c7de-11ed-9829-00224849bf5e
name: 'Marielle Dare II'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
type:
type: string
example: 'theme[]'
data:
type: array
example:
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: consequatur_sapiente
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Blanditiis numquam ea ut incidunt adipisci non et assumenda. Velit consequuntur ut necessitatibus quisquam rem expedita ducimus. Vero quisquam a fuga ullam ratione quo.'
user:
username: sed_iure
uuid: 0f4c9bbf-c7de-11ed-9829-00224849bf5e
name: 'Arden Bergnaum'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: voluptas_ad
name: Miss
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Ipsa molestias itaque dolorem nostrum qui quidem. Illo vel ipsam et et non sapiente alias. Quia quos saepe sit blanditiis voluptatem et voluptatem. Quis ea eligendi doloribus iste tempore quisquam dolorem.'
user:
username: culpa_laborum
uuid: 0f4dfbf1-c7de-11ed-9829-00224849bf5e
name: 'Marielle Dare II'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
items:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: consequatur_sapiente
name:
type: string
example: Miss
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Blanditiis numquam ea ut incidunt adipisci non et assumenda. Velit consequuntur ut necessitatibus quisquam rem expedita ducimus. Vero quisquam a fuga ullam ratione quo.'
user:
type: object
properties:
username:
type: string
example: sed_iure
uuid:
type: string
example: 0f4c9bbf-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Arden Bergnaum'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- Theme
post:
summary: 'Create a Theme'
operationId: createATheme
description: 'Create a theme using a theme manifest and save to your dddice.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: multipart/form-data
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: unde_rem
name: Ms.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Necessitatibus et voluptate minima voluptatem quam. Enim et dolores eveniet amet rem corrupti. Nisi voluptatem alias et.'
user:
username: ad_non
uuid: 0f54fb3c-c7de-11ed-9829-00224849bf5e
name: 'Pascale Schmeler'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: unde_rem
name:
type: string
example: Ms.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Necessitatibus et voluptate minima voluptatem quam. Enim et dolores eveniet amet rem corrupti. Nisi voluptatem alias et.'
user:
type: object
properties:
username:
type: string
example: ad_non
uuid:
type: string
example: 0f54fb3c-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Pascale Schmeler'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- Theme
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
frag_shader:
type: string
description: 'Custom fragment shader'
example: ratione
manifest:
type: string
description: 'Theme manifest configuration'
example: '{"meshes":{"d4":"/mesh/d04.fbx","d6":"/mesh/d06.fbx","d8":"/mesh/d08.fbx","d10":"/mesh/d10.fbx","d10x":"/mesh/d10.fbx","d12":"/mesh/d12.fbx","d20":"/mesh/d20.fbx"},"available_dice":["d4","d6","d8","d10","d10x","d12","d20"],"physics":{"inertia":{"d4":5,"d6":12,"d8":10,"d10":9,"d10x":9,"d12":8,"d20":6},"weight":{"d4":300,"d6":300,"d8":340,"d10":350,"d10x":350,"d12":350,"d20":400}},"sizes":{"d4":1,"d6":1,"d8":1,"d10":1,"d10x":1,"d12":1,"d20":1},"sounds":[{"src":"/sounds/roll-1.mp3","on":"die.collide"},{"src":"/sounds/roll-2.mp3","on":"die.collide"},{"src":"/sounds/roll-3.mp3","on":"die.collide"}],"uniforms":{"diffuse":{"type":"color","value":{"r":1,"g":0.929,"b":0}},"number":{"type":"color","value":{"r":0.463,"g":0.424,"b":0}}},"values":{"d4":[1,2,3,4],"d6":[1,2,3,4,5,6],"d8":[1,2,3,4,5,6,7,8],"d10":[1,2,3,4,5,6,7,8,9,10],"d12":[1,2,3,4,5,6,7,8,9,10,11,12],"d20":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20],"d10x":[10,20,30,40,50,60,70,80,90,0]},"id":"delectus_perferendis","version":"1.0.0","api_version":"1.0","name":"Miss","description":"Distinctio esse est dolores sit praesentium laboriosam officiis. Iure qui voluptatibus quidem atque nobis est consectetur enim. Eveniet harum quod quae optio repellat.","label":{"color":"#000000","background_color":"#e3d12d"},"textures":[{"binding":"u_numberMap","src":{"d4":"u_numberMap.png","d6":"u_numberMap.png","d8":"u_numberMap.png","d10":"u_numberMap.png","d12":"u_numberMap.png","d20":"u_numberMap.png","d10x":"u_numberMap_d10x.png"}}],"user":{"username":"ea_est","uuid":"c5de15e0-4337-11ed-abda-0242ac120003","name":"Ms. Demetris Mraz II","created_at":"2022-10-03T16:23:55.000000Z","updated_at":"2022-10-03T16:23:55.000000Z"},"created_at":"2022-10-03T16:23:55.000000Z","updated_at":"2022-10-03T16:23:55.000000Z"}'
vert_shader:
type: string
description: 'Custom vertex shader'
example: expedita
assets:
type: array
description: 'Associated theme assets, filenames must match manifest.json references'
example:
- null
items:
type: File
required:
- manifest
'/api/1.0/theme/{id}':
get:
summary: 'Get Theme'
operationId: getTheme
description: 'Get information about a theme. Returns the latest version.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: impedit_neque
name: Dr.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Laborum sed enim vel occaecati non ducimus. Eveniet veritatis corrupti ea suscipit ut odio odit molestiae. Omnis a ducimus ab natus quo reiciendis. Ut sed sequi minus quisquam.'
user:
username: aut_quos
uuid: 0f57ba89-c7de-11ed-9829-00224849bf5e
name: 'Miss Laurine Padberg'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: impedit_neque
name:
type: string
example: Dr.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Laborum sed enim vel occaecati non ducimus. Eveniet veritatis corrupti ea suscipit ut odio odit molestiae. Omnis a ducimus ab natus quo reiciendis. Ut sed sequi minus quisquam.'
user:
type: object
properties:
username:
type: string
example: aut_quos
uuid:
type: string
example: 0f57ba89-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Miss Laurine Padberg'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- Theme
delete:
summary: 'Delete Theme'
operationId: deleteTheme
description: 'Delete all versions of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
'/api/1.0/theme/{id}/version':
get:
summary: 'Get All Theme Versions'
operationId: getAllThemeVersions
description: 'List all versions of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'theme[]'
data:
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: optio_sequi
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Libero occaecati voluptates quae repellendus quod recusandae. Quas explicabo quibusdam nisi nam suscipit. Ad molestiae expedita ut voluptatem in omnis et earum.'
user:
username: esse_ipsam
uuid: 0f5bb0f7-c7de-11ed-9829-00224849bf5e
name: 'Prof. Margarett Veum'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: officiis_laboriosam
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Vitae sapiente nulla quis optio quia. Necessitatibus perferendis non assumenda eaque rerum. Esse est est quidem. Iure nostrum debitis blanditiis aliquid.'
user:
username: in_aperiam
uuid: 0f5cf8d5-c7de-11ed-9829-00224849bf5e
name: 'Dedrick Kirlin'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
type:
type: string
example: 'theme[]'
data:
type: array
example:
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: optio_sequi
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Libero occaecati voluptates quae repellendus quod recusandae. Quas explicabo quibusdam nisi nam suscipit. Ad molestiae expedita ut voluptatem in omnis et earum.'
user:
username: esse_ipsam
uuid: 0f5bb0f7-c7de-11ed-9829-00224849bf5e
name: 'Prof. Margarett Veum'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: officiis_laboriosam
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Vitae sapiente nulla quis optio quia. Necessitatibus perferendis non assumenda eaque rerum. Esse est est quidem. Iure nostrum debitis blanditiis aliquid.'
user:
username: in_aperiam
uuid: 0f5cf8d5-c7de-11ed-9829-00224849bf5e
name: 'Dedrick Kirlin'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
items:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: optio_sequi
name:
type: string
example: Prof.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Libero occaecati voluptates quae repellendus quod recusandae. Quas explicabo quibusdam nisi nam suscipit. Ad molestiae expedita ut voluptatem in omnis et earum.'
user:
type: object
properties:
username:
type: string
example: esse_ipsam
uuid:
type: string
example: 0f5bb0f7-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Prof. Margarett Veum'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
'/api/1.0/theme/{id}/version/{version}':
get:
summary: 'Get a Theme Version'
operationId: getAThemeVersion
description: 'Get a specific version of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: soluta_officiis
name: Mrs.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Voluptas itaque illo sed dignissimos quos. Earum quaerat sed beatae iste nulla rerum. Rerum porro voluptatum debitis.'
user:
username: corporis_necessitatibus
uuid: 0f60810a-c7de-11ed-9829-00224849bf5e
name: 'Prof. Jay Bartoletti MD'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: soluta_officiis
name:
type: string
example: Mrs.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Voluptas itaque illo sed dignissimos quos. Earum quaerat sed beatae iste nulla rerum. Rerum porro voluptatum debitis.'
user:
type: object
properties:
username:
type: string
example: corporis_necessitatibus
uuid:
type: string
example: 0f60810a-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Prof. Jay Bartoletti MD'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- Theme
delete:
summary: 'Delete Theme Version'
operationId: deleteThemeVersion
description: 'Delete a specific version of a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
-
in: path
name: version
description: 'Theme Version.'
example: 1.0.0
required: true
schema:
type: string
'/api/1.0/theme/{id}/report':
post:
summary: 'Report Theme'
operationId: reportTheme
description: 'Report a theme for abuse or spam.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- Theme
parameters:
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
/api/1.0/room:
get:
summary: 'List Rooms'
operationId: listRooms
description: 'List all rooms created or joined by a user'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'room[]'
data:
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: Jt-Fxbs
passcode: nobis
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: mollitia_magni
uuid: 0eeac150-c7de-11ed-9829-00224849bf5e
name: 'Dr. Leopold Kemmer III'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants:
-
id: 2
username: tempore_velit
color: '#5270d6'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: nam_itaque
uuid: 0eeb2ea6-c7de-11ed-9829-00224849bf5e
name: 'Cydney Mitchell'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
id: 3
username: numquam_est
color: '#b3c89d'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: facere_esse
uuid: 0eeba45f-c7de-11ed-9829-00224849bf5e
name: 'Miss Kenya Bechtelar Jr.'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: 88M3QkB
passcode: sit
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: non_nobis
uuid: 0eed9be7-c7de-11ed-9829-00224849bf5e
name: 'Brad Kautzer'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants:
-
id: 4
username: dolorem_sapiente
color: '#ad2430'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: at_et
uuid: 0eedf131-c7de-11ed-9829-00224849bf5e
name: 'Mikayla Schroeder'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
id: 5
username: similique_enim
color: '#74a072'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: et_deleniti
uuid: 0eee4f70-c7de-11ed-9829-00224849bf5e
name: 'Catharine Wiegand'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
properties:
type:
type: string
example: 'room[]'
data:
type: array
example:
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: Jt-Fxbs
passcode: nobis
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: mollitia_magni
uuid: 0eeac150-c7de-11ed-9829-00224849bf5e
name: 'Dr. Leopold Kemmer III'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants:
-
id: 2
username: tempore_velit
color: '#5270d6'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: nam_itaque
uuid: 0eeb2ea6-c7de-11ed-9829-00224849bf5e
name: 'Cydney Mitchell'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
id: 3
username: numquam_est
color: '#b3c89d'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: facere_esse
uuid: 0eeba45f-c7de-11ed-9829-00224849bf5e
name: 'Miss Kenya Bechtelar Jr.'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: 88M3QkB
passcode: sit
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: non_nobis
uuid: 0eed9be7-c7de-11ed-9829-00224849bf5e
name: 'Brad Kautzer'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants:
-
id: 4
username: dolorem_sapiente
color: '#ad2430'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: at_et
uuid: 0eedf131-c7de-11ed-9829-00224849bf5e
name: 'Mikayla Schroeder'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
id: 5
username: similique_enim
color: '#74a072'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: et_deleniti
uuid: 0eee4f70-c7de-11ed-9829-00224849bf5e
name: 'Catharine Wiegand'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: Jt-Fxbs
passcode:
type: string
example: nobis
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: mollitia_magni
uuid:
type: string
example: 0eeac150-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Dr. Leopold Kemmer III'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
participants:
type: array
example:
-
id: 2
username: tempore_velit
color: '#5270d6'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: nam_itaque
uuid: 0eeb2ea6-c7de-11ed-9829-00224849bf5e
name: 'Cydney Mitchell'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
id: 3
username: numquam_est
color: '#b3c89d'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: facere_esse
uuid: 0eeba45f-c7de-11ed-9829-00224849bf5e
name: 'Miss Kenya Bechtelar Jr.'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
id:
type: integer
example: 2
username:
type: string
example: tempore_velit
color:
type: string
example: '#5270d6'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: nam_itaque
uuid:
type: string
example: 0eeb2ea6-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Cydney Mitchell'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
tags:
- Room
post:
summary: 'Create a Room'
operationId: createARoom
description: "Create a room and use the slug to perform actions in that room.\n\nIf `is_public` is set to `false`, the returned `passcode` will be required\nfor future requests to perform actions in this room.\n\nYou may optionally pass a valid `passcode` to generate your own code."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: qiiK3mb
passcode: aliquid
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: neque_natus
uuid: 0ef2e483-c7de-11ed-9829-00224849bf5e
name: 'Mr. Sofia White III'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: qiiK3mb
passcode:
type: string
example: aliquid
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: neque_natus
uuid:
type: string
example: 0ef2e483-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Mr. Sofia White III'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
is_public:
type: boolean
description: 'Public or private'
example: true
name:
type: string
description: Name
example: dignissimos
passcode:
type: string
description: 'Passcode required for private rooms'
example: et
'/api/1.0/room/{slug}':
get:
summary: 'Get a Room'
operationId: getARoom
description: 'Get information about a room and active participants.'
parameters:
-
in: query
name: passcode
description: 'Passcode required for private room'
example: officia
required: false
schema:
type: string
description: 'Passcode required for private room'
example: officia
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: FOKLLdw
passcode: consequatur
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: consequatur_consequatur
uuid: 0ef5bc62-c7de-11ed-9829-00224849bf5e
name: 'Heaven Terry'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: FOKLLdw
passcode:
type: string
example: consequatur
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: consequatur_consequatur
uuid:
type: string
example: 0ef5bc62-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Heaven Terry'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
participants:
type: array
example: []
tags:
- Room
patch:
summary: 'Update a Room'
operationId: updateARoom
description: 'Update the name of a room'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: multipart/form-data
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: b61eCQt
passcode: qui
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: omnis_nesciunt
uuid: 0ef9cccf-c7de-11ed-9829-00224849bf5e
name: 'Mireille Collier'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: b61eCQt
passcode:
type: string
example: qui
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: omnis_nesciunt
uuid:
type: string
example: 0ef9cccf-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Mireille Collier'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
is_public:
type: boolean
description: 'Public or private'
example: false
name:
type: string
description: Name
example: et
passcode:
type: boolean
description: 'Passcode required for private rooms'
example: false
background:
type: string
format: binary
description: 'Must be a file.'
delete:
summary: 'Delete a Room'
operationId: deleteARoom
description: 'Delete a room you own.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- Room
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: nihil
required: true
schema:
type: string
'/api/1.0/room/{slug}/roll':
patch:
summary: 'Update Room Rolls'
operationId: updateRoomRolls
description: 'Automatically pickup dice from the board or unhide dice to players for all rolls in a room and for the current player.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'roll[]'
data:
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: magnam_libero
uuid: 0efe0494-c7de-11ed-9829-00224849bf5e
name: 'Mazie Will'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: cumque
slug: hQUQRl6
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 9
username: corporis_omnis
color: '#6048ce'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: numquam_quis
uuid: 0efee80f-c7de-11ed-9829-00224849bf5e
name: 'Fiona Hackett'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f000e49-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: true
is_visible: true
is_cleared: true
is_dropped: false
value: 7
value_to_display: '7'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 7
equation: 1d20
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: esse_eveniet
uuid: 0f01a357-c7de-11ed-9829-00224849bf5e
name: 'Columbus Jast'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: aut
slug: J1d6kE7
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 10
username: eos_ex
color: '#993da4'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: quo_expedita
uuid: 0f02798f-c7de-11ed-9829-00224849bf5e
name: 'Fritz Zboncak'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f035086-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: false
is_dropped: false
value: 20
value_to_display: '20'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 20
equation: 1d20
external_id: null
participants: []
properties:
type:
type: string
example: 'roll[]'
data:
type: array
example:
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: magnam_libero
uuid: 0efe0494-c7de-11ed-9829-00224849bf5e
name: 'Mazie Will'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: cumque
slug: hQUQRl6
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 9
username: corporis_omnis
color: '#6048ce'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: numquam_quis
uuid: 0efee80f-c7de-11ed-9829-00224849bf5e
name: 'Fiona Hackett'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f000e49-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: true
is_visible: true
is_cleared: true
is_dropped: false
value: 7
value_to_display: '7'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 7
equation: 1d20
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: esse_eveniet
uuid: 0f01a357-c7de-11ed-9829-00224849bf5e
name: 'Columbus Jast'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: aut
slug: J1d6kE7
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 10
username: eos_ex
color: '#993da4'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: quo_expedita
uuid: 0f02798f-c7de-11ed-9829-00224849bf5e
name: 'Fritz Zboncak'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f035086-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: false
is_dropped: false
value: 20
value_to_display: '20'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 20
equation: 1d20
external_id: null
participants: []
items:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: magnam_libero
uuid:
type: string
example: 0efe0494-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Mazie Will'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: cumque
slug:
type: string
example: hQUQRl6
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 9
username: corporis_omnis
color: '#6048ce'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: numquam_quis
uuid: 0efee80f-c7de-11ed-9829-00224849bf5e
name: 'Fiona Hackett'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
id:
type: integer
example: 9
username:
type: string
example: corporis_omnis
color:
type: string
example: '#6048ce'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username: { type: string, example: numquam_quis }
uuid: { type: string, example: 0efee80f-c7de-11ed-9829-00224849bf5e }
name: { type: string, example: 'Fiona Hackett' }
created_at: { type: string, example: '2023-03-21T11:46:46.000000Z' }
updated_at: { type: string, example: '2023-03-21T11:46:46.000000Z' }
values:
type: array
example:
-
uuid: 0f000e49-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: true
is_visible: true
is_cleared: true
is_dropped: false
value: 7
value_to_display: '7'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 0f000e49-c7de-11ed-9829-00224849bf5e
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: true
is_visible:
type: boolean
example: true
is_cleared:
type: boolean
example: true
is_dropped:
type: boolean
example: false
value:
type: integer
example: 7
value_to_display:
type: string
example: '7'
type:
type: string
example: d20
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
total_value:
type: integer
example: 7
equation:
type: string
example: 1d20
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Room
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dice:
type: object
description: 'Partial dice roll.'
example:
is_hidden: true
properties:
is_visible:
type: boolean
description: 'Roll value hidden'
example: true
is_cleared:
type: boolean
description: 'Roll value cleared'
example: false
required:
- dice
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: 1
required: true
schema:
type: integer
'/api/1.0/room/{slug}/participant':
post:
summary: 'Join a Room'
operationId: joinARoom
description: 'Join a room as a participant'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: fvZ_EcP
passcode: et
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: voluptas_ex
uuid: 0f07c025-c7de-11ed-9829-00224849bf5e
name: 'Crystel Johns'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: fvZ_EcP
passcode:
type: string
example: et
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: voluptas_ex
uuid:
type: string
example: 0f07c025-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Crystel Johns'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
passcode:
type: string
description: 'Passcode required for private room'
example: deleniti
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: quibusdam
required: true
schema:
type: string
'/api/1.0/room/{slug}/participant/{id}':
patch:
summary: 'Update a Participant'
operationId: updateAParticipant
description: 'Update the username or color of the room participant.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: 'Untitled Room'
is_public: true
bg_file_path: null
slug: 5xxpGak
passcode: cum
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: deserunt_facilis
uuid: 0f0b6b2f-c7de-11ed-9829-00224849bf5e
name: 'Delta Schaden II'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
participants: []
properties:
data:
type: object
properties:
name:
type: string
example: 'Untitled Room'
is_public:
type: boolean
example: true
bg_file_path:
type: string
example: null
slug:
type: string
example: 5xxpGak
passcode:
type: string
example: cum
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: deserunt_facilis
uuid:
type: string
example: 0f0b6b2f-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Delta Schaden II'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
participants:
type: array
example: []
tags:
- Room
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
passcode:
type: string
description: 'Passcode required for private room'
example: sapiente
username:
type: string
description: "Update a participant's username"
example: nemo
color:
type: string
description: "Update a participant's color."
example: '#FF0000'
delete:
summary: 'Leave a Room'
operationId: leaveARoom
description: "Remove a participant from a room. Participants can choose to leave a room\nusing this endpoint. Room owners have permission to remove any participant."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- Room
parameters:
-
in: path
name: slug
description: 'The slug of the room.'
example: ab
required: true
schema:
type: string
-
in: path
name: id
description: 'Participant ID'
example: repellendus
required: true
schema:
type: string
/api/1.0/roll:
post:
summary: 'Create a Roll'
operationId: createARoll
description: "Perform a dice roll and optionally send the result to a public or private room.\n\nDice roll values are calculated using the API but can optionally receive a\n`value` and/or `value_to_display` attribute to pass a predetermined value (i.e. when integrating with VTTs).\n\n**Operators**\nOperators allow one to manipulate the outcome of the dice roll. The syntax of operators is based on [Avrae](https://avrae.io/commands#roll) which\nimplements [d20 dice syntax](https://d20.readthedocs.io/en/latest/start.html#dice-syntax)."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: necessitatibus_illum
uuid: 0f15cfbf-c7de-11ed-9829-00224849bf5e
name: 'Zachariah Rath IV'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: sint
slug: oaIg6xJ
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 13
username: fugiat_ut
color: '#fe0a0e'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: cupiditate_beatae
uuid: 0f17270b-c7de-11ed-9829-00224849bf5e
name: 'Augusta Ruecker'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f1803da-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: true
is_dropped: false
value: 6
value_to_display: '6'
type: d10
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 6
equation: 1d10
external_id: null
participants: []
properties:
data:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: necessitatibus_illum
uuid:
type: string
example: 0f15cfbf-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Zachariah Rath IV'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: sint
slug:
type: string
example: oaIg6xJ
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 13
username: fugiat_ut
color: '#fe0a0e'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: cupiditate_beatae
uuid: 0f17270b-c7de-11ed-9829-00224849bf5e
name: 'Augusta Ruecker'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
id:
type: integer
example: 13
username:
type: string
example: fugiat_ut
color:
type: string
example: '#fe0a0e'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: cupiditate_beatae
uuid:
type: string
example: 0f17270b-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Augusta Ruecker'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
values:
type: array
example:
-
uuid: 0f1803da-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: true
is_dropped: false
value: 6
value_to_display: '6'
type: d10
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 0f1803da-c7de-11ed-9829-00224849bf5e
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: false
is_visible:
type: boolean
example: true
is_cleared:
type: boolean
example: true
is_dropped:
type: boolean
example: false
value:
type: integer
example: 6
value_to_display:
type: string
example: '6'
type:
type: string
example: d10
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
total_value:
type: integer
example: 6
equation:
type: string
example: 1d10
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
dice:
type: array
description: 'List of dice rolls.'
example:
-
type: D20
theme: dddice-red
-
type: D20
theme: dddice-red
items:
type: object
properties:
is_hidden:
type: boolean
description: ''
example: true
theme:
type: string
description: 'Theme ID'
example: impedit
type:
type: string
description: 'Type of dice. Valid types are D20, D12, D10, D8, D6, and D4.'
example: totam
label:
type: string
description: ''
example: qui
value:
type: number
description: 'Dice value. If no value is provided, dddice will generate a value using our balanced random number generator.'
example: 2.24706
value_to_display:
type: string|object
description: 'This can be used to replace the numeric value. This is useful in cases where a D20 might contain letters instead of numbers or if a player is speaking in tongues or hieroglyphs.'
example: eos
required:
- theme
- type
external_id:
type: string
description: 'An ID for this roll generated by an external system.'
example: perferendis
operator:
type: object
description: 'Optional operators to manipulate the final value of the dice'
example: []
properties:
k:
type: string
description: 'Keep all matched values.'
example: '"h2"'
p:
type: string
description: 'Drop all matched values (Not yet implemented)'
example: occaecati
rr:
type: string
description: 'Reroll all matched values until none match (Not yet implemented)'
example: cumque
ro:
type: string
description: 'Reroll all matched values once (Not yet implemented)'
example: ipsa
ra:
type: string
description: 'Reroll up to one matched value once, keeping the original roll (Not yet implemented)'
example: aut
e:
type: string
description: 'Explode, rolls another die for each matched value (Not yet implemented)'
example: quia
mi:
type: number
description: 'Set a minimum value for each die (Not yet implemented)'
example: 1.0
ma:
type: number
description: 'Set a maximum value for each die (Not yet implemented)'
example: 8151725.2072
room:
type: string
description: 'Room slug.'
example: HvvOlTl
whisper:
type: array
description: 'Participant IDs to whisper this roll to. Only participants specified will see this roll.'
example:
- 124309.615
items:
type: number
label:
type: string
description: 'Optional label for this roll.'
example: '"Longbow damage with Hunter''s Mark"'
required:
- dice
patch:
summary: 'Bulk Update Rolls'
operationId: bulkUpdateRolls
description: "Pickup dice from the board or unhide dice to players for multiple rolls.\n\nAccepts an array of objects with the the same parameters as `PATCH /api/1.0/roll/{id}`."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'roll[]'
data:
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: magni_aut
uuid: 0f273c97-c7de-11ed-9829-00224849bf5e
name: 'Prof. Dayna Grimes PhD'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: cum
slug: ymKIYbx
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 16
username: qui_et
color: '#419fc2'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: numquam_eum
uuid: 0f2821cd-c7de-11ed-9829-00224849bf5e
name: 'Anya Bartoletti'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f28fa87-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 6
value_to_display: '6'
type: d10
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 6
equation: 1d10
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: provident_quia
uuid: 0f2a8253-c7de-11ed-9829-00224849bf5e
name: 'Winston Kovacek'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: rerum
slug: nHpzf9u
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 17
username: aut_adipisci
color: '#58342e'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: sed_amet
uuid: 0f2b5fba-c7de-11ed-9829-00224849bf5e
name: 'Theodore Lowe'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f2c3752-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: false
is_dropped: false
value: 20
value_to_display: '20'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 20
equation: 1d20
external_id: null
participants: []
properties:
type:
type: string
example: 'roll[]'
data:
type: array
example:
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: magni_aut
uuid: 0f273c97-c7de-11ed-9829-00224849bf5e
name: 'Prof. Dayna Grimes PhD'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: cum
slug: ymKIYbx
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 16
username: qui_et
color: '#419fc2'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: numquam_eum
uuid: 0f2821cd-c7de-11ed-9829-00224849bf5e
name: 'Anya Bartoletti'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f28fa87-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 6
value_to_display: '6'
type: d10
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 6
equation: 1d10
external_id: null
participants: []
-
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: provident_quia
uuid: 0f2a8253-c7de-11ed-9829-00224849bf5e
name: 'Winston Kovacek'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: rerum
slug: nHpzf9u
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 17
username: aut_adipisci
color: '#58342e'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: sed_amet
uuid: 0f2b5fba-c7de-11ed-9829-00224849bf5e
name: 'Theodore Lowe'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f2c3752-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: true
is_cleared: false
is_dropped: false
value: 20
value_to_display: '20'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 20
equation: 1d20
external_id: null
participants: []
items:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: magni_aut
uuid:
type: string
example: 0f273c97-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Prof. Dayna Grimes PhD'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: cum
slug:
type: string
example: ymKIYbx
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 16
username: qui_et
color: '#419fc2'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: numquam_eum
uuid: 0f2821cd-c7de-11ed-9829-00224849bf5e
name: 'Anya Bartoletti'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
id:
type: integer
example: 16
username:
type: string
example: qui_et
color:
type: string
example: '#419fc2'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username: { type: string, example: numquam_eum }
uuid: { type: string, example: 0f2821cd-c7de-11ed-9829-00224849bf5e }
name: { type: string, example: 'Anya Bartoletti' }
created_at: { type: string, example: '2023-03-21T11:46:46.000000Z' }
updated_at: { type: string, example: '2023-03-21T11:46:46.000000Z' }
values:
type: array
example:
-
uuid: 0f28fa87-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: true
is_visible: false
is_cleared: false
is_dropped: false
value: 6
value_to_display: '6'
type: d10
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 0f28fa87-c7de-11ed-9829-00224849bf5e
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: true
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 6
value_to_display:
type: string
example: '6'
type:
type: string
example: d10
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
total_value:
type: integer
example: 6
equation:
type: string
example: 1d10
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
rolls:
type: array
description: 'List of rolls.'
example:
-
uuid: '1'
dice:
-
uuid: '1'
is_hidden: true
items:
type: object
properties:
uuid:
type: required
description: 'Roll ID'
example: 8340ef32-8a69-33e7-9d48-ecda88aaa680
dice:
type: array
description: 'List of partial dice rolls.'
example:
-
uuid: '1'
is_hidden: true
items:
type: object
properties:
is_visible:
type: boolean
description: 'Roll value hidden'
example: false
is_cleared:
type: boolean
description: 'Roll value cleared'
example: true
room:
type: string
description: ''
example: aspernatur
required:
- dice
required:
- rolls
'/api/1.0/roll/{id}':
get:
summary: 'Get a Roll'
operationId: getARoll
description: 'Fetch roll information including the user and optional room information'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: est_praesentium
uuid: 0f1bb704-c7de-11ed-9829-00224849bf5e
name: 'Miss Vilma Maggio DVM'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: occaecati
slug: DuPFa2a
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 14
username: sed_rerum
color: '#fd8845'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: earum_officiis
uuid: 0f1ca040-c7de-11ed-9829-00224849bf5e
name: 'Miss Norene Brakus IV'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f1d7963-c7de-11ed-9829-00224849bf5e
is_hidden: true
is_user_value: true
is_visible: true
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d8
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 2
equation: 1d8
external_id: null
participants: []
properties:
data:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: est_praesentium
uuid:
type: string
example: 0f1bb704-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Miss Vilma Maggio DVM'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: occaecati
slug:
type: string
example: DuPFa2a
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 14
username: sed_rerum
color: '#fd8845'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: earum_officiis
uuid: 0f1ca040-c7de-11ed-9829-00224849bf5e
name: 'Miss Norene Brakus IV'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
id:
type: integer
example: 14
username:
type: string
example: sed_rerum
color:
type: string
example: '#fd8845'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: earum_officiis
uuid:
type: string
example: 0f1ca040-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Miss Norene Brakus IV'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
values:
type: array
example:
-
uuid: 0f1d7963-c7de-11ed-9829-00224849bf5e
is_hidden: true
is_user_value: true
is_visible: true
is_cleared: false
is_dropped: false
value: 2
value_to_display: '2'
type: d8
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 0f1d7963-c7de-11ed-9829-00224849bf5e
is_hidden:
type: boolean
example: true
is_user_value:
type: boolean
example: true
is_visible:
type: boolean
example: true
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 2
value_to_display:
type: string
example: '2'
type:
type: string
example: d8
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
total_value:
type: integer
example: 2
equation:
type: string
example: 1d8
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
patch:
summary: 'Update a Roll'
operationId: updateARoll
description: 'Pickup dice from the board or unhide dice to players'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
direction: 180
velocity: 1
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: ut_eos
uuid: 0f2147c1-c7de-11ed-9829-00224849bf5e
name: 'Cleta Cummings'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
room:
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: tempora
slug: kefO5b4
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
deleted_at: null
participants:
-
id: 15
username: quisquam_voluptatem
color: '#79f36e'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: delectus_tempora
uuid: 0f2233d2-c7de-11ed-9829-00224849bf5e
name: 'Deja Orn V'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
values:
-
uuid: 0f230fe7-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: false
is_cleared: false
is_dropped: false
value: 6
value_to_display: '6'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
total_value: 6
equation: 1d20
external_id: null
participants: []
properties:
data:
type: object
properties:
direction:
type: integer
example: 180
velocity:
type: integer
example: 1
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: ut_eos
uuid:
type: string
example: 0f2147c1-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Cleta Cummings'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
room:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: tempora
slug:
type: string
example: kefO5b4
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
deleted_at:
type: string
example: null
participants:
type: array
example:
-
id: 15
username: quisquam_voluptatem
color: '#79f36e'
position: 0
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
user:
username: delectus_tempora
uuid: 0f2233d2-c7de-11ed-9829-00224849bf5e
name: 'Deja Orn V'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
id:
type: integer
example: 15
username:
type: string
example: quisquam_voluptatem
color:
type: string
example: '#79f36e'
position:
type: integer
example: 0
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: delectus_tempora
uuid:
type: string
example: 0f2233d2-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Deja Orn V'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
values:
type: array
example:
-
uuid: 0f230fe7-c7de-11ed-9829-00224849bf5e
is_hidden: false
is_user_value: false
is_visible: false
is_cleared: false
is_dropped: false
value: 6
value_to_display: '6'
type: d20
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
uuid:
type: string
example: 0f230fe7-c7de-11ed-9829-00224849bf5e
is_hidden:
type: boolean
example: false
is_user_value:
type: boolean
example: false
is_visible:
type: boolean
example: false
is_cleared:
type: boolean
example: false
is_dropped:
type: boolean
example: false
value:
type: integer
example: 6
value_to_display:
type: string
example: '6'
type:
type: string
example: d20
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
total_value:
type: integer
example: 6
equation:
type: string
example: 1d20
external_id:
type: string
example: null
participants:
type: array
example: []
tags:
- Roll
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
room:
type: string
description: ''
example: quisquam
dice:
type: array
description: 'List of partial dice rolls.'
example:
-
uuid: '1'
is_hidden: true
items:
type: object
properties:
uuid:
type: string
description: ''
example: a272911c-cb70-328b-88a5-23232ee715df
is_visible:
type: boolean
description: 'Roll value hidden'
example: true
is_cleared:
type: boolean
description: 'Roll value cleared'
example: true
required:
- uuid
required:
- dice
parameters:
-
in: path
name: id
description: 'Roll ID'
example: et
required: true
schema:
type: string
/api/1.0/share:
get:
summary: 'List Share Requests'
operationId: listShareRequests
description: "\n\nFetch a list of active and inactive share requests."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'share[]'
data:
-
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: assumenda_excepturi
uuid: 0f302a04-c7de-11ed-9829-00224849bf5e
name: 'Rhea Luettgen'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
theme:
slug: laborum_illo
is_available: true
is_extendable: 1
is_discoverable: 1
name: Mr.
description: 'Nihil impedit nulla repudiandae in consequatur earum recusandae. Velit perferendis qui sed corporis aut. Excepturi molestiae quidem quo id dolor omnis. Inventore a soluta aut distinctio. Eum optio qui quas fugit enim.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: in_consequuntur
uuid: 0f31a5e3-c7de-11ed-9829-00224849bf5e
name: 'Howard Senger'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
theme:
slug: aliquid_quasi
is_available: true
is_extendable: 1
is_discoverable: 1
name: Ms.
description: 'Id aspernatur et dolorem ipsam id quas. Autem iure molestiae qui omnis odio sequi.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
properties:
type:
type: string
example: 'share[]'
data:
type: array
example:
-
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: assumenda_excepturi
uuid: 0f302a04-c7de-11ed-9829-00224849bf5e
name: 'Rhea Luettgen'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
theme:
slug: laborum_illo
is_available: true
is_extendable: 1
is_discoverable: 1
name: Mr.
description: 'Nihil impedit nulla repudiandae in consequatur earum recusandae. Velit perferendis qui sed corporis aut. Excepturi molestiae quidem quo id dolor omnis. Inventore a soluta aut distinctio. Eum optio qui quas fugit enim.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
-
updated_at: '2023-03-21T11:46:46.000000Z'
created_at: '2023-03-21T11:46:46.000000Z'
user:
username: in_consequuntur
uuid: 0f31a5e3-c7de-11ed-9829-00224849bf5e
name: 'Howard Senger'
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
theme:
slug: aliquid_quasi
is_available: true
is_extendable: 1
is_discoverable: 1
name: Ms.
description: 'Id aspernatur et dolorem ipsam id quas. Autem iure molestiae qui omnis odio sequi.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:46.000000Z'
updated_at: '2023-03-21T11:46:46.000000Z'
items:
type: object
properties:
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
user:
type: object
properties:
username:
type: string
example: assumenda_excepturi
uuid:
type: string
example: 0f302a04-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Rhea Luettgen'
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
theme:
type: object
properties:
slug:
type: string
example: laborum_illo
is_available:
type: boolean
example: true
is_extendable:
type: integer
example: 1
is_discoverable:
type: integer
example: 1
name:
type: string
example: Mr.
description:
type: string
example: 'Nihil impedit nulla repudiandae in consequatur earum recusandae. Velit perferendis qui sed corporis aut. Excepturi molestiae quidem quo id dolor omnis. Inventore a soluta aut distinctio. Eum optio qui quas fugit enim.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:46.000000Z'
tags:
- 'Share Dice'
post:
summary: 'Create Share Request'
operationId: createShareRequest
description: 'Create a share request for a given theme.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
user:
username: eius_natus
uuid: 0f345c73-c7de-11ed-9829-00224849bf5e
name: 'Carlie Rice'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
theme:
slug: soluta_consequatur
is_available: true
is_extendable: 1
is_discoverable: 1
name: Mrs.
description: 'Illum atque ut illum aut nihil. Eius ipsam totam ratione deleniti. Debitis iste tempora incidunt autem aliquid fugiat maxime.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
user:
type: object
properties:
username:
type: string
example: eius_natus
uuid:
type: string
example: 0f345c73-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Carlie Rice'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
theme:
type: object
properties:
slug:
type: string
example: soluta_consequatur
is_available:
type: boolean
example: true
is_extendable:
type: integer
example: 1
is_discoverable:
type: integer
example: 1
name:
type: string
example: Mrs.
description:
type: string
example: 'Illum atque ut illum aut nihil. Eius ipsam totam ratione deleniti. Debitis iste tempora incidunt autem aliquid fugiat maxime.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Share Dice'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
slug:
type: string
description: 'Theme slug.'
example: dddice-standard
limit:
type: integer
description: 'Number of times this share request can be accepted'
example: 14
expires_at:
type: string
description: 'Expiration date or datetime'
example: iusto
required:
- slug
'/api/1.0/share/{id}':
get:
summary: 'Get Share Request'
operationId: getShareRequest
description: "\n\nGet information about a share request."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
user:
username: qui_veritatis
uuid: 0f36a45c-c7de-11ed-9829-00224849bf5e
name: 'Leonardo Hahn'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
theme:
slug: velit_repellat
is_available: true
is_extendable: 1
is_discoverable: 1
name: Ms.
description: 'Aliquam occaecati et velit sit corrupti beatae. Fuga maxime modi eius aut voluptatem laboriosam. Voluptatum dolor sint perferendis eos qui voluptas. Natus voluptas sit ipsum non autem architecto doloremque.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
user:
type: object
properties:
username:
type: string
example: qui_veritatis
uuid:
type: string
example: 0f36a45c-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Leonardo Hahn'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
theme:
type: object
properties:
slug:
type: string
example: velit_repellat
is_available:
type: boolean
example: true
is_extendable:
type: integer
example: 1
is_discoverable:
type: integer
example: 1
name:
type: string
example: Ms.
description:
type: string
example: 'Aliquam occaecati et velit sit corrupti beatae. Fuga maxime modi eius aut voluptatem laboriosam. Voluptatum dolor sint perferendis eos qui voluptas. Natus voluptas sit ipsum non autem architecto doloremque.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Share Dice'
patch:
summary: 'Update Share Request'
operationId: updateShareRequest
description: "\n\nUpdate information about a share request."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
user:
username: est_alias
uuid: 0f38c62c-c7de-11ed-9829-00224849bf5e
name: 'Mr. Melvina Pfeffer'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
theme:
slug: corporis_dolores
is_available: true
is_extendable: 1
is_discoverable: 1
name: Ms.
description: 'Vero porro reiciendis molestiae assumenda repellat distinctio porro. Ex recusandae nam explicabo excepturi culpa quibusdam. Placeat quasi tempore voluptatum itaque quas odio. Doloribus cupiditate est sed voluptatem minima.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
user:
type: object
properties:
username:
type: string
example: est_alias
uuid:
type: string
example: 0f38c62c-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Mr. Melvina Pfeffer'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
theme:
type: object
properties:
slug:
type: string
example: corporis_dolores
is_available:
type: boolean
example: true
is_extendable:
type: integer
example: 1
is_discoverable:
type: integer
example: 1
name:
type: string
example: Ms.
description:
type: string
example: 'Vero porro reiciendis molestiae assumenda repellat distinctio porro. Ex recusandae nam explicabo excepturi culpa quibusdam. Placeat quasi tempore voluptatum itaque quas odio. Doloribus cupiditate est sed voluptatem minima.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Share Dice'
delete:
summary: 'Delete Share Request'
operationId: deleteShareRequest
description: "\n\nDelete a share request which will invalidate any shared URLs"
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- 'Share Dice'
post:
summary: 'Accept Share Request'
operationId: acceptShareRequest
description: "Accept a user's share request which will add the specified theme to your **Digital Dice Box**.\n\nYou can retrieve and modify this theme from your **Digitial Dice Box** by using the [DiceBox](#dice-box) endpoints."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
user:
username: sapiente_sed
uuid: 0f3bcbbe-c7de-11ed-9829-00224849bf5e
name: 'Mr. Kane Oberbrunner'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
theme:
slug: distinctio_odio
is_available: true
is_extendable: 1
is_discoverable: 1
name: Mrs.
description: 'Dolor qui non non quia rem. Delectus repudiandae magni aut quibusdam ea. Nostrum numquam eaque consequatur est quae sint.'
form_state: null
deleted_at: null
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
user:
type: object
properties:
username:
type: string
example: sapiente_sed
uuid:
type: string
example: 0f3bcbbe-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Mr. Kane Oberbrunner'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
theme:
type: object
properties:
slug:
type: string
example: distinctio_odio
is_available:
type: boolean
example: true
is_extendable:
type: integer
example: 1
is_discoverable:
type: integer
example: 1
name:
type: string
example: Mrs.
description:
type: string
example: 'Dolor qui non non quia rem. Delectus repudiandae magni aut quibusdam ea. Nostrum numquam eaque consequatur est quae sint.'
form_state:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Share Dice'
parameters:
-
in: path
name: id
description: 'The ID of the share request'
example: ea
required: true
schema:
type: string
/api/1.0/user:
get:
summary: 'Get Authenticated User'
operationId: getAuthenticatedUser
description: 'Get the current authenticated user.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: user
data:
name: 'Cyril Mayert'
username: dolorem_neque
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
rooms:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: autem
slug: XgLtBwR
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
deleted_at: null
properties:
type:
type: string
example: user
data:
type: object
properties:
name:
type: string
example: 'Cyril Mayert'
username:
type: string
example: dolorem_neque
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
rooms:
type: array
example:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: autem
slug: XgLtBwR
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
deleted_at: null
items:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: autem
slug:
type: string
example: XgLtBwR
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
deleted_at:
type: string
example: null
tags:
- User
post:
summary: 'Create Guest User'
operationId: createGuestUser
description: "Create a guest user to communicate with other API endpoints. Returns a token that can be used to fetch a user.\n\nThis route is rate-limited to 1 account/24-hour."
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
type: user
data:
name: 'Miss Rosalind Skiles'
username: sapiente_cupiditate
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
rooms:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: est
slug: uo1PuNX
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
deleted_at: null
properties:
type:
type: string
example: user
data:
type: object
properties:
name:
type: string
example: 'Miss Rosalind Skiles'
username:
type: string
example: sapiente_cupiditate
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
rooms:
type: array
example:
-
is_public: true
name: 'Untitled Room'
bg_file_path: null
passcode: est
slug: uo1PuNX
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
deleted_at: null
items:
type: object
properties:
is_public:
type: boolean
example: true
name:
type: string
example: 'Untitled Room'
bg_file_path:
type: string
example: null
passcode:
type: string
example: est
slug:
type: string
example: uo1PuNX
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
deleted_at:
type: string
example: null
tags:
- User
security: []
/api/1.0/user/token:
post:
summary: 'Create API Token'
operationId: createAPIToken
description: 'Returns a new API token for the authenticated user.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
type: token
data: ''
properties:
type:
type: string
example: token
data:
type: string
example: ''
tags:
- User
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: non
'/api/1.0/user/token/{token}':
delete:
summary: 'Delete API Key'
operationId: deleteAPIKey
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- User
parameters:
-
in: path
name: token
description: Token
example: iure
required: true
schema:
type: string
/api/1.0/dice-box:
get:
summary: 'List Dice Box Collection'
operationId: listDiceBoxCollection
description: 'Fetch a list of all dice in your **Digital Dice Box**.'
parameters:
-
in: query
name: filter
description: 'Filter themes by name'
example: similique
required: false
schema:
type: string
description: 'Filter themes by name'
example: similique
-
in: query
name: ids
description: 'Comma seperated list of themes IDs to get'
example: vel
required: false
schema:
type: string
description: 'Comma seperated list of themes IDs to get'
example: vel
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
type: 'theme[]'
data:
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: vel_consequatur
name: Mrs.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Eos sequi esse optio tempora sit ad. Voluptate labore quia dolores molestias quas. Quis sequi maiores quo expedita saepe dicta.'
user:
username: quidem_nesciunt
uuid: 0f3eddba-c7de-11ed-9829-00224849bf5e
name: 'Jillian Monahan'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: aut_placeat
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Aut ipsam odit eos rerum fugit veniam. Quis dolorem vel sit et et aut rem exercitationem. Voluptatem sit dolor sit voluptas ut molestiae.'
user:
username: consequuntur_quia
uuid: 0f40510c-c7de-11ed-9829-00224849bf5e
name: 'Deanna Pfeffer'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
type:
type: string
example: 'theme[]'
data:
type: array
example:
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: vel_consequatur
name: Mrs.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Eos sequi esse optio tempora sit ad. Voluptate labore quia dolores molestias quas. Quis sequi maiores quo expedita saepe dicta.'
user:
username: quidem_nesciunt
uuid: 0f3eddba-c7de-11ed-9829-00224849bf5e
name: 'Jillian Monahan'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
-
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: aut_placeat
name: Prof.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Aut ipsam odit eos rerum fugit veniam. Quis dolorem vel sit et et aut rem exercitationem. Voluptatem sit dolor sit voluptas ut molestiae.'
user:
username: consequuntur_quia
uuid: 0f40510c-c7de-11ed-9829-00224849bf5e
name: 'Deanna Pfeffer'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
items:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: vel_consequatur
name:
type: string
example: Mrs.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Eos sequi esse optio tempora sit ad. Voluptate labore quia dolores molestias quas. Quis sequi maiores quo expedita saepe dicta.'
user:
type: object
properties:
username:
type: string
example: quidem_nesciunt
uuid:
type: string
example: 0f3eddba-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Jillian Monahan'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Dice Box'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
limit:
type: number
description: ''
example: 2011286.0096872
filter:
type: string
description: ''
example: est
'/api/1.0/dice-box/{slug}':
get:
summary: 'Get Dice Box Theme'
operationId: getDiceBoxTheme
description: "\n\nGet information about a theme in your **Digital Dice Box**."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: ex_omnis
name: Ms.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Quia odio enim et quis. Expedita recusandae aperiam non et est. Eum fugit dolorum qui minima perferendis dolor in a. Non non iste voluptatem sed provident voluptatem.'
user:
username: aspernatur_sint
uuid: 0f448e03-c7de-11ed-9829-00224849bf5e
name: 'Dr. Claire Kub I'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: ex_omnis
name:
type: string
example: Ms.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Quia odio enim et quis. Expedita recusandae aperiam non et est. Eum fugit dolorum qui minima perferendis dolor in a. Non non iste voluptatem sed provident voluptatem.'
user:
type: object
properties:
username:
type: string
example: aspernatur_sint
uuid:
type: string
example: 0f448e03-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Dr. Claire Kub I'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Dice Box'
patch:
summary: 'Update Dice Box Theme'
operationId: updateDiceBoxTheme
description: "\n\nUpgrade theme version in your **Digital Dice Box**."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
meshes:
d4: 'https://dddice.com/mesh/d04.fbx'
d6: 'https://dddice.com/mesh/d06.fbx'
d8: 'https://dddice.com/mesh/d08.fbx'
d10: 'https://dddice.com/mesh/d10.fbx'
d10x: 'https://dddice.com/mesh/d10.fbx'
d12: 'https://dddice.com/mesh/d12.fbx'
d20: 'https://dddice.com/mesh/d20.fbx'
available_dice:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
physics:
inertia:
d4: 5
d6: 12
d8: 10
d10: 9
d10x: 9
d12: 8
d20: 6
weight:
d4: 300
d6: 300
d8: 340
d10: 350
d10x: 350
d12: 350
d20: 400
sizes:
d4: 1
d6: 1
d8: 1
d10: 1
d10x: 1
d12: 1
d20: 1
sounds:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
uniforms:
number:
type: color
value:
b: 0
g: 0.424
r: 0.463
diffuse:
type: color
value:
b: 0
g: 0.929
r: 1
values:
d4:
- 1
- 2
- 3
- 4
d6:
- 1
- 2
- 3
- 4
- 5
- 6
d8:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
d10:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
d12:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
d20:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
d10x:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
id: beatae_saepe
name: Ms.
label:
color: '#000000'
background_color: '#e3d12d'
version: 1.0.0
textures:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
api_version: '1.0'
description: 'Qui natus id aut numquam. Quis in et rerum molestiae. Ex voluptas repudiandae dolorum quia aliquam aut. Harum laboriosam occaecati corrupti.'
user:
username: corrupti_exercitationem
uuid: 0f4730ef-c7de-11ed-9829-00224849bf5e
name: 'Prof. Yesenia Powlowski'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
created_at: '2023-03-21T11:46:47.000000Z'
updated_at: '2023-03-21T11:46:47.000000Z'
properties:
data:
type: object
properties:
meshes:
type: object
properties:
d4:
type: string
example: 'https://dddice.com/mesh/d04.fbx'
d6:
type: string
example: 'https://dddice.com/mesh/d06.fbx'
d8:
type: string
example: 'https://dddice.com/mesh/d08.fbx'
d10:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d10x:
type: string
example: 'https://dddice.com/mesh/d10.fbx'
d12:
type: string
example: 'https://dddice.com/mesh/d12.fbx'
d20:
type: string
example: 'https://dddice.com/mesh/d20.fbx'
available_dice:
type: array
example:
- d4
- d6
- d8
- d10
- d10x
- d12
- d20
items:
type: string
physics:
type: object
properties:
inertia:
type: object
properties:
d4:
type: integer
example: 5
d6:
type: integer
example: 12
d8:
type: integer
example: 10
d10:
type: integer
example: 9
d10x:
type: integer
example: 9
d12:
type: integer
example: 8
d20:
type: integer
example: 6
weight:
type: object
properties:
d4:
type: integer
example: 300
d6:
type: integer
example: 300
d8:
type: integer
example: 340
d10:
type: integer
example: 350
d10x:
type: integer
example: 350
d12:
type: integer
example: 350
d20:
type: integer
example: 400
sizes:
type: object
properties:
d4:
type: integer
example: 1
d6:
type: integer
example: 1
d8:
type: integer
example: 1
d10:
type: integer
example: 1
d10x:
type: integer
example: 1
d12:
type: integer
example: 1
d20:
type: integer
example: 1
sounds:
type: array
example:
-
src: 'https://dddice.com/sounds/roll-1.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-2.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-3.mp3'
'on': die.collide
-
src: 'https://dddice.com/sounds/roll-loading-sm.mp3'
'on': roll.loading
value: 2
-
src: 'https://dddice.com/sounds/roll-loading-lg.mp3'
'on': roll.loading
value: '>=3'
items:
type: object
properties:
src:
type: string
example: 'https://dddice.com/sounds/roll-1.mp3'
'on':
type: string
example: die.collide
uniforms:
type: object
properties:
number:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.424
r:
type: number
example: 0.463
diffuse:
type: object
properties:
type:
type: string
example: color
value:
type: object
properties:
b:
type: integer
example: 0
g:
type: number
example: 0.929
r:
type: integer
example: 1
values:
type: object
properties:
d4:
type: array
example:
- 1
- 2
- 3
- 4
items:
type: integer
d6:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
items:
type: integer
d8:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
items:
type: integer
d10:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
items:
type: integer
d12:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
items:
type: integer
d20:
type: array
example:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
items:
type: integer
d10x:
type: array
example:
- 10
- 20
- 30
- 40
- 50
- 60
- 70
- 80
- 90
- 0
items:
type: integer
id:
type: string
example: beatae_saepe
name:
type: string
example: Ms.
label:
type: object
properties:
color:
type: string
example: '#000000'
background_color:
type: string
example: '#e3d12d'
version:
type: string
example: 1.0.0
textures:
type: array
example:
-
src:
d4: u_numberMap.png
d6: u_numberMap.png
d8: u_numberMap.png
d10: u_numberMap.png
d12: u_numberMap.png
d20: u_numberMap.png
d10x: u_numberMap_d10x.png
binding: u_numberMap
items:
type: object
properties:
src:
type: object
properties:
d4:
type: string
example: u_numberMap.png
d6:
type: string
example: u_numberMap.png
d8:
type: string
example: u_numberMap.png
d10:
type: string
example: u_numberMap.png
d12:
type: string
example: u_numberMap.png
d20:
type: string
example: u_numberMap.png
d10x:
type: string
example: u_numberMap_d10x.png
binding:
type: string
example: u_numberMap
api_version:
type: string
example: '1.0'
description:
type: string
example: 'Qui natus id aut numquam. Quis in et rerum molestiae. Ex voluptas repudiandae dolorum quia aliquam aut. Harum laboriosam occaecati corrupti.'
user:
type: object
properties:
username:
type: string
example: corrupti_exercitationem
uuid:
type: string
example: 0f4730ef-c7de-11ed-9829-00224849bf5e
name:
type: string
example: 'Prof. Yesenia Powlowski'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
created_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
updated_at:
type: string
example: '2023-03-21T11:46:47.000000Z'
tags:
- 'Dice Box'
delete:
summary: 'Delete Dice Box Theme'
operationId: deleteDiceBoxTheme
description: "\n\nDelete a share request which will invalidate any shared URLs"
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
tags:
- 'Dice Box'
parameters:
-
in: path
name: slug
description: 'The slug of the dice box.'
example: impedit
required: true
schema:
type: string
-
in: path
name: id
description: 'The ID of the theme.'
example: dddice-standard
required: true
schema:
type: string
tags:
-
name: Theme
description: "\nAPI for managing themes."
-
name: Room
description: "\nAPI for managing rooms."
-
name: Roll
description: "\nAPI for creating and managing dice rolls."
-
name: 'Share Dice'
description: "\nAPI for managing share requests."
-
name: User
description: "\nAPI for managing users."
-
name: 'Dice Box'
description: "\nAPI for managing themes in your **Digital Dice Box**."
components:
securitySchemes:
default:
type: http
scheme: bearer
description: ''
security:
-
default: []