Before you start
You need a Zeptar workspace and the ability to create an API key in it. All requests go to:Make your first request
1
Create an API key
In the dashboard, open ZeptarAPI → API keys and choose Create API
key. Give it a name and grant at least
agents: read. Copy the key — it
starts with zsk_ and is shown only once.Prefer the API? Create one with a session cookie:2
Store the key
Keep the key out of your source code. Put it in an environment variable:Or add it to a
.env file your app loads at startup:.env
3
Call the API
List the agents in your workspace. Pass the key as a Bearer token.
4
Read the response
A successful call returns A missing or invalid key returns
200 OK with your agents:401 Unauthorized; a key without the
required scope returns 403 insufficient_scope. See
Authentication for the details.Next steps
Authentication
Session cookies, API keys, scopes, and the error shapes to expect.
Create an agent
Go beyond reading — create and configure agents over the API.
Request log
Inspect every API call your keys make, with filtering and export.