Skip to main content

API reference

The ideate.xyz API can be accessed at: https://ideate.xyz/api

Authentication​

All API requests require authentication using an API key in the following header:

Authorization: Bearer IDEATE_API_KEY

To obtain an API key, create an account at ideate.xyz/login. Your API key can be found in the account settings.

Response Format​

API responses are in JSON format and include these fields:

  • status: The request status code, see table below.
  • data: The response data (for successful requests).
  • error: Error message (for failed requests).

Status codes​

Status Code
Description
200
Success
400
Bad Request
401
Unauthorized
402
Usage Quota Exceeded
404
Not Found
500
Internal Server Error