summary refs log tree commit diff
path: root/COMMANDS.md
blob: ffd6c2680cffd4ad625af0d586a0d867aa58526e (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
# Commands

> **NOTE**
> This has not been updated with recently added moderation commands!

## `register`
Register an account.

### Required fields
- string `username`: 1-20 characters, a-z0-9-_
- string `password`: 1-255 characters
- string `invite_code`: 16 characters

## `login_pswd`
Log in using a password.

### Required fields
- string `username`: 1-20 characters
- string `password`: 1-255 characters

## `login_token`
Log in using a token.

### Required fields
- string `token`: 32-127 characters

## `get_user`
Get a user's profile.
*Authentication required.*

### Required fields
- string `username`: 1-20 characters

## `set_property`
Set a property of your account, such as your display name or bio.
*Authentication required.*

### Required fields
- string `property`: 1-63 characters
  - Should be a valid property, such as `display_name`, `bio`, `avatar`, or `lastfm`.
- string `value`: 0-2047 characters

## `get_inbox`
Get the inbox.
*Authentication required.*
*No required fields.*

## `get_post`
Get a post by ID.
*Authentication required.*

### Required fields
- string `id`: 8-127 characters

## `post`
Create a post.
*Authentication required.*

### Required fields
- string `content`: 0-3000 characters
- list `replies`: 0-3 items
- list `attachments`: 0-3 items