API Usage Guide

Overview

This API provides a simple endpoint to retrieve the dominant color of an image using the Vibrant library. Follow the instructions below to integrate this API into your projects using Node.js and cURL.

Endpoints

Get Dominant Color

Endpoint: /getDominantColor
Method: POST
Request Body: JSON
- imageUrl (string): URL of the image for which you want to determine the dominant color.

Usage

Node.js

const axios = require('axios');

const apiUrl = 'https://imageapi-ten.vercel.app/getDominantColor';
const imageUrl = 'https://example.com/image.jpg';

axios.post(apiUrl, { imageUrl })
  .then(response => {
    const dominantColor = response.data.dominantColor;
    console.log(`Dominant Color: ${dominantColor}`);
  })
  .catch(error => {
    console.error('Error:', error.message || error);
  });

Python

import requests

api_url = "https://imageapi-ten.vercel.app/getDominantColor"
image_url = "https://example.com/image.jpg"

response = requests.post(api_url, json={"imageUrl": image_url})
result = response.json()

dominant_color = result.get("dominantColor")
print(f"Dominant Color: {dominant_color}")

Curl

curl -X POST -H "Content-Type: application/json" -d '{"imageUrl": "https://example.com/image.jpg"}' https://imageapi-ten.vercel.app/getDominantColor

API Installation

Prerequisites

Ensure you have Node.js installed on your machine. If not, you can download it from Node.js website.

Installation Steps

Clone the repository:

git clone https://github.com/markbosire/imageapi.git

Navigate to the project directory:
```
cd repo
```
Install Node.js modules:
```
npm install
```
Run the App
```
node index.js
```