API Endpoints

ExplainThis offers a RESTful interface for source walkthroughs and analysis. All routes are accessible over HTTPS and require authentication.

Below you will find each endpoint, its parameters, and example requests. Use the Explain Code endpoint to send a snippet and get back a plain-English walkthrough. Use the List Explanations endpoint to fetch your saved results.

{
  "code": "function fibonacci(n) {\n  if (n <= 1) return n;\n  return fibonacci(n - 1) + fibonacci(n - 2);\n}",
  "mode": "performance",
  "language": "javascript",
  "audience": "intermediate",
  "focus": [
    "performance"
  ]
}

{
  "explanation": "This is a recursive implementation of the Fibonacci sequence...",
  "sections": [
    {
      "title": "Summary",
      "content": "..."
    }
  ],
  "suggestions": [
    {
      "type": "Improvement",
      "description": "Memoize repeated calls"
    }
  ],
  "metadata": {
    "tokens": 320,
    "complexity": {
      "cognitive": 4,
      "cyclomatic": 3,
      "halstead": 12.5
    }
  }
}

Focus Areas

When you call the Explain Code endpoint, you can ask the AI to pay extra attention to specific topics. Here is what each focus area covers:

• readability — Is the source easy to read and follow?
• performance — Could it run faster or use less memory?
• security — Are there any security risks?
• best_practices — Does the input follow common standards? Read our best practices guide for tips on getting the most from this focus area.
• architecture — Is the overall design sound?
• testing — Is it easy to test?
• documentation — Are comments and docs clear enough?
• scalability — Will it handle growth well?
• maintainability — Will future developers understand it?

Response Codes