BestMate Developer API

Integrate advanced prompt optimization directly into your applications with our powerful API and MCP server

AI-Powered OptimizationRESTful APISecure Authentication
Quick Start
Get up and running with the BestMate API in minutes

Sign in to generate your API key

POST/api/bestmate/optimize
Submit a prompt for AI-powered optimization using Claude 4 Opus and Gemini 2.5

Request Headers

Authorization: Bearer bm_your_api_key_here
Content-Type: application/json

Request Body

{
  "prompt": "Write a function to calculate fibonacci numbers",
  "context": "For a Python coding tutorial",
  "domain": "education",
  "model": "claude-4-opus",
  "temperature": 0.3,
  "optimization_type": "comprehensive"
}
Required: prompt
Optional: context, domain, model, temperature, optimization_type

Response

{
  "sessionId": "session_abc123def456",
  "optimizationSessionId": 42,
  "status": "processing",
  "message": "Prompt submitted for optimization",
  "config": {
    "model": "claude-4-opus",
    "temperature": 0.3,
    "optimization_type": "comprehensive",
    "context": "For a Python coding tutorial",
    "domain": "education",
    "source": "mcp"
  },
  "tokensRemaining": 99
}
GET/api/bestmate/optimize/[sessionId]/results
Retrieve optimization results for a specific session

Request Headers

Authorization: Bearer bm_your_api_key_here

Response

{
  "sessionId": "session_abc123def456",
  "originalPrompt": "Write a function to calculate fibonacci numbers",
  "status": "completed",
  "suggestions": [
    {
      "id": "claude_4_opus_suggestion",
      "model": "claude-4-opus",
      "optimizedPrompt": "Create a Python function that efficiently calculates Fibonacci numbers...",
      "improvements": [
        "Added clear function signature and documentation",
        "Included efficiency considerations for large numbers",
        "Added error handling for edge cases"
      ],
      "reasoning": "Enhanced with proper structure and educational context",
      "hallucinationRate": 0.03,
      "structureScore": 0.95,
      "consistencyScore": 0.92,
      "confidence": 0.94
    },
    {
      "id": "gemini_2.5_suggestion",
      "model": "gemini-2.5-pro",
      "optimizedPrompt": "Design a well-documented Python function for Fibonacci calculation...",
      "improvements": [
        "Structured execution framework",
        "Added success criteria and output standards",
        "Enhanced actionability and professional delivery"
      ],
      "reasoning": "Systematic approach with clear phases and metrics",
      "hallucinationRate": 0.06,
      "structureScore": 0.86,
      "consistencyScore": 0.83,
      "confidence": 0.85
    }
  ],
  "optimizationSessionId": 42
}
POST/api/bestmate/evaluate
Evaluate a prompt for clarity, effectiveness, and specificity

Request Body

{
  "prompt": "Write a function to calculate fibonacci numbers",
  "context": "For a Python coding tutorial",
  "criteria": ["clarity", "effectiveness", "specificity"]
}
Required: prompt
Optional: context, criteria

Response

{
  "id": "eval_abc123def456",
  "prompt": "Write a function to calculate fibonacci numbers",
  "scores": {
    "clarity": 0.87,
    "effectiveness": 0.73,
    "specificity": 0.82,
    "overall": 0.81
  },
  "feedback": "This prompt demonstrates strong foundational elements...",
  "suggestions": [
    "Add structured formatting with headers and bullet points",
    "Include specific success criteria or evaluation metrics",
    "Break down the task into clear, sequential steps"
  ]
}
Error Responses
Common error responses and their meanings

401 Unauthorized

{ "error": "Authorization header missing" }

400 Bad Request

{ "error": "Prompt is required" }

403 Forbidden

{ "error": "Insufficient tokens. Please upgrade your plan." }

404 Not Found

{ "error": "Session not found" }
Rate Limits & Usage
API usage limits and token consumption
1 Token
per optimization
Free
evaluation requests
No Limit
on API calls

Note: Each optimization request consumes 1 token from your account balance. Check your remaining tokens in the response or via the dashboard.