Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.adrian.secureagentics.ai/llms.txt

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

Agents are the core resource in Secureagentics. Each agent represents an AI system whose activity you want to monitor, govern, and audit. Use these endpoints to register new agents, retrieve their details, and remove them when they are no longer needed.

​
Register an agent

POST /v1/agents Creates a new agent and returns the agent object with its assigned ID. The name must be unique within your account.

​
Request body

​
name
string
required
Unique name for the agent within your account.
​
description
string
Human-readable description of the agent’s purpose or function.
​
framework
string
The AI framework the agent is built on. One of: openai, langchain, custom.
​
metadata
object
Arbitrary key-value pairs for storing additional context, such as environment or team ownership. Values must be strings.

​
Response fields

​
id
string
required
Unique agent identifier, prefixed with agt_.
​
name
string
required
The agent’s name as provided at registration.
​
description
string
Human-readable description of the agent.
​
framework
string
The AI framework associated with the agent.
​
created_at
string
required
ISO 8601 timestamp of when the agent was created.
​
status
string
required
Current agent status. One of: active, inactive.
cURL
curl --request POST \
  --url https://api.secureagentics.ai/v1/agents \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "customer-support-bot",
    "description": "Handles tier-1 customer support tickets",
    "framework": "openai",
    "metadata": {
      "env": "production",
      "team": "cx-platform"
    }
  }'

​
List all agents

GET /v1/agents Returns a paginated list of all agents registered in your account. Use limit and offset to page through results.

​
Query parameters

​
limit
integer
default:"20"
Maximum number of agents to return per page. Accepted range: 1–100.
​
offset
integer
default:"0"
Number of agents to skip before returning results. Use for pagination.
​
status
string
Filter agents by status. One of: active, inactive.

​
Response fields

​
items
object[]
required
Array of agent objects matching the query.
​
total
integer
required
Total number of agents in your account matching the applied filters, regardless of pagination.
cURL
curl --request GET \
  --url "https://api.secureagentics.ai/v1/agents?limit=20&offset=0&status=active" \
  --header "Authorization: Bearer YOUR_API_KEY"

​
Get an agent

GET /v1/agents/{id} Retrieves a single agent by its ID. Returns a 404 error if the agent does not exist.

​
Path parameters

​
id
string
required
The agent ID, prefixed with agt_.

​
Response fields

Returns a single agent object. See Register an agent for the full list of response fields.
cURL
curl --request GET \
  --url https://api.secureagentics.ai/v1/agents/agt_01j9xkz2m3n4p5q6r7s8t9u0 \
  --header "Authorization: Bearer YOUR_API_KEY"

​
Delete an agent

DELETE /v1/agents/{id} Permanently deletes an agent and all associated data. This action is irreversible. Returns 204 No Content on success.
Deleting an agent also removes all events, policy associations, and audit records linked to it. This cannot be undone.

​
Path parameters

​
id
string
required
The agent ID, prefixed with agt_.
cURL
curl --request DELETE \
  --url https://api.secureagentics.ai/v1/agents/agt_01j9xkz2m3n4p5q6r7s8t9u0 \
  --header "Authorization: Bearer YOUR_API_KEY"