Get Agents Markdown

GET

https://api.zignallabs.com/detect/docs/agents.md

GET

/detect/docs/agents.md

$ curl https://api.zignallabs.com/detect/docs/agents.md \
>      -H "Content-Type: application/json"

200Retrieved

1 "# Detect API Documentation - Agents\n\nThis document provides detailed information about the Detect API endpoints related to agent operations, optimized for consumption by large language model agents.\n\n## Overview\n\nThe Detect API allows access to real-time detection streams and alerts for monitored visual and narrative threats.\n\n## Endpoints\n\n### GET /detect/agents\nRetrieve a list of all active agents currently monitoring data streams.\n\n#### Response\n- `200 OK` - Returns a JSON array of agent objects.\n\n### GET /detect/agents/{agentId}\nRetrieve detailed information about a specific agent by its unique identifier.\n\n#### Parameters\n- `agentId` (string, required): The unique identifier of the agent.\n\n#### Response\n- `200 OK` - Returns the agent details including status, configuration, and last activity timestamp.\n\n## Authentication\n\nAll endpoints require an API key passed in the request header `Authorization: Bearer <api_key>`.\n\n## Usage Notes\n\n- Ensure your API key has the necessary permissions to access agent data.\n- Rate limits apply as per your subscription plan.\n\nFor more detailed examples and SDK usage, refer to the official Zignal Detect API developer portal."

Returns the Detect API documentation in a markdown format optimized for LLM agent consumption.

Response

Successful response