API Documentation

Authentication

All API requests require a Bearer token authentication header:

Authorization: Bearer your-api-key-here

Rate Limits

  • 100 requests per hour
  • 2000 requests per day

Endpoints

Generate Pet Name

POST /api/v1/generate-name

Request Body:
{
    "pet_type": "dog",  // Required: dog, cat, bird, fish
    "gender": "male",   // Required: male, female, neutral
    "characteristics": "playful, energetic"  // Optional
}
Response:
{
    "name": "Apollo",
    "pet_type": "dog",
    "gender": "male",
    "success": true,
    "meaning": "Greek god of sun and light",
    "cultural_reference": "Ancient Greek mythology",
    "name_origin": "Greek",
    "details": "Full explanation of name significance..."
}
Error Response:
{
    "error": "Error message here",
    "success": false
}

Example Usage

curl -X POST \
    https://your-domain.com/api/v1/generate-name \
    -H "Authorization: Bearer your-api-key-here" \
    -H "Content-Type: application/json" \
    -d '{
        "pet_type": "dog",
        "gender": "male",
        "characteristics": "playful, energetic"
    }'