top_gun_live/openapi.json at main · Spacemandomains/top_gun_live · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
{
  "openapi": "3.1.0",
  "info": {
    "title": "Top GUN GEO-Lens API",
    "description": "Professional auditing for Generative Engine Optimization (GEO). Measures brand visibility and citations in LLM search results.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://top-gun-live.vercel.app",
      "description": "Production server managed by Wilfred L. Lee Jr."
    }
  ],
  "paths": {
    "/api/v1/audit": {
      "get": {
        "summary": "Perform a GEO visibility audit",
        "operationId": "getGeoAudit",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "description": "The brand or topic to audit for LLM visibility",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Audit",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "visibility_score": { "type": "string" },
                    "top_citations": { "type": "array", "items": { "type": "string" } },
                    "llm_index_status": { "type": "string" },
                    "provider": { "type": "string" }
                  }
                }
              }
            }
          },
          "402": {
            "description": "Payment Required - $1.50 USD per request"
          }
        }
      }
    }
  }
}