Skip to main content
Get up and running with the Exec API in just a few steps.

​
Prerequisites

You have an Exec workspace with admin access

​
Step 1: Create an API Key

1

Go to Settings > API

Navigate to your workspace settings and click API in the sidebar.
2

Create a new key

Click Create API Key, enter a name like “Quickstart Test”, and click Create.
3

Copy your key

Copy the displayed key immediately. It looks like exec_live_aB3dE5...

​
Step 2: Make Your First Request

Open a terminal and run this command, replacing YOUR_API_KEY with the key you copied: 
curl -X GET "https://api.exec.com/rest/v1/workspace" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

response = requests.get(
    "https://api.exec.com/rest/v1/workspace",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
print(response.json())

fetch("https://api.exec.com/rest/v1/workspace", {
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
})
.then(res => res.json())
.then(data => console.log(data));

​
Step 3: Check the Response

You should receive a JSON response with your workspace information: 
{
  "id": "a1b2c3d4e5f6",
  "name": "Your Workspace Name",
  "url_slug": "your-workspace",
  "created_at": "2024-01-15T10:30:00Z"
}
If you see your workspace data, you’re all set!

​
Troubleshooting

  • Check that your API key is correct and complete
  • Ensure the key hasn’t been deactivated
  • Verify the Bearer prefix is included (with the space)
  • Verify you’re using the correct base URL: https://api.exec.com/rest/v1/
  • Check your network connection and firewall settings

​
Next Steps

Get Practice Data

Pull roleplay session scores, transcripts, and feedback

Track Skill Proficiency

See how your team is progressing on key skills

Monitor Assignments

Check assignment completion status and scores

Scenario Analytics

Get aggregate performance metrics for scenarios