Color Palette Generator API Documentation

# Use this endpoint to make a GET requests to the API
https://api.apiverve.com/v1/colorpalette
                 

Color Palette is a simple tool for generating color palettes. It returns a list of colors based on a given color input.

To use this API, you need an API key. You can get one by creating an account on apiverve.com and visiting your dashboard.

Important: Ensure that this API is enabled from within your dashboard to use it in your application. If not, you may receive a 403 error

Most of our APIs are also available on and

{
  "status": "ok",
  "error": null,
  "data": {
    "source": "#FF5733",
    "hue": 11,
    "variation": "soft",
    "colorPalette": [
      {
        "hex": "#cc988f",
        "name": "Oriental Pink"
      },
      {
        "hex": "#805f59",
        "name": "Russett"
      },
      {
        "hex": "#e6d2cf",
        "name": "Dust Storm"
      },
      {
        "hex": "#bf6e60",
        "name": "Contessa"
      },
      {
        "hex": "#a2cc8f",
        "name": "Pine Glade"
      },
      {
        "hex": "#658059",
        "name": "Glade Green"
      },
      {
        "hex": "#d6e6cf",
        "name": "Willow Brook"
      },
      {
        "hex": "#7dbf60",
        "name": "Mantis"
      },
      {
        "hex": "#607b89",
        "name": "Lynch"
      },
      {
        "hex": "#597380",
        "name": "Cutty Sark"
      },
      {
        "hex": "#cfdee6",
        "name": "Botticelli"
      },
      {
        "hex": "#60a0bf",
        "name": "Fountain Blue"
      }
    ],
    "colorPaletteRaw": [
      "cc988f",
      "805f59",
      "e6d2cf",
      "bf6e60",
      "a2cc8f",
      "658059",
      "d6e6cf",
      "7dbf60",
      "607b89",
      "597380",
      "cfdee6",
      "60a0bf"
    ]
  },
  "code": 200
}
                

Generate Palette

Token Usage: 1

Generate a color palette from a single color

QUERY PARAMETERS

Field	Type	Description
color	string	(Required) The base color to generate the palette from (e.g., FF5733)
variation	string	The variation of the color palette (e.g., soft, hard, pastel, light, pale)

SAMPLE REQUEST QUERY

curl --request GET \
--url 'https://api.apiverve.com/v1/colorpalette?variation=soft&color=FF5733' \
--header 'x-api-key: YOUR_API_KEY'
                

RESPONSE CONTENT TYPES

The Color Palette Generator API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

Authentication

# Here is a curl example
curl \
-X GET https://api.apiverve.com/v1/colorpalette \
-H 'x-api-key={{YOUR-API-KEY}}' \
-F 'auth=true' \
                

The Color Palette Generator API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

To use any API, you must have it enabled from within your dashboard. Disabled APIs will fail to respond to your requests.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

Error Code	Meaning
401	Your request was made with invalid credentials. This error also appears when you don't pass the x-api-key header in your request.
403	Typically, this occurs when you are trying to access an API that you have not enabled.

Rate Limits

{
    "status": "error",
    "data": null,
    "error": "Rate limit exceeded. Please upgrade your subscription plan."
}
                

Each subscription has its own rate limit. Your limit is based on your subscription plan (free or paid). If you exceed your limits, don't worry. You can always upgrade or downgrade at any time.

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a details JSON.

The Color Palette Generator API uses the following error code:

Error Code	Meaning
429	You have exceeded your rate limit and further requests will be denied until the next cycle.

Errors

For reference, the Color Palette Generator API uses the following error codes:

Error Code	Meaning
Code	Message
200	The request was successful. The response will include the requested data.
400	The request was invalid. The response will include a message that explains the error.
401	The request was not authorized. Usually, this means that the API key is missing or invalid.
403	This means that the request was trying to access a resource that it does not have permission to access.
404	This means that the resource you are trying to access does not exist.
429	This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request.
500	This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible.