Pixela API Document

API Document for Pixela ( https://pixe.la/ ) .

POST - /v1/users


Create a new Pixela user.

Help page

User - Pixela Help Center

HTTP Method , API endpoint

POST /v1/users

Request Body

Key Type Description
token string [required] A token string used to authenticate as a user to be created. The token string is hashed and saved.
Validation rule: [ -~]{8,128}
username string [required] User name for this service.
Validation rule: [a-z][a-z0-9-]{1,32}
agreeTermsOfService string [required] Specify yes or no whether you agree to the terms of service.
Please see: Terms of service - Japanese version / Terms of service - English version
notMinor string [required] Specify yes or no as to whether you are not a minor or if you are a minor and you have the parental consent of using this service.
thanksCode string [optional] Set thanks-code . If it is a valid thanks-code, some limited features will be available. For details, please check How to support Pixela by Patreon / Use Limited Features.

Possible errors by HTTP response status code

  • 400 Bad Request
    • This is an error if there is some mistake in your request. Unless the mistake is corrected, the request will not succeed.
  • 403 Forbidden
    • This error occurs when Pixela is unable to process your request due to its terms or specifications.
  • 404 Not Found
    • This error occurs when your request destination does not exist.
    • This error also occurs when authentication to the request destination is not successful.
  • 409 Conflict
    • This error occurs when your request conflicts with something else. Check the message in the response body, and review or retry the request.
  • 500 Internal Server Error
    • Status in the event of an unexpected error. Retrying the request may be successfully processed.


$ curl -X POST https://pixe.la/v1/users -d '{"token":"thisissecret", "username":"a-know", "agreeTermsOfService":"yes", "notMinor":"yes", "thanksCode":"ThisIsThanksCode"}'
{"message":"Success. Let's visit https://pixe.la/@a-know , it is your profile page!","isSuccess":true}