Get started

Get your Record API key

Create a key in the Record app, then send it on every request.

API keys live in the Record app. A key is scoped to a single client, which is your account, and it is the only credential the APIs accept.

Create a key#

1

Sign in to Record

Go to the Record app and sign in. Create an account first if you do not have one.

2

Open the API keys page

Go to Settings, find the API keys section, then select Manage API keys.

3

Create the key

Select Create key and give it a name that says where you will use it, such as "Production sync" or "Staging". A name per environment makes a key safe to revoke on its own.

4

Copy and store the key

We show the full key once, at creation. It starts with trk_live_. Copy it into a secrets manager straight away. We cannot show it again. If you lose a key, revoke it and create another.

If Create key is disabled, your workspace role does not allow it. Ask a workspace admin to grant you access, or to create the key for you.

Use your key#

Set the key as an environment variable rather than writing it into source.

bash
export TRK_API_KEY="trk_live_..."

Send it as a Bearer token on every request.

bash
curl -X POST "https://ingest.takerecord.com/api/v1/catalogue/works" \
  -H "Authorization: Bearer $TRK_API_KEY" \
  -H "Content-Type: application/json" \
  -d @works.json

To make your first request, follow the Quickstart. For scopes, client binding and the rules we enforce, see Authentication.

Keep the key safe#

Anyone holding the key can write to your catalogue. Treat it like a password.

  • Store it in a secrets manager. Never in source control, and never in client-side code.
  • Use a separate key per environment, so revoking one does not stop the others.
  • Revoke any key you think has leaked. Revocation takes effect immediately.