Giter Club home page Giter Club logo

imageapi's Introduction

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

  1. Clone the repository:

    git clone https://github.com/markbosire/imageapi.git
  2. Navigate to the project directory:

    cd repo
  3. Install Node.js modules:

    npm install
  4. Run the App

    node index.js

imageapi's People

Contributors

markbosire avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.