OpenAPI & Swagger Documentation

For AI, automation, and developer tooling, we provide a full OpenAPI (Swagger) schema for the NotifiedBy API.

• OpenAPI/Swagger UI: Interactive API explorer and documentation

• OpenAPI JSON: Machine-readable schema for code generation and AI tools

You can use these resources to: - Generate client SDKs automatically - Integrate with Postman, Swagger Codegen, or AI assistants - Enable LLMs and bots to understand the API structure and parameters

Links

• Swagger UI (Interactive Docs)

• OpenAPI JSON Schema

• ReDoc (Alternative UI)

Tip: - These endpoints are always up-to-date with the deployed API. - You can download the OpenAPI JSON and use it with tools like Postman, Swagger Codegen, or AI code assistants.

Example Usage

• Generate Python client:

  openapi-generator-cli generate -i https://notifiedby.com/api/schema/ -g python -o notifiedby_client
  

• Import into Postman:

  1. Download the OpenAPI JSON from the link above

  2. In Postman, click “Import” and select the file

• Use with AI tools:

  Many AI coding assistants can consume OpenAPI schemas to answer questions and generate code.