Pixela API Document

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

GET - /v1/users/<username>/graphs/<graphID>/analyze

Description

The AI analyzes the Pixel posted to the graph specified by <graphID> and responds with the results in a string of up to approximately 1000 characters.

Please pay attention to the following points.

  • The analysis will cover Pixel posts from the last year.
  • You cannot use this API if any of the following apply.
  • The AI analysis results are reset once a day.
  • The language of the analysis results is determined based on the timezone setting configured in Graph.
  • You can obtain better analysis results by setting the description for the Graph.

Help page

Graph - Pixela Help Center

HTTP Method , API endpoint

GET /v1/users/<username>/graphs/<graphID>/analyze

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.
    • This error will also be returned if allowAIProcessing is not set to true for your User, or if the number of Pixels posted in the last year is less than 30.
  • 402 Payment Required
    • This error is returned if you are not a Pixela Supporter. Only Pixela Supporters can use this API.
  • 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.
  • 500 Internal Server Error
    • Status in the event of an unexpected error. Retrying the request may be successfully processed.
  • 503 Service Unavailable
    • This error occurs when Pixela is temporarily unavailable. Please take a moment and retry your request.

Example

$ curl -X GET https://pixe.la/v1/users/a-know/graphs/test-graph/analyze
{"isSuccess":true,"analysis":"Here are the analysis results.\n\nThe daily scores are generally concentrated in the positive range, and ...