API Reference

Anthias API v2.0.0 — manage assets, device settings, backups, and integrations over HTTP.

assets

get 0

Responses

0

Array of:

AssetSerializerV2

FieldTypeNotes
0stringread-only
1integer (int64) | null
2string (date-time) | null
3booleanread-only
4boolean
5boolean
6string | null
7string | null
8boolean
9integer (int64)
10boolean
11string (date-time) | null
12string | null
post 0

Request body application/json

Schema: CreateAssetSerializerV2

FieldTypeNotes
0stringread-only
1integer
2string (date-time)
3stringwrite-only
4boolean
5boolean
6string
7string
8boolean
9integer
10boolean
11string (date-time)
12string

Responses

0

Schema: AssetSerializerV2

FieldTypeNotes
0stringread-only
1integer (int64) | null
2string (date-time) | null
3booleanread-only
4boolean
5boolean
6string | null
7string | null
8boolean
9integer (int64)
10boolean
11string (date-time) | null
12string | null
get 1

Parameters

NameInTypeRequired
asset_idpathstringyes

Responses

0

Schema: AssetSerializerV2

FieldTypeNotes
0stringread-only
1integer (int64) | null
2string (date-time) | null
3booleanread-only
4boolean
5boolean
6string | null
7string | null
8boolean
9integer (int64)
10boolean
11string (date-time) | null
12string | null
put 1

Parameters

NameInTypeRequired
asset_idpathstringyes

Request body application/json

Schema: UpdateAssetSerializerV2

FieldTypeNotes
0integer
1string (date-time)
2boolean
3boolean
4string
5boolean
6integer
7boolean
8string (date-time)

Responses

0

Schema: AssetSerializerV2

FieldTypeNotes
0stringread-only
1integer (int64) | null
2string (date-time) | null
3booleanread-only
4boolean
5boolean
6string | null
7string | null
8boolean
9integer (int64)
10boolean
11string (date-time) | null
12string | null
patch 1

Parameters

NameInTypeRequired
asset_idpathstringyes

Request body application/json

Schema: PatchedUpdateAssetSerializerV2

FieldTypeNotes
0integer
1string (date-time)
2boolean
3boolean
4string
5boolean
6integer
7boolean
8string (date-time)

Responses

0

Schema: AssetSerializerV2

FieldTypeNotes
0stringread-only
1integer (int64) | null
2string (date-time) | null
3booleanread-only
4boolean
5boolean
6string | null
7string | null
8boolean
9integer (int64)
10boolean
11string (date-time) | null
12string | null
delete 1

Parameters

NameInTypeRequired
asset_idpathstringyes

Responses

0 No response body
get 2

The content of the asset. `type` can either be `file` or `url`. In case of a file, the fields `mimetype`, `filename`, and `content` will be present. In case of a URL, the field `url` will be present.

Parameters

NameInTypeRequired
asset_idpathstringyes

Responses

0
FieldTypeNotes
0string
1string
2string
3string
4string
get 3

Use any of the following commands to control asset playback: * `next` - Show the next asset * `previous` - Show the previous asset * `asset&{asset_id}` - Show the asset with the specified `asset_id`

Parameters

NameInTypeRequired
commandpathstringyes

Responses

0

string

post 4

Request body application/json

Schema: PlaylistOrderSerializerMixin

FieldTypeNotes
0stringComma-separated list of asset IDs in the order they should be played. For example: `793406aa1fd34b85aa82614004c0e63a,1c5cfa719d1f4a9abae16c983a18903b,9c41068f3b7e452baf4dc3f9b7906595`write-only

Responses

0 No response body

backup

post 5

Create a backup of the current Anthias instance, which includes the following: * current settings * image and video assets * asset metadata (e.g. name, duration, play order, status), which is stored in a SQLite database

Responses

0

string

device settings

get 6

Responses

0

Schema: DeviceSettingsSerializerV2

FieldTypeNotes
0string
1string
2string
3boolean
4boolean
5integer
6integer
7string
8boolean
9boolean
10boolean
11string
patch 6

Request body application/json

Schema: PatchedUpdateDeviceSettingsSerializerV2

FieldTypeNotes
0string
1any
2string
3string
4boolean
5boolean
6integer
7integer
8string
9string
10string
11boolean
12boolean
13boolean
14string

Responses

0
FieldTypeNotes
0string
1
FieldTypeNotes
0string

file asset

post 7

Request body 0

FieldTypeNotes
0string (binary)

Responses

0
FieldTypeNotes
0string
1string

info

get 8

Responses

0
FieldTypeNotes
0string
1string
2[string null]
3string
4string
5string[]
6number
7string
8object
9boolean
10object
11string

integrations

get 9

Responses

0

Schema: IntegrationsSerializerV2

FieldTypeNotes
0string | null
1string | null
2string | null
3string | null
4string | null
5string | null
6boolean

reboot

post 10

Responses

0 No response body

recover

post 11

Recover data from a backup file. The backup file must be a `.tar.gz` file.

Request body 0

FieldTypeNotes
0string (binary)

Responses

0

string

shutdown

post 12

Responses

0 No response body