Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getinteract.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

API keys give external tools and scripts secure, programmatic access to Interact. You can use them to trigger agent jobs on a schedule from your own systems or to retrieve results without logging in to the platform. Go to Settings → API to manage your API keys.

​
What API keys are used for

The Interact API lets you:
  • Trigger agent jobs — start a job run from an external system (e.g. a data pipeline, a scheduler, or a custom workflow)
  • Read job results — retrieve the output of completed agent jobs for use in other tools
See the API reference for full endpoint documentation.

​
Creating an API key

1

Go to Settings → API

Click Create API key.
2

Give the key a name

Choose a descriptive name to identify where this key will be used — e.g. “Production scheduler” or “Data pipeline integration”.
3

Select permissions

Choose what the key is allowed to do:
PermissionWhat it allows
Read jobs (agent_jobs_read)Retrieve job results and status
Trigger jobs (agent_jobs_trigger)Start agent job runs
Select one or both permissions. You cannot create a key with no permissions.
4

Save and copy the key

Click Create. Your API key is displayed once — copy it immediately and store it securely (e.g. in a password manager or secrets vault).Once you close the dialog, the key cannot be shown again. If you lose it, you’ll need to create a new one.
Treat your API key like a password. Do not share it publicly, commit it to a code repository, or include it in client-side code. Anyone with the key can trigger agent jobs in your organization.

​
Managing existing keys

From the API keys list, you can see:
  • Name — what you named the key when creating it
  • Permissions — what the key is allowed to do
  • Created — when the key was created
  • Last used — when the key was last used to make an API call
You can delete a key at any time. Deleted keys immediately stop working — make sure to update any integrations that use the key before deleting it.

​
Key format

Interact API keys start with int_ followed by a 48-character random string. Example: 
int_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4