mint.json

{
  "name": "Helicone OSS LLM Observability",
  "theme": "venus",
  "logo": {
    "light": "/logo/light.png",
    "dark": "/logo/dark.svg"
  },
  "metadata": {
    "og:site_name": "Helicone OSS LLM Observability",
    "og:image": "/favicon.svg",
    "twitter:site": "@helicone_ai",
    "twitter:image": "/favicon.svg"
  },
  "favicon": "/favicon.svg",
  "anchors": [
    {
      "name": "API Reference",
      "icon": "code",
      "url": "rest"
    },
    {
      "name": "Guides",
      "icon": "file-lines",
      "url": "guides"
    },
    {
      "name": "FAQ",
      "icon": "lightbulb",
      "url": "faq"
    }
  ],
  "analytics": {
    "koala": {
      "publicApiKey": "pk_28dd6b0bb95629a42e92bd526a1234a9fc79"
    },
    "posthog": {
      "apiKey": "phc_jeluwNoJNpc7zEzkQrPbjyMOqdnJQjFAVr849LaEaPG"
    }
  },
  "colors": {
    "primary": "#0CA5E9",
    "light": "#0CA5E9",
    "dark": "#0CA5E9"
  },
  "modeToggle": {
    "default": "light"
  },
  "topbarCtaButton": {
    "name": "Dashboard",
    "url": "https://us.helicone.ai/#:~:text=Discord-,Sign,-In"
  },
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true,
    "raiseIssue": true
  },
  "openapi": ["/swagger.json"],
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "getting-started/quick-start",
        "helicone-headers/helicone-auth",
        {
          "group": "Self Host",
          "pages": [
            "getting-started/self-host/overview",
            "getting-started/self-host/cloud",
            "getting-started/self-host/docker",
            "getting-started/self-host/kubernetes",
            "getting-started/self-host/manual"
          ],
          "icon": "server",
          "iconType": "solid"
        }, 
        "helicone-headers/header-directory"
      ]
    },
    {
      "group": "Dev Integrations",
      "pages": [
        {
          "group": "Generic Gateway",
          "pages": [
            "getting-started/integration-method/gateway",
            "getting-started/integration-method/custom"
          ]
        },
        {
          "group": "Async Logging",
          "pages": ["getting-started/integration-method/openllmetry"]
        },
        {
          "group": "OpenAI",
          "pages": [
            "integrations/openai/javascript",
            "integrations/openai/python",
            "integrations/openai/langchain",
            "integrations/openai/llamaindex",
            "integrations/openai/crewai",
            "integrations/openai/curl",
            "integrations/openai/assistants"
          ]
        },
        {
          "group": "Azure OpenAI",
          "pages": [
            "integrations/azure/javascript",
            "integrations/azure/python",
            "integrations/azure/langchain",
            "integrations/azure/curl"
          ]
        },
        {
          "group": "Anthropic",
          "pages": [
            "integrations/anthropic/javascript",
            "integrations/anthropic/python",
            "integrations/anthropic/langchain",
            "integrations/anthropic/curl"
          ]
        },
        {
          "group": "Ollama",
          "pages": ["integrations/ollama/javascript"]
        },
        {
          "group": "AWS Bedrock",
          "pages": [
            "integrations/bedrock/javascript",
            "integrations/bedrock/python"
          ]
        },
        {
          "group": "Gemini",
          "pages": [
            {
              "group": "API",
              "pages": [
                "integrations/gemini/api/javascript",
                "integrations/gemini/api/python",
                "integrations/gemini/api/curl"
              ]
            },
            {
              "group": "Vertex AI (Enterprise)",
              "pages": [
                "integrations/gemini/vertex/javascript",
                "integrations/gemini/vertex/python",
                "integrations/gemini/vertex/curl"
              ]
            }
          ]
        },
        "getting-started/integration-method/vercelai",
        "getting-started/integration-method/anyscale",
        "getting-started/integration-method/together",
        "getting-started/integration-method/hyperbolic",
        {
          "group": "Groq",
          "pages": [
            "integrations/groq/javascript",
            "integrations/groq/python",
            "integrations/groq/curl"
          ]
        },
        {
          "group": "Instructor",
          "pages": [
            "integrations/instructor/javascript",
            "integrations/instructor/python"
          ]
        },
        "getting-started/integration-method/deepinfra",
        "getting-started/integration-method/openrouter",
        {
          "group": "LiteLLM",
          "pages": [
            "getting-started/integration-method/litellm-openllmetry",
            "getting-started/integration-method/litellm"
          ]
        },
        "getting-started/integration-method/fireworks",
        {
          "group": "Vector DB",
          "pages": [
            "integrations/vectordb/python",
            "integrations/vectordb/javascript",
            "integrations/vectordb/curl"
          ]
        },
        {
          "group": "Tools",
          "pages": [
            "integrations/tools/python",
            "integrations/tools/javascript",
            "integrations/tools/curl"
          ]
        }
      ]
    },
    {
      "group": "Other Integrations",
      "pages": [
        "getting-started/integration-method/posthog",
        "other-integrations/ragas",
        "other-integrations/open-webui",
        "other-integrations/meta-gpt",
        "other-integrations/open-devin",
        "other-integrations/embedchain",
        "other-integrations/dify",
        {
          "group": "Upstash",
          "pages": [
            "other-integrations/upstash-qstash",
            "other-integrations/upstash-rag"
          ]
        },
        "other-integrations/firecrawl",
        "other-integrations/bubble"
      ]
    },
    {
      "group": "Features",
      "pages": [
        {
          "group": "Evaluation",
          "pages": [
            "features/advanced-usage/feedback",
            "features/advanced-usage/scores"
          ]
        },
        "features/sessions",
        "features/prompts",
        "features/experiments",
        {
          "group": "Webhooks",
          "pages": ["features/webhooks", "features/webhooks-testing"]
        },

        "features/advanced-usage/custom-properties",
        "features/advanced-usage/caching",
        "features/advanced-usage/omit-logs",
        "features/advanced-usage/user-metrics",
        "features/fine-tuning",
        "getting-started/integration-method/gateway-fallbacks",
        "features/advanced-usage/retries",
        "features/advanced-usage/custom-rate-limits",
        "features/advanced-usage/vault",
        "features/advanced-usage/moderations",
        "features/advanced-usage/llm-security",
        "features/customer-portal"
      ]
    },
    {
      "group": "References",
      "pages": [
        "references/api",
        "references/proxy-vs-async",
        "references/availability",
        "references/latency-affect",
        "references/data-autonomy",
        "references/open-source",
        "references/how-we-calculate-cost"
      ]
    },
    {
      "group": "Guides",
      "pages": [
        "guides/overview",
        {
          "group": "Cookbooks",
          "pages": [
            "guides/cookbooks/fine-tune",
            "guides/cookbooks/experiments",
            "guides/cookbooks/getting-user-requests",
            "guides/cookbooks/getting-sessions",
            "guides/cookbooks/etl",
            "guides/cookbooks/replay-session",
            "guides/cookbooks/predefining-request-id",
            "guides/cookbooks/environment-tracking",
            "guides/cookbooks/segmentation",
            "guides/cookbooks/github-actions",
            "guides/cookbooks/debugging",
            "guides/cookbooks/labeling-request-data"
          ]
        },
        {
          "group": "Prompt Engineering",
          "pages": [
            "guides/prompt-engineering/be-specific-and-clear",
            "guides/prompt-engineering/use-structured-formats",
            "guides/prompt-engineering/leverage-role-playing",
            "guides/prompt-engineering/implement-few-shot-learning",
            "guides/prompt-engineering/use-constrained-outputs",
            "guides/prompt-engineering/use-chain-of-thought-prompting"
          ]
        }
      ]
    },
    {
      "group": "Applications",
      "pages": [
        "guides/applications/overview",
        {
          "group": "Use Cases",
          "pages": [
            "guides/applications/resell-a-model",
            "guides/applications/bill-by-usage"
          ]
        }
      ]
    },
    {
      "group": "FAQ",
      "pages": [
        "faq/overview",
        {
          "group": "Categories",
          "pages": [
            "faq/tag/platform",
            "faq/tag/security",
            "faq/tag/concepts",
            "faq/tag/fine-tuning"
          ]
        },
        {
          "group": "",
          "pages": [
            "faq/openai-fine-tuning-api",
            "faq/llm-fine-tuning-time",
            "faq/rag-vs-fine-tuning",
            "faq/compliance",
            "faq/enable-stream-usage",
            "faq/how-encryption-works",
            "faq/secret-vs-public-key",
            "faq/soc2"
          ]
        }
      ]
    },
    {
      "group": "User",
      "pages": [
        "rest/user/post-v1userquery",
        "rest/user/post-v1user-metricsquery"
      ]
    },
    {
      "group": "Request",
      "pages": [
        "rest/request/post-v1requestquery",
        "rest/request/post-v1request-feedback",
        "rest/request/post-v1request-score",
        "rest/request/put-v1request-property"
      ]
    },
    {
      "group": "Prompt",
      "pages": [
        "rest/prompt/post-v1promptquery",
        "rest/prompt/post-v1prompt-query",
        "rest/prompt/post-v1promptversion-subversion",
        "rest/prompt/post-v1prompt-versionsquery"
      ]
    },
    {
      "group": "Dataset",
      "pages": [
        "rest/dataset/post-v1experimentdataset",
        "rest/dataset/post-v1experimentdatasetrandom",
        "rest/dataset/post-v1experimentdataset-query",
        "rest/dataset/post-v1experimentdataset-mutate"
      ]
    },
    {
      "group": "Experiment",
      "pages": ["rest/experiment/post-v1experiment"]
    },
    {
      "group": "Customer",
      "pages": [
        "rest/customer/post-v1customer-usagequery",
        "rest/customer/post-v1customerquery"
      ]
    }
  ],
  "topbarLinks": [
    {
      "name": "Discord",
      "url": "https://discord.com/invite/zsSTcH2qhG"
    },
    {
      "name": "Github",
      "url": "https://github.com/Helicone/helicone"
    }
  ],
  "footerSocials": {
    "twitter": "https://twitter.com/helicone_ai",
    "linkedin": "https://www.linkedin.com/company/helicone/about/",
    "github": "https://github.com/Helicone/helicone",
    "discord": "https://discord.com/invite/zsSTcH2qhG"
  },
  "redirects": [
    {
      "source": "/getting-started/proxy-vs-async",
      "destination": "/references/proxy-vs-async"
    },
    {
      "source": "/faq/availability",
      "destination": "/references/availability"
    },
    {
      "source": "/faq/how-encryption-works",
      "destination": "/references/how-encryption-works"
    },
    {
      "source": "/faq/how-we-calculate-cost",
      "destination": "/references/how-we-calculate-cost"
    },
    {
      "source": "/faq/latency-affect",
      "destination": "/references/latency-affect"
    },
    {
      "source": "/use-cases/data-autonomy",
      "destination": "/references/data-autonomy"
    },

    {
      "source": "/use-cases/bill-by-usage",
      "destination": "/guides/applications/bill-by-usage"
    },
    {
      "source": "/use-cases/resell-a-model",
      "destination": "/guides/applications/resell-a-model"
    },

    {
      "source": "/use-cases/debugging",
      "destination": "/guides/cookbooks/debugging"
    },
    {
      "source": "/use-cases/environment-tracking",
      "destination": "/guides/cookbooks/environment-tracking"
    },
    {
      "source": "/use-cases/etl",
      "destination": "/guides/cookbooks/etl"
    },
    {
      "source": "/use-cases/experiments",
      "destination": "/guides/cookbooks/experiments"
    },
    {
      "source": "/use-cases/getting-user-requests",
      "destination": "/guides/cookbooks/getting-user-requests"
    },
    {
      "source": "/use-cases/github-actions",
      "destination": "/guides/cookbooks/github-actions"
    },
    {
      "source": "/use-cases/labeling-request-data",
      "destination": "/guides/cookbooks/labeling-request-data"
    },
    {
      "source": "/use-cases/predefining-request-id",
      "destination": "/guides/cookbooks/predefining-request-id"
    },
    {
      "source": "/use-cases/replay-session",
      "destination": "/guides/cookbooks/replay-session"
    },
    {
      "source": "/use-cases/segmentation",
      "destination": "/guides/cookbooks/segmentation"
    },

    {
      "source": "/use-cases/enable-stream-usage",
      "destination": "/faq/enable-stream-usage"
    },
    {
      "source": "/use-cases/secret-vs-public-key",
      "destination": "/faq/secret-vs-public-key"
    },

    {
      "source": "/getting-started/self-deploy-cloud",
      "destination": "/getting-started/self-host/cloud"
    },
    {
      "source": "/getting-started/self-deploy-docker",
      "destination": "/getting-started/self-host/docker"
    },
    {
      "source": "/getting-started/self-deploy",
      "destination": "/getting-started/self-host/manual"
    }
  ]
}