Skip to main content

Overview

The Segmind Banner Generation API generates a banner image by first creating a text prompt using the existing Banner Prompt Generator, then submitting it to Segmind’s API for image generation. It offers two options: a banner with a logo or a banner without a logo. The process concludes with polling for the final image URL, making this tool ideal for creating professional, web3-themed banners for businesses.

API Endpoints

  • Prompt Generation:
    • URL: https://text-tad.droplinked.workers.dev/
    • Method: POST
  • Segmind Workflow Submission:
    • With Logo: https://api.segmind.com/workflows/67792f3899c1698a193130be-v2
    • Without Logo: https://api.segmind.com/workflows/67d66d953fccc7a19c84cfa1-v1
    • Method: POST
  • Segmind Polling:
    • URL: https://api.segmind.com/workflows/request/[request_id]
    • Method: GET
  • Content-Type: application/json

Authentication

This API requires two API keys:
  1. For Prompt Generation (via text-tad.droplinked.workers.dev):
    • Header: api-key
    • Value: <YOUR_API_KEY> (provided by Droplinked).
  2. For Segmind API (via api.segmind.com):
    • Header: x-api-key
    • Value: <YOUR_SEGMIND_API_KEY> (your Segmind account API key).
Contact Droplinked support at support@droplinked.com to obtain these API keys.

Request Format

The process involves three steps:

Step 1: Generate Banner Prompt

This step uses the existing Banner Prompt Generator API to create a text prompt. Request Body Example Request Body
Response A JSON object containing the generated prompt. Example Response

Step 2: Submit to Segmind Workflow

Submit the generated prompt to Segmind’s API to start banner generation. There are two options: with a logo or without a logo. Option 1: Banner With Logo Request Body Example Request Body
Endpoint
  • URL: https://api.segmind.com/workflows/67792f3899c1698a193130be-v2
Option 2: Banner Without Logo Request Body Example Request Body
Endpoint
  • URL: https://api.segmind.com/workflows/67d66d953fccc7a19c84cfa1-v1
Response (Both Options) A JSON object with a polling URL and request ID. Example Response

Step 3: Poll for Final Image URL

Use the poll_url from Step 2 to check the status and retrieve the final image URL. Request
  • Method: GET
  • URL: The poll_url from the Step 2 response (e.g., https://api.segmind.com/workflows/request/68fe486045f6afa20e521094f20192ab).
  • Headers: Include the Segmind API key (x-api-key).
Response A JSON object with the status and final image URL once completed. Example Response

JavaScript Example

Below is an example of how to use the Segmind Banner Generation API in JavaScript with the fetch API, supporting both banner options:

Error Handling

  • Prompt Generation Errors:
    • Invalid API Key: Returns “Unauthorized”.
    • Missing Fields: If command_name, description, or category is missing, an error may occur.
  • Segmind Submission Errors:
    • 401 Unauthorized: If the Segmind API key is invalid.
    • 400 Bad Request: If input_description or input_seed is missing (or input_logo for the “With Logo” option).
  • Polling Errors:
    • 404 Not Found: If the request_id is invalid.
    • 503 Service Unavailable: If Segmind is down.

Example Error Output (Segmind Submission)

Best Practices

  1. Input Quality: Provide a detailed description and relevant category for optimal banner prompts.
  2. Logo URL: For the “With Logo” option, ensure the input_logo URL is accessible and points to a valid image.
  3. Polling Strategy: Use a reasonable polling interval (e.g., 5-10 seconds) to avoid overloading the Segmind API.
  4. Error Handling: Implement retry logic for polling to handle transient failures.

Support

For assistance or to request API keys (for either the prompt generation or Segmind API), contact Droplinked support at support@droplinked.com. Provide details such as your use case and expected request volume.