Before you begin
Before you start, make sure you have:- Workspace write permission: Permission to add agents to the workspace. Workspaces where you lack it are disabled in the picker, with the reason on hover.
- Secret store: A place to keep the agent’s API key, such as a secret manager or encrypted CI secrets.
1
Open New agent form
Open the form from any of these places:
- Web app: Select New, then Agent.
- Settings: Open Settings, select Agents under Developer, then New agent.
- Atlan Desktop: Select New, then Agent, then Add manually.
2
Name agent and pick workspace
Fill in the first step, then select Continue:
3
Describe how agent runs
Fill in what applies, then select Create agent. Leave blank what your code sets.
4
Copy API key
Atlan shows the agent’s Client ID and API key once. Copy the key into your secret store now, or select Copy as .env for the variables the atlanai SDK reads. Atlan won’t show this key again.Send the agent’s runs with this key, not a personal one. Runs sent with a personal key are filed under that person; see Traces appear under person instead of agent.
5
Verify key
On the same screen, select Copy the check command and run it. It sends the key as a bearer token, and a successful response confirms the agent can authenticate. Then select Done. The agent is listed in Settings → Agents and in its workspace.
Troubleshooting
If the form says Need write permission on this workspace to add an agent, pick a workspace that is enabled in the picker, or ask that workspace’s admin for access. If Atlan says the agent was created but its API key didn’t come back, rotate the API key from the agent’s profile to get one. If the agent’s traces later appear under a person instead, see Traces troubleshooting.Next steps
- Send and verify traces: Send the agent’s runs to Atlan with its key and confirm they arrive.
See also
- How agents work: What an agent record holds and what its profile shows.
- Send bearer token: Store a key securely and confirm the identity it resolves to.