Skip to content

API Docs

Riku edited this page Mar 11, 2020 · 6 revisions

Nekos.cafe API

The API for nekos.cafe is pretty simple as long as you know how HTTP works.

Basic endpoints

https://nekos.cafe/api/info - GET

This endpoint provides information about the API, such as total files, if invite mode is on, or if admin signups are enabled, this is mainly for the frontend to decide to hide or unhide certain elements as they may not be needed. Example below.

{
  "inviteonly": true,
  "adminreg": false,
  "totalfiles": 63,
  "uploadURL": "https://i.nekos.cafe/"
}

User endpoints

https://nekos.cafe/api/user/info - POST

This endpoint requests the header token which contains the token of the user, it returns the username and the file count associated with the user. Example below.

{
  "username": "Moptop",
  "filecount": 36
}

https://nekos.cafe/api/user/signup - POST

This endpoint lets the user create an account. It requires the headers username, password, and optionally regkey if invite-only mode is enabled. It returns a message which says "Success!". The token is returned at the /api/token/get endpoint.

https://nekos.cafe/api/user/delete - POST

This endpoint deletes the user account, all files associated with the account are purged and all traces are deleted. The endpoint requires the headers username, and password. Token is not used due to security issues. The response should be "This user has been deleted" if the user was successfully purged.

Clone this wiki locally