Get OpenAPI Spec

GET

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

GET

/detect/docs

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

200Retrieved

1 "openapi: 3.0.3\ninfo:\n  title: Data API - Detect\n  version: 1.0.0\n  description: >-\n    The Zignal Detect API provides access to real-time detection streams and alerts for monitored visual and narrative threats.\npaths:\n  /detect/docs:\n    get:\n      summary: Get OpenAPI Spec\n      description: Returns the OpenAPI 3.0 specification for the Detect API as a YAML document.\n      operationId: getDetectDocs\n      tags:\n        - Documentation\n      responses:\n        '200':\n          description: Successful response\n          content:\n            application/x-yaml:\n              schema:\n                type: string\n      security:\n        - api-key-security: []\nservers:\n  - url: https://api.zignallabs.com\ncomponents:\n  securitySchemes: {}\n"

Returns the OpenAPI 3.0 specification for the Detect API as a YAML document.

Response

Successful response