Docs

Using the API

Authenticate scripts and automations with an API key and call any workspace operation over REST

Amdahl exposes the same workspace operations two ways. Use MCP for agent clients like Claude and Cursor; use the REST API for scripts, automation, and backend services. Both authenticate with the same kind of API key, sent the same way.

Get an API key

In the Amdahl app, open Settings, then Developer and create an API key. It looks like amdhl_.... You see the full key once, so copy it somewhere safe. Treat it like a password. Anyone with the key can act as you.

Send it on every request

Put the key in an X-API-Key header. The REST surface lives under https://app.amdahl.co/api/platform/v1. Here is a request that asks Amdahl who you are:

bash
curl https://app.amdahl.co/api/platform/v1/me \
  -H "X-API-Key: amdhl_your_key_here"

You get back your account details:

json
{
  "email": "[email protected]",
  "first_name": "Ada",
  "last_name": "Lovelace"
}

See what your key can do

The public surface is documented in two places that never drift from the server:

  • The tool catalog — every externally reachable operation with its description, required scopes, and required role.
  • The OpenAPI spec — the machine-readable request/response schemas, with a browser "try it" console.

Whether a given call works for your key comes down to its scopes: a 403 with scope_denied names the missing scope, and a 403 with not_on_public_api means the operation is console-only and not part of the public surface at all. Start with the Quickstart to prove the loop end to end.

Keeping your key safe

  • Never put it in front-end code or commit it to a repo. Keep it in a server-side secret or environment variable.
  • Lost it or leaked it? Delete the key in settings and create a new one. The old one stops working immediately.
  • You can have more than one key, for example one per script, so you can revoke them independently.