Skip to main content
GET
/
agents
/
{agentId}
/
config
JavaScript
import Cerca from '@cerca-dev/sdk';

const client = new Cerca({
  apiKey: process.env['CERCA_API_KEY'], // This is the default and can be omitted
});

const effectiveConfiguration = await client.agents.retrieveConfig('agent_abc123');

console.log(effectiveConfiguration.approvals);
{
  "approvals": {
    "tools": {},
    "timeoutMs": 123
  },
  "approvalsWritableByAgent": true,
  "defaultModel": "<string>",
  "lockedByFleet": [],
  "resolvedFromFleet": [],
  "tools": [],
  "instructions": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cerca.dev/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agentId
string
required
Minimum string length: 1
Example:

"agent_abc123"

Response

Effective agent configuration.

​
approvals
object
required
​
approvalsWritableByAgent
boolean
required
​
defaultModel
string
required
​
lockedByFleet
enum<string>[]
required
Available options:
defaultModel,
instructions,
tools,
approvals
​
resolvedFromFleet
enum<string>[]
required
Available options:
defaultModel,
instructions,
tools,
approvals
​
tools
enum<string>[]
required

Effective internal runtime tools after applying fleet defaults, fleet locks, and the agent allowlist.

Available options:
get_time,
sub_thread,
wait,
tool.call,
tool.discover,
artifact.read,
agent.threads.list,
agent.threads.get,
agent.approvals.cancel,
agent.approvals.grant_thread,
agent.approvals.grant_agent,
agent.create,
agent.approvals.update,
tool.connect,
sandbox.exec,
sandbox.read,
sandbox.write_file,
sandbox.read_file,
sandbox.spawn,
sandbox.stdin,
sandbox.session_read,
sandbox.kill,
sandbox.list_sessions,
sandbox.sync_artifact,
memory.read,
memory.list,
memory.search,
memory.write,
memory.delete,
db.query,
web.search,
web.fetch,
agent.schedule.list,
agent.schedule.create,
agent.schedule.update,
agent.schedule.delete,
agent.schedule.trigger
​
instructions
string