Get Agents Markdown

GET

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

GET

/newsroom/docs/agents.md

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

200Retrieved

1 "# Newsroom API Documentation for Agents\n\nThis document provides detailed information about the Newsroom API endpoints related to agents, optimized for large language model (LLM) agent consumption.\n\n## Overview\n\nThe Newsroom API allows you to access and manage agent-related data within the Zignal platform. This documentation covers available endpoints, request parameters, response formats, and usage examples.\n\n---\n\n### GET /newsroom/agents\n\nRetrieve a list of agents with their metadata and current status.\n\n**Request:**\n- No parameters required.\n\n**Response:**\n```json\n[\n  {\n    \"agentId\": \"a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78\",\n    \"name\": \"Media Monitoring Agent\",\n    \"status\": \"active\",\n    \"lastUpdated\": \"2024-06-10T12:00:00Z\"\n  },\n  {\n    \"agentId\": \"z9y8x7w6-v5u4-3210-ts98-rq76po54nm32\",\n    \"name\": \"Social Listening Agent\",\n    \"status\": \"inactive\",\n    \"lastUpdated\": \"2024-05-22T08:30:00Z\"\n  }\n]\n```\n\n---\n\n### Authentication\n\nAll requests require an API key passed in the header:\n```\nAuthorization: Bearer YOUR_API_KEY\n```\n\n---\n\nFor more detailed information, please refer to the full API reference or contact support."

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

Response

Successful response