mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Documentation",
  "logo": {
    "dark": "/logo/dark.png",
    "light": "/logo/light.png"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#161617",
    "light": "#FCFCFC",
    "dark": "#161617",
    "anchors": {
      "from": "#D9EE50",
      "to": "#FCFCFC"
    }
  },
  "topbarLinks": [
    {
      "name": "Support",
      "url": "mailto:support@poly-ai.com"
    },
    {
      "name": "Platform",
      "url": "https://jupiter.polyai.app/"
    }
  ],
  "topbarCtaButton": {
    "name": "Request a demo",
    "url": "https://poly.ai/request-a-demo/"
  },
  "tabs": [
    {
      "name": "Platform",
      "url": "/home"
    },
    {
      "name": "API Reference",
      "url": "/api-reference"
    },
    {
      "name": "Integrations",
      "url": "/integrations"
    }
  ],
  "anchors": [
    {
      "name": "Home",
      "icon": "book-open-cover",
      "url": "https://docs.poly.ai/home"
    },
    {
      "name": "Community",
      "icon": "slack",
      "url": "https://polyaijupiter-uki8686.slack.com/archives/C075ST5UK7Y"
    },
    {
      "name": "Blog",
      "icon": "newspaper",
      "url": "https://poly.ai/resources/?_resource_type=post"
    }
  ],
  "navigation": [
    {
      "group": "Introduction",
      "pages": [
        "/home",
        {
          "group": "Getting started",
          "pages": [
            "get-started/quickstart",
            "get-started/account-creation",
            "get-started/assistant-chat"
          ]
        }
      ]
    },
    {
      "group": "Analyze",
      "pages": [
        {
          "group": "Conversations",
          "pages": [
            "analytics/conversations/introduction",
            "analytics/conversations/review",
            "analytics/conversations/annotations",
            "analytics/conversations/diagnosis"
          ]
        },
        {
          "group": "Dashboards",
          "pages": [
            "analytics/dashboards/introduction",
            "analytics/dashboards/standard",
            "analytics/dashboards/safety",
            "analytics/dashboards/custom"
          ]
        },
        {
          "group": "Call data",
          "pages": [
            "call-data/introduction",
            "call-data/conversations-api/handoff-states",
            "call-data/conversations-api/list-conversations",
            "call-data/platform-transcripts",
            "call-data/s3-to-s3"
          ]
        }
      ]
    },
    {
      "group": "Build",
      "pages": [
        {
          "group": "Knowledge base",
          "pages": [
            "knowledge-base/introduction",
            {
              "group": "Actions",
              "pages": [
                "knowledge-base/how-to-setup-action/introduction",
                "knowledge-base/how-to-setup-action/send-sms",
                "knowledge-base/how-to-setup-action/function-call",
                "knowledge-base/how-to-setup-action/handoff"
              ]
            },
            "knowledge-base/RAG/introduction"
          ]
        },
        "agent-settings/rules",
        {
          "group": "Call handoffs",
          "pages": [
            "call-handoff/introduction"
          ]
        },
        {
          "group": "SMS",
          "pages": [
            "sms/introduction"
          ]
        },
        {
          "group": "Flows",
          "pages": [
            "flows/introduction",
            "flows/object"
          ]
        },
        {
          "group": "Functions",
          "pages": [
            "function/introduction",
            "function/how-to-setup",
            "function/using-functions-in-knowledge-base",
            "function/how-to-use-secret",
            "function/import-library",
            "function/variables",
            "function/start-function"
          ]
        },
        {
          "group": "Speech recognition",
          "pages": [
            "speech-recognition/introduction"
          ]
        },
        {
          "group": "Response control",
          "pages": [
            "response-control/introduction"
          ]
        },
        {
          "group": "About",
          "pages": [
            "agent-settings/about",
            "agent-settings/introduction",
            "agent-settings/model-use"
          ]
        }
      ]
    },
    {
      "group": "Configure",
      "pages": [
        {
          "group": "Audio management",
          "pages": [
            "audio-management/introduction"
          ]
        },
        "environments-and-versions/introduction",
        {
          "group": "Voice",
          "pages": [
            "voice/introduction",
            "voice/what-is-good-voice",
            "voice/configure",
            "voice/custom-voice-request"
          ]
        },
        {
          "group": "Variant management",
          "pages": [
            "variant-management/introduction"
          ]
        },
        {
          "group": "Telephony",
          "pages": [
            "telephony/introduction",
            "telephony/how-to-buy-number",
            {
              "group": "Twilio",
              "pages": [
                "telephony/twilio/introduction",
                "telephony/twilio/how-to-integrate-sms",
                "telephony/twilio/how-to-integrate-voice",
                "telephony/twilio/how-to-handoff"
              ]
            }
          ]
        },
        {
          "group": "User management",
          "pages": [
            "user-management/introduction",
            "user-management/access-control-scope",
            "user-management/invite-users"
          ]
        }
      ]
    },
    {
      "group": "Integrations",
      "pages": [
        "integrations/introduction"
      ]
    },
    {
      "group": "Voice",
      "pages": [
        "integrations/voice/introduction",
        "integrations/voice/amazon-connect",
        {
          "group": "SIP",
          "pages": [
            "integrations/voice/sip/five9",
            "integrations/voice/sip/genesys",
            "integrations/voice/sip/NICEinContact",
            "integrations/voice/sip/custom-sip"
          ]
        },
        "integrations/voice/twilio"
      ]
    },
    {
      "group": "Web chat",
      "pages": [
        "integrations/web-chat/introduction",
        "integrations/web-chat/in-app-chat",
        "integrations/web-chat/sms",
        "integrations/web-chat/whatsapp"
      ]
    },
    {
      "group": "Backend integrations",
      "pages": [
        "integrations/hotSOS",
        "integrations/opentable",
        "integrations/salesforce",
        "integrations/zendesk"
      ]
    },
    {
      "group": "API reference",
      "pages": [
        "api-reference/introduction"
      ]
    },
    {
      "group": "Chat",
      "pages": [
        "api-reference/chat/introduction",
        "api-reference/chat/endpoint/create-a-chat",
        "api-reference/chat/endpoint/respond-to-a-chat"
      ]
    },
    {
      "group": "Conversations",
      "pages": [
        "api-reference/conversations/endpoint/get-conversation",
        "api-reference/conversations/endpoint/get-handoff",
        "api-reference/conversations/endpoint/get-max-concurrent"
      ]
    },
    {
      "group": "Troubleshoot",
      "pages": [
        "troubleshoot/introduction",
        "troubleshoot/faq",
        "troubleshoot/error_code_debug",
        "troubleshoot/report",
        "troubleshoot/support-guide"
      ]
    },
    {
      "group": "Legal",
      "pages": [
        "legal/terms-of-service",
        "legal/privacy-policy",
        "legal/compliance"
      ]
    }
  ],
  "footerSocials": {
    "x": "https://x.com/polyaivoice",
    "youtube": "https://www.youtube.com/@polyaivoice",
    "facebook": "https://www.facebook.com/PolyAIVoice",
    "linkedin": "https://www.linkedin.com/company/polyai/"
  }
}