APIドキュメント

作成 : だいちまる

このページをみてくださりありがとうございます！
APIドキュメントです！
まだ実装されていないAPIも今後は追加予定です。

注意

v1.3.4からの仕様変更されたAPI(bot-api)はv1.4.0にて廃止されました。

警告

uwuzu v1.6.0以降のuwuzuが対象です！

警告

必ず「このAPIは以下のリンクより使用が可能です。」にあるURLに従って使用してください！
少しでも異なるURLにするとエラーなど正常に使用できないおそれがございます。

serverinfo-api

GET

POST

なし

このAPIは以下のリンクより使用が可能です。
サーバー情報を取得できます。

https://{domain}/api/serverinfo-api

必須パラメータ

none

サンプル

{
  "server_info": {
    "server_name": "新規さば",
    "server_icon": "https://uwuzu.example.com/img/uwuzu_icon.png",
    "server_description": "ようこそ新規さばへ！etc...",
    "adminstor": {
      "name": "あどみん",
      "email": "admin@uwuzu.example.com"
    },
    "terms_url": "https://uwuzu.example.com/rule/terms",
    "privacy_policy_url": "https://uwuzu.example.com/rule/privacypolicy",
    "max_ueuse_length": 1024,
    "invitation_code": false,
    "account_migration": true,
    "usage": {
      "users": 120,
      "ueuse": 5000
    }
  },
  "software": {
    "name": "uwuzu",
    "version": "1.3.6",
    "repository": "https://github.com/Daichimarukana/uwuzu"
  },
  "server_notice": [
    {
      "title": "お知らせ！",
      "note": "サービスを開始しました！",
      "editor": "admin",
      "datetime": "2024-03-29 14:35:06"
    }
  ]
}

me

GET

POST

read:me

このAPIは以下のリンクより使用が可能です。
自分のユーザー情報を取得できます。
メールアドレスなど一部の情報は取得できません。

https://{domain}/api/me/

必須パラメータ

?token={token}
or
{
  "token":{token}
}

サンプル

{
  "username": "あどみん",
  "userid": "admin",
  "profile": "あどみんです！",
  "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "user_header": https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "registered_date": "2024-03-09 02:19:04",
  "followee": [
    "test1",
    "tester"
  ],
  "followee_cnt": 2,
  "follower": [],
  "follower_cnt": 0,
  "ueuse_cnt": 38,
  "isBot": false,
  "isAdmin": true,
  "role": [
    {
      "name": "ゆーざー",
      "color": "CCCCCC",
      "effect": "none",
      "id": "user"
    }
  ],
  "language": "ja-JP"
}

me/notification

GET

POST

read:notifications

このAPIは以下のリンクより使用が可能です。
自分宛の通知を取得できます。
valueid欄は、通知に紐づけられているユーズのIDや、その他通知に他のデータを紐付ける際に使用されます。

https://{domain}/api/me/notification/

必須パラメータ

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

{
  "0": {
    "from": {
      "username": "tester",
      "userid": "tester",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png"
    },
    "category": "reply",
    "title": "testerさんが返信しました！",
    "text": "test1",
    "datetime": "2025-08-02 18:12:29",
    "valueid": "5zfg8iqtnpcj",
    "is_checked": true
  },
  "1": {
    "from": {
      "username": "tester",
      "userid": "tester",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png"
    },
    "category": "reply",
    "title": "testerさんが返信しました！",
    "text": "test2",
    "datetime": "2025-08-02 18:12:27",
    "valueid": "1pekdvjyeg8er",
    "is_checked": true
  },
  "success": true
}

me/notification/read

GET

POST

write:notifications

このAPIは以下のリンクより使用が可能です。
自分宛の通知を一括既読できます。

https://{domain}/api/me/notification/read

必須パラメータ

?token={token}
or
{
  "token":{token}
}

サンプル

{
  "success": true
}

me/settings

GET

POST

write:me

このAPIは以下のリンクより使用が可能です。
重要な情報以外の自分のアカウント設定を変更できます。

https://{domain}/api/me/settings/

必須パラメータ(オプションパラメータをどれか一つ以上含めてください)

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&username={username}&profile={profile}
or
{
  "username":{username},
  "profile":{profile},
  "icon":{Base64_Encode_Image},
  "header":{Base64_Encode_Image}
}

サンプル

{
  "success": true
}

users

GET

POST

read:users

このAPIは以下のリンクより使用が可能です。
自分以外のユーザー情報を取得できます。

https://{domain}/api/users/

必須パラメータ

?token={token}&userid={userid}
or
{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "username": "あどみん",
  "userid": "admin",
  "profile": "あどみんです！",
  "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "user_header": https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "registered_date": "2024-03-09 02:19:04",
  "followee": [
    "test1",
    "tester"
  ],
  "followee_cnt": 2,
  "follower": [
    "test1",
  ],
  "follower_cnt": 1,
  "ueuse_cnt": 38,
  "isBot": false,
  "isAdmin": true,
  "role": [
    {
      "name": "ゆーざー",
      "color": "CCCCCC",
      "effect": "none",
      "id": "user"
    }
  ],
  "online_status": "Offline",
  "language": "ja-JP"
}

users/follow

GET

POST

write:follow

このAPIは以下のリンクより使用が可能です。
自分以外のユーザーをフォローできます。

https://{domain}/api/users/follow

必須パラメータ

?token={token}&userid={userid}
or
{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "userid":"admin"
  "success":true
}

users/unfollow

GET

POST

write:follow

このAPIは以下のリンクより使用が可能です。
自分以外のユーザーのフォローを解除できます。

https://{domain}/api/users/unfollow

必須パラメータ

?token={token}&userid={userid}
or
{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "userid":"admin",
  "success":true
}

ueuse

GET

POST

read:ueuse

このAPIは以下のリンクより使用が可能です。
必須パラメータのみ指定の場合直近25件のユーズを取得します。
limitを100件以上にすることはできません。 pageは次のX件を取得します。

https://{domain}/api/ueuse/

必須パラメータ

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tzv",
    "relpyid": "",
    "reuseid": "",
    "text": "Test\nTest",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin",
      "test1"
    ],
    "favorite_cnt": "2",
    "datetime": "2024-04-19 20:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/get

GET

POST

read:ueuse

このAPIは以下のリンクより使用が可能です。
特定の投稿を一つだけ取得します。(単一の投稿を取得します。)

https://{domain}/api/ueuse/get

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tzv",
    "relpyid": "",
    "reuseid": "",
    "text": "Test\nTest",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin",
      "test1"
    ],
    "favorite_cnt": "2",
    "datetime": "2024-04-19 20:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/replies

GET

POST

read:ueuse

このAPIは以下のリンクより使用が可能です。
特定の投稿とそれにされた返信を取得します。帰ってきたjsonの一番上の投稿がuniqidにて指定したものになります。オプションパラメータで取得する数とページを指定できます。一度に取得できる最大数は100件です。

https://{domain}/api/ueuse/replies

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tzv",
    "relpyid": "",
    "reuseid": "",
    "text": "Test\nTest",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin",
      "test1"
    ],
    "favorite_cnt": "2",
    "datetime": "2024-04-19 20:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  },
  {
    "uniqid": "1vgsg0v3tzb",
    "relpyid": "",
    "reuseid": "",
    "text": "***Nice***",
    "account": {
      "username": "あどみん2",
      "userid": "admin2",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "admin"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 20:33:14",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/mentions

GET

POST

read:ueuse

注意

v1.6.0以前と以後で仕様が異なっており、v1.6.0以前に行われたメンションは取得できません。
使用方法は同じです。

このAPIは以下のリンクより使用が可能です。
自分のメンションされた投稿を取得します。

https://{domain}/api/ueuse/mentions

必須パラメータ

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgsg0v3tfv",
    "relpyid": "",
    "reuseid": "",
    "text": "@admin",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "test1"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 10:33:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/search

GET

POST

read:ueuse

このAPIは以下のリンクより使用が可能です。
keywordに入れた言葉をすべての投稿の中から検索してマッチしたものを返します。

https://{domain}/api/ueuse/search

必須パラメータ

?token={token}&keyword={keyword}
or
{
  "token":{token},
  "keyword":{keyword}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgs00v3tfv",
    "relpyid": "",
    "reuseid": "",
    "text": "検索",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "test1"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 10:34:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

ueuse/create

GET

POST

write:ueuse

このAPIは以下のリンクより使用が可能です。
このAPIを使用すると新たに投稿をすることができます。

https://{domain}/api/ueuse/create

必須パラメータ

?token={token}&text={text}
or
{
  "token":{token},
  "text":{text}
}

オプションパラメータ
画像の投稿はJSONでPOSTリクエストした際のみ利用できます。
画像はBase64にエンコードして送信する必要があります。
replyidにリプライ先IDを入れることで返信を送信できます。

&nsfw={true/false}&replyid={返信先id}&reuseid={リユーズ先id}
or
{
  "nsfw":{true/false},
  "image1":{Base64_Encode_Image},
  "image2":{Base64_Encode_Image},
  "image3":{Base64_Encode_Image},
  "image4":{Base64_Encode_Image},
  "replyid":{Uniqid},
  "reuseid":{Uniqid}
}

サンプル

{
  "uniqid": "qy0lwn9orf",
  "userid": "admin"
}

ueuse/delete

GET

POST

write:ueuse

このAPIは以下のリンクより使用が可能です。
投稿の削除が可能です。

https://{domain}/api/ueuse/delete

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

サンプル
エラーが発生した場合にsuccessがfalseになる場合があります。

{
  "uniqid": "qy0lwn9orf",
  "userid": "admin",
  "success":true
}

ueuse/bookmark

GET

POST

read:bookmark

このAPIは以下のリンクより使用が可能です。
ログインしているユーザーのブックマークを取得できます。

https://{domain}/api/ueuse/bookmark/

必須パラメータ

?token={token}
or
{
  "token":{token}
}

オプションパラメータ

&limit={limit}&page={page}
or
{
  "limit":{limit},
  "page":{page}
}

サンプル

[
  {
    "uniqid": "1vgs00v3tfv",
    "relpyid": "",
    "reuseid": "",
    "text": "ブックマーク",
    "account": {
      "username": "あどみん",
      "userid": "admin",
      "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
      "user_header": "https://uwuzu.example.com/userheads/XXXXXXXXXX-XXXXX.png",
      "is_bot": false,
    },
    "photo1": "none",
    "photo2": "none",
    "photo3": "none",
    "photo4": "none",
    "video1": "none",
    "favorite": [
      "tester"
    ],
    "favorite_cnt": "1",
    "datetime": "2024-04-19 10:34:13",
    "abi": "none",
    "abidatetime": "0000-00-00 00:00:00",
    "nsfw": false
  }
]

favorite/change

GET

POST

write:favorite

このAPIは以下のリンクより使用が可能です。
いいねを追加・削除できます。 favorite_listには追加・削除後の最新のいいねのデータが入ります。

https://{domain}/api/farovite/change

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

サンプル

{
  "favorite_list": ",admin",
  "success": true
}

favorite/get

GET

POST

read:ueuse

このAPIは以下のリンクより使用が可能です。
いいねの情報を取得できます favorite_listには最新のいいねのデータが入ります。

https://{domain}/api/farovite/get

必須パラメータ

?token={token}&uniqid={uniqid}
or
{
  "token":{token},
  "uniqid":{uniqid}
}

サンプル

{
  "favorite_list": ",admin",
  "success": true
}

token/get

GET

POST

なし

このAPIは以下のリンクより使用が可能です。
APIアクセストークンを1回だけ取得できます。

https://{domain}/api/token/get

必須パラメータ

?session={sessionid}
or
{
  "session":{sessionid}
}

サンプル

{
  "success": true,
  "username": "あどみん",
  "userid": "admin",
  "token": "LLOC2lHPVoPqCqKWmvbdcdo9DmAHyySpBwqxseohtYilob85A8g9Ebd9m9UbERw9"
}

admin/users

POST

read:admin:users

このAPIは以下のリンクより使用が可能です。
重要な情報を含めたユーザーの情報の取得が可能です。
取得にはAPIトークンの所有者が管理者アカウントである必要があります。

https://{domain}/api/admin/users/

必須パラメータ

{
  "token":{token},
  "userid":{userid}
}

サンプル

{
  "success": true,
  "username": "あどみぬ",
  "userid": "admin",
  "profile": "あどみんです！",
  "user_icon": "https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "user_header": https://uwuzu.example.com/usericons/XXXXXXXXXX-XXXXX.png",
  "registered_date": "2024-03-09 02:19:04",
  "followee": [
    "test1",
    "tester"
  ],
  "followee_cnt": 2,
  "follower": [],
  "follower_cnt": 0,
  "ueuse_cnt": 38,
  "isBot": false,
  "isAdmin": true,
  "role": [
    {
      "name": "公式",
      "color": "CCCCCC",
      "effect": "none",
      "id": "official"
    }
  ],
  "online_status": "Online",
  "real_online_status": "Online",
  "last_login_datetime": "2025-12-30 02:28:03",
  "last_login_ipaddress": "192.168.1.1",
  "mailaddress": "test@example.com",
  "is_2fa_configured": true,
  "language": "ja-JP"
}

admin/users/sanction

POST

write:admin:user-sanction

このAPIは以下のリンクより使用が可能です。
ユーザーへの通知の送信・アカウントの凍結・凍結解除・BANが可能です。
取得にはAPIトークンの所有者が管理者アカウントである必要があります。

https://{domain}/api/admin/users/sanction

必須パラメータ

{
  "token":{token},
  "userid":{userid},
  "type": {"notification/frozen/unfrozen/ban"},
  "notification_title": {notification_title}, //typeがnotificationの場合のみ
  "notification_message": {notification_message}, //typeがnotification・frozenの場合のみ
  "really": {2fa_code/"yes_i_will_delete_[userid]"}, //banの場合のみ。管理者アカウントで2段階認証が有効な場合は2段階認証コード、無効な場合は大文字小文字まで正確に「yes_i_will_delete_[userid]」
}

サンプル

{
  "success":true,
  "userid":"admin"
}

admin/reports

POST

read:admin:reports

このAPIは以下のリンクより使用が可能です。
通報情報の取得が可能です。
取得にはAPIトークンの所有者が管理者アカウントである必要があります。

https://{domain}/api/admin/reports/

必須パラメータ

{
  "token":{token}
}

オプションパラメータ

{
  "limit":{limit},
  "page":{page}
}

サンプル

{
  "success": true,
  "data": [
    {
      "reported_userid": "admin",
      "total_count": 1,
      "details": [
        {
          "uniqid": "1v4pzm2slpfmf",
          "reporter_userid": "admin",
          "message": "test",
          "datetime": "2025-12-30 02:48:29"
        }
      ]
    }
  ]
}

admin/reports/resolve

POST

write:admin:reports

このAPIは以下のリンクより使用が可能です。
通報の解決が可能です。
取得にはAPIトークンの所有者が管理者アカウントである必要があります。

https://{domain}/api/admin/reports/resolve

必須パラメータ

{
  "token":{token},
  "reported_userid":{reported_userid}, //まとめて解決する場合
  "uniqid":{uniqid}, //個別に解決する場合
}

サンプル

{
  "success":true,
  "reported_userid":"admin"
}

2025/12/30(最終更新)

serverinfo-api​

me​

me/notification​

me/notification/read​

me/settings​

users​

users/follow​

users/unfollow​

ueuse​

ueuse/get​

ueuse/replies​

ueuse/mentions​

ueuse/search​

ueuse/create​

ueuse/delete​

ueuse/bookmark​

favorite/change​

favorite/get​

token/get​

admin/users​

admin/users/sanction​

admin/reports​

admin/reports/resolve​

serverinfo-api

me

me/notification

me/notification/read

me/settings

users

users/follow

users/unfollow

ueuse

ueuse/get

ueuse/replies

ueuse/mentions

ueuse/search

ueuse/create

ueuse/delete

ueuse/bookmark

favorite/change

favorite/get

token/get

admin/users

admin/users/sanction

admin/reports

admin/reports/resolve