Skip to main content

API Endpoint

  • URL: https://text-tad.droplinked.workers.dev/
  • Method: POST
  • Content-Type: application/json

Authentication

To use the API, an API key is required. 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

Example Request Body

Response Format

  • Content-Type: text/plain
  • Response: A plain text string containing the enhanced description, formatted with:
    • 3-5 bullet points using hyphens (-)
    • 1-2 relevant emojis maximum
    • No JSON wrapper, Markdown, or additional explanations

Example Response

Guidelines for Generated Descriptions

The API adheres to these rules:
  1. Direct Output: Only the enhanced description is returned—no JSON, formatting markers, or explanations.
  2. Structure: Descriptions consist of:
    • An introductory sentence (optional, based on input).
    • 3-5 bullet points starting with hyphens (-).
  3. Content:
    • Incorporates SEO keywords derived from the title and description.
    • Uses clear, benefit-driven language tailored to the specified tone.
    • Includes 1-2 relevant emojis maximum.
  4. Restrictions:
    • No JSON syntax or wrappers.
    • No Markdown (e.g., **, #).
    • No technical notes or extraneous text.

JavaScript Example

Below is an example of how to use the Product Description Generator API in JavaScript with the fetch API:

Error Handling

  • Invalid API Key: Returns an error message (e.g., “Unauthorized”).
  • Missing Required Fields: If command_name, title, or tone is missing, the API may return an error or unexpected output.
  • Network Errors: Handle errors in the .catch block of the fetch call.

Example Error Output

Best Practices

  1. Tone Selection: Choose a tone that matches your target audience (e.g., “casual”, “luxury”, “tech-savvy”).
  2. Input Description: Provide an optional description to give the API more context, though it works fine with just a title.
  3. Consistency: Use consistent tones across related products for brand coherence.
  4. Testing: Experiment with different titles and tones to refine the output.

Support

For assistance with the API or to request an API key, contact Droplinked support at support@droplinked.com. Include details like your use case and expected request volume.