Developers · Quickstart

Your first zero-spend call.

Five steps from nothing to a TEST_ONLY project. Nothing here can start paid work: real production, provider execution and billing are switched off service-wide.

Who can do this today: step 1 works for anyone. Steps 2–5 need a private-test key, which is available to invited testers from the customer area. If you are not invited yet, read the steps, then tell us what you want to build.

  1. Step 1: Read the public capabilities record

    No key needed. This is the authoritative statement of which service switches are on.

    curl https://theamateur.co.uk/api/video/v1/capabilities

    Expect "realProjectCreationEnabled": false, "providerExecutionEnabled": false and "billingEnabled": false while the service is in private testing.

  2. Step 2: Create a private-test key

    Sign in, open API keys in the customer area and choose Create test credential. It is shown once; store it in your secret manager, not in source control.

    Private-test keys carry the scopes projects:read and projects:test. See API keys for rotation and revocation.

  3. Step 3: Check who the key belongs to

    A bearer key identifies your organisation and returns the same capability switches.

    curl -H "Authorization: Bearer $AVS_KEY" \
      https://theamateur.co.uk/api/video/v1/me

    A 401 means the header is missing or the key was revoked or mistyped.

  4. Step 4: Create a TEST_ONLY project

    Test projects exercise the control plane without renderer execution, billing or provider spend.

    curl -X POST https://theamateur.co.uk/api/video/v1/test-projects \
      -H "Authorization: Bearer $AVS_KEY" \
      -H "Content-Type: application/json" \
      -d '{"title":"Connection test"}'

    A 201 response returns the project. Its stage is TEST_ONLY and its nextAction.code is TEST_ONLY_NO_ACTION.

  5. Step 5: Read it back, or connect your agent

    Fetch the project by id, or point an MCP client at https://theamateur.co.uk/mcp/video with the same key. MCP tools are prefixed: start with video_connection_status, then video_create_test_project.

    curl -H "Authorization: Bearer $AVS_KEY" \
      https://theamateur.co.uk/api/video/v1/projects/<project-id>

    MCP configuration: MCP guide. The same project appears in your customer area.

If something fails

  • 401 — missing, mistyped or revoked key. Create a new one under API keys in the customer area.
  • 403 — the key lacks the scope. Private-test keys cannot create real projects; that is expected.
  • Anything else — see troubleshooting or contact us with the request time and status code (never the key).