Introduction to the API

You can use the API to interact with the RBLX/ai service. The API is a RESTful API that allows you to perform various actions, such as generating graphic(s), generating variations, viewing the community images, viewing your images and viewing your current balance.

The API is currently in beta, and is subject to change. We will be adding more endpoints and features as we continue to improve the service.

Endpoints

The API has the following endpoints:

• /api/v1/generate-icon-thumbnail: This endpoint allows you to generate Icons & Thumbnails using the API. You can specify the prompt, and the number of variations you want to generate.

• /api/v1/generate-vector: This endpoint allows you to generate Vectors using the API. You can specify the prompt, and the number of variations you want to generate.

• /api/v1/generate-logo: This endpoint allows you to generate Logos using the API. You can specify the prompt, and the number of variations you want to generate.

• /api/v1/get-image-operation: This endpoint allows you to get the operation of an image. You can specify the operation ID and it will return the status of the operation and the images generated.

• /api/v1/get-balance: This endpoint allows you to check your current credits balance.

• /api/v1/get-community: This endpoint allows you to get the latest graphics generated by the community.

• /api/v1/get-history: This endpoint allows you to get the history of graphics you have generated.

Image Operation

When you call the API to generate a graphic, you will want to poll the operation to check if it is completed. It uses a queue system to generate the graphics so this will be based on a unique ID you can get from the response of the endpoint.

Authentication

To use the API, you will need to authenticate with your account. You can do this by including your API key in the request header.

headers: {
    "x-api-key": "Bearer <your-api-key>"
}

You can find your API key in the API section of the dashboard.

Rate Limiting

We have implemented rate limiting to prevent abuse and ensure that the service remains stable. The rate limit is set to 10 requests per second for the Hobby plan. If you exceed this limit, you will receive a 429 error code. See the following table for the rate limits for each plan:

• Hobby Plan: 10 requests/1s API Limit
• Pro Plan: 60 requests/1s API Limit
• Advanced Plan: 90 requests/1s API Limit

Contact Us

If you have any questions or need assistance with the API, please contact us at [email protected].