mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Relevance AI Documentation",
  "logo": {
    "dark": "/images/logo/dark.png",
    "light": "/images/logo/light.png"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#4F46E5",
    "light": "#a5b4fc",
    "dark": "#3730a3"
  },
  "topbarLinks": [
    {
      "name": "Log In",
      "url": "https://auth.relevanceai.com/login/"
    }
  ],
  "topbarCtaButton": {
    "name": "Sign Up",
    "url": "https://auth.relevanceai.com/signup/"
  },
  "tabs": [],
  "feedback": {
    "thumbsRating": true
  },
  "anchors": [
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://discord.gg/8VHJJrQZMM"
    },
    {
      "name": "Developer Docs & SDK",
      "icon": "python",
      "url": "https://sdk.relevanceai.com/"
    }
  ],
  "navigation": [
    {
      "group": "Get started",
      "pages": [
        "get-started/introduction",
        {
          "group": "Key concepts",
          "pages": [
            "get-started/key-concepts/agent",
            "get-started/key-concepts/tools",
            "get-started/key-concepts/data",
            "get-started/key-concepts/templates",
            "get-started/key-concepts/api-keys"
          ]
        },
        "get-started/quickstart/agent",
        "get-started/quickstart/templates",
        "get-started/quickstart/knowledge",
        "get-started/quickstart/integrations",
        "security",
        "get-started/plans",
        "get-started/system-limits"
      ]
    },
    {
      "group": "Agents",
      "pages": [
        "agent/introduction",
        "agent/templates",
        "agent/agent-configuration",
        "agent/bosh-bdr-agent",
        {
          "group": "API",
          "pages": ["agent/api/conversation", "agent/api/list-conversations"]
        },
        "agent/faq"
      ]
    },
    {
      "group": "Tools",
      "pages": [
        "tool/introduction",
        "tool/templates",
        "tool/create-a-tool",
        {
          "group": "User inputs",
          "pages": [
            "tool/user-inputs/getting-started",
            "tool/user-inputs/text-input",
            "tool/user-inputs/long-text-input",
            "tool/user-inputs/options-drop-down",
            "tool/user-inputs/numeric-input",
            "tool/user-inputs/text-list",
            "tool/user-inputs/json",
            "tool/user-inputs/list-of-jsons",
            "tool/user-inputs/file-to-text",
            "tool/user-inputs/file-to-url",
            "tool/user-inputs/table",
            "tool/user-inputs/check-box",
            "tool/what-are-chains"
          ]
        },
        {
          "group": "Tool steps",
          "pages": [
            "tool/tool-steps/getting-started",
            {
              "group": "LLM",
              "pages": [
                "tool/tool-steps/llms/llm",
                "tool/tool-steps/llms/llm-advance-setting",
                "tool/tool-steps/llms/validators",
                "tool/tool-steps/llms/how-to-handle-too-much-text",
                "tool/tool-steps/llms/prompt",
                "tool/tool-steps/llms/llm-output"
              ]
            },
            "tool/tool-steps/code-javascript",
            {
              "group": "Code - Python",
              "pages": [
                "tool/tool-steps/python-code/code-python",
                "tool/tool-steps/python-code/code-python-helper-functions",
                "tool/tool-steps/python-code/code-studio-transformation-python-helper-functions"
              ]
            },
            "tool/tool-steps/convert-pdf-to-text",
            "tool/tool-steps/extract-website-content",
            "tool/tool-steps/knowledge-search",
            "tool/tool-steps/convert-audio-video-to-text",
            "tool/tool-steps/insert-in-ds",
            "tool/tool-steps/split-text",
            "tool/tool-steps/vectorize-and-search",
            "tool/tool-steps/convert-spreadsheet-to-json",
            "tool/tool-steps/convert-string-to-json",
            "tool/tool-steps/json-filtered",
            "tool/tool-steps/combine-string-array"
          ]
        },
        {
          "group": "Knowledge",
          "pages": ["tool/knowledge/knowledge"]
        },
        {
          "group": "Run",
          "pages": ["tool/single-run", "tool/bulk-run"]
        },
        "tool/export",
        {
          "group": "Advanced setup",
          "pages": [
            "tool/advanced-setup/conditions",
            "tool/advanced-setup/loops",
            "tool/advanced-setup/output-configuration",
            "tool/advanced-setup/string-conversion"
          ]
        },
        {
          "group": "Provider setup",
          "pages": ["tool/provider-setup/azure-openai"]
        },
        {
          "group": "API",
          "pages": ["tool/api/long-running-tools"]
        },
        "tool/errors",
        "tool/faq"
      ]
    },
    {
      "group": "Data",
      "pages": ["data/introduction", "data/data-table", "data/faq"]
    },
    {
      "group": "Use cases",
      "pages": [
        {
          "group": "General",
          "pages": [
            "templates/gpt-on-my-files",
            "templates/gpt-on-my-website",
            "example-use-cases/knowledge-retrieval",
            "templates/extract-data-from-pdf",
            "templates/text-categorizer-classifier",
            "templates/summarize-meeting-transcript"
          ]
        },
        {
          "group": "Research",
          "pages": [
            "templates/category-tag-suggester",
            "templates/sentiment-analysis",
            "templates/anonymize-text",
            {
              "group": "Interview analysis",
              "pages": [
                "templates/audio-transcription-high-level-summary",
                "templates/audio-to-utterance-mark-sections",
                "templates/audio-to-utterance-data-table",
                "templates/category-suggester-for-transcript",
                "templates/focused-summarization-quote",
                "templates/analyze-responses-in-focus-groups"
              ]
            }
          ]
        },
        {
          "group": "Sales",
          "pages": [
            "example-use-cases/few-shot-prompting",
            "example-use-cases/prospecting"
          ]

        }
      ]
    },
    {
      "group": "Integrations",
      "pages": [
        "integrations/zoom",
        "integrations/salesforce",
        "integrations/hubspot",
        "integrations/whatsapp-personal",
        "integrations/outlook",
        "integrations/email-warmups",
        {
          "group": "Vector database",
          "pages": ["integrations/vector-databases/redis"]
        }
      ]
    },
    {
      "group": "SDK",
      "pages": [
        "sdk/quickstart",
        {
          "group": "Building chains",
          "pages": [
            "sdk/reference/creating-chain",
            "sdk/reference/setup",
            "sdk/reference/params"
          ]
        },
        "sdk/reference/transformation-steps",
        "sdk/reference/deploying-chain",
        "sdk/dashboard/notebook",
        {
          "group": "Guides",
          "pages": ["sdk/guides/pdf-qa", "sdk/guides/charting-agent"]
        }
      ]
    },
    {
      "group": "Datasets",
      "pages": ["datasets/introduction", "datasets/reference"]
    }
  ],
  "footerSocials": {
    "twitter": "https://twitter.com/relevanceai_",
    "github": "https://github.com/relevanceai",
    "linkedin": "https://linkedin.com/company/relevanceai"
  },
  "analytics": {
    "ga4": {
      "measurementId": "G-HZ1VEVP01K"
    },
    "posthog": {
      "apiKey": "phc_f3YHtchuTCLwrunsQCKtzQlUPbfy7yyKLezua95UIH"
    }
  },
  "redirects": [
    {
      "source": "/get-started/system_limits",
      "destination": "/get-started/system-limits"
    },
    {
      "source": "/docs/agent/agent-api",
      "destination": "/docs/agent/api/conversation"
    },
    {
      "source": "/agent/api-call-to-list-conversation",
      "destination": "/agent/api/list-conversations"
    },
    {
      "source": "/notebook/introduction",
      "destination": "/tool/introduction"
    },
    {
      "source": "/templates/bulk-run",
      "destination": "/tool/bulk-run"
    },
    {
      "source": "/templates/faq",
      "destination": "/tool/faq"
    },
    {
      "source": "/templates/introduction",
      "destination": "/tool/introduction"
    },
    {
      "source": "/templates/single-run",
      "destination": "/tool/single-run"
    },
    {
      "source": "/templates/long-running-tools",
      "destination": "/tool/api/long-running-tools"
    },
    {
      "source": "/tool/long-running-tools",
      "destination": "/tool/api/long-running-tools"
    },
    {
      "source": "/build-custom-tools/user-inputs/getting_started",
      "destination": "/tool/user-inputs/getting-started"
    },
    {
      "source": "/build-custom-tools/:slug*",
      "destination": "/tool/:slug*"
    }
  ]
}