API Documentation

Last updated: October 30, 2025

Introduction

Welcome to the Key2Prompt API documentation. This guide will help you integrate Key2Prompt's prompt generation capabilities into your applications and services. Our API is designed to be simple, RESTful, and easy to use.

The Key2Prompt API allows you to programmatically generate prompts based on keywords, enabling automated content generation workflows for your applications.

Authentication

All API requests require authentication using your personal API key. Your API key must be included in the request headers to authenticate your requests.

Getting Your API Key

API Endpoint

The Key2Prompt API is accessible at the following base URL:

Generate Prompt

Generate a prompt based on a keyword or short phrase.

Request Format

The API uses a unique approach where authentication and prompt data are passed through HTTP headers rather than the request body.

Response Format

Successful requests return a JSON object containing the generated prompt.

{
  "success": true,
  "prompt": "Generated prompt text based on your keyword",
  "keyword": "your-keyword",
  "timestamp": "2025-10-30T22:28:27.627Z"
}

Code Examples

Here are examples of how to use the Key2Prompt API in different programming languages:

cURL

curl -X POST https://api.key2prompt.com/api/prompt/generate \
  -H "Content-Type: application/json" \
  -H "APIKey: your-api-key-here" \
  -H "prompt: your keyword or phrase" \
  -d '{}'

JavaScript/Node.js

// Using fetch (Browser/Node.js 18+)
const apiKey = 'your-api-key-here';
const keyword = 'your keyword or phrase';

const response = await fetch('https://api.key2prompt.com/api/prompt/generate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'APIKey': apiKey,
    'prompt': keyword
  },
  body: JSON.stringify({})
});

const data = await response.json();
console.log('Generated prompt:', data.prompt);

// Using axios
const axios = require('axios');

const apiKey = 'your-api-key-here';
const keyword = 'your keyword or phrase';

try {
  const response = await axios.post(
    'https://api.key2prompt.com/api/prompt/generate',
    {},
    {
      headers: {
        'Content-Type': 'application/json',
        'APIKey': apiKey,
        'prompt': keyword
      }
    }
  );
  
  console.log('Generated prompt:', response.data.prompt);
} catch (error) {
  console.error('Error:', error.response?.data || error.message);
}

Python

import requests

api_key = 'your-api-key-here'
keyword = 'your keyword or phrase'

headers = {
    'Content-Type': 'application/json',
    'APIKey': api_key,
    'prompt': keyword
}

response = requests.post(
    'https://api.key2prompt.com/api/prompt/generate',
    headers=headers,
    json={}
)

if response.status_code == 200:
    data = response.json()
    print(f"Generated prompt: {data['prompt']}")
else:
    print(f"Error: {response.status_code} - {response.text}")

PHP

<?php

$apiKey = 'your-api-key-here';
$keyword = 'your keyword or phrase';

$ch = curl_init('https://api.key2prompt.com/api/prompt/generate');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'APIKey: ' . $apiKey,
    'prompt: ' . $keyword
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode === 200) {
    $data = json_decode($response, true);
    echo "Generated prompt: " . $data['prompt'];
} else {
    echo "Error: " . $httpCode . " - " . $response;
}

?>

Rate Limits

API rate limits vary based on your subscription plan:

When you exceed your rate limit, the API will return a 429 (Too Many Requests) status code. Consider implementing exponential backoff in your application to handle rate limiting gracefully.

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

Error Response Format:

{
  "success": false,
  "error": "Error message describing what went wrong",
  "statusCode": 400
}

Best Practices

• Secure Your API Key: Never expose your API key in client-side code or public repositories. Use environment variables or secure configuration management.
• Implement Error Handling: Always handle API errors gracefully and provide meaningful feedback to your users.
• Use HTTPS: Always use HTTPS when making API requests to ensure data is encrypted in transit.
• Cache Responses: If you're generating prompts for the same keywords repeatedly, consider caching the results to reduce API calls.
• Monitor Usage: Keep track of your API usage in the Profile page to avoid hitting rate limits unexpectedly.
• Implement Retry Logic: Use exponential backoff when retrying failed requests, especially for 429 and 5xx errors.

Support

If you have questions about the API or need assistance:

• Visit our Contact page to submit a support request
• Email us directly at support@key2prompt.com
• Check your Subscription page to upgrade your plan for higher rate limits