mint.json

{
  "name": "Metal",
  "api": {
    "baseUrl": "https://api.getmetal.io"
  },
  "logo": {
    "href": "https://getmetal.io",
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  },
  "favicon": "/favicon.png",
  "colors": {
    "primary": "#008000",
    "light": "#1BBD1B",
    "dark": "#008000",
    "anchors": {
      "from": "#1BBD1B",
      "to": "#008000"
    }
  },
  "topbarCtaButton": {
    "type": "github",
    "url": "https://github.com/getmetal/Metal"
  },
  "topbarLinks": [
    {
      "name": "Contact",
      "url": "https://discord.gg/GHY3Y8tU3J"
    }
  ],
  "anchors": [
    {
      "name": "REST API",
      "icon": "rectangle-terminal",
      "url": "rest-api"
    },
    {
      "name": "Examples",
      "icon": "rectangle-code",
      "url": "examples"
    }
  ],
  "navigation": [
    {
      "group": "Introduction",
      "pages": [
        "introduction/introduction",
        "introduction/learn-introduction",
        {
          "group": "How Metal Works",
          "pages": [
            "introduction/learn-retrieval",
            "introduction/learn-memory",
            "introduction/learn-extraction"
          ]
        }
      ]
    },
    {
      "group": "Getting Started",
      "pages": ["getting-started/quickstart"]
    },
    {
      "group": "Products",
      "pages": [
        "product/attribute-extraction",
        "product/chatbot",
        "product/semantic-search"
      ]
    },
    {
      "group": "API Reference",
      "pages": [
        "api-reference/node",
        "api-reference/python",
        "api-reference/rest-api"
      ]
    },
    {
      "group": "Overview",
      "pages": ["rest-api/introduction"]
    },
    {
      "group": "🔑 Account",
      "pages": ["rest-api/account/get-current", "rest-api/account/get-org"]
    },
    {
      "group": "📈 Analytics",
      "pages": ["rest-api/analytics/get-queries"]
    },
    {
      "group": "🚀 Apps",
      "pages": [
        "rest-api/apps/add-app",
        "rest-api/apps/get-app",
        "rest-api/apps/get-apps",
        "rest-api/apps/update-app"
      ]
    },
    {
      "group": "📄 Data Entities",
      "pages": [
        "rest-api/dataentities/create",
        "rest-api/dataentities/get-one",
        "rest-api/dataentities/get-all",
        "rest-api/dataentities/delete"
      ]
    },
    {
      "group": "🗄️ Datasources",
      "pages": [
        "rest-api/datasources/create",
        "rest-api/datasources/get-one",
        "rest-api/datasources/get-all",
        "rest-api/datasources/update",
        "rest-api/datasources/delete"
      ]
    },
    {
      "group": "🧬 Embedding Documents",
      "pages": [
        "rest-api/documents/indexing",
        "rest-api/documents/bulk",
        "rest-api/documents/update",
        "rest-api/documents/search",
        "rest-api/documents/get-one",
        "rest-api/documents/get",
        "rest-api/documents/delete-one",
        "rest-api/documents/delete-many"
      ]
    },
    {
      "group": "🔗 Indexes",
      "pages": [
        "rest-api/indexes/post",
        "rest-api/indexes/get-one",
        "rest-api/indexes/get",
        "rest-api/indexes/update",
        "rest-api/indexes/delete"
      ]
    },
    {
      "group": "Platform",
      "pages": [
        "platform/analytics",
        "platform/integrations",
        "platform/limits",
        "platform/logs"
      ]
    },
    {
      "group": "Tools",
      "pages": ["tools/chatbot-starter-kit"]
    },
    {
      "group": "Guides",
      "pages": [
        "guides/misc-create-index",
        "guides/misc-get-queries",
        "guides/misc-create-chatbot",
        "guides/misc-semantic-search",
        "guides/misc-retrieval-pipeline",
        "guides/misc-chunking-config",
        "guides/misc-get-keys",
        "guides/misc-index-archiving",
        "guides/misc-run-attribute-extraction"
      ]
    },
    {
      "group": "Overview",
      "pages": ["examples/overview", "examples/node", "examples/python"]
    }
  ],
  "footerSocials": {
    "discord": "https://discord.gg/GHY3Y8tU3J",
    "github": "https://github.com/getmetal/Metal",
    "twitter": "https://twitter.com/Metal_io",
    "linkedin": "https://www.linkedin.com/company/getmetal/about/"
  }
}