API Endpoint
- URL:
https://image-cap.droplinked.workers.dev/ - Method:
POST - Content-Type:
application/json
Authentication
Access to the API requires an API key. Contact Droplinked support to obtain your API key. Include it in the request headers as follows:- Header:
api-key - Value:
<YOUR_API_KEY>(provided by Droplinked)
Request Format
The API accepts a JSON payload with the following fields:Request Body
| Field | Type | Required | Description |
|---|---|---|---|
command_name | String | Yes | Must be set to "title_from_image" for this functionality. |
imageUrl | String | Yes | URL of the product image to analyze and generate a title from. |
Example Request Body
Response Format
- Content-Type:
text/plain - Response: A single-line string representing the generated product title, with no quotes, punctuation, or additional text.
Example Response
Guidelines for Generated Titles
The API follows these strict rules when generating titles:- Mode: Operates in
GENERATE_TITLE_MODE: TRUE, transforming visual descriptions into titles. - Input: Expects a product visual description derived from the image (processed internally).
- Output: Produces a single-line title only, with:
- Maximum 60 characters.
- Brand name (if identified in the image).
- Exact color and pattern as described.
- Product type included.
- Format:
- No quotes or punctuation at the end.
- Concise and precise, matching the exact product depicted.
- Restrictions:
- No conversational text, questions, or explanations.
- No additional formatting beyond the title itself.
Example Transformation
- Visual Description: “Champion brand hoodie in mulled berry red with tie-dye pattern, featuring front pocket and drawstring hood”
- Output Title:
Champion Mulled Berry Tie-Dye Pullover Hoodie
JavaScript Example
Below is an example of how to use the Image-to-Title Generator API in JavaScript with thefetch API:
Error Handling
- Invalid API Key: Returns an error message (e.g., “Unauthorized”).
- Missing Fields: If
command_nameorimageUrlis missing, the API may return an error or fail silently. - Invalid Image URL: If the URL is inaccessible or invalid, an error may occur.
- Network Issues: Handle errors in the
.catchblock of thefetchcall.
Example Error Output
Best Practices
- Image Quality: Use clear, high-quality images for accurate visual description extraction.
- URL Accessibility: Ensure the
imageUrlis publicly accessible or properly authenticated. - Consistency: Test with various product images to ensure title accuracy aligns with your catalog.
- SEO Optimization: The generated titles are inherently SEO-friendly due to precise keywords.