Playground API

Introduction

The Playground API is designed for generating easily sharable, public URLs to view the solutions generated by various NextBillion.ai services. Users can choose the NextBillion service to be used to generate a solution and also the duration for which the solution remains available publicly. A publicly shareable URL linked to the solution is returned in the response after a valid request is submitted. The shareable URL opens up the NB Cloud Console API Playground view with the solution which then can be modified within it.

Use the following method to generate a shareable URL to an NextBillion solution:

GET

https://api.nextbillion.io/playground/share?key=<your_api_key>

Request Parameter

Response Body

API Query Limits

NextBillion.ai allows a maximum rate limit of 6000 queries per minute or 100 queries/second for continuous requests.

Note: We can increase the quota if needed, on request. Contact [email protected] for more details.

API Error Codes

Response Code	Description	Additional Notes
200	Normal success case.	Normal success case.
400	Input validation failed.	There is a missing or an invalid parameter or a parameter with an invalid value type is added to the request.
401	APIKEY not supplied or invalid.	This error occurs when the wrong API key is passed in the request or the key is missing altogether.
403	APIKEY is valid but does not have access to requested resources.	You might be querying for a geographical region which is not valid for your account or requesting a service which is not enabled for you.
404	Requested host/path not found.	This error occurs when a malformed hostname is used.
413	Request entity too large	This error is caused when the length of input request URI or the request body is too large. Please modify the request. Reach out to [email protected] if the issue still persists.
422	Could not process the request.	The request could not be completed for the given set of locations or parameter configuration.
429	Too many requests.	QPM reached or API request count quota reached.
500	Internal Service error.	There was an internal issue with NextBillion.ai services. You can reach out to [email protected] for an explanation.