> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.zignallabs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.zignallabs.com/_mcp/server.

# Get Agents Markdown

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

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


Reference: https://docs.zignallabs.com/api-reference/data-api-detect/documentation/get-detect-agents-md

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: zignal-data-api-detect
  version: 1.0.0
paths:
  /detect/docs/agents.md:
    get:
      operationId: getDetectAgentsMd
      summary: Get Agents Markdown
      description: >
        Returns the Detect API documentation in a markdown format optimized for
        LLM agent consumption.
      tags:
        - documentation
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties: {}
servers:
  - url: https://api.zignallabs.com
    description: https://api.zignallabs.com

```

## Examples



**Request**

```json
{}
```

**Response**

```json
"# 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."
```

**SDK Code**

```python
import requests

url = "https://api.zignallabs.com/detect/docs/agents.md"

payload = {}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.zignallabs.com/detect/docs/agents.md';
const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.zignallabs.com/detect/docs/agents.md"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.zignallabs.com/detect/docs/agents.md")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.zignallabs.com/detect/docs/agents.md")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.zignallabs.com/detect/docs/agents.md', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.zignallabs.com/detect/docs/agents.md");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.zignallabs.com/detect/docs/agents.md")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```