{
  "openapi": "3.1.0",
  "info": {
    "title": "The Visibility Guide API",
    "version": "1.0.0",
    "description": "Search, read and compare published AI visibility platform profiles. Read-only, no API key. Does not provide live pricing or measured rankings. Version 1 uses /api/v1. Existing unversioned endpoints remain compatible aliases. Breaking changes will use a new major path; deprecated versions will be announced in these docs at least 90 days before retirement. All requests are read-only and safe to retry. No asynchronous jobs or writes exist."
  },
  "servers": [
    {
      "url": "https://thevisibilityguide.com"
    }
  ],
  "security": [],
  "paths": {
    "/api/v1/platforms": {
      "get": {
        "operationId": "find_platforms",
        "summary": "Find platform profiles",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "Search platform names and descriptions",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "focus",
            "in": "query",
            "description": "Guide focus group",
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "discovery",
                "analytics",
                "content",
                "readiness"
              ]
            }
          },
          {
            "name": "limit",
            "in": "query",
            "description": "Page size, maximum five profiles",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 5,
              "default": 5
            }
          },
          {
            "name": "offset",
            "in": "query",
            "description": "Zero-based result offset",
            "schema": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated catalog",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "count": {
                      "type": "integer"
                    },
                    "total": {
                      "type": "integer"
                    },
                    "limit": {
                      "type": "integer"
                    },
                    "offset": {
                      "type": "integer"
                    },
                    "next_offset": {
                      "type": [
                        "integer",
                        "null"
                      ]
                    },
                    "platforms": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Platform"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "404": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "405": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/platforms/{slug}": {
      "get": {
        "operationId": "get_platform",
        "summary": "Read one complete profile",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "nur-ai",
                "profound",
                "peec-ai",
                "gauge",
                "otterly-ai"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Platform profile",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Platform"
                }
              }
            }
          },
          "404": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "400": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "405": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/compare": {
      "get": {
        "operationId": "compare_platforms",
        "summary": "Compare two to five platform profiles",
        "parameters": [
          {
            "name": "ids",
            "in": "query",
            "description": "Two to five comma-separated platform slugs",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Public catalog result. Includes source URLs and review dates.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "404": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          },
          "405": {
            "description": "Structured problem response",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/Problem"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Platform": {
        "type": "object",
        "required": [
          "slug",
          "name",
          "canonical_url",
          "sources",
          "reviewed_at"
        ],
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "desc": {
            "type": "string"
          },
          "intro": {
            "type": "string"
          },
          "focus": {
            "type": "string"
          },
          "focus_groups": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "canonical_url": {
            "type": "string",
            "format": "uri"
          },
          "reviewed_at": {
            "type": "string",
            "format": "date"
          },
          "features": {
            "type": "array",
            "items": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "fit": {
            "type": "string"
          },
          "check": {
            "type": "string"
          },
          "take": {
            "type": "string"
          },
          "sources": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "url": {
                  "type": "string",
                  "format": "uri"
                }
              }
            }
          }
        }
      },
      "Problem": {
        "type": "object",
        "required": [
          "type",
          "title",
          "status",
          "detail",
          "instance"
        ],
        "properties": {
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "integer"
          },
          "detail": {
            "type": "string"
          },
          "instance": {
            "type": "string"
          }
        }
      }
    }
  }
}