API Documentation

Get Keywords API

The Get Keywords API endpoint allows you to extract keywords from images using our advanced AI-powered service.

Endpoint

POST /api/getkeywords

Authentication

Authentication is required using a userToken in the request body. You can find your userToken in the Settings page.

Request Body

The request body should be in JSON format with the following structure:

{ "images": [ { "filename": "string",
            "base64": "string", "isTransparent": boolean } ], "email": "string",
            "userToken": "string" }

Parameters:

images - Array of image objects containing:
- filename - Name of the image file
- base64 - Base64 encoded image data
- isTransparent - Boolean indicating if image has transparency
email - User's email address
userToken - Authentication token

Example Request

{ "images": [ { "filename": "dvigjr.jpg",
            "base64": "/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1...",
            "isTransparent": false } ], "email": "[email protected]",
            "userToken": "ABCDEFGHIJKLMNOPQRSTUVWXYZ" }

Response

The API returns a JSON response containing the extracted keywords and metadata.

{ "success": true, "keywords": [ "nature",
            "landscape", "mountain", "sky", ... ], "metadata": {
            "categories": "Business", "tokensUsed": 789 } }

Error Handling

In case of errors, the API will return an error response:

{ "success": false, "error": "Error message
            description", "code": "ERROR_CODE" }

Common Error Codes:

INVALID_TOKEN - Authentication token is invalid or expired
INVALID_IMAGE - Image data is corrupted or in wrong format
RATE_LIMIT_EXCEEDED - Too many requests