Getting started

Our API allows you to programmatically interact with your Magic Inspector account. This API can be useful for automating your testing workflows, or for building custom integrations with other tools.

Before you can make requests to the Magic Inspector API, you will need to grab your API key from your dashboard as explained below.

Get your API key

Open your Magic Inspector dashboard.
Click on the Settings button.
Click on "Create a new API Key".
Enter a name for your API key and select the associated permissions.
Copy your API key (you won't be able to see it again).

Test your API key

curl https://api.magicinspector.com/v1/stats --header "X-Api-Key: YOUR_API_KEY"

Example response

{
  "data": {
    "projects": [
      {
        "id": "F7J6WCPvTQ8Q9ZEU8dqm",
        "name": "YOUR PROJECT",
        "tests": {
          "count": 0
        }
      }
    ]
  }
}