blob: 8eedca0c3fdd457140dc7d7953e774914585c512 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# Jellything Rust API
For making your own applications that implement client functionality, use the
`jellyclient` crate. The `jellycommon` crate exposes commonly used structs like
those used in the library and for jhls.
## Generated Documentation
- [jellything](/doc/jellything/)
- [jellycommon](/doc/jellycommon/)
- [jellyremuxer](/doc/jellyremuxer/)
- [jellytranscode](/doc/jellytranscode/)
- [jellyimport](/doc/jellyimport/)
- [jellymatroska](/doc/jellymatroska/)
- [ebml_derive](/doc/ebml_derive/)
- [jellybase](/doc/jellybase/)
- [jellystream](/doc/jellystream/)
- [jellytool](/doc/jellytool/)
# Jellything HTTP API
Most endpoints require the `Accept` header to be present and set to
`application/json` and `image/avif` respectively. Any endpoint returning JSON,
will report errors with an object containing error string in the `error` key.
Routes marked with `*` require authentification.
The `jellyclient` crate already implements most API functionality. The
`jellycommon` crate provides useful structs for deserializing data (also
reexported in jellyclient).
```toml
# Cargo.toml
[depedencies]
jellyclient = { git = "https://codeberg.org/metamuffin/jellything.git" }
```
## General
### GET `/api/version`
Returns API version number.
### POST `/api/create_session`
Request body contains JSON with keys `username`, `password`, `expire` (in
seconds) and `drop_permissions` (a list of permissions, that this session cannot
use). The Response contains the session cookie as a string in JSON.
### GET* `/n/<id>`
Request a library node (either a directory or item). Returns it as `NodePublic`.
### GET* `/n/<id>/extended`
Request extended informationf for library node. Returns it as `ExtendedNode`.
## Assets
All asset endpoints redirect to the asset that you need. Returned images are
coded with AVIF. The `width` parameter is the width of the resolution you want
to image to be.
> [!WARNING] The actual returned resolution must not be exactly what you
> requested.
### GET* `/n/<id>/asset?<role>&<width>`
Where `role` is one of `backdrop` or `poster` and
### GET* `/n/<id>/thumbnail?<t>&<width>`
Returns a single frame from some track video of the media at a given time `t`.
### GET* `/n/<id>/person/<index>/asset?<group>&<width>`
Returns headshot of a person from that node.
## Stream
### GET* `/stream/<id>?<format>&<index>&<profile>&<index>&<tracks>&<webm>`
Responds with the stream directly or a redirect to the actual source in case of
federation.
|
