mintlify_chunks.json

[{"id":"d7a5983a-470f-4ab3-830e-555eb4f02ad9","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"18bb3669-e3b6-4fef-b100-7641f5e7d58e","created_at":"2024-06-25T04:45:28.049531","updated_at":"2024-06-25T04:45:28.049531","chunk_html":"Preview Distribution\nYou can now test if your distribution is set up properly by going to the General tab and visiting the Distribution domain name URL. All pages should be directing to your main landing page, but if you append /docs to the URL, you should see it going to the Mintlify documentation instance.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Preview Distribution"},"tracking_id":"integrations/subpath/route53-cloudfront-Preview-Distribution","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"97250c25-70fd-4ffd-ad3a-f5ee67807561","link":"content/components/code","qdrant_point_id":"39692241-243f-46df-872c-c39f25fafbe5","created_at":"2024-06-25T04:45:24.349709","updated_at":"2024-06-25T04:45:24.434542","chunk_html":"Syntax Highlighting\nPut the name of your programming language after the three backticks to get syntax highlighting. We use Prism for syntax highlighting. Test Drive Prism lists all the languages supported.","metadata":{"breadcrumbs":["Components","Code Blocks"],"title":"Syntax Highlighting"},"tracking_id":"content/components/code-Syntax-Highlighting","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/code"]},{"id":"ef53d037-9ad0-49ed-b7e6-ab6fa442f2bd","link":"integrations/analytics/google-analytics","qdrant_point_id":"2e002e7a-a27a-4ae6-a359-d2e663c7ca28","created_at":"2024-06-25T04:45:24.972617","updated_at":"2024-06-25T04:45:24.972618","chunk_html":"Wait\nGoogle Analytics takes two to three days to show your data. You can use the Google Analytics Debugger to check analytics are enabled correctly. The extension will log to your browser's console every time GA4 makes a request. Preview links have analytics turned off.","metadata":{"breadcrumbs":["Analytics","Google Analytics 4"],"title":"Wait"},"tracking_id":"integrations/analytics/google-analytics-Wait","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/google-analytics"]},{"id":"5e18aeb9-bedf-4135-b80c-834114f66f1e","link":"development","qdrant_point_id":"0e1f152b-d0d5-4875-ba76-25ae8dea9bf4","created_at":"2024-06-25T04:45:23.554051","updated_at":"2024-06-25T04:45:23.594160","chunk_html":"Validating Links\nThe CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Validating Links"},"tracking_id":"development-Validating-Links","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["development"]},{"id":"eecfc5b5-9993-4d44-8bae-8032445e6a4d","link":"integrations/user-auth/choosing-an-auth-method","qdrant_point_id":"9f31fbf9-5a32-4175-b489-469d71aad18f","created_at":"2024-06-25T04:45:25.299372","updated_at":"2024-06-25T04:45:25.299372","chunk_html":"Choosing an Auth Method\nHow to decide which auth method is right for your docs","metadata":{"breadcrumbs":["User Auth","Authenticating","Choosing an Auth Method"],"title":"Choosing an Auth Method"},"tracking_id":"integrations/user-auth/choosing-an-auth-method-Choosing-an-Auth-Method-How-to-d","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/user-auth/choosing-an-auth-method"]},{"id":"2597f60f-9195-40cb-a92f-a9e5df08dd9a","link":"integrations/analytics/clearbit","qdrant_point_id":"24f5cf6c-db8b-493c-ae69-12bab5afdf44","created_at":"2024-06-25T04:45:24.647269","updated_at":"2024-06-25T04:45:24.647269","chunk_html":"Clearbit\nClearbit\nAdd the following to your mint.json file to send analytics to Clearbit. \"analytics\": {\n    \"clearbit\": {\n        \"publicApiKey\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Clearbit"],"title":"Clearbit"},"tracking_id":"integrations/analytics/clearbit-Clearbit-Clearbit-Add-the-follow","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/clearbit"]},{"id":"083abd07-b0dd-4310-89fa-30fa3f006294","link":"integrations/support/front","qdrant_point_id":"9ccf2ccf-b8d0-47e0-bbd6-a44becd468e8","created_at":"2024-06-25T04:45:28.225538","updated_at":"2024-06-25T04:45:28.225539","chunk_html":"Front\nFront\nAdd the following to your mint.json file to add an Front Chat widget. \"integrations\": {\n    \"front\": \"CHAT_ID\"\n}","metadata":{"breadcrumbs":["Support","Front"],"title":"Front"},"tracking_id":"integrations/support/front-Front-Front-Add-the-following-to","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/support/front"]},{"id":"ea0127f6-406c-4169-9971-c865c314fcc6","link":"integrations/privacy/osano","qdrant_point_id":"7c5f2c50-9c14-4e6d-8340-18316dfef687","created_at":"2024-06-25T04:45:26.563241","updated_at":"2024-06-25T04:45:26.563241","chunk_html":"Osano\nOsano\nAdd the following to your mint.json file to add the Osano cookie consent manager. \"integrations\": {\n    \"osano\": \"SOURCE\"\n}","metadata":{"breadcrumbs":["Privacy","Osano"],"title":"Osano"},"tracking_id":"integrations/privacy/osano-Osano-Osano-Add-the-following-to","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/privacy/osano"]},{"id":"0960c3e0-b56e-45e6-911f-604e14eab96b","link":"integrations/analytics/koala","qdrant_point_id":"ec691751-4534-475f-8f1d-e90fe02079ea","created_at":"2024-06-25T04:45:25.199111","updated_at":"2024-06-25T04:45:25.199112","chunk_html":"Koala\nKoala\nAdd the following to your mint.json file to send analytics to Koala. \"analytics\": {\n    \"koala\": {\n        \"publicApiKey\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Koala"],"title":"Koala"},"tracking_id":"integrations/analytics/koala-Koala-Koala-Add-the-following-to","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/koala"]},{"id":"5e5b2a18-c820-47ca-95b4-70c1b6d24536","link":"integrations/analytics/plausible","qdrant_point_id":"2f5ea514-30fc-4011-9465-946bcb6e889c","created_at":"2024-06-25T04:45:25.871429","updated_at":"2024-06-25T04:45:25.871429","chunk_html":"Plausible\nPlausible\nAdd your site's domain to mint.json to send analytics to Plausible. Do not include http:// or https:// with your domain. \"analytics\": {\n    \"plausible\": {\n        \"domain\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Plausible"],"title":"Plausible"},"tracking_id":"integrations/analytics/plausible-Plausible-Plausible-Add-your-sit","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/plausible"]},{"id":"d7670021-455b-4ab6-ba9a-0d69befb3531","link":"content/components/accordions","qdrant_point_id":"60c03911-7852-456b-aaf8-623afea40ed1","created_at":"2024-06-25T04:45:23.183290","updated_at":"2024-06-25T04:45:23.183290","chunk_html":"Props\nTitle in the Accordion preview. Detail below the title in the Accordion preview. Whether the Accordion is open by default. A Font Awesome icon or SVG code One of \"regular\", \"solid\", \"light\", \"thin\", \"sharp-solid\", \"duotone\", or\n\"brands\"","metadata":{"breadcrumbs":["Components","Accordions"],"title":"Props"},"tracking_id":"content/components/accordions-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/accordions"]},{"id":"db204495-d268-4fa1-b545-f73127702bc7","link":"settings/versioning","qdrant_point_id":"1fc634f1-b4ea-4d30-9017-7d69d3d1cd2b","created_at":"2024-06-25T04:45:30.321792","updated_at":"2024-06-25T04:45:30.321792","chunk_html":"Setup\nAdd \"versions\": [\"v2\", \"v1\"] to your mint.json file where \"v1\" and \"v2\" are the names of your versions. You can put any number of versions in this array. The first version from the array serves as the default version. The versions dropdown will show your versions in the order you include them in\nmint.json.","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Setup"},"tracking_id":"settings/versioning-Setup","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"19f1963b-6332-4288-a731-1c1d89dedbe6","link":"integrations/support/intercom","qdrant_point_id":"c0b2e2c4-593c-4227-bee8-a1c14df6292f","created_at":"2024-06-25T04:45:25.134322","updated_at":"2024-06-25T04:45:25.134323","chunk_html":"Intercom\nIntercom\nAdd the following to your mint.json file to add an Intercom widget. \"integrations\": {\n    \"intercom\": \"APP_ID\"\n}","metadata":{"breadcrumbs":["Support","Intercom"],"title":"Intercom"},"tracking_id":"integrations/support/intercom-Intercom-Intercom-Add-the-follow","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/support/intercom"]},{"id":"2379edc2-7553-460a-88da-626709374d8b","link":"integrations/analytics/fathom","qdrant_point_id":"6a31a0ff-0043-4dd8-b0cb-75531569270f","created_at":"2024-06-25T04:45:24.790144","updated_at":"2024-06-25T04:45:24.790145","chunk_html":"Fathom\nFathom\nAdd the following to your mint.json file to send analytics to Fathom. You can get the siteId from your script settings. \"analytics\": {\n    \"fathom\": {\n        \"siteId\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Fathom"],"title":"Fathom"},"tracking_id":"integrations/analytics/fathom-Fathom-Fathom-Add-the-following-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/fathom"]},{"id":"2ad4bff6-ca36-421b-82ba-e32faaa26750","link":"integrations/analytics/logrocket","qdrant_point_id":"4a1c6c63-dcf6-47eb-b45b-60089e234b11","created_at":"2024-06-25T04:45:25.298319","updated_at":"2024-06-25T04:45:25.298320","chunk_html":"Logrocket\nLogrocket\nAdd the following to your mint.json file to send analytics to Logrocket. \"analytics\": {\n    \"logrocket\": {\n        \"apiKey\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Logrocket"],"title":"Logrocket"},"tracking_id":"integrations/analytics/logrocket-Logrocket-Logrocket-Add-the-foll","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/logrocket"]},{"id":"5ec88074-253d-4d25-a331-f90ffe920e73","link":"content/components/params","qdrant_point_id":"74b2ecec-5416-4c67-a363-4d5b3ce8c3a9","created_at":"2024-06-25T04:45:22.321734","updated_at":"2024-06-25T04:45:22.321734","chunk_html":"Props\nWhether it is a query, path, body, or header parameter followed by the name Expected type of the parameter's value Indicate whether the parameter is required Indicate whether the parameter is deprecated Default value used by the server if the request does not provide a value Value that will be used to initialize the playground Placeholder text for the input in the playground Description of the parameter (markdown enabled)","metadata":{"breadcrumbs":["API Components","Parameter Fields"],"title":"Props"},"tracking_id":"content/components/params-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/params"]},{"id":"6392b0b6-2815-4bf9-bfeb-69166b520683","link":"integrations/analytics/amplitude","qdrant_point_id":"9b2d0ffb-294b-4960-b11a-f30a1cffccd0","created_at":"2024-06-25T04:45:24.502893","updated_at":"2024-06-25T04:45:24.502893","chunk_html":"Amplitude\nAmplitude\nAdd the following to your mint.json file to send analytics to Amplitude. \"analytics\": {\n    \"amplitude\": {\n        \"apiKey\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Amplitude"],"title":"Amplitude"},"tracking_id":"integrations/analytics/amplitude-Amplitude-Amplitude-Add-the-foll","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/amplitude"]},{"id":"32d5b2c0-686f-4847-920f-a73484c7040b","link":"integrations/analytics/posthog","qdrant_point_id":"f09c89e1-56a7-444c-91ce-7d9e5aac10d8","created_at":"2024-06-25T04:45:26.057941","updated_at":"2024-06-25T04:45:26.057941","chunk_html":"PostHog\nPostHog\nAdd the following to your mint.json file to send analytics to PostHog. You only need to include apiHost if you are self-hosting PostHog. We send events to https://app.posthog.com by default. \"analytics\": {\n    \"posthog\": {\n        \"apiKey\": \"required\",\n        \"apiHost\": \"optional\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","PostHog"],"title":"PostHog"},"tracking_id":"integrations/analytics/posthog-PostHog-PostHog-Add-the-followin","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/posthog"]},{"id":"a959b2e6-5932-4a8b-8df4-917753bfdc66","link":"content/components/frames","qdrant_point_id":"4382fb8c-52ec-419f-957c-1e6f72abfdc3","created_at":"2024-06-25T04:45:24.724735","updated_at":"2024-06-25T04:45:24.724735","chunk_html":"Frames\nUse the Frame component to wrap images or other components in a container.","metadata":{"breadcrumbs":["Components","Frames"],"title":"Frames"},"tracking_id":"content/components/frames-Frames-Use-the-Frame-component-t","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/frames"]},{"id":"28cd1d05-0945-4a7e-be0a-2cc4533390e5","link":"settings/broken-links","qdrant_point_id":"8a25ba4e-d1cc-4c3f-8fbc-28a5a0da30ac","created_at":"2024-06-25T04:45:28.548656","updated_at":"2024-06-25T04:45:28.593737","chunk_html":"Broken Links\nCatch broken links with our CLI. Simply install the CLI and run the command: The CLI will identify any relative links in your docs that don't exist.","metadata":{"breadcrumbs":["Configurations","Redirects and Broken Links"],"title":"Broken Links"},"tracking_id":"settings/broken-links-Broken-Links","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/broken-links"]},{"id":"8eccc90b-4f3b-4e96-880a-a6fbaef98964","link":"integrations/analytics/heap","qdrant_point_id":"2dd6b143-01b7-4571-81db-f3d69f35d34a","created_at":"2024-06-25T04:45:24.937716","updated_at":"2024-06-25T04:45:24.937716","chunk_html":"Heap\nHeap\nAdd the following to your mint.json file to send analytics to Heap. \"analytics\": {\n    \"heap\": {\n        \"appId\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Heap"],"title":"Heap"},"tracking_id":"integrations/analytics/heap-Heap-Heap-Add-the-following-to-y","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/heap"]},{"id":"b79c5be4-73b1-4a1c-bbbb-98033f552d8b","link":"integrations/analytics/mixpanel","qdrant_point_id":"4d505813-c257-460c-aade-49048856f5aa","created_at":"2024-06-25T04:45:25.407734","updated_at":"2024-06-25T04:45:25.407734","chunk_html":"Mixpanel\nMixpanel\nAdd the following to your mint.json file to send analytics to Mixpanel. \"analytics\": {\n    \"mixpanel\": {\n        \"projectToken\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Mixpanel"],"title":"Mixpanel"},"tracking_id":"integrations/analytics/mixpanel-Mixpanel-Mixpanel-Add-the-follow","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/mixpanel"]},{"id":"767fcb6e-1c49-46d6-b5b0-88884a7ccf82","link":"settings/navigation","qdrant_point_id":"606a2a62-8c12-4d66-b538-35069ac6e7f5","created_at":"2024-06-25T04:45:29.797819","updated_at":"2024-06-25T04:45:29.841473","chunk_html":"Groups\nCreate groups by recursively nesting a group within a group.","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Groups"},"tracking_id":"settings/navigation-Groups","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"4ee73926-84a8-4cde-84d2-d60b96721c54","link":"integrations/analytics/pirsch","qdrant_point_id":"d8bd48dc-4f07-4aee-8c36-c9d8459910c9","created_at":"2024-06-25T04:45:25.724645","updated_at":"2024-06-25T04:45:25.724646","chunk_html":"Pirsch\nPirsch\nAdd the following to your mint.json file to send analytics to Pirsch. You can get your site ID from Settings > Developer > Identification Code. \"analytics\": {\n    \"pirsch\": {\n        \"id\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Pirsch"],"title":"Pirsch"},"tracking_id":"integrations/analytics/pirsch-Pirsch-Pirsch-Add-the-following-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/pirsch"]},{"id":"7f511c13-49e7-43ab-8b7f-696745b2fd43","link":"integrations/analytics/hotjar","qdrant_point_id":"b42c2442-6bd9-43e6-b5b0-2cf1bf10c519","created_at":"2024-06-25T04:45:25.053644","updated_at":"2024-06-25T04:45:25.053644","chunk_html":"HotJar\nHotJar\nAdd the following to your mint.json file to send analytics to HotJar. \"analytics\": {\n    \"hotjar\": {\n        \"hjid\": \"required\",\n        \"hjsv\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","HotJar"],"title":"HotJar"},"tracking_id":"integrations/analytics/hotjar-HotJar-HotJar-Add-the-following-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/hotjar"]},{"id":"45ac1a3b-50f5-4599-ad51-3f6527988c3d","link":"development","qdrant_point_id":"8718c59d-7293-49fb-bee9-8b0a72ad0b0f","created_at":"2024-06-25T04:45:23.624363","updated_at":"2024-06-25T04:45:23.624364","chunk_html":"Deployment\nIf the deployment is successful, you should see the following:","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Deployment"},"tracking_id":"development-Deployment","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["development"]},{"id":"d04e7160-825d-458c-bb09-dddcaa3deb18","link":"list-table","qdrant_point_id":"fde63b44-43fe-47a6-99d9-1890a783c49b","created_at":"2024-06-25T04:45:26.179434","updated_at":"2024-06-25T04:45:26.179434","chunk_html":"Lists and Tables\nDisplay information in lists and tables","metadata":{"breadcrumbs":["Writing Content","Lists and Tables"],"title":"Lists and Tables"},"tracking_id":"list-table-Lists-and-Tables-Display-informa","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["list-table"]},{"id":"92265fb2-8558-474d-93f5-7ed1edcf750d","link":"content/components/expandables","qdrant_point_id":"2fb6cd2b-48ee-462b-8102-89c92d8e42b6","created_at":"2024-06-25T04:45:24.684762","updated_at":"2024-06-25T04:45:24.684762","chunk_html":"Props\nThe name of the object you are showing. Used to generate the \"Show NAME\" and\n\"Hide NAME\" text. Set to true to show the component as open when the page loads.","metadata":{"breadcrumbs":["API Components","Expandables"],"title":"Props"},"tracking_id":"content/components/expandables-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/expandables"]},{"id":"3a9d8bc0-a51c-47a4-b6f0-be32d8875fd1","link":"api-playground/openapi/advanced-features","qdrant_point_id":"900c442d-7061-4d8f-8845-6ab5639f19b3","created_at":"2024-06-25T04:45:21.787819","updated_at":"2024-06-25T04:45:21.842840","chunk_html":"x-codeSamples\nIf your users interact with your API using an SDK rather than directly through a network request, you can add code samples to your OpenAPI document, and Mintlify will display them in your OpenAPI pages. You can define your code samples using the x-codeSamples extension. This property can be added within any request method, and has the following schema: The language of the code sample. The label for the sample. This is useful when providing multiple examples for a single endpoint. The source code of the sample. Here's an example of some code samples for a plant tracking app, which has both a Bash CLI tool and a JavaScript SDK.","metadata":{"breadcrumbs":["API References","Using OpenAPI","Advanced Features"],"title":"x-codeSamples"},"tracking_id":"api-playground/openapi/advanced-features-x-codeSamples","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/advanced-features"]},{"id":"63a94fa5-9524-4efa-bd7e-7149db18fc6d","link":"integrations/rest-api/update-status","qdrant_point_id":"805f5e5a-123d-4ebf-9ef6-c9eb32dfd473","created_at":"2024-06-25T04:45:26.950017","updated_at":"2024-06-25T04:45:26.950017","chunk_html":"\n\nREST Endpoint GET /project/update-status/{statusId}\n\nSummary: Get the status of an update \n\nDescription: N/A\n\nSecurity methods: \nheader: Authorization: bearer auth\n\nRequest params: \npath params:\nstatusId:\n\tstring\n\tDescription: The status ID of a triggered update.\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: object\n\tDescription: N/A\n\tExample: {\"_id\":\"<string>\",\"projectId\":\"<string>\",\"createdAt\":\"<string>\",\"endedAt\":\"<string>\",\"status\":\"queued\",\"summary\":\"<string>\",\"logs\":[\"<string>\"],\"subdomain\":\"<string>\",\"screenshot\":\"<string>\",\"screenshotLight\":\"<string>\",\"screenshotDark\":\"<string>\",\"author\":\"<string>\",\"commit\":{\"sha\":\"<string>\",\"ref\":\"<string>\",\"message\":\"<string>\",\"filesChanged\":{\"added\":[\"<string>\"],\"modified\":[\"<string>\"],\"removed\":[\"<string>\"]}},\"source\":\"internal\"}\n\n","metadata":{},"tracking_id":"integrations/rest-api/update-status-API-Metadata:-GET-/project/update-status/{statusId}","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"code","num_value":null,"group_tracking_ids":["integrations/rest-api/update-status"]},{"id":"5e10fa0c-ef63-47fd-9388-76b4413f4bc5","link":"content/components/steps","qdrant_point_id":"fea7fd2e-f0a3-4754-85df-67ff8ee67780","created_at":"2024-06-25T04:45:22.538370","updated_at":"2024-06-25T04:45:22.582743","chunk_html":"Steps\nSteps are the best way to display a series of actions of events to your users. You can add as many steps as desired. First Step These are instructions or content that only pertain to the first step. Second Step These are instructions or content that only pertain to the second step. Third Step These are instructions or content that only pertain to the third step.","metadata":{"breadcrumbs":["Components","Steps"],"title":"Steps"},"tracking_id":"content/components/steps-Steps","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/steps"]},{"id":"af766324-c64c-43f8-842d-78413a523e95","link":"api-playground/openapi/advanced-features","qdrant_point_id":"ad76ce29-1025-490e-8aaf-ffdf7a66df0a","created_at":"2024-06-25T04:45:21.752044","updated_at":"2024-06-25T04:45:21.752044","chunk_html":"oneOf, anyOf, allOf\nFor complex datatypes, OpenAPI provides the oneOf , anyOf , and allOf keywords, allowing you to combine schemas in certain ways. You can read more about these keywords in the Swagger documentation , but essentially: oneOf functions like an \"exclusive-or\" operator anyOf functions like an \"or\" operator allOf functions like an \"and\" operator Mintlify treats the oneOf and anyOf keywords the same. We have found that, when people use oneOf , they often mean anyOf - and there is often no meaningful difference to the user. Mintlify performs some preprocessing on your OpenAPI document to display these complex combinations in a readable way. For example, when you combine two object schemas with allOf , Mintlify combines the properties of both into a single object. When you combine two schemas with anyOf or oneOf , Mintlify displays the options in a tabbed container. To give your options helpful names, make sure to give each subschema a unique title field. Mintlify currently does not support the not keyword.","metadata":{"breadcrumbs":["API References","Using OpenAPI","Advanced Features"],"title":"oneOf, anyOf, allOf"},"tracking_id":"api-playground/openapi/advanced-features-oneOf,-anyOf,-allOf","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/advanced-features"]},{"id":"151e13f3-ff4d-4f0a-aeb4-a4084b7514c8","link":"page","qdrant_point_id":"2c32e069-c335-4240-bcf3-b97ac4f2ad68","created_at":"2024-06-25T04:45:26.854313","updated_at":"2024-06-25T04:45:26.896617","chunk_html":"Descriptions\nYou can show a description that shows directly under the title with the\ndescription metadata.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Descriptions"},"tracking_id":"page-Descriptions","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"b89727ce-4356-4c23-85cc-8708e0785074","link":"content/components/accordion-groups","qdrant_point_id":"98f5fb5e-40ee-4999-b8d3-bec9792026fe","created_at":"2024-06-25T04:45:22.952337","updated_at":"2024-06-25T04:45:22.952338","chunk_html":"Accordion Groups\nGroup multiple accordions into a single display.","metadata":{"breadcrumbs":["Components","Accordion Groups"],"title":"Accordion Groups"},"tracking_id":"content/components/accordion-groups-Accordion-Groups-Group-multiple-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/accordion-groups"]},{"id":"66b96b39-bd9a-437e-a89f-e3d9592fceb4","link":"content/components/accordions","qdrant_point_id":"77ff76e4-af54-4c7b-ac24-f860b73b407d","created_at":"2024-06-25T04:45:23.087443","updated_at":"2024-06-25T04:45:23.087444","chunk_html":"Accordions\nA dropdown component for toggling content","metadata":{"breadcrumbs":["Components","Accordions"],"title":"Accordions"},"tracking_id":"content/components/accordions-Accordions-A-dropdown-component-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/accordions"]},{"id":"3d0c824d-41d7-4592-82a9-3f5eda7b7607","link":"image-embeds","qdrant_point_id":"4e8c18c7-8e8b-446f-a267-e29ba2a7ccc2","created_at":"2024-06-25T04:45:23.725008","updated_at":"2024-06-25T04:45:23.725008","chunk_html":"Images, Videos, and Embeds\nAdd image, video, and other HTML elements","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Images, Videos, and Embeds"},"tracking_id":"image-embeds-Images,-Videos,-and-Embeds-Add-i","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["image-embeds"]},{"id":"3bfd9d35-dad9-4020-9772-5c882bfab488","link":"page","qdrant_point_id":"8c92aada-cdc6-4dfb-9c93-f31147643316","created_at":"2024-06-25T04:45:27.056559","updated_at":"2024-06-25T04:45:27.103605","chunk_html":"Wide Mode\nYou can hide the table of contents on the right side of the page. This is useful\nif you don't have any headings, or you want to take advantage of the extra\nhorizontal space.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Wide Mode"},"tracking_id":"page-Wide-Mode","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"5863fa2d-9a3a-4e4b-9a81-97579f1b54ba","link":"content/components/steps","qdrant_point_id":"608fabe5-a086-48c3-9775-5c31bc8675ac","created_at":"2024-06-25T04:45:22.500298","updated_at":"2024-06-25T04:45:22.500298","chunk_html":"Steps\nSequence content using the Steps component","metadata":{"breadcrumbs":["Components","Steps"],"title":"Steps"},"tracking_id":"content/components/steps-Steps-Sequence-content-using-the","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/steps"]},{"id":"0d982635-1c9e-409d-bc12-eaae1a3f6a7f","link":"settings/global","qdrant_point_id":"3a5f0857-bec1-4712-ab73-3ed4e0260fef","created_at":"2024-06-25T04:45:29.273179","updated_at":"2024-06-25T04:45:29.323626","chunk_html":"Redirects\nAn array of paths you want to configure to permanently redirect to another path Example: Redirect The path that you want to redirect from. Example: /source The path that you want to redirect to. Example: /destination","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Redirects"},"tracking_id":"settings/global-Redirects","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"072d2eaf-ff2a-4f23-ba4e-8d3d8f548e6f","link":"content/components/icons","qdrant_point_id":"40d4bc92-5073-4eea-976d-2390b1f70e77","created_at":"2024-06-25T04:45:21.856350","updated_at":"2024-06-25T04:45:21.856351","chunk_html":"Props\nA Font Awesome icon One of regular , solid , light , thin , sharp-solid , duotone , brands The color of the icon as a hex code The size of the icon in pixels","metadata":{"breadcrumbs":["Components","Icons"],"title":"Props"},"tracking_id":"content/components/icons-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/icons"]},{"id":"f09fbf48-ff84-47d1-841a-8aeef15025d7","link":"reusable-snippets","qdrant_point_id":"528416bd-df23-49b2-bc29-9ea39fdfae60","created_at":"2024-06-25T04:45:27.803626","updated_at":"2024-06-25T04:45:27.803626","chunk_html":"Reusable Snippets\nOne of the core principles of software development is DRY (Don't Repeat\nYourself). This is a principle that applies to documentation as\nwell. If you find yourself repeating the same content in multiple places, you\nshould consider creating a custom snippet to keep your content in sync.","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Reusable Snippets"},"tracking_id":"reusable-snippets-Reusable-Snippets","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["reusable-snippets"]},{"id":"c63bec53-5eb8-4275-8ecf-80b0cd988ae3","link":"list-table","qdrant_point_id":"03b24bfa-7481-4347-bc06-eb81e3959a6a","created_at":"2024-06-25T04:45:26.213713","updated_at":"2024-06-25T04:45:26.260126","chunk_html":"Ordered List\nTo create an ordered list, add line items with numbers followed by periods First item Second item Third item Fourth item","metadata":{"breadcrumbs":["Writing Content","Lists and Tables"],"title":"Ordered List"},"tracking_id":"list-table-Ordered-List","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["list-table"]},{"id":"54b558a7-3287-4f66-b02a-b4b8e3d7101d","link":"text","qdrant_point_id":"115d1651-94b9-4aa7-8005-7aff4c086cc2","created_at":"2024-06-25T04:45:30.904830","updated_at":"2024-06-25T04:45:30.904830","chunk_html":"Linking to Pages\nYou can add a link by wrapping text in []() . You would write [link to google](https://google.com) to link to google. Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, [link to text](/content/text) links to the page \"Text\" in our components section. Relative links like [link to text](../text) will open slower because we cannot optimize them as easily. You can validate broken links in your docs with our CLI.","metadata":{"breadcrumbs":["Writing Content","Headers and Text"],"title":"Linking to Pages"},"tracking_id":"text-Linking-to-Pages","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["text"]},{"id":"45bcfbb3-9186-4153-86d9-87a0f242415c","link":"content/components/callouts","qdrant_point_id":"d92cc49c-1532-4d7f-bbeb-6fd44c8efa5e","created_at":"2024-06-25T04:45:23.229517","updated_at":"2024-06-25T04:45:23.229517","chunk_html":"Callout Boxes\nUse callouts to add eye-catching context to your content","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Callout Boxes"},"tracking_id":"content/components/callouts-Callout-Boxes-Use-callouts-to-ad","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/callouts"]},{"id":"68ffaede-c434-468f-9372-9e850f31d4d2","link":"content/components/frames","qdrant_point_id":"92e308e3-fb59-4ab3-b525-42eae66480f9","created_at":"2024-06-25T04:45:21.484179","updated_at":"2024-06-25T04:45:21.484179","chunk_html":"Frames\nFrames are very helpful if you want to center an image.","metadata":{"breadcrumbs":["Components","Frames"],"title":"Frames"},"tracking_id":"content/components/frames-Frames","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/frames"]},{"id":"77caca84-8d17-410f-be6f-aae565516ada","link":"integrations/sdks/stainless","qdrant_point_id":"7b70b61e-bfcb-48ef-a981-9038664c6f3e","created_at":"2024-06-25T04:45:27.353691","updated_at":"2024-06-25T04:45:27.353691","chunk_html":"Stainless\nAutomate your SDK example snippets in the API playground","metadata":{"breadcrumbs":["SDKs","Stainless"],"title":"Stainless"},"tracking_id":"integrations/sdks/stainless-Stainless-Automate-your-SDK-exam","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/sdks/stainless"]},{"id":"2fa2a75b-4ac5-42bc-a747-105cd07bcf15","link":"settings/custom-domain","qdrant_point_id":"9a2c7e3a-fb2f-45d8-b483-e288d3cf1551","created_at":"2024-06-25T04:45:28.382942","updated_at":"2024-06-25T04:45:28.382942","chunk_html":"Custom Domain\nTo set up your documentation on a custom subdomain, you'll need to set your desired custom subdomain in your Mintlify settings and configure your DNS settings on your domain provider. Looking to set up a custom subdirectory domain like mintlify.com/docs? Find\ninstructions here.","metadata":{"breadcrumbs":["Configurations","Custom Domain"],"title":"Custom Domain"},"tracking_id":"settings/custom-domain-Custom-Domain","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/custom-domain"]},{"id":"1632e13f-4c52-48d6-b8c5-9c416261f0d7","link":"content/components/card-groups","qdrant_point_id":"c3d297e2-e754-4dd7-a46c-fd1032d649e8","created_at":"2024-06-25T04:45:23.604847","updated_at":"2024-06-25T04:45:23.604848","chunk_html":"Card Groups\nShow cards side by side in a grid format","metadata":{"breadcrumbs":["Components","Card Groups"],"title":"Card Groups"},"tracking_id":"content/components/card-groups-Card-Groups-Show-cards-side-by-s","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/card-groups"]},{"id":"81e64721-b1c0-47a7-9df8-6744bd5ec7ee","link":"settings/navigation","qdrant_point_id":"ce7bbfd2-966f-427a-99e5-1993adb85ed0","created_at":"2024-06-25T04:45:29.510581","updated_at":"2024-06-25T04:45:29.598913","chunk_html":"Tabs\nTabs help distinguish between different topics or sections of your\ndocumentation. They show up above the main sidebar. Configure tabs with the tabs field of the mint.json file. The url field of\nthe tab object should map to a folder of content added to your sidebar, or an\nexternal link. To configure the default Documentation primary tab, add the primaryTab field\nto your mint.json file with your desired name. Any files in your navigation\nnot in a folder reserved by another tab will show up in the primary tab.","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Tabs"},"tracking_id":"settings/navigation-Tabs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"16e1d1b7-be4e-4ca6-ab0a-d0f0193f1c7a","link":"content/components/code","qdrant_point_id":"68aaeafa-16c0-4f57-bf60-c45e527c17a6","created_at":"2024-06-25T04:45:24.248415","updated_at":"2024-06-25T04:45:24.330876","chunk_html":"Basic Code Block\nUse fenced code blocks by enclosing code in three backticks.","metadata":{"breadcrumbs":["Components","Code Blocks"],"title":"Basic Code Block"},"tracking_id":"content/components/code-Basic-Code-Block","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/code"]},{"id":"1156695f-aaa2-4870-898d-edeaa9b5eb3f","link":"image-embeds","qdrant_point_id":"33f2b9e9-3463-4f07-aad7-37fbdec18cab","created_at":"2024-06-25T04:45:23.921905","updated_at":"2024-06-25T04:45:23.967368","chunk_html":"Disable Image Zoom\nTo disable the default zoom on click for images, add the noZoom property to image embeds.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Disable Image Zoom"},"tracking_id":"image-embeds-Disable-Image-Zoom","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["image-embeds"]},{"id":"0e24c2c0-a01c-4949-b4e4-ece18cd50209","link":"content/components/callouts","qdrant_point_id":"254b6512-ceac-4992-9772-630a2d400237","created_at":"2024-06-25T04:45:23.480200","updated_at":"2024-06-25T04:45:23.526470","chunk_html":"Tip Callouts\nThis suggests a helpful tip","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Tip Callouts"},"tracking_id":"content/components/callouts-Tip-Callouts","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/callouts"]},{"id":"2f704bc5-70b2-47d0-8123-5fd6c4619571","link":"settings/versioning","qdrant_point_id":"6f425954-c3d0-4e07-81b0-3cf7752b105e","created_at":"2024-06-25T04:45:30.656377","updated_at":"2024-06-25T04:45:30.656377","chunk_html":"Reusable Pages\nNot all content has to be hidden though! Any content without a version value shows up in every version so you never duplicate content!","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Reusable Pages"},"tracking_id":"settings/versioning-Reusable-Pages","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"337dfa5a-a747-4f26-953c-30dd52cfde72","link":"api-playground/mdx/authentication","qdrant_point_id":"1a3b5fd2-ea90-41a5-a10f-4340e3a551c7","created_at":"2024-06-25T04:45:21.334768","updated_at":"2024-06-25T04:45:21.421420","chunk_html":"Authentication Name\nBy default, basic authentication asks for username and password. However, basic authentication can use a different name for username and password. For example, you could have called it user-id:user-key. You can set the name property in mint.json to override the default functionality. Use colons to separate each property you want to request. You can also request a single API key by excluding the colon.","metadata":{"breadcrumbs":["API References","Using MDX","Authentication"],"title":"Authentication Name"},"tracking_id":"api-playground/mdx/authentication-Authentication-Name","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/mdx/authentication"]},{"id":"ba4818bf-cbad-4aef-aba6-c4c49349cedb","link":"integrations/analytics/clearbit","qdrant_point_id":"7e96af9a-4163-4751-8b44-a906bf2bcebd","created_at":"2024-06-25T04:45:24.537644","updated_at":"2024-06-25T04:45:24.627028","chunk_html":"Clearbit\nAdd the following to your mint.json file to send analytics to Clearbit.","metadata":{"breadcrumbs":["Analytics","Clearbit"],"title":"Clearbit"},"tracking_id":"integrations/analytics/clearbit-Clearbit","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/clearbit"]},{"id":"c680d65a-e28c-4d27-9611-2e75db7913c2","link":"integrations/subpath/cloudflare","qdrant_point_id":"8d19ebf5-bc7c-4b94-a2c1-798b1c70a6c7","created_at":"2024-06-25T04:45:27.668125","updated_at":"2024-06-25T04:45:27.744415","chunk_html":"Edit Worker Script\nClick on Edit Code and add the following script into the worker's code. Edit DOCS_URL by replacing [SUBDOMAIN] with your unique subdomain and\nCUSTOM_URL with your website's base URL. Click on Deploy and wait for the changes to propagate (it can take up to a few\nhours).","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Edit Worker Script"},"tracking_id":"integrations/subpath/cloudflare-Edit-Worker-Script","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/cloudflare"]},{"id":"f8d77267-add1-4369-ab5f-2dd1bbd1d436","link":"content/components/callouts","qdrant_point_id":"68087a1b-84ce-4104-9a6e-c996c5a65880","created_at":"2024-06-25T04:45:23.262918","updated_at":"2024-06-25T04:45:23.304328","chunk_html":"Note Callouts\nThis adds a note in the content","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Note Callouts"},"tracking_id":"content/components/callouts-Note-Callouts","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/callouts"]},{"id":"8f92a3a6-67a2-4950-ac4a-d6ab5e6c2b22","link":"settings/github","qdrant_point_id":"d18f70d2-d6cb-4054-a3e0-baf5481881e7","created_at":"2024-06-25T04:45:28.651045","updated_at":"2024-06-25T04:45:28.651045","chunk_html":"Permissions\nDuring the installation of our GitHub app, you will be prompted to grant certain\npermissions: Read and write access to checks , contents , deployments , pull requests ,\nand workflows These permissions are leveraged to provide a seamless experience when managing\nyour docs. When you make a commit to the branch you configured as your docs deployment\nbranch, we fetch the contents of the files changed to update your docs. To\naccomplish this we need read access to your contents. When pull requests are created we create a check and preview deployment which is\nwhy we need write access to checks and deployments. Inside the Mintlify web editor, Mintlify works on your behalf to create branches\nand pull requests which is why we need write access to pull requests and\nworkflows. If you are concerned about the write permissions, the GitHub App will only\nhave access to the repos you give it access to and if you have branch\nprotections on it cannot push directly to your branches - it abides by your\nbranch protection rules.","metadata":{"breadcrumbs":["Configurations","GitHub"],"title":"Permissions"},"tracking_id":"settings/github-Permissions","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/github"]},{"id":"71ec362d-841f-4772-8baf-b1336d9b1ef6","link":"api-playground/openapi/setup","qdrant_point_id":"fc2f19d5-a1fe-44a0-a6c7-e99a5ad73906","created_at":"2024-06-25T04:45:22.083992","updated_at":"2024-06-25T04:45:22.083992","chunk_html":"Create MDX files for OpenAPI endpoints\nTo add the OpenAPI endpoints into your docs, each endpoint requires a corresponding MDX file. You can autogenerate these MDX files from your OpenAPI document using our scraper, or create each page manually.","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"Create MDX files for OpenAPI endpoints"},"tracking_id":"api-playground/openapi/setup-Create-MDX-files-for-OpenAPI-endpoints","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/setup"]},{"id":"73c35991-59fa-4f5e-ad51-064c8e9ab244","link":"settings/navigation","qdrant_point_id":"cdf17de6-866a-4f1b-aa16-bf1dee63e8b0","created_at":"2024-06-25T04:45:29.865263","updated_at":"2024-06-25T04:45:29.950789","chunk_html":"Folders\nSimply put your MDX files in folders and update the paths in mint.json. For example, to have a page at https://yoursite.com/your-folder/your-page you\nwould make a folder called your-folder containing an MDX file called\nyour-page.mdx. You cannot use api for the name of a folder unless you nest it inside\nanother folder. Mintlify uses Next.js which reserves the top-level api folder for internal server calls. We recommend using the folder name\napi-reference instead.","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Folders"},"tracking_id":"settings/navigation-Folders","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"5044d4f8-cac9-49eb-8769-23ff3d9e909e","link":"settings/seo","qdrant_point_id":"b3bdf236-fde4-4660-909c-06d5c0b9070e","created_at":"2024-06-25T04:45:30.221782","updated_at":"2024-06-25T04:45:30.264811","chunk_html":"Sitemaps\nMintlify automatically generates a sitemap.xml file and a robots.txt file. Simply add /sitemap.xml to the end of your website URL to see your sitemap. We recommend submitting the sitemap to search engines for improved SEO. Only pages included in your mint.json are included by default. To include hidden links, add seo.indexHiddenPages to your mint.json:","metadata":{"breadcrumbs":["Configurations","Search Engine Optimization"],"title":"Sitemaps"},"tracking_id":"settings/seo-Sitemaps","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/seo"]},{"id":"ef5ab392-ff35-48b3-a17e-64276b4e48f7","link":"content/components/responses","qdrant_point_id":"290d83f2-1e0d-4579-8b71-e13faa98fba0","created_at":"2024-06-25T04:45:22.469194","updated_at":"2024-06-25T04:45:22.469194","chunk_html":"Props\nThe name of the response value. Expected type of the response value The default value. Show \"required\" beside the field name.","metadata":{"breadcrumbs":["API Components","Response Fields"],"title":"Props"},"tracking_id":"content/components/responses-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/responses"]},{"id":"8c5449bf-7649-42c6-94d7-918c13ba00b5","link":"content/components/callouts","qdrant_point_id":"9ff1dd06-8bea-4515-a913-13083025ef30","created_at":"2024-06-25T04:45:23.342704","updated_at":"2024-06-25T04:45:23.386959","chunk_html":"Warning Callouts\nThis raises a warning to watch out for","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Warning Callouts"},"tracking_id":"content/components/callouts-Warning-Callouts","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/callouts"]},{"id":"4f3d4bad-00ed-4a7d-9667-1bc42e2f86c2","link":"text","qdrant_point_id":"a393aba0-a1b8-4746-b75e-9a90a9de0fb8","created_at":"2024-06-25T04:45:30.719417","updated_at":"2024-06-25T04:45:30.719417","chunk_html":"Headers and Text\nText, title, and styling in standard markdown","metadata":{"breadcrumbs":["Writing Content","Headers and Text"],"title":"Headers and Text"},"tracking_id":"text-Headers-and-Text-Text,-title,-an","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["text"]},{"id":"f7d9a6c2-2cdb-4621-9c2f-9d67426e9b63","link":"integrations/user-auth/choosing-an-auth-method","qdrant_point_id":"cccc112f-58c9-4018-a5cd-93ed33ad9e1c","created_at":"2024-06-25T04:45:25.407946","updated_at":"2024-06-25T04:45:25.407946","chunk_html":"Pros & Cons\nShared Session Pros: Users that are logged into your dashboard are automatically logged into your docs Your users' sessions are persistent, meaning you can refresh data without requiring additional login Minimal setup required Cons: Your docs will make a request to your backend, which may be undesirable JWT Pros: No dashboard needed Reduced risk of API endpoint abuse Zero CORS configuration Cons: Must build new functionality around your existing login flow Dashboard sessions and docs authentication are completely decoupled, so users will need to log in to your dashboard and your docs separately Every time you want to refresh user data, your users must re-login to your docs If your users' data changes frequently, you must require your users to log in frequently or risk having stale data in the docs If your users' data rarely changes, this shouldn't be a problem","metadata":{"breadcrumbs":["User Auth","Authenticating","Choosing an Auth Method"],"title":"Pros & Cons"},"tracking_id":"integrations/user-auth/choosing-an-auth-method-Pros-&-Cons","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/choosing-an-auth-method"]},{"id":"685aa50e-deec-40a2-8f64-410f8cf68994","link":"integrations/user-auth/choosing-an-auth-method","qdrant_point_id":"42fb34ef-e9be-4da8-88a8-c800b1965874","created_at":"2024-06-25T04:45:25.369240","updated_at":"2024-06-25T04:45:25.369240","chunk_html":"Prerequisites\nShared Session You have a dashboard or other user portal hosted at your domain. Your users' session credentials are stored as cookies. You can create a new API endpoint at the same origin or a subdomain of your dashboard. If your dashboard is at foo.com , the API URL must start with foo.com or *.foo.com If your dashboard is at dash.foo.com , the API URL must start with dash.foo.com or *.dash.foo.com Your docs are hosted at the same domain as your dashboard. If your dashboard is at foo.com , your docs must be hosted at foo.com or *.foo.com If your dashboard is at *.foo.com , your docs must be hosted at foo.com or *.foo.com JWT You have some existing login flow. You can add a final step in this login flow that creates a JWT and redirects to the docs.","metadata":{"breadcrumbs":["User Auth","Authenticating","Choosing an Auth Method"],"title":"Prerequisites"},"tracking_id":"integrations/user-auth/choosing-an-auth-method-Prerequisites","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/choosing-an-auth-method"]},{"id":"f4ad1a57-deb7-4a1c-8732-c7cdbd0396c1","link":"integrations/user-auth/shared-session","qdrant_point_id":"9d9fa22d-3cbe-4d6e-92ef-3bc82d5741ae","created_at":"2024-06-25T04:45:26.004695","updated_at":"2024-06-25T04:45:26.004695","chunk_html":"Implementation\nCreate your Info API Create an API endpoint that uses session authentication to identify users, and responds with a JSON payload following the UserInfo format. If the API domain does not exactly match the docs domain: Add the docs domain to your API's Access-Control-Allow-Origin header (must not be *) Ensure your API’s Access-Control-Allow-Credentials header is true These CORS options only need to be enabled on the single endpoint responsible for returning user information. We do not recommend enabling these options on all dashboard endpoints. Configure your User Auth settings Go to your Mintlify dashboard settings and add the API URL and your Login URL to your User Auth settings.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Implementation"},"tracking_id":"integrations/user-auth/shared-session-Implementation","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/shared-session"]},{"id":"3c79c8e9-7689-4153-a6fc-be479275eb36","link":"content/components/code-groups","qdrant_point_id":"27715878-aa2f-413d-8fd8-3235dad33852","created_at":"2024-06-25T04:45:23.986530","updated_at":"2024-06-25T04:45:24.156838","chunk_html":"Code Groups\nYou will need to make Code Blocks then add the <CodeGroup> component around them. Every Code Block must have a filename because we use the names for the tab buttons. See below for an example of the end result.","metadata":{"breadcrumbs":["Components","Code Groups"],"title":"Code Groups"},"tracking_id":"content/components/code-groups-Code-Groups","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/code-groups"]},{"id":"6b0d428c-44ea-4f7e-807e-4c02f4dbf756","link":"settings/authentication","qdrant_point_id":"c2db3523-2cdd-4576-a5a3-ea2987ab4cbd","created_at":"2024-06-25T04:45:28.342046","updated_at":"2024-06-25T04:45:28.342047","chunk_html":"Single Sign-On (SSO)\nCustomize how your team can login to Mintlify","metadata":{"breadcrumbs":["Configurations","Single Sign-On (SSO)"],"title":"Single Sign-On (SSO)"},"tracking_id":"settings/authentication-Single-Sign-On-(SSO)-Customize-h","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["settings/authentication"]},{"id":"085a9e1c-5e19-47f5-9ab0-472b50b98dc7","link":"integrations/user-auth/shared-session","qdrant_point_id":"6a207e5a-c083-47d5-8f0a-a1afbe6b5d81","created_at":"2024-06-25T04:45:25.975741","updated_at":"2024-06-25T04:45:25.975742","chunk_html":"Shared Session Auth\nThis method utilizes the session authentication info already stored in your user’s browser to create a seamless documentation experience.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Shared Session Auth"},"tracking_id":"integrations/user-auth/shared-session-Shared-Session-Auth","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/shared-session"]},{"id":"dc87ea9b-7856-435d-b8d7-cd59690dfe3d","link":"integrations/sdks/speakeasy","qdrant_point_id":"4d134ea4-4e55-4894-8a3d-f1f199bab531","created_at":"2024-06-25T04:45:27.136624","updated_at":"2024-06-25T04:45:27.136624","chunk_html":"Mintlify Docs Repository Changes\nThe workflow files produced will automatically bundle your source OpenAPI spec and Speakeasy code samples into a single output file, openapi.yaml . Mintlify will use this output file when constructing your API reference.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Mintlify Docs Repository Changes"},"tracking_id":"integrations/sdks/speakeasy-Mintlify-Docs-Repository-Changes","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/sdks/speakeasy"]},{"id":"c4d6c3ca-23fe-4a60-bba1-9656b66ad4c9","link":"integrations/rest-api/overview","qdrant_point_id":"4197fde3-c7e9-4c16-b9ad-5ba55aca81f2","created_at":"2024-06-25T04:45:26.748516","updated_at":"2024-06-25T04:45:26.748517","chunk_html":"Overview\nThe Mintlify REST API is only available on the startup plan and above. Leverage the external API to programmatically trigger an update when desired.\nThe primary use-case will be to trigger updates. We will be adding more and more\nfunctionality to the API overtime. Let us know what else you want to see in\nour community!","metadata":{"breadcrumbs":["Mintlify REST API","Overview"],"title":"Overview"},"tracking_id":"integrations/rest-api/overview-Overview","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/rest-api/overview"]},{"id":"dcfa99aa-6d26-4857-b268-1d865a3c96fc","link":"integrations/subpath/cloudflare","qdrant_point_id":"640c0532-8d1e-4013-8e35-2fd51362fcd5","created_at":"2024-06-25T04:45:27.581837","updated_at":"2024-06-25T04:45:27.581838","chunk_html":"Create Cloudflare Worker\nNavigate to the Workers & Pages > Create application > Create worker . You\nshould be able to presented with the following screen where you can create a new\nCloudlfare worker.","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Create Cloudflare Worker"},"tracking_id":"integrations/subpath/cloudflare-Create-Cloudflare-Worker","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/cloudflare"]},{"id":"ec6a5528-7277-451e-aaa2-28a87d103153","link":"integrations/sdks/speakeasy","qdrant_point_id":"71b8b929-21c8-46be-b88e-e2e85c98db53","created_at":"2024-06-25T04:45:27.165309","updated_at":"2024-06-25T04:45:27.209575","chunk_html":"Interactive CLI Set Up\nRun the following commands to set up the .speakeasy/workflow.yaml and .github/workflows/sdk_generation.yaml files through the interactive Speakeasy CLI. Set up your source spec. The source spec is the OpenAPI spec that code samples will be generated for, and it's often the same specification used to power Mintlify docs. Add the overlay created by Speakeasy to inject code snippets into your spec. Provide a name and path for the OpenAPI spec. This will be the final spec used by Mintlify. Finally, Add your SPEAKEASY_API_KEY as a repository secret to your Minlify repo under Settings > Secrets & Variables > Actions . Find the Speakeasy API key in the Speakeasy dashboard under the API Keys tab.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Interactive CLI Set Up"},"tracking_id":"integrations/sdks/speakeasy-Interactive-CLI-Set-Up","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/sdks/speakeasy"]},{"id":"8c3360b7-66de-4d3a-ae63-9778af58a9ee","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"5e73523c-1f11-4a07-b3e7-f3dcecc9bfff","created_at":"2024-06-25T04:45:28.004146","updated_at":"2024-06-25T04:45:28.004146","chunk_html":"Default (*)\nLastly, we're going to edit the Default (*) behavior. We're going to change the default behavior's Origin and origin groups to the staging URL (in our case mintlify-landing-page.vercel.app ). Click on Save changes.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Default (*)"},"tracking_id":"integrations/subpath/route53-cloudfront-Default-(*)","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"d691640e-6e2e-4521-8172-bb9100fdf748","link":"integrations/analytics/google-analytics","qdrant_point_id":"b77155d1-e255-44c4-9b36-3da26ec16cb3","created_at":"2024-06-25T04:45:24.892316","updated_at":"2024-06-25T04:45:24.950063","chunk_html":"Put Measurement ID in mint.json\nAdd your Measurement ID to your mint.json file like so:","metadata":{"breadcrumbs":["Analytics","Google Analytics 4"],"title":"Put Measurement ID in mint.json"},"tracking_id":"integrations/analytics/google-analytics-Put-Measurement-ID-in-mint.json","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/google-analytics"]},{"id":"34e908b7-0384-4b2a-b04e-6fffbc21607e","link":"integrations/analytics/google-tag-manager","qdrant_point_id":"05a57924-2ff0-463c-998b-af0bc5821a98","created_at":"2024-06-25T04:45:24.766852","updated_at":"2024-06-25T04:45:25.095101","chunk_html":"Google Tag Manager\nAdd your tag ID to mint.json file and we'll inject the Google Tag Manager script to all your pages. You are responsible for setting up cookie consent banners with Google Tag Manager if you need them. \"analytics\": {\n    \"gtm\": {\n        \"tagId\": \"GTM-MGBL4PW\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Google Tag Manager"],"title":"Google Tag Manager"},"tracking_id":"integrations/analytics/google-tag-manager-Google-Tag-Manager","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"code","num_value":null,"group_tracking_ids":["integrations/analytics/google-tag-manager"]},{"id":"a6b4383d-662f-4f4e-b05f-4f95ccadaf92","link":"settings/global","qdrant_point_id":"beff5b26-5d11-413f-8524-0ec6252e9187","created_at":"2024-06-25T04:45:28.848728","updated_at":"2024-06-25T04:45:28.940931","chunk_html":"Styling\nName of your company or project. Used for the global title. Path to logo image or object with path to \"light\" and \"dark\" mode logo images Logo Path to the logo in light mode. For example: /path/to/logo.svg Path to the logo in dark mode. For example: /path/to/logo.svg Where clicking on the logo links you to Path to the favicon image. For example: /path/to/favicon.svg Hex color codes for your global theme Colors The primary color. Used most often for highlighted content, section\nheaders, accents, in light mode The primary color for dark mode. Used most often for highlighted content,\nsection headers, accents, in dark mode The primary color for important buttons The color of the background in both light and dark mode Object The hex color code of the background in light mode The hex color code of the background in dark mode A background image to be displayed behind every page. See example with\nInfisical and FRPC. Customize the dark mode toggle. ModeToggle Set if you always want to show light or dark mode for new users. When not\nset, we default to the same mode as the user's operating system. Set to true to hide the dark/light mode toggle. You can combine isHidden with default to force your docs to only use light or dark mode. For example:","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Styling"},"tracking_id":"settings/global-Styling","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"e8b643b7-58bb-457f-b8f8-53aaabebc2bc","link":"api-playground/openapi/writing-openapi","qdrant_point_id":"8bbc2621-8779-4d2c-b995-ee165e8a74d6","created_at":"2024-06-25T04:45:22.463662","updated_at":"2024-06-25T04:45:22.463663","chunk_html":"Writing OpenAPI\nUse OpenAPI features to enhance your Mintlify docs","metadata":{"breadcrumbs":["API References","Using OpenAPI","Writing OpenAPI"],"title":"Writing OpenAPI"},"tracking_id":"api-playground/openapi/writing-openapi-Writing-OpenAPI-Use-OpenAPI-feat","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["api-playground/openapi/writing-openapi"]},{"id":"154d4d4a-5ce5-4803-abff-045cc64e5dfe","link":"api-playground/mdx/configuration","qdrant_point_id":"961167dd-048e-4cab-8ada-56f2374a4384","created_at":"2024-06-25T04:45:21.482735","updated_at":"2024-06-25T04:45:21.657975","chunk_html":"MDX Setup\nMintlify allows you to define your API endpoints using a combination of mint.json configuration, MDX metadata fields, and the <ParamFields /> component. From the defined endpoints, we generate an API playground, request examples, and response examples. Configure your API In your mint.json file, define your base URL and auth method: If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field: Find a full list of API configurations here. Create your endpoint pages Each API endpoint page should have a corresponding MDX file. At the top of each file, define: You can specify path parameters by adding the parameter name to the path, wrapped with {}: If you have baseUrl configured in mint.json , you can use relative paths like /v1/endpoint. Add your endpoints to your docs Add your endpoint pages to the sidebar by adding the paths to the navigation field in your mint.json . Learn more about structuring your docs here.","metadata":{"breadcrumbs":["API References","Using MDX","MDX Setup"],"title":"MDX Setup"},"tracking_id":"api-playground/mdx/configuration-MDX-Setup","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/mdx/configuration"]},{"id":"e6cafde8-f950-443d-89ea-1aca04b0f78f","link":"api-playground/openapi/advanced-features","qdrant_point_id":"fec09d62-9ba3-44f7-93b4-df252b4209cf","created_at":"2024-06-25T04:45:21.712007","updated_at":"2024-06-25T04:45:21.712008","chunk_html":"Advanced Features\nOpenAPI 3 has some advanced features for describing complex APIs. Here's how you can use them with Mintlify.","metadata":{"breadcrumbs":["API References","Using OpenAPI","Advanced Features"],"title":"Advanced Features"},"tracking_id":"api-playground/openapi/advanced-features-Advanced-Features","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/advanced-features"]},{"id":"8287b758-b325-4315-81fd-2a33de14ba2d","link":"content/components/icons","qdrant_point_id":"e40f9bb7-b316-4eaa-8d02-2fa023e3e12e","created_at":"2024-06-25T04:45:21.721959","updated_at":"2024-06-25T04:45:21.721959","chunk_html":"Icons\nUse [Font Awesome](https://fontawesome.com/icons) icons anywhere in the doc","metadata":{"breadcrumbs":["Components","Icons"],"title":"Icons"},"tracking_id":"content/components/icons-Icons-Use-[Font-Awesome](https:/","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/icons"]},{"id":"7ce95094-5c88-413d-8f3a-f4e05f29ed9b","link":"content/components/callouts","qdrant_point_id":"076f74a3-49bb-42f6-b898-37c8e6317cc5","created_at":"2024-06-25T04:45:23.546051","updated_at":"2024-06-25T04:45:23.585340","chunk_html":"Check Callouts\nThis brings us a checked status","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Check Callouts"},"tracking_id":"content/components/callouts-Check-Callouts","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/callouts"]},{"id":"76966f1b-0391-420d-9a35-cc4a72bdf878","link":"image-embeds","qdrant_point_id":"23e769af-836a-4ad5-83f6-d37ecd658b3e","created_at":"2024-06-25T04:45:24.057777","updated_at":"2024-06-25T04:45:24.099280","chunk_html":"Dark Mode\nTo use separate images for light and dark mode, use Tailwind CSS to hide and show images.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Dark Mode"},"tracking_id":"image-embeds-Dark-Mode","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["image-embeds"]},{"id":"3412d234-0c17-471d-ac38-9d8d9deacefd","link":"integrations/analytics/mixpanel","qdrant_point_id":"91f4c02a-40cb-4a1a-af32-9d173000beaf","created_at":"2024-06-25T04:45:25.336914","updated_at":"2024-06-25T04:45:25.378804","chunk_html":"Mixpanel\nAdd the following to your mint.json file to send analytics to Mixpanel.","metadata":{"breadcrumbs":["Analytics","Mixpanel"],"title":"Mixpanel"},"tracking_id":"integrations/analytics/mixpanel-Mixpanel","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/mixpanel"]},{"id":"8eb31ad7-68a8-454d-bd88-dee6d10b5549","link":"integrations/analytics/overview","qdrant_point_id":"af3e4339-1458-4d3c-bfb4-d23f8b65f98a","created_at":"2024-06-25T04:45:25.450311","updated_at":"2024-06-25T04:45:25.450312","chunk_html":"Analytics Integrations\nIntegrate with an analytics platform to track viewer events","metadata":{"breadcrumbs":["Analytics","Analytics Integrations"],"title":"Analytics Integrations"},"tracking_id":"integrations/analytics/overview-Analytics-Integrations-Integrate","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/overview"]},{"id":"648370d1-1f0c-44f3-94ac-f8e48482cdc1","link":"integrations/user-auth/jwt","qdrant_point_id":"d2b9279b-ad26-446a-8d57-bbb3714bfe23","created_at":"2024-06-25T04:45:25.524805","updated_at":"2024-06-25T04:45:25.524805","chunk_html":"Implementation\nGenerate a private key Go to your Mintlify dashboard settings and generate a private key. Store this key somewhere secure where it can be accessed by your backend. Create a login flow Create a login flow that does the following: Authenticate the user Create a JWT containing the authenticated user's info in the UserInfo format Sign the JWT with the secret Create a redirect URL back to your docs, including the JWT as a query parameter with the name user_auth Configure your User Auth settings Return to your Mintlify dashboard settings and add the login URL to your User Auth settings.","metadata":{"breadcrumbs":["User Auth","Authenticating","JWT Auth"],"title":"Implementation"},"tracking_id":"integrations/user-auth/jwt-Implementation","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/jwt"]},{"id":"3cfce50f-08a2-44d7-aacf-9febb5eeb40a","link":"integrations/user-auth/sending-data","qdrant_point_id":"5b982354-e3d2-4bd5-9b77-2b57fd8aba8b","created_at":"2024-06-25T04:45:25.871292","updated_at":"2024-06-25T04:45:25.924718","chunk_html":"Sending Data\nDepending on your authentication configuration, your API will respond with either a raw JSON object or a signed JWT. The shape of the data is the same for both: The time at which this information should expire, in seconds since epoch . If the user loads the page and the current time is after this value, the stored data will be deleted.\nFor JWT Auth: This is not the same as the exp claim of the JWT. The exp claim determines when a JWT should no longer be considered valid, and should be set as low as possible. In this case, it can probably be set to 10 seconds or lower. The expiresAt field determines when retrieved data should be considered stale, and can be anywhere from one day to several weeks. A list of groups that the user belongs to. This will determine which pages should be shown to this user. If any of these groups is listed in the groups field of a page’s metadata, that page will be shown. A bag of values that can be accessed from within MDX content using the userContext variable. For example, if you have supplied { firstName: 'Ronan' } as your content field, you can use the following in your MDX: Good morning, {userContext.firstName}! User-specific values that will be prefilled in the API playground if supplied. For example, if each of my customers makes requests at a specific subdomain, I can send { server: { subdomain: 'foo' } } as my apiPlaygroundInputs field, and this value will be prefilled on any API page with this subdomain value. The header , query , and cookie fields will only be prefilled if they are part of your security scheme . Creating a standard header parameter named Authorization is not sufficient to enable this feature. To know if a field will be prefilled, navigate to your existing docs and check if the field is in either the Authorization or Server section.","metadata":{"breadcrumbs":["User Auth","Sending Data"],"title":"Sending Data"},"tracking_id":"integrations/user-auth/sending-data-Sending-Data","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/sending-data"]},{"id":"0f6ca6fa-ff8b-44cc-85ed-2c1dbf66d861","link":"integrations/user-auth/shared-session","qdrant_point_id":"cc7d7066-9582-4db5-b02d-dcdbd355a055","created_at":"2024-06-25T04:45:26.098037","updated_at":"2024-06-25T04:45:26.098037","chunk_html":"Dashboard at subdomain, docs at root\nI have a dashboard at dash.foo.com , which uses cookie-based session authentication. My dashboard API routes are hosted at dash.foo.com/api . I want to set up authentication for my docs hosted at foo.com/docs. To set up authentication with Mintlify, I create another dashboard endpoint dash.foo.com/api/docs/user-info which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add https://foo.com to the Access-Control-Allow-Origin allow-list for this route only , and ensure my Access-Control-Allow-Credentials configuration is set to true for this route only. I then go to the Mintlify dashboard settings and enter https://dash.foo.com/api/docs/user-info for the API URL field.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Dashboard at subdomain, docs at root"},"tracking_id":"integrations/user-auth/shared-session-Dashboard-at-subdomain,-docs-at-root","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/shared-session"]},{"id":"e81678cf-c404-4eb7-ba04-26749be01759","link":"page","qdrant_point_id":"f1e7dcbe-d420-4bd3-bdda-917ff58d17ec","created_at":"2024-06-25T04:45:26.524578","updated_at":"2024-06-25T04:45:26.524578","chunk_html":"Page Titles and Metadata\nSetting the title and metadata for navigation and SEO","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Page Titles and Metadata"},"tracking_id":"page-Page-Titles-and-Metadata-Setting","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["page"]},{"id":"caa406b7-3749-4799-9aa0-6d4161982b8a","link":"integrations/privacy/overview","qdrant_point_id":"d344379c-13c8-4aff-88db-ff787545947d","created_at":"2024-06-25T04:45:26.643181","updated_at":"2024-06-25T04:45:26.643181","chunk_html":"Data Privacy Integrations\nOsano","metadata":{"breadcrumbs":["Privacy","Data Privacy Integrations"],"title":"Data Privacy Integrations"},"tracking_id":"integrations/privacy/overview-Data-Privacy-Integrations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/privacy/overview"]},{"id":"cf377716-f579-4da7-8bb9-8c284610aa38","link":"integrations/rest-api/overview","qdrant_point_id":"e62d79a8-6304-40ba-8c94-c96fb8a405b4","created_at":"2024-06-25T04:45:26.781251","updated_at":"2024-06-25T04:45:26.781251","chunk_html":"Authentication\nYou can generate an API key through\nthe dashboard . The API key is\nassociated with the entire org and can be used across multiple deployments.","metadata":{"breadcrumbs":["Mintlify REST API","Overview"],"title":"Authentication"},"tracking_id":"integrations/rest-api/overview-Authentication","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/rest-api/overview"]},{"id":"4b693e42-43a4-4630-9f0a-000081191bf8","link":"page","qdrant_point_id":"2b437b7c-e9cc-42c4-bb57-307ffdc5f476","created_at":"2024-06-25T04:45:26.929877","updated_at":"2024-06-25T04:45:26.970159","chunk_html":"Sidebar Title\nYou can show a different title in the navigation with the sidebarTitle metadata. This is useful if your title is long and you want something shorter in\nthe navigation links.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Sidebar Title"},"tracking_id":"page-Sidebar-Title","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"7d351b3d-2d25-4cfd-aaf0-2144d83409cd","link":"integrations/subpath/cloudflare","qdrant_point_id":"5a64af73-64ee-46a9-a9ba-9b897a4fb691","created_at":"2024-06-25T04:45:27.515313","updated_at":"2024-06-25T04:45:27.515313","chunk_html":"Cloudflare\nHost documentation at a /docs subpath using Cloudflare Workers","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Cloudflare"},"tracking_id":"integrations/subpath/cloudflare-Cloudflare-Host-documentation-at","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/subpath/cloudflare"]},{"id":"a777957a-9426-4be7-9be6-137de0c44b9a","link":"integrations/subpath/cloudflare","qdrant_point_id":"e18d5c04-e6e5-4786-b231-c002dabf13a1","created_at":"2024-06-25T04:45:27.762282","updated_at":"2024-06-25T04:45:27.762282","chunk_html":"Reach out to Mintlify team\nOnce completing the Cloudflare setup, the Mintlify team will setup the\nsubdirectory settings in your deployment. Reach out over\nemail.","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Reach out to Mintlify team"},"tracking_id":"integrations/subpath/cloudflare-Reach-out-to-Mintlify-team","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/cloudflare"]},{"id":"3ec4c619-4811-44fb-a6b8-546b8806986f","link":"reusable-snippets","qdrant_point_id":"cadbb1a7-edc6-4b5b-b435-07c0a3c53580","created_at":"2024-06-25T04:45:27.773169","updated_at":"2024-06-25T04:45:27.773170","chunk_html":"Reusable Snippets\nReusable, custom snippets to keep content in sync","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Reusable Snippets"},"tracking_id":"reusable-snippets-Reusable-Snippets-Reusable,-cust","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["reusable-snippets"]},{"id":"7c455733-7c29-4462-8758-e90737c61a56","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"eec9fca9-34dc-483a-933c-e18d6d2332f2","created_at":"2024-06-25T04:45:27.968844","updated_at":"2024-06-25T04:45:27.968844","chunk_html":"/docs\nThe second behavior should be the same as the first one but with a Path pattern of /docs and Origin and origin groups pointing to the same .mintlify.dev URL.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"/docs"},"tracking_id":"integrations/subpath/route53-cloudfront-/docs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"16acca3f-38b0-4f1a-8fca-1947cef43701","link":"settings/broken-links","qdrant_point_id":"42bc4df5-78ea-420d-ac56-d88259cf57b9","created_at":"2024-06-25T04:45:28.612382","updated_at":"2024-06-25T04:45:28.697517","chunk_html":"Redirects\nSet up 301 redirects by adding the redirects field into your mint.json file. This will permanently redirect /source/path to /destination/path so that you don't lose any previous SEO for the original page. To match a wildcard path, use * after a parameter. In this example, /beta/:slug* will match /beta/introduction and redircets it to /v2/introduction.","metadata":{"breadcrumbs":["Configurations","Redirects and Broken Links"],"title":"Redirects"},"tracking_id":"settings/broken-links-Redirects","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/broken-links"]},{"id":"9c528efe-3f70-4c9e-a990-296cf5a7ea5b","link":"settings/seo","qdrant_point_id":"7650a55a-8602-48c0-884b-7dcf9a89f7dc","created_at":"2024-06-25T04:45:30.050846","updated_at":"2024-06-25T04:45:30.050847","chunk_html":"Search Engine Optimization\nSupported Meta Tags og:site_name og:title og:description og:url og:image og:locale og:logo article:publisher twitter:title twitter:description twitter:url twitter:image twitter:site og:image:width og:image:height","metadata":{"breadcrumbs":["Configurations","Search Engine Optimization"],"title":"Search Engine Optimization"},"tracking_id":"settings/seo-Search-Engine-Optimization","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/seo"]},{"id":"2de18718-7ad9-4ba3-9426-25381e4ae3b1","link":"settings/seo","qdrant_point_id":"a9905c8e-ca51-41d6-8f16-5fdaa130b770","created_at":"2024-06-25T04:45:30.081788","updated_at":"2024-06-25T04:45:30.128917","chunk_html":"Default meta tags\nYou can set default meta tags by adding the metadata field to your mint.json.","metadata":{"breadcrumbs":["Configurations","Search Engine Optimization"],"title":"Default meta tags"},"tracking_id":"settings/seo-Default-meta-tags","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/seo"]},{"id":"6b897eee-8332-444b-ba0f-eae1b2dacd0f","link":"integrations/custom/css","qdrant_point_id":"b2facf9b-91b2-42f3-bf17-761c89cb7413","created_at":"2024-06-25T04:45:26.255625","updated_at":"2024-06-25T04:45:26.255626","chunk_html":"Using Identifiers\nMintlify has a set of common identifiers to help you tag important elements of the UI. Some, but not all are listed in the following: #topbar-cta-button #navbar #sidebar #content-area table-of-contents Use inspect element to find references to elements you're looking to\ncustomize. References and the styling of common elements are subject to change as the\nplatform evolves. Please use custom styling with caution.","metadata":{"breadcrumbs":["Custom Scripts","Custom CSS"],"title":"Using Identifiers"},"tracking_id":"integrations/custom/css-Using-Identifiers","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/custom/css"]},{"id":"a9dafe7c-7149-4d83-9d74-8c9634779192","link":"integrations/user-auth/sending-data","qdrant_point_id":"8b84ba1e-7852-41d9-95a1-1c3ccafc42e1","created_at":"2024-06-25T04:45:25.838626","updated_at":"2024-06-25T04:45:25.838627","chunk_html":"Sending Data\nThe types and shape of user data you can send to Mintlify","metadata":{"breadcrumbs":["User Auth","Sending Data"],"title":"Sending Data"},"tracking_id":"integrations/user-auth/sending-data-Sending-Data-The-types-and-shape","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/user-auth/sending-data"]},{"id":"e9978a69-f0af-42c1-8802-b0a429f7f9c8","link":"content/components/accordion-groups","qdrant_point_id":"ef1d3f07-6829-4a45-a3bc-002a336f0fac","created_at":"2024-06-25T04:45:22.984902","updated_at":"2024-06-25T04:45:23.068169","chunk_html":"Accordion Groups\nSimply add <AccordionGroup> around your existing <Accordion> components. FAQ without Icon You can put other components inside Accordions. FAQ with Icon Check out the Accordion docs for all the supported props. FAQ without Icon Check out the Accordion docs for all the supported props. AccordionGroup does not have any props.","metadata":{"breadcrumbs":["Components","Accordion Groups"],"title":"Accordion Groups"},"tracking_id":"content/components/accordion-groups-Accordion-Groups","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/accordion-groups"]},{"id":"588d1eb8-9399-4779-852b-7619dacb3c8d","link":"content/components/expandables","qdrant_point_id":"a23b1856-5930-46e0-ae41-0d7ba836928b","created_at":"2024-06-25T04:45:24.625044","updated_at":"2024-06-25T04:45:24.666039","chunk_html":"Expandables\nproperties The full name of the user Whether the user is over 21 years old","metadata":{"breadcrumbs":["API Components","Expandables"],"title":"Expandables"},"tracking_id":"content/components/expandables-Expandables","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/expandables"]},{"id":"eb9b6125-c6a9-4b46-aec0-8b00fba0d35d","link":"content/components/cards","qdrant_point_id":"d9c56362-3d2f-4b8a-8592-3a74246f19c7","created_at":"2024-06-25T04:45:23.914504","updated_at":"2024-06-25T04:45:23.914505","chunk_html":"Props\nThe title of the card A Font Awesome icon or SVG code in icon={} One of regular , solid , light , thin , sharp-solid , duotone , brands The color of the icon as a hex code The url that clicking on the card would navigate the user to","metadata":{"breadcrumbs":["Components","Cards"],"title":"Props"},"tracking_id":"content/components/cards-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/cards"]},{"id":"e00a3006-8658-40b0-aa84-eea50afe58d9","link":"list-table","qdrant_point_id":"7e8bcf5b-f82a-43a1-8e0d-aabc02a5d13f","created_at":"2024-06-25T04:45:26.284343","updated_at":"2024-06-25T04:45:26.327485","chunk_html":"Unordered List\nTo create an unordered list, add dashes (- ), asterisks (* ), or plus signs (+ ) in front of line items First item Second item Third item Fourth item","metadata":{"breadcrumbs":["Writing Content","Lists and Tables"],"title":"Unordered List"},"tracking_id":"list-table-Unordered-List","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["list-table"]},{"id":"ae1d18cd-f8cd-4b25-b4f2-103d5f82cde4","link":"integrations/user-auth/overview","qdrant_point_id":"fe146f8f-93e5-4d8a-b048-318dbe4bfc62","created_at":"2024-06-27T01:19:03.314322","updated_at":"2024-06-27T01:19:03.314323","chunk_html":"What is User Auth\nUser Auth allows you to configure a method for identifying and authenticating your users. Once authenticated, you can share user-specific information that can be used to personalize the docs. This unlocks some powerful features: Customize MDX content with a user's information, such as their name, plan, or title. Prefill API keys in the API Playground for streamlined use. (Coming soon!) Selectively show pages in the navigation based on a user's groups.","metadata":{"breadcrumbs":["User Auth","Overview"],"title":"What is User Auth"},"tracking_id":"integrations/user-auth/overview-What-is-User-Auth","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/overview"]},{"id":"454f5636-37e5-4f35-a593-6e9fe835cc86","link":"page","qdrant_point_id":"9ecf2679-2017-43be-9231-bc2890dcc677","created_at":"2024-06-25T04:45:27.190158","updated_at":"2024-06-25T04:45:27.247046","chunk_html":"External Links\nIf you want the sidebar to open an external URL, you can set the url metadata\nin any page.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"External Links"},"tracking_id":"page-External-Links","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"737c5f9c-9180-4151-b2d1-0374f83a322a","link":"settings/custom-domain","qdrant_point_id":"2e2003f4-8dfc-4d81-8934-3cf362f70380","created_at":"2024-06-25T04:45:28.477424","updated_at":"2024-06-25T04:45:28.529967","chunk_html":"Configuring your DNS\nProceed to your domain's DNS settings on your domain provider. Create a new DNS entry, inputting the following values: If you are using Cloudflare for your DNS provider, you'll need to have the “full strict” security option enabled for the https setting. Please contact support if you don't see the custom subdomain set up after the above configuration.","metadata":{"breadcrumbs":["Configurations","Custom Domain"],"title":"Configuring your DNS"},"tracking_id":"settings/custom-domain-Configuring-your-DNS","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/custom-domain"]},{"id":"e8b3d6a3-38ac-45f4-9a7e-b335b1fa6d2a","link":"content/components/cards","qdrant_point_id":"e682c584-179b-4b9e-8415-cf22a38a3bd7","created_at":"2024-06-25T04:45:23.779632","updated_at":"2024-06-25T04:45:23.832062","chunk_html":"Cards\nCard Title This is how you use a card with an icon and a link. Clicking on this card\nbrings you to the Card Group page.","metadata":{"breadcrumbs":["Components","Cards"],"title":"Cards"},"tracking_id":"content/components/cards-Cards","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/cards"]},{"id":"03891d6d-5eca-44e9-99a2-c99a5e8251f4","link":"integrations/support/overview","qdrant_point_id":"18911897-b30b-4d01-8b07-0ea090497980","created_at":"2024-06-25T04:45:25.201397","updated_at":"2024-06-25T04:45:25.201397","chunk_html":"Support Integrations\nIntercom Front","metadata":{"breadcrumbs":["Support","Support Integrations"],"title":"Support Integrations"},"tracking_id":"integrations/support/overview-Support-Integrations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/support/overview"]},{"id":"ce5ae931-937b-4bfb-a942-9939fa1ee6fe","link":"code","qdrant_point_id":"a07fb4d7-6c82-46c6-a092-d5de8c7651bb","created_at":"2024-06-25T04:45:22.725236","updated_at":"2024-06-25T04:45:22.725236","chunk_html":"Code Blocks\nDisplay inline code and code blocks","metadata":{"breadcrumbs":["Writing Content","Code Blocks"],"title":"Code Blocks"},"tracking_id":"code-Code-Blocks-Display-inline-code-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["code"]},{"id":"54e3badd-86b0-4fc4-97b6-a8bf7f2d3d40","link":"integrations/sdks/speakeasy","qdrant_point_id":"57dba895-6a4c-4605-bff2-f501d734fa73","created_at":"2024-06-25T04:45:27.024270","updated_at":"2024-06-25T04:45:27.024270","chunk_html":"Speakeasy\nYou can integrate Speakeasy-generated code snippets from your SDKs directly into your Mintlify API reference documentation. SDK usage snippets are shown in the interactive playground of your Mintlify-powered documentation.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Speakeasy"},"tracking_id":"integrations/sdks/speakeasy-Speakeasy","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/sdks/speakeasy"]},{"id":"21309857-6e34-4233-9b21-91b4eb549cda","link":"page","qdrant_point_id":"53d26fff-7d0f-41b8-ab96-7dee02bb5289","created_at":"2024-06-25T04:45:27.124930","updated_at":"2024-06-25T04:45:27.168699","chunk_html":"Custom Mode\nYou can remove all elements except for the top bar with custom mode. This mode\nprovides you with a blank canvas and could be utilized to create a \"landing\npage\" for your docs.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Custom Mode"},"tracking_id":"page-Custom-Mode","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"1db6caa2-b6d1-4e45-9958-480cb15d97f8","link":"settings/github","qdrant_point_id":"b5e061da-875e-4446-b26b-578bc64efed5","created_at":"2024-06-25T04:45:28.550847","updated_at":"2024-06-25T04:45:28.550847","chunk_html":"GitHub\nSync your docs with a GitHub repo","metadata":{"breadcrumbs":["Configurations","GitHub"],"title":"GitHub"},"tracking_id":"settings/github-GitHub-Sync-your-docs-with-a-Git","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["settings/github"]},{"id":"2d2b1eb4-ac47-489a-8034-f1750e5f5bd3","link":"settings/add-members","qdrant_point_id":"74a02e98-9d14-4ddf-ae0b-e01a1f8d3c66","created_at":"2024-06-25T04:45:28.297670","updated_at":"2024-06-25T04:45:28.297671","chunk_html":"Editor Permissions\nThe team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same Github account that was used while signing up for Mintlify. If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check. In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the dashboard to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates. Learn more about our pricing here.","metadata":{"breadcrumbs":["Configurations","Editor Permissions"],"title":"Editor Permissions"},"tracking_id":"settings/add-members-Editor-Permissions","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/add-members"]},{"id":"b34c39eb-14b6-4da7-b2d6-2a654e57043f","link":"settings/navigation","qdrant_point_id":"5abb783b-5f0b-4f1a-9743-124e193242e3","created_at":"2024-06-25T04:45:29.625672","updated_at":"2024-06-25T04:45:29.709134","chunk_html":"Anchors\nAnchors provide another way to direct users to sections of your documentation,\nor link out to external URLs. Configure anchors with the anchors field of the mint.json file. The url field of the tab object should map an external link, or a folder of content\nadded to your sidebar. More fields for anchors can be found\nhere. To configure the default Documentation top anchor, add the topAnchor field\nto your mint.json.","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Anchors"},"tracking_id":"settings/navigation-Anchors","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"c08755a9-7f92-4a81-94ed-423f5fa2c641","link":"settings/broken-links","qdrant_point_id":"18fce136-b952-4ebc-8bf2-daf4f80c619a","created_at":"2024-06-25T04:45:28.475951","updated_at":"2024-06-25T04:45:28.475952","chunk_html":"Redirects and Broken Links\nTools to help prevent invalid links","metadata":{"breadcrumbs":["Configurations","Redirects and Broken Links"],"title":"Redirects and Broken Links"},"tracking_id":"settings/broken-links-Redirects-and-Broken-Links-Tools","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["settings/broken-links"]},{"id":"c8a705d4-eae3-4a23-8907-b49183b19338","link":"text","qdrant_point_id":"1a622c8a-3649-4ace-be9d-fd0f004dbfd3","created_at":"2024-06-25T04:45:30.935386","updated_at":"2024-06-25T04:45:30.978517","chunk_html":"Singleline\nTo create a blockquote, add a > in front of a paragraph. Dorothy followed her through many of the beautiful rooms in her castle.","metadata":{"breadcrumbs":["Writing Content","Headers and Text"],"title":"Singleline"},"tracking_id":"text-Singleline","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["text"]},{"id":"4f27d31c-1e5a-45e3-b14f-a9b3b467931e","link":"settings/global","qdrant_point_id":"44fbaaba-e3df-48da-8894-3175b75adb59","created_at":"2024-06-25T04:45:28.787634","updated_at":"2024-06-25T04:45:28.787634","chunk_html":"Global Settings\nCustomize your documentation using the mint.json file","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Global Settings"},"tracking_id":"settings/global-Global-Settings-Customize-your-d","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"f005d5b9-1a06-4a5a-92fe-350a7fca8b74","link":"content/components/frames","qdrant_point_id":"0d8c8791-4235-4ede-9f50-21308276d664","created_at":"2024-06-25T04:45:21.574356","updated_at":"2024-06-25T04:45:21.690725","chunk_html":"Props\nOptional caption text to show centered under your component.","metadata":{"breadcrumbs":["Components","Frames"],"title":"Props"},"tracking_id":"content/components/frames-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/frames"]},{"id":"46c05511-4508-4058-806e-f2b1a266ca2e","link":"content/components/card-groups","qdrant_point_id":"2100e591-d831-49cf-b620-78bc165847a9","created_at":"2024-06-25T04:45:23.651650","updated_at":"2024-06-25T04:45:23.697353","chunk_html":"Card Groups\nThe CardGroup component lets you group multiple Card components together. It's most often used to put multiple cards on the same column. First Card Neque porro quisquam est qui dolorem ipsum quia dolor sit amet Second Card Lorem ipsum dolor sit amet, consectetur adipiscing elit Third Card Ut enim ad minim veniam, quis nostrud exercitation ullamco Fourth Card Excepteur sint occaecat cupidatat non proident","metadata":{"breadcrumbs":["Components","Card Groups"],"title":"Card Groups"},"tracking_id":"content/components/card-groups-Card-Groups","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/card-groups"]},{"id":"85260f16-f6af-4f9d-9f7d-3f40a65444f2","link":"content/components/mermaid-diagrams","qdrant_point_id":"3ee10051-1740-4049-b4a6-88f166f8f549","created_at":"2024-06-25T04:45:21.937179","updated_at":"2024-06-25T04:45:22.028553","chunk_html":"Mermaid Diagrams\nMermaid lets you create visual diagrams using text and code. You can create the following using Mermaid diagrams: Flowchart Sequence diagram Class diagram State diagram Entity relationship diagram User journey and more For a complete list of diagrams supported by Mermaid, check out their website.","metadata":{"breadcrumbs":["Components","Mermaid Diagrams"],"title":"Mermaid Diagrams"},"tracking_id":"content/components/mermaid-diagrams-Mermaid-Diagrams","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/mermaid-diagrams"]},{"id":"d58c87a2-b119-4640-b289-0b451bd1b24e","link":"integrations/user-auth/jwt","qdrant_point_id":"8a7f0600-2b8e-4fa5-840c-62c68e23a783","created_at":"2024-06-25T04:45:25.554693","updated_at":"2024-06-25T04:45:25.554693","chunk_html":"Example\nI want to set up authentication for my docs hosted at docs.foo.com . I want my docs to be completely separate from my dashboard (or I don’t have a dashboard at all). To set up authentication with Mintlify, I go to my Mintlify dashboard and generate a JWT secret. I create a web URL https://foo.com/docs-login that initiates a login flow for my users. At the end of this login flow, once I have verified the identity of the user, I create a JWT containing the user’s custom data according to Mintlify’s specification. I sign this JWT with my Mintlify secret, create a redirect URL of the form https://docs.foo.com?user_auth={SIGNED_JWT} , and redirect the user. I then go to the Mintlify dashboard settings and enter https://foo.com/docs-login for the Login URL field.","metadata":{"breadcrumbs":["User Auth","Authenticating","JWT Auth"],"title":"Example"},"tracking_id":"integrations/user-auth/jwt-Example","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/jwt"]},{"id":"e00f1b07-d6eb-4a87-8d92-46442a971009","link":"development","qdrant_point_id":"0a6a1540-3654-4ddb-9c02-0d88ef768b5f","created_at":"2024-06-25T04:45:23.449008","updated_at":"2024-06-25T04:45:23.534684","chunk_html":"Mintlify Versions\nPlease note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Mintlify Versions"},"tracking_id":"development-Mintlify-Versions","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["development"]},{"id":"fdf6cd81-6096-42bd-8a20-6a2fa50a2133","link":"content/components/steps","qdrant_point_id":"8dd412f1-a786-4983-bd67-5ddd2aeeaa46","created_at":"2024-06-25T04:45:22.650005","updated_at":"2024-06-25T04:45:22.650006","chunk_html":"Individual Step Props\nThe content of a step either as plain text, or components. A Font Awesome icon or SVG code in icon={} One of regular , solid , light , thin , sharp-solid , duotone , brands The title is the primary text for the step and shows up next to the indicator. The number of the step. The size of the step titles. One of p , h2 and h3.","metadata":{"breadcrumbs":["Components","Steps"],"title":"Individual Step Props"},"tracking_id":"content/components/steps-Individual-Step-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/steps"]},{"id":"7ddfa39c-7b05-403b-bd14-2febeb1bdb0f","link":"api-playground/openapi/setup","qdrant_point_id":"b539e095-782c-44ca-a870-fb35b35ec9c7","created_at":"2024-06-25T04:45:22.224926","updated_at":"2024-06-25T04:45:22.309298","chunk_html":"Manually generate files\nBy using the OpenAPI reference, the name, description, parameters, responses, and the API playground will be automatically generated using the specifications. If you have multiple OpenAPI files, include the name of the OpenAPI file (without the file type .json or .yaml ) to correctly map the information. The method endpoint must match the endpoint specified in the OpenAPI\nspecifications exactly. If the endpoint doesn't exist in the OpenAPI file,\nan empty page will be rendered.","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"Manually generate files"},"tracking_id":"api-playground/openapi/setup-Manually-generate-files","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/setup"]},{"id":"a9616be6-19f7-46cf-96f8-90d21c8f251d","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"1a6b34e0-44ca-4ff2-8515-9f345ec39400","created_at":"2024-06-25T04:45:27.819348","updated_at":"2024-06-25T04:45:27.819348","chunk_html":"Route 53 and Cloudfront\nPrerequisite : Your primary domain (company.com) is hosted on Route 53.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Route 53 and Cloudfront"},"tracking_id":"integrations/subpath/route53-cloudfront-Route-53-and-Cloudfront","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"0b413295-bdfe-4da7-9b5a-b7e77a92c718","link":"settings/global","qdrant_point_id":"a2a4d02a-c186-46fc-8334-457604f46102","created_at":"2024-06-25T04:45:28.962530","updated_at":"2024-06-25T04:45:29.071944","chunk_html":"Structure\nAn array of groups with all the pages within that group Navigation The name of the group. The relative paths to the markdown files that will serve as pages. Note: groups are recursive, so to add a sub-folder add another group object in the page array. The Fontawesome icon for the group. Note: this only applies to sub-folders. The type of Fontawesome icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin Array of names and urls of links you want to include in the topbar TopbarLink The name of the button. The url once you click on the button. Example: https://mintlify.com/contact Topbar Call to Action Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. If type is a link: What the button links to. If type is a github: Link to the repository to load GitHub information from. Text inside the button. Only required if type is a link. Array of version names. Only use this if you want to show different versions\nof docs with a dropdown in the navigation bar. An array of the anchors, includes the icon, color, and url. Anchor The Font Awesome icon used to feature the anchor. Example: comments The name of the anchor label. Example: Community The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties from and to that are each a hex color. Used if you want to hide an anchor until the correct docs version is selected. Pass true if you want to hide the anchor until you directly link someone to docs inside it. One of: \"brands\", \"duotone\", \"light\", \"sharp-solid\", \"solid\", or \"thin\" Override the default configurations for the top-most anchor. Note: if you have\ntabs configured, this does not apply. Object The name of the top-most anchor Font Awesome icon. One of: \"brands\", \"duotone\", \"light\", \"sharp-solid\", \"solid\", or \"thin\" An array of navigational tabs. Example: Tabs The name of the tab label. The start of the URL that marks what pages go in the tab. Generally, this\nis the name of the folder you put your pages in. Pass true if you want to hide the tab until you directly link someone to docs inside it. An object of social media accounts where the key:property pair represents the social media platform and the account url. Example: FooterSocials One of the following values website , facebook , x , youtube , discord , slack , github , linkedin , instagram , hacker-news Example: x The URL to the social platform. Example: https://x.com/mintlify Configurations to enable feedback buttons Feedback Enables a rating system for users to indicate whether the page has been helpful Enables a button to allow users to suggest edits via pull requests Enables a button to allow users to raise an issue about the documentation Configurations to change the search prompt Search Set the prompt for the search bar. Default is Search...","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Structure"},"tracking_id":"settings/global-Structure","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"6c8e7a59-f33f-4f51-b471-820fe2e5d5ba","link":"image-embeds","qdrant_point_id":"137b3a04-3d4a-4c50-94e3-0ad9cd55bf49","created_at":"2024-06-25T04:45:23.784234","updated_at":"2024-06-25T04:45:23.835706","chunk_html":"Using Markdown\nThe markdown syntax lets you add images using the following code Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like Cloudinary or S3 . You can then use that URL and embed.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Using Markdown"},"tracking_id":"image-embeds-Using-Markdown","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["image-embeds"]},{"id":"dd9886af-8f98-4672-ab8e-d91d55ba21f7","link":"image-embeds","qdrant_point_id":"edf132d0-a140-4ca4-b6d3-0a9aa1d70207","created_at":"2024-06-25T04:45:23.854750","updated_at":"2024-06-25T04:45:23.894664","chunk_html":"Using Embeds\nTo get more customizability with images, you can also use embeds to add images.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Using Embeds"},"tracking_id":"image-embeds-Using-Embeds","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["image-embeds"]},{"id":"0ebc6b77-bc54-4248-b48e-58190645732b","link":"integrations/custom/js","qdrant_point_id":"3b42a1b6-1a54-4ee7-8cd1-59638eb13866","created_at":"2024-06-25T04:45:26.284796","updated_at":"2024-06-25T04:45:26.284796","chunk_html":"Custom JS\nAdd JavaScript functionality globally","metadata":{"breadcrumbs":["Custom Scripts","Custom JS"],"title":"Custom JS"},"tracking_id":"integrations/custom/js-Custom-JS-Add-JavaScript-functio","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/custom/js"]},{"id":"e47c69ee-34b0-4673-b293-9a9f703366c1","link":"reusable-snippets","qdrant_point_id":"4df98072-a226-4d2e-ba7e-6c5aa2e71c8e","created_at":"2024-06-25T04:45:28.079834","updated_at":"2024-06-25T04:45:28.169049","chunk_html":"Reusable components\nInside your snippet file, create a component that takes in props by exporting\nyour component in the form of an arrow function. MDX does not compile inside the body of an arrow function. Stick to HTML\nsyntax when you can or use a default export if you need to use MDX. Import the snippet into your destination file and pass in the props","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Reusable components"},"tracking_id":"reusable-snippets-Reusable-components","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["reusable-snippets"]},{"id":"8fafbe28-be43-4e83-81d4-822ed7670ca6","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"a3e0b455-bfad-453a-bc30-35b919db7086","created_at":"2024-06-25T04:45:27.875907","updated_at":"2024-06-25T04:45:27.875908","chunk_html":"Add Default Origin\nAfter creating the distribution, navigate to the Origins tab. We want to find a staging URL that mirrors where the main domain (example.com). This is highly variant depending on how your landing page is hosted. For instance, if your landing page is hosted on Webflow, you can use the\nWebflow's staging URL. It would look like .webflow.io. If you use Vercel, you use the .vercel.app domain available for every project. If you're unsure on how to get a staging URL for your landing page, contact\nsupport and we'd be happy to help Once you have the staging URL, ours for instance is mintlify-landing-page.vercel.app , create a new Origin and add it as the Origin domain. By this point, you should have two Origins - one with [SUBDOMAIN].mintlify.app and another with with staging URL.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Add Default Origin"},"tracking_id":"integrations/subpath/route53-cloudfront-Add-Default-Origin","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"77098c0b-29c3-4833-88a0-7b3bb49bcdf8","link":"settings/authentication","qdrant_point_id":"edab058f-e42d-4e38-93ae-7b332a15236c","created_at":"2024-06-25T04:45:28.374051","updated_at":"2024-06-25T04:45:28.374052","chunk_html":"Single Sign-On (SSO)\nMintlify supports single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us! SSO functionality is available on our enterprise plan. Contact\nus to learn more!","metadata":{"breadcrumbs":["Configurations","Single Sign-On (SSO)"],"title":"Single Sign-On (SSO)"},"tracking_id":"settings/authentication-Single-Sign-On-(SSO)","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/authentication"]},{"id":"28cb09a8-f5d7-4df6-89d2-d6bfc2a019e2","link":"development","qdrant_point_id":"c6e80acd-a07a-420e-813f-04f103c0078b","created_at":"2024-06-25T04:45:23.344787","updated_at":"2024-06-25T04:45:23.427039","chunk_html":"Custom Ports\nBy default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the --port flag. To run Mintlify on port 3333, for instance, use this command: If you attempt to run Mintlify on a port that's already in use, it will use the next available port:","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Custom Ports"},"tracking_id":"development-Custom-Ports","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["development"]},{"id":"1be5387b-ec83-46a3-8ebe-36d119cb6202","link":"content/components/tabs","qdrant_point_id":"89249d6a-cc66-40cd-9f6d-965d150d6750","created_at":"2024-06-25T04:45:23.011185","updated_at":"2024-06-25T04:45:23.011186","chunk_html":"Tab Props\nThe title of the tab. Short titles are easier to navigate.","metadata":{"breadcrumbs":["Components","Tabs"],"title":"Tab Props"},"tracking_id":"content/components/tabs-Tab-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/tabs"]},{"id":"542b1bb5-c5be-4427-820f-34cd91a7990b","link":"integrations/user-auth/overview","qdrant_point_id":"bfdc00a7-7281-453c-9ae3-3360dba7d3a7","created_at":"2024-06-27T01:19:03.206164","updated_at":"2024-06-27T01:19:03.206164","chunk_html":"Overview\nGive your users a personalized docs experience","metadata":{"breadcrumbs":["User Auth","Overview"],"title":"Overview"},"tracking_id":"integrations/user-auth/overview-Overview-Give-your-users-a-perso","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/user-auth/overview"]},{"id":"e1abd475-01e1-4d0a-ba5d-1295469a6e36","link":"api-playground/mdx/authentication","qdrant_point_id":"ea5ee072-1b24-4192-8272-c9826e0195d4","created_at":"2024-06-25T04:45:21.185862","updated_at":"2024-06-25T04:45:21.273970","chunk_html":"Enabling Authentication\nYou can add an authentication method to your mint.json to enable it on every page or you can set it on a per-page basis. The page's authentication method will override mint.json if both are set.","metadata":{"breadcrumbs":["API References","Using MDX","Authentication"],"title":"Enabling Authentication"},"tracking_id":"api-playground/mdx/authentication-Enabling-Authentication","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/mdx/authentication"]},{"id":"30d6c832-2533-43d1-a712-854fc0f71788","link":"integrations/analytics/logrocket","qdrant_point_id":"1e472a0b-4d2c-4417-b8ae-e8bde1661bd9","created_at":"2024-06-25T04:45:25.237980","updated_at":"2024-06-25T04:45:25.280351","chunk_html":"Logrocket\nAdd the following to your mint.json file to send analytics to Logrocket.","metadata":{"breadcrumbs":["Analytics","Logrocket"],"title":"Logrocket"},"tracking_id":"integrations/analytics/logrocket-Logrocket","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/logrocket"]},{"id":"095b1f26-711e-44e2-9522-fac7a01fcf98","link":"integrations/custom/css","qdrant_point_id":"46af0473-9c59-4d60-ab14-ed30d3f283b7","created_at":"2024-06-25T04:45:26.178822","updated_at":"2024-06-25T04:45:26.235832","chunk_html":"Adding style.css\nFor example, you can add the following style.css file to customize the styling of the navbar and footer.","metadata":{"breadcrumbs":["Custom Scripts","Custom CSS"],"title":"Adding style.css"},"tracking_id":"integrations/custom/css-Adding-style.css","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/custom/css"]},{"id":"e82f6dc6-b8e0-44ec-90e0-c183b3a7ef90","link":"development","qdrant_point_id":"b31b6e2c-f7aa-4dac-9931-96f80a069a3e","created_at":"2024-06-25T04:45:23.150215","updated_at":"2024-06-25T04:45:23.150216","chunk_html":"Development\nPreview changes locally to update your docs","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Development"},"tracking_id":"development-Development-Preview-changes-loca","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["development"]},{"id":"e56892ec-79b4-4f68-8740-4833187305d2","link":"content/components/tooltips","qdrant_point_id":"8103a266-540f-4d5e-a924-1d236db3412e","created_at":"2024-06-25T04:45:23.048679","updated_at":"2024-06-25T04:45:23.048680","chunk_html":"Tooltips\nShow a definition when you hover over text.","metadata":{"breadcrumbs":["Components","Tooltips"],"title":"Tooltips"},"tracking_id":"content/components/tooltips-Tooltips-Show-a-definition-when-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/tooltips"]},{"id":"f671b691-3b84-4617-a4b5-48bdbbf81ca5","link":"development","qdrant_point_id":"17cc8af4-77d1-40ea-a842-96c44df6cf24","created_at":"2024-06-25T04:45:23.654390","updated_at":"2024-06-25T04:45:23.654390","chunk_html":"Code Formatting\nWe suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the MDX VSCode extension for syntax highlighting, and Prettier for code formatting.","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Code Formatting"},"tracking_id":"development-Code-Formatting","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["development"]},{"id":"5e030dee-5ace-4af3-a803-2d758789daa4","link":"content/components/callouts","qdrant_point_id":"0acb9bb4-ada1-418f-922e-37d0736408d1","created_at":"2024-06-25T04:45:23.406115","updated_at":"2024-06-25T04:45:23.459907","chunk_html":"Info Callouts\nThis draws attention to important information","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Info Callouts"},"tracking_id":"content/components/callouts-Info-Callouts","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/callouts"]},{"id":"5b1d93ee-e1c3-4a94-9559-76ad5862fbc7","link":"list-table","qdrant_point_id":"152b15be-9b5e-4b99-b267-63e626238fbc","created_at":"2024-06-25T04:45:26.422064","updated_at":"2024-06-25T04:45:26.422065","chunk_html":"Tables\nProperty Description Name Full name of user Age Reported age Joined Whether the user joined the community","metadata":{"breadcrumbs":["Writing Content","Lists and Tables"],"title":"Tables"},"tracking_id":"list-table-Tables","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["list-table"]},{"id":"22c16434-21d1-4154-841c-aa456d5e703e","link":"quickstart","qdrant_point_id":"a59127b5-5ccc-4df2-9a5d-a960e33f25a1","created_at":"2024-06-25T04:45:27.745663","updated_at":"2024-06-25T04:45:27.745663","chunk_html":"All Done!\nCongrats! You've set up your Mintlify Docs and it's looking amazing! Need support or want to give some feedback? You can join our community or drop us an email at [email protected].","metadata":{"breadcrumbs":["Getting Started","Quickstart"],"title":"All Done!"},"tracking_id":"quickstart-All-Done!","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["quickstart"]},{"id":"14d1c122-0248-4287-aad8-28b6b5c27ca3","link":"settings/versioning","qdrant_point_id":"440fd1a1-8903-47bc-a502-98e2e67d3df5","created_at":"2024-06-25T04:45:30.387076","updated_at":"2024-06-25T04:45:30.433038","chunk_html":"Anchors\nYou can hide an entire anchor based on a version. This is useful when you have dozens of pages you want to hide. For example, for an API reference section. In mint.json , simply add version to your anchor. Anchors without a version value are shown in every version. You don't need to add v1/ or v2/ to the start of your URLs, but some customers do it to keep their doc files organized.","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Anchors"},"tracking_id":"settings/versioning-Anchors","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"f2c27e36-f9e0-46fd-90b7-869b93b3c3da","link":"api-playground/openapi/setup","qdrant_point_id":"c1e4b75c-b139-4c79-992f-636e81214bb2","created_at":"2024-06-25T04:45:22.121917","updated_at":"2024-06-25T04:45:22.202152","chunk_html":"Autogenerate files (Recommended)\nOur Mintlify scraper helps autogenerate MDX files for your OpenAPI endpoints. Use the relative path to the OpenAPI document in your codebase. If you're using a publicly-hosted OpenAPI document, you can just supply the URL in place of a path. Add the -o flag to specify a folder to populate the files into. If a folder is not specified, the files will populate into the current folder. Learn more about our scraping package here. The scraper will output an array of Navigation entries containing your OpenAPI MDX files. You can either append these entries to your existing Navigation, or add the files to your Navigation manually. If your OpenAPI document is invalid, the files will not autogenerate.","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"Autogenerate files (Recommended)"},"tracking_id":"api-playground/openapi/setup-Autogenerate-files-(Recommended)","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/setup"]},{"id":"5f9efb4b-8ae7-40d4-b691-8ab00871c112","link":"content/components/steps","qdrant_point_id":"1d0aa90e-851a-446c-868f-d31d45397677","created_at":"2024-06-25T04:45:22.602200","updated_at":"2024-06-25T04:45:22.602201","chunk_html":"Steps Props\nA list of Step components. The size of the step titles. One of p , h2 and h3.","metadata":{"breadcrumbs":["Components","Steps"],"title":"Steps Props"},"tracking_id":"content/components/steps-Steps-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/steps"]},{"id":"ef1ddf67-b96a-4296-91a5-adf8587e3fac","link":"integrations/custom/js","qdrant_point_id":"607fc2ac-daee-4665-8dbb-f618b684502b","created_at":"2024-06-25T04:45:26.316815","updated_at":"2024-06-25T04:45:26.316815","chunk_html":"Custom JS\nCustom JS is available on the growth plan. Custom JS allows you to add custom executable code globally. It is the equivalent of adding a <script> tag with JS code into every page.","metadata":{"breadcrumbs":["Custom Scripts","Custom JS"],"title":"Custom JS"},"tracking_id":"integrations/custom/js-Custom-JS","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/custom/js"]},{"id":"519d2a39-19f7-4658-9fcf-33b49395b232","link":"integrations/analytics/google-tag-manager","qdrant_point_id":"717cae3e-73f7-4603-a457-2b3be5b08bb7","created_at":"2024-06-25T04:45:24.796221","updated_at":"2024-06-25T04:45:24.796221","chunk_html":"Google Tag Manager\nGoogle Tag Manager\nAdd your tag ID to mint.json file and we'll inject the Google Tag Manager script to all your pages. You are responsible for setting up cookie consent banners with Google Tag Manager if you need them. \"analytics\": {\n    \"gtm\": {\n        \"tagId\": \"required\"\n    }\n}","metadata":{"breadcrumbs":["Analytics","Google Tag Manager"],"title":"Google Tag Manager"},"tracking_id":"integrations/analytics/google-tag-manager-Google-Tag-Manager-Google-Tag-Ma","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/google-tag-manager"]},{"id":"e53853f1-7048-4bdb-b2b1-a12977a2a7cd","link":"integrations/privacy/overview","qdrant_point_id":"0a964830-97f8-42f5-a7a1-e0ec343b3867","created_at":"2024-06-25T04:45:26.673853","updated_at":"2024-06-25T04:45:26.727996","chunk_html":"Enabling Data Privacy Integrations\nYou can add data privacy platforms onto your docs. Add the integrations field into your mint.json file with your respective scripts. If you'd like to request a data privacy platform integration, please let us know in our community.","metadata":{"breadcrumbs":["Privacy","Data Privacy Integrations"],"title":"Enabling Data Privacy Integrations"},"tracking_id":"integrations/privacy/overview-Enabling-Data-Privacy-Integrations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/privacy/overview"]},{"id":"f1deae7b-f961-42e4-ad8c-d0c9dfeac0ee","link":"page","qdrant_point_id":"e8c1660e-96a2-4381-926f-473c3f990ad0","created_at":"2024-06-25T04:45:26.989089","updated_at":"2024-06-25T04:45:27.035279","chunk_html":"Sidebar Icons\nWant an icon for your sidebar item like the ones in\ncomponents ? You can set an icon attribute in\nthe metadata! All icons from Font Awesome are\navailable for us. You can also set an icon type (optional). If not set, the icon\ntype will be regular.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Sidebar Icons"},"tracking_id":"page-Sidebar-Icons","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"0fd9017e-293d-4bfc-a0b2-bc839f40ffdb","link":"quickstart","qdrant_point_id":"229154a4-0675-40e2-984b-bd88daccdcff","created_at":"2024-06-25T04:45:27.384365","updated_at":"2024-06-25T04:45:27.384366","chunk_html":"Getting Started with Mintlify Docs\nWelcome to the Mintlify documentation guide. Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify.","metadata":{"breadcrumbs":["Getting Started","Quickstart"],"title":"Getting Started with Mintlify Docs"},"tracking_id":"quickstart-Getting-Started-with-Mintlify-Docs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["quickstart"]},{"id":"031e2ec0-c832-46d7-9435-bb3c50f0cd54","link":"settings/custom-domain","qdrant_point_id":"16587949-61ec-4429-807f-82b4af07464c","created_at":"2024-06-25T04:45:28.412035","updated_at":"2024-06-25T04:45:28.412035","chunk_html":"Dashboard Settings\nHead over to your dashboard project Click on the \"Add custom subdomain\". Enter your desired custom subdomain. For example, docs.mintlify.com.","metadata":{"breadcrumbs":["Configurations","Custom Domain"],"title":"Dashboard Settings"},"tracking_id":"settings/custom-domain-Dashboard-Settings","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/custom-domain"]},{"id":"b30c44d5-9a94-4486-84fe-8c1474516419","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"a1cdd748-0beb-4c3f-b23d-43b5579e474a","created_at":"2024-06-25T04:45:27.937743","updated_at":"2024-06-25T04:45:27.937744","chunk_html":"/docs/*\nThe first behavior should have a Path pattern of /docs/* with Origin and origin groups pointing to the .mintlify.dev URL (in our case acme.mintlify.dev) For Cache policy , select CachingOptimized and create behavior.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"/docs/*"},"tracking_id":"integrations/subpath/route53-cloudfront-/docs/*","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"ffbcf35e-ab69-4d2f-8797-89fa075a62af","link":"settings/custom-domain","qdrant_point_id":"c76cd983-e981-408d-9bb7-8deacdbde946","created_at":"2024-06-25T04:45:28.448939","updated_at":"2024-06-25T04:45:28.448939","chunk_html":"Verification with Vercel\nIf Vercel happens to be your domain provider, you will have to add a verification TXT record. This information will show on your dashboard after submitting your custom subdomain, as well as be emailed to you.","metadata":{"breadcrumbs":["Configurations","Custom Domain"],"title":"Verification with Vercel"},"tracking_id":"settings/custom-domain-Verification-with-Vercel","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/custom-domain"]},{"id":"ff9905ff-1374-4a6c-aebc-c4a00e3afd73","link":"settings/authentication","qdrant_point_id":"5c3bd4e7-7932-48e8-a2bf-0fee19bf6fb2","created_at":"2024-06-25T04:45:28.405661","updated_at":"2024-06-25T04:45:28.405662","chunk_html":"Okta\nSAML Create an application Under Applications , click to create a new app integration using SAML 2.0. Configure integration Enter the following: Single sign-on URL (provided by Mintlify) Audience URI (provided by Mintlify) Name ID Format: EmailAddress Attribute Statements: Name Name format Value firstName Basic user.firstName lastName Basic user.lastName Send us your IdP information Once the application is set up, navigate to the sign-on tab and send us the metadata URL.\nWe'll enable the connection from our side using this information. OIDC Create an application Under Applications , click to create a new app integration using OIDC.\nYou should choose the Web Application application type. Configure integration Select the authorization code grant type and enter the Redirect URI provided by Mintlify. Send us your IdP information Once the application is set up, navigate to the General tab and locate the client ID & client secret.\nPlease securely provide us with these, along with your Okta instance URL (e.g. <your-tenant-name>.okta.com ). You can send these via a service like 1Password or SendSafely.","metadata":{"breadcrumbs":["Configurations","Single Sign-On (SSO)"],"title":"Okta"},"tracking_id":"settings/authentication-Okta","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/authentication"]},{"id":"9595c649-d254-47d9-b42b-a7f4dd390493","link":"code","qdrant_point_id":"c24b40b4-ba11-4618-88d5-9e24fa28ef5b","created_at":"2024-06-25T04:45:22.759289","updated_at":"2024-06-25T04:45:22.803846","chunk_html":"Inline Code\nTo denote a word or phrase as code, enclose it in backticks (`).","metadata":{"breadcrumbs":["Writing Content","Code Blocks"],"title":"Inline Code"},"tracking_id":"code-Inline-Code","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["code"]},{"id":"cbe2fc38-dc33-4508-b369-a62cf2c6dcb0","link":"settings/authentication","qdrant_point_id":"88890151-5afb-47df-be37-53df4816b11c","created_at":"2024-06-25T04:45:28.446097","updated_at":"2024-06-25T04:45:28.446098","chunk_html":"Google Workspace\nSAML Create an application Under Web and mobile apps , select Add custom SAML app from the Add app dropdown. Send us your IdP information Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team. Configure integration On the Service provider details page, enter the following: ACS URL (provided by Mintlify) Entity ID (provided by Mintlify) Name ID format: EMAIL Name ID: Basic Information > Primary email On the next page, enter the following attribute statements: Google Directory Attribute App Attribute First name firstName Last name lastName Once this step is complete and users are assigned to the application, let our team know and we'll enable SSO for your account!","metadata":{"breadcrumbs":["Configurations","Single Sign-On (SSO)"],"title":"Google Workspace"},"tracking_id":"settings/authentication-Google-Workspace","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/authentication"]},{"id":"061a16b0-02f8-4c75-9972-1f616f0c7a3f","link":"integrations/analytics/hotjar","qdrant_point_id":"c2ee3278-6fb3-4342-a692-be2020f61584","created_at":"2024-06-25T04:45:24.972864","updated_at":"2024-06-25T04:45:25.034031","chunk_html":"HotJar\nAdd the following to your mint.json file to send analytics to HotJar.","metadata":{"breadcrumbs":["Analytics","HotJar"],"title":"HotJar"},"tracking_id":"integrations/analytics/hotjar-HotJar","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/hotjar"]},{"id":"dcdd7df5-3904-4b95-9f94-d3de3d171a07","link":"integrations/analytics/heap","qdrant_point_id":"e92891c1-4c93-4f8a-a3d9-f7b0ff33bdf4","created_at":"2024-06-25T04:45:24.826802","updated_at":"2024-06-25T04:45:24.902479","chunk_html":"Heap\nAdd the following to your mint.json file to send analytics to Heap.","metadata":{"breadcrumbs":["Analytics","Heap"],"title":"Heap"},"tracking_id":"integrations/analytics/heap-Heap","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/heap"]},{"id":"5d6e5d3e-d779-4184-a676-50dd0d85ec66","link":"content/components/card-groups","qdrant_point_id":"b5c050c2-fa2b-4a66-8264-2cc9d4081e7d","created_at":"2024-06-25T04:45:23.716647","updated_at":"2024-06-25T04:45:23.716648","chunk_html":"Props\nThe number of columns per row","metadata":{"breadcrumbs":["Components","Card Groups"],"title":"Props"},"tracking_id":"content/components/card-groups-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/card-groups"]},{"id":"f0df05e9-df33-42ed-9fa0-51b31d03f649","link":"integrations/user-auth/shared-session","qdrant_point_id":"2fac4fb4-209a-4dfe-8b6b-1d7158844c70","created_at":"2024-06-25T04:45:26.061289","updated_at":"2024-06-25T04:45:26.061289","chunk_html":"Dashboard at subdomain, docs at subdomain\nI have a dashboard at dash.foo.com , which uses cookie-based session authentication. My dashboard API routes are hosted at dash.foo.com/api . I want to set up authentication for my docs hosted at docs.foo.com. To set up authentication with Mintlify, I create another dashboard endpoint dash.foo.com/api/docs/user-info which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add https://docs.foo.com to the Access-Control-Allow-Origin allow-list for this route only , and ensure my Access-Control-Allow-Credentials configuration is set to true for this route only. I then go to the Mintlify dashboard settings and enter https://dash.foo.com/api/docs/user-info for the API URL field.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Dashboard at subdomain, docs at subdomain"},"tracking_id":"integrations/user-auth/shared-session-Dashboard-at-subdomain,-docs-at-subdomain","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/shared-session"]},{"id":"154d4d4a-5ce5-4803-abff-045cc64e5dfe","link":"api-playground/mdx/configuration","qdrant_point_id":"961167dd-048e-4cab-8ada-56f2374a4384","created_at":"2024-06-25T04:45:21.482735","updated_at":"2024-06-25T04:45:21.657975","chunk_html":"MDX Setup\nMintlify allows you to define your API endpoints using a combination of mint.json configuration, MDX metadata fields, and the <ParamFields /> component. From the defined endpoints, we generate an API playground, request examples, and response examples. Configure your API In your mint.json file, define your base URL and auth method: If you would not like to show an API playground, you don't need to include auth types. Hide the playground with the following field: Find a full list of API configurations here. Create your endpoint pages Each API endpoint page should have a corresponding MDX file. At the top of each file, define: You can specify path parameters by adding the parameter name to the path, wrapped with {}: If you have baseUrl configured in mint.json , you can use relative paths like /v1/endpoint. Add your endpoints to your docs Add your endpoint pages to the sidebar by adding the paths to the navigation field in your mint.json . Learn more about structuring your docs here.","metadata":{"breadcrumbs":["API References","Using MDX","MDX Setup"],"title":"MDX Setup"},"tracking_id":"api-playground/mdx/configuration-MDX-Setup","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"e6cafde8-f950-443d-89ea-1aca04b0f78f","link":"api-playground/openapi/advanced-features","qdrant_point_id":"fec09d62-9ba3-44f7-93b4-df252b4209cf","created_at":"2024-06-25T04:45:21.712007","updated_at":"2024-06-25T04:45:21.712008","chunk_html":"Advanced Features\nOpenAPI 3 has some advanced features for describing complex APIs. Here's how you can use them with Mintlify.","metadata":{"breadcrumbs":["API References","Using OpenAPI","Advanced Features"],"title":"Advanced Features"},"tracking_id":"api-playground/openapi/advanced-features-Advanced-Features","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"8287b758-b325-4315-81fd-2a33de14ba2d","link":"content/components/icons","qdrant_point_id":"e40f9bb7-b316-4eaa-8d02-2fa023e3e12e","created_at":"2024-06-25T04:45:21.721959","updated_at":"2024-06-25T04:45:21.721959","chunk_html":"Icons\nUse [Font Awesome](https://fontawesome.com/icons) icons anywhere in the doc","metadata":{"breadcrumbs":["Components","Icons"],"title":"Icons"},"tracking_id":"content/components/icons-Icons-Use-[Font-Awesome](https:/","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"7ce95094-5c88-413d-8f3a-f4e05f29ed9b","link":"content/components/callouts","qdrant_point_id":"076f74a3-49bb-42f6-b898-37c8e6317cc5","created_at":"2024-06-25T04:45:23.546051","updated_at":"2024-06-25T04:45:23.585340","chunk_html":"Check Callouts\nThis brings us a checked status","metadata":{"breadcrumbs":["Components","Callout Boxes"],"title":"Check Callouts"},"tracking_id":"content/components/callouts-Check-Callouts","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"76966f1b-0391-420d-9a35-cc4a72bdf878","link":"image-embeds","qdrant_point_id":"23e769af-836a-4ad5-83f6-d37ecd658b3e","created_at":"2024-06-25T04:45:24.057777","updated_at":"2024-06-25T04:45:24.099280","chunk_html":"Dark Mode\nTo use separate images for light and dark mode, use Tailwind CSS to hide and show images.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Dark Mode"},"tracking_id":"image-embeds-Dark-Mode","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"3412d234-0c17-471d-ac38-9d8d9deacefd","link":"integrations/analytics/mixpanel","qdrant_point_id":"91f4c02a-40cb-4a1a-af32-9d173000beaf","created_at":"2024-06-25T04:45:25.336914","updated_at":"2024-06-25T04:45:25.378804","chunk_html":"Mixpanel\nAdd the following to your mint.json file to send analytics to Mixpanel.","metadata":{"breadcrumbs":["Analytics","Mixpanel"],"title":"Mixpanel"},"tracking_id":"integrations/analytics/mixpanel-Mixpanel","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"8eb31ad7-68a8-454d-bd88-dee6d10b5549","link":"integrations/analytics/overview","qdrant_point_id":"af3e4339-1458-4d3c-bfb4-d23f8b65f98a","created_at":"2024-06-25T04:45:25.450311","updated_at":"2024-06-25T04:45:25.450312","chunk_html":"Analytics Integrations\nIntegrate with an analytics platform to track viewer events","metadata":{"breadcrumbs":["Analytics","Analytics Integrations"],"title":"Analytics Integrations"},"tracking_id":"integrations/analytics/overview-Analytics-Integrations-Integrate","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"648370d1-1f0c-44f3-94ac-f8e48482cdc1","link":"integrations/user-auth/jwt","qdrant_point_id":"d2b9279b-ad26-446a-8d57-bbb3714bfe23","created_at":"2024-06-25T04:45:25.524805","updated_at":"2024-06-25T04:45:25.524805","chunk_html":"Implementation\nGenerate a private key Go to your Mintlify dashboard settings and generate a private key. Store this key somewhere secure where it can be accessed by your backend. Create a login flow Create a login flow that does the following: Authenticate the user Create a JWT containing the authenticated user's info in the UserInfo format Sign the JWT with the secret Create a redirect URL back to your docs, including the JWT as a query parameter with the name user_auth Configure your User Auth settings Return to your Mintlify dashboard settings and add the login URL to your User Auth settings.","metadata":{"breadcrumbs":["User Auth","Authenticating","JWT Auth"],"title":"Implementation"},"tracking_id":"integrations/user-auth/jwt-Implementation","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"3cfce50f-08a2-44d7-aacf-9febb5eeb40a","link":"integrations/user-auth/sending-data","qdrant_point_id":"5b982354-e3d2-4bd5-9b77-2b57fd8aba8b","created_at":"2024-06-25T04:45:25.871292","updated_at":"2024-06-25T04:45:25.924718","chunk_html":"Sending Data\nDepending on your authentication configuration, your API will respond with either a raw JSON object or a signed JWT. The shape of the data is the same for both: The time at which this information should expire, in seconds since epoch . If the user loads the page and the current time is after this value, the stored data will be deleted.\nFor JWT Auth: This is not the same as the exp claim of the JWT. The exp claim determines when a JWT should no longer be considered valid, and should be set as low as possible. In this case, it can probably be set to 10 seconds or lower. The expiresAt field determines when retrieved data should be considered stale, and can be anywhere from one day to several weeks. A list of groups that the user belongs to. This will determine which pages should be shown to this user. If any of these groups is listed in the groups field of a page’s metadata, that page will be shown. A bag of values that can be accessed from within MDX content using the userContext variable. For example, if you have supplied { firstName: 'Ronan' } as your content field, you can use the following in your MDX: Good morning, {userContext.firstName}! User-specific values that will be prefilled in the API playground if supplied. For example, if each of my customers makes requests at a specific subdomain, I can send { server: { subdomain: 'foo' } } as my apiPlaygroundInputs field, and this value will be prefilled on any API page with this subdomain value. The header , query , and cookie fields will only be prefilled if they are part of your security scheme . Creating a standard header parameter named Authorization is not sufficient to enable this feature. To know if a field will be prefilled, navigate to your existing docs and check if the field is in either the Authorization or Server section.","metadata":{"breadcrumbs":["User Auth","Sending Data"],"title":"Sending Data"},"tracking_id":"integrations/user-auth/sending-data-Sending-Data","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"0f6ca6fa-ff8b-44cc-85ed-2c1dbf66d861","link":"integrations/user-auth/shared-session","qdrant_point_id":"cc7d7066-9582-4db5-b02d-dcdbd355a055","created_at":"2024-06-25T04:45:26.098037","updated_at":"2024-06-25T04:45:26.098037","chunk_html":"Dashboard at subdomain, docs at root\nI have a dashboard at dash.foo.com , which uses cookie-based session authentication. My dashboard API routes are hosted at dash.foo.com/api . I want to set up authentication for my docs hosted at foo.com/docs. To set up authentication with Mintlify, I create another dashboard endpoint dash.foo.com/api/docs/user-info which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then add https://foo.com to the Access-Control-Allow-Origin allow-list for this route only , and ensure my Access-Control-Allow-Credentials configuration is set to true for this route only. I then go to the Mintlify dashboard settings and enter https://dash.foo.com/api/docs/user-info for the API URL field.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Dashboard at subdomain, docs at root"},"tracking_id":"integrations/user-auth/shared-session-Dashboard-at-subdomain,-docs-at-root","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"e81678cf-c404-4eb7-ba04-26749be01759","link":"page","qdrant_point_id":"f1e7dcbe-d420-4bd3-bdda-917ff58d17ec","created_at":"2024-06-25T04:45:26.524578","updated_at":"2024-06-25T04:45:26.524578","chunk_html":"Page Titles and Metadata\nSetting the title and metadata for navigation and SEO","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Page Titles and Metadata"},"tracking_id":"page-Page-Titles-and-Metadata-Setting","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"caa406b7-3749-4799-9aa0-6d4161982b8a","link":"integrations/privacy/overview","qdrant_point_id":"d344379c-13c8-4aff-88db-ff787545947d","created_at":"2024-06-25T04:45:26.643181","updated_at":"2024-06-25T04:45:26.643181","chunk_html":"Data Privacy Integrations\nOsano","metadata":{"breadcrumbs":["Privacy","Data Privacy Integrations"],"title":"Data Privacy Integrations"},"tracking_id":"integrations/privacy/overview-Data-Privacy-Integrations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"cf377716-f579-4da7-8bb9-8c284610aa38","link":"integrations/rest-api/overview","qdrant_point_id":"e62d79a8-6304-40ba-8c94-c96fb8a405b4","created_at":"2024-06-25T04:45:26.781251","updated_at":"2024-06-25T04:45:26.781251","chunk_html":"Authentication\nYou can generate an API key through\nthe dashboard . The API key is\nassociated with the entire org and can be used across multiple deployments.","metadata":{"breadcrumbs":["Mintlify REST API","Overview"],"title":"Authentication"},"tracking_id":"integrations/rest-api/overview-Authentication","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"4b693e42-43a4-4630-9f0a-000081191bf8","link":"page","qdrant_point_id":"2b437b7c-e9cc-42c4-bb57-307ffdc5f476","created_at":"2024-06-25T04:45:26.929877","updated_at":"2024-06-25T04:45:26.970159","chunk_html":"Sidebar Title\nYou can show a different title in the navigation with the sidebarTitle metadata. This is useful if your title is long and you want something shorter in\nthe navigation links.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Sidebar Title"},"tracking_id":"page-Sidebar-Title","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"7d351b3d-2d25-4cfd-aaf0-2144d83409cd","link":"integrations/subpath/cloudflare","qdrant_point_id":"5a64af73-64ee-46a9-a9ba-9b897a4fb691","created_at":"2024-06-25T04:45:27.515313","updated_at":"2024-06-25T04:45:27.515313","chunk_html":"Cloudflare\nHost documentation at a /docs subpath using Cloudflare Workers","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Cloudflare"},"tracking_id":"integrations/subpath/cloudflare-Cloudflare-Host-documentation-at","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"a777957a-9426-4be7-9be6-137de0c44b9a","link":"integrations/subpath/cloudflare","qdrant_point_id":"e18d5c04-e6e5-4786-b231-c002dabf13a1","created_at":"2024-06-25T04:45:27.762282","updated_at":"2024-06-25T04:45:27.762282","chunk_html":"Reach out to Mintlify team\nOnce completing the Cloudflare setup, the Mintlify team will setup the\nsubdirectory settings in your deployment. Reach out over\nemail.","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Reach out to Mintlify team"},"tracking_id":"integrations/subpath/cloudflare-Reach-out-to-Mintlify-team","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"3ec4c619-4811-44fb-a6b8-546b8806986f","link":"reusable-snippets","qdrant_point_id":"cadbb1a7-edc6-4b5b-b435-07c0a3c53580","created_at":"2024-06-25T04:45:27.773169","updated_at":"2024-06-25T04:45:27.773170","chunk_html":"Reusable Snippets\nReusable, custom snippets to keep content in sync","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Reusable Snippets"},"tracking_id":"reusable-snippets-Reusable-Snippets-Reusable,-cust","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"7c455733-7c29-4462-8758-e90737c61a56","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"eec9fca9-34dc-483a-933c-e18d6d2332f2","created_at":"2024-06-25T04:45:27.968844","updated_at":"2024-06-25T04:45:27.968844","chunk_html":"/docs\nThe second behavior should be the same as the first one but with a Path pattern of /docs and Origin and origin groups pointing to the same .mintlify.dev URL.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"/docs"},"tracking_id":"integrations/subpath/route53-cloudfront-/docs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"16acca3f-38b0-4f1a-8fca-1947cef43701","link":"settings/broken-links","qdrant_point_id":"42bc4df5-78ea-420d-ac56-d88259cf57b9","created_at":"2024-06-25T04:45:28.612382","updated_at":"2024-06-25T04:45:28.697517","chunk_html":"Redirects\nSet up 301 redirects by adding the redirects field into your mint.json file. This will permanently redirect /source/path to /destination/path so that you don't lose any previous SEO for the original page. To match a wildcard path, use * after a parameter. In this example, /beta/:slug* will match /beta/introduction and redircets it to /v2/introduction.","metadata":{"breadcrumbs":["Configurations","Redirects and Broken Links"],"title":"Redirects"},"tracking_id":"settings/broken-links-Redirects","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"9c528efe-3f70-4c9e-a990-296cf5a7ea5b","link":"settings/seo","qdrant_point_id":"7650a55a-8602-48c0-884b-7dcf9a89f7dc","created_at":"2024-06-25T04:45:30.050846","updated_at":"2024-06-25T04:45:30.050847","chunk_html":"Search Engine Optimization\nSupported Meta Tags og:site_name og:title og:description og:url og:image og:locale og:logo article:publisher twitter:title twitter:description twitter:url twitter:image twitter:site og:image:width og:image:height","metadata":{"breadcrumbs":["Configurations","Search Engine Optimization"],"title":"Search Engine Optimization"},"tracking_id":"settings/seo-Search-Engine-Optimization","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"2de18718-7ad9-4ba3-9426-25381e4ae3b1","link":"settings/seo","qdrant_point_id":"a9905c8e-ca51-41d6-8f16-5fdaa130b770","created_at":"2024-06-25T04:45:30.081788","updated_at":"2024-06-25T04:45:30.128917","chunk_html":"Default meta tags\nYou can set default meta tags by adding the metadata field to your mint.json.","metadata":{"breadcrumbs":["Configurations","Search Engine Optimization"],"title":"Default meta tags"},"tracking_id":"settings/seo-Default-meta-tags","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"5aa71355-504e-4014-a28c-4612c75fb412","link":"settings/versioning","qdrant_point_id":"12222100-1d80-4d5d-bc93-2fb9497474ba","created_at":"2024-06-25T04:45:30.585218","updated_at":"2024-06-25T04:45:30.635580","chunk_html":"Pages\nYou can version a single page. Add version to the top of your page metadata like so: Your navigation config in mint.json should include the page like normal, but the page will only show up when the correct version is selected.","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Pages"},"tracking_id":"settings/versioning-Pages","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"de0ca4a6-e0b6-486b-9458-cd019c6b1d95","link":"integrations/user-auth/overview","qdrant_point_id":"4ce11056-cf50-4e2c-8e47-30d79e7d2ea7","created_at":"2024-06-27T01:19:03.502501","updated_at":"2024-06-27T01:19:03.502502","chunk_html":"Prefilling API Keys\nIf you return API Playground inputs in the user info, they will automatically be prefilled in the API Playground. Make sure the name of the field in the user info is an exact match of the name in the API Playground. /* \n### Showing/Hiding Pages\n\nBy default, every page is visible to every user. If you want to restrict which pages are visible to your users, you can add a `groups` field in your page metadata.\nWhen determining which pages to show to the user, Mintlify will check which groups the user belongs to.\nIf the user is not in any of the groups listed in the page metadata, the page will not be shown.\n\n```md\n---\ntitle: 'Managing Your Users'\ndescription: 'Adding and removing users from your organization'\ngroups: ['admin']\n---\n```\n\nHere's a table that displays whether a page is shown for different combinations of `groups` in UserInfo and page metadata:\n\n|                                    | `groups` not in UserInfo | `groups: []` in UserInfo | `groups: ['admin']` in UserInfo |\n|:-----------------------------------|:------------------------:|:-------------------------:|:--------------------------------:|\n| `groups` not in metadata           |                        ✅ |                        ✅ |                               ✅ |\n| `groups: []` in metadata           |                        ❌ |                        ❌ |                               ❌ |\n| `groups: ['admin']` in metadata    |                        ❌ |                        ❌ |                               ✅ |\n\n<Note>Note that an empty array in the page metadata is interpreted as \"No groups should see this page.\"</Note> */","metadata":{"breadcrumbs":["User Auth","Overview"],"title":"Prefilling API Keys"},"tracking_id":"integrations/user-auth/overview-Prefilling-API-Keys","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/overview"]},{"id":"bdb9ea59-3205-48c7-92ea-42fa8268eb30","link":"api-playground/mdx/configuration","qdrant_point_id":"13b50c0a-8752-45cb-9c36-d3143c325ef1","created_at":"2024-06-25T04:45:21.444775","updated_at":"2024-06-25T04:45:21.444776","chunk_html":"MDX Setup\nGenerate docs pages for your API endpoints using MDX","metadata":{"breadcrumbs":["API References","Using MDX","MDX Setup"],"title":"MDX Setup"},"tracking_id":"api-playground/mdx/configuration-MDX-Setup-Generate-docs-pages-fo","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["api-playground/mdx/configuration"]},{"id":"685aa50e-deec-40a2-8f64-410f8cf68994","link":"integrations/user-auth/choosing-an-auth-method","qdrant_point_id":"42fb34ef-e9be-4da8-88a8-c800b1965874","created_at":"2024-06-25T04:45:25.369240","updated_at":"2024-06-25T04:45:25.369240","chunk_html":"Prerequisites\nShared Session You have a dashboard or other user portal hosted at your domain. Your users' session credentials are stored as cookies. You can create a new API endpoint at the same origin or a subdomain of your dashboard. If your dashboard is at foo.com , the API URL must start with foo.com or *.foo.com If your dashboard is at dash.foo.com , the API URL must start with dash.foo.com or *.dash.foo.com Your docs are hosted at the same domain as your dashboard. If your dashboard is at foo.com , your docs must be hosted at foo.com or *.foo.com If your dashboard is at *.foo.com , your docs must be hosted at foo.com or *.foo.com JWT You have some existing login flow. You can add a final step in this login flow that creates a JWT and redirects to the docs.","metadata":{"breadcrumbs":["User Auth","Authenticating","Choosing an Auth Method"],"title":"Prerequisites"},"tracking_id":"integrations/user-auth/choosing-an-auth-method-Prerequisites","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"f4ad1a57-deb7-4a1c-8732-c7cdbd0396c1","link":"integrations/user-auth/shared-session","qdrant_point_id":"9d9fa22d-3cbe-4d6e-92ef-3bc82d5741ae","created_at":"2024-06-25T04:45:26.004695","updated_at":"2024-06-25T04:45:26.004695","chunk_html":"Implementation\nCreate your Info API Create an API endpoint that uses session authentication to identify users, and responds with a JSON payload following the UserInfo format. If the API domain does not exactly match the docs domain: Add the docs domain to your API's Access-Control-Allow-Origin header (must not be *) Ensure your API’s Access-Control-Allow-Credentials header is true These CORS options only need to be enabled on the single endpoint responsible for returning user information. We do not recommend enabling these options on all dashboard endpoints. Configure your User Auth settings Go to your Mintlify dashboard settings and add the API URL and your Login URL to your User Auth settings.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Implementation"},"tracking_id":"integrations/user-auth/shared-session-Implementation","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"3c79c8e9-7689-4153-a6fc-be479275eb36","link":"content/components/code-groups","qdrant_point_id":"27715878-aa2f-413d-8fd8-3235dad33852","created_at":"2024-06-25T04:45:23.986530","updated_at":"2024-06-25T04:45:24.156838","chunk_html":"Code Groups\nYou will need to make Code Blocks then add the <CodeGroup> component around them. Every Code Block must have a filename because we use the names for the tab buttons. See below for an example of the end result.","metadata":{"breadcrumbs":["Components","Code Groups"],"title":"Code Groups"},"tracking_id":"content/components/code-groups-Code-Groups","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"6b0d428c-44ea-4f7e-807e-4c02f4dbf756","link":"settings/authentication","qdrant_point_id":"c2db3523-2cdd-4576-a5a3-ea2987ab4cbd","created_at":"2024-06-25T04:45:28.342046","updated_at":"2024-06-25T04:45:28.342047","chunk_html":"Single Sign-On (SSO)\nCustomize how your team can login to Mintlify","metadata":{"breadcrumbs":["Configurations","Single Sign-On (SSO)"],"title":"Single Sign-On (SSO)"},"tracking_id":"settings/authentication-Single-Sign-On-(SSO)-Customize-h","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"085a9e1c-5e19-47f5-9ab0-472b50b98dc7","link":"integrations/user-auth/shared-session","qdrant_point_id":"6a207e5a-c083-47d5-8f0a-a1afbe6b5d81","created_at":"2024-06-25T04:45:25.975741","updated_at":"2024-06-25T04:45:25.975742","chunk_html":"Shared Session Auth\nThis method utilizes the session authentication info already stored in your user’s browser to create a seamless documentation experience.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Shared Session Auth"},"tracking_id":"integrations/user-auth/shared-session-Shared-Session-Auth","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"dc87ea9b-7856-435d-b8d7-cd59690dfe3d","link":"integrations/sdks/speakeasy","qdrant_point_id":"4d134ea4-4e55-4894-8a3d-f1f199bab531","created_at":"2024-06-25T04:45:27.136624","updated_at":"2024-06-25T04:45:27.136624","chunk_html":"Mintlify Docs Repository Changes\nThe workflow files produced will automatically bundle your source OpenAPI spec and Speakeasy code samples into a single output file, openapi.yaml . Mintlify will use this output file when constructing your API reference.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Mintlify Docs Repository Changes"},"tracking_id":"integrations/sdks/speakeasy-Mintlify-Docs-Repository-Changes","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"c4d6c3ca-23fe-4a60-bba1-9656b66ad4c9","link":"integrations/rest-api/overview","qdrant_point_id":"4197fde3-c7e9-4c16-b9ad-5ba55aca81f2","created_at":"2024-06-25T04:45:26.748516","updated_at":"2024-06-25T04:45:26.748517","chunk_html":"Overview\nThe Mintlify REST API is only available on the startup plan and above. Leverage the external API to programmatically trigger an update when desired.\nThe primary use-case will be to trigger updates. We will be adding more and more\nfunctionality to the API overtime. Let us know what else you want to see in\nour community!","metadata":{"breadcrumbs":["Mintlify REST API","Overview"],"title":"Overview"},"tracking_id":"integrations/rest-api/overview-Overview","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"dcfa99aa-6d26-4857-b268-1d865a3c96fc","link":"integrations/subpath/cloudflare","qdrant_point_id":"640c0532-8d1e-4013-8e35-2fd51362fcd5","created_at":"2024-06-25T04:45:27.581837","updated_at":"2024-06-25T04:45:27.581838","chunk_html":"Create Cloudflare Worker\nNavigate to the Workers & Pages > Create application > Create worker . You\nshould be able to presented with the following screen where you can create a new\nCloudlfare worker.","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Create Cloudflare Worker"},"tracking_id":"integrations/subpath/cloudflare-Create-Cloudflare-Worker","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"ec6a5528-7277-451e-aaa2-28a87d103153","link":"integrations/sdks/speakeasy","qdrant_point_id":"71b8b929-21c8-46be-b88e-e2e85c98db53","created_at":"2024-06-25T04:45:27.165309","updated_at":"2024-06-25T04:45:27.209575","chunk_html":"Interactive CLI Set Up\nRun the following commands to set up the .speakeasy/workflow.yaml and .github/workflows/sdk_generation.yaml files through the interactive Speakeasy CLI. Set up your source spec. The source spec is the OpenAPI spec that code samples will be generated for, and it's often the same specification used to power Mintlify docs. Add the overlay created by Speakeasy to inject code snippets into your spec. Provide a name and path for the OpenAPI spec. This will be the final spec used by Mintlify. Finally, Add your SPEAKEASY_API_KEY as a repository secret to your Minlify repo under Settings > Secrets & Variables > Actions . Find the Speakeasy API key in the Speakeasy dashboard under the API Keys tab.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Interactive CLI Set Up"},"tracking_id":"integrations/sdks/speakeasy-Interactive-CLI-Set-Up","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"8c3360b7-66de-4d3a-ae63-9778af58a9ee","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"5e73523c-1f11-4a07-b3e7-f3dcecc9bfff","created_at":"2024-06-25T04:45:28.004146","updated_at":"2024-06-25T04:45:28.004146","chunk_html":"Default (*)\nLastly, we're going to edit the Default (*) behavior. We're going to change the default behavior's Origin and origin groups to the staging URL (in our case mintlify-landing-page.vercel.app ). Click on Save changes.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Default (*)"},"tracking_id":"integrations/subpath/route53-cloudfront-Default-(*)","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"d691640e-6e2e-4521-8172-bb9100fdf748","link":"integrations/analytics/google-analytics","qdrant_point_id":"b77155d1-e255-44c4-9b36-3da26ec16cb3","created_at":"2024-06-25T04:45:24.892316","updated_at":"2024-06-25T04:45:24.950063","chunk_html":"Put Measurement ID in mint.json\nAdd your Measurement ID to your mint.json file like so:","metadata":{"breadcrumbs":["Analytics","Google Analytics 4"],"title":"Put Measurement ID in mint.json"},"tracking_id":"integrations/analytics/google-analytics-Put-Measurement-ID-in-mint.json","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"d2e56c7a-4751-4008-8327-1da4e7ca64f2","link":"integrations/analytics/overview","qdrant_point_id":"f1812a5b-758e-49c4-a42d-bc2569f73c71","created_at":"2024-06-25T04:45:25.509901","updated_at":"2024-06-25T04:45:25.592","chunk_html":"Enabling Analytics\nSet your analytics keys in mint.json . You can add an unlimited number of analytics integrations for free. The syntax for mint.json is below. You only need to include entries for the platforms you want to connect.","metadata":{"breadcrumbs":["Analytics","Analytics Integrations"],"title":"Enabling Analytics"},"tracking_id":"integrations/analytics/overview-Enabling-Analytics","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/overview"]},{"id":"a29b53e6-17c7-47d9-af19-4975507a74f2","link":"integrations/analytics/overview","qdrant_point_id":"439591f9-433a-4438-9d19-074f7fcfda8d","created_at":"2024-06-25T04:45:25.482015","updated_at":"2024-06-25T04:45:25.482015","chunk_html":"Analytics Integrations\nAmplitude Mixpanel PostHog Google Analytics 4 (GA4) Google Tag Manager HotJar Koala LogRocket Pirsch Plausible Fathom Clearbit Heap","metadata":{"breadcrumbs":["Analytics","Analytics Integrations"],"title":"Analytics Integrations"},"tracking_id":"integrations/analytics/overview-Analytics-Integrations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/overview"]},{"id":"d3981382-39dd-45ab-81e3-9ae6d1bf0433","link":"integrations/user-auth/shared-session","qdrant_point_id":"90cd1fe9-9abd-4859-84bc-08065f6ba165","created_at":"2024-06-25T04:45:25.944115","updated_at":"2024-06-25T04:45:25.944115","chunk_html":"Shared Session Auth\nSeamlessly share user sessions between your dashboard and your docs","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Shared Session Auth"},"tracking_id":"integrations/user-auth/shared-session-Shared-Session-Auth-Seamlessly-s","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/user-auth/shared-session"]},{"id":"1a91a82a-2673-402a-ae1a-16e5bcf8a972","link":"integrations/rest-api/trigger-update","qdrant_point_id":"ee30d34d-e7e2-437f-829f-fd6e7501d697","created_at":"2024-06-25T04:45:26.883483","updated_at":"2024-06-25T04:45:26.883483","chunk_html":"\n\nREST Endpoint POST /project/update/{projectId}\n\nSummary: Trigger an update \n\nDescription: Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check.\n\nSecurity methods: \nheader: Authorization: bearer auth\n\nRequest params: \npath params:\nprojectId:\n\tstring\n\tDescription: The ID of the project to trigger an update on. Can be retrieved from your dashboard.\n\tExample: \"<string>\"\n\n\nRequest body: N/A\n\n\nResponses: \n200: object\n\tDescription: N/A\n\tExample: {\"statusId\":\"<string>\"}\n\n","metadata":{},"tracking_id":"integrations/rest-api/trigger-update-API-Metadata:-POST-/project/update/{projectId}","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"code","num_value":null,"group_tracking_ids":["integrations/rest-api/trigger-update"]},{"id":"c5764f6e-d032-43bd-aca7-7cc5edc6377b","link":"content/components/sticky-examples","qdrant_point_id":"37fe89b2-361a-46cc-94c1-42f0703a4495","created_at":"2024-06-25T04:45:22.836993","updated_at":"2024-06-25T04:45:22.879646","chunk_html":"Response Example\nThe <ResponseExample> component is the same as <RequestExample> but will show up underneath it.","metadata":{"breadcrumbs":["API Components","Sidebar Code Examples"],"title":"Response Example"},"tracking_id":"content/components/sticky-examples-Response-Example","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/sticky-examples"]},{"id":"deb7c069-d3f8-45ab-8bef-a1c51e4c6757","link":"quickstart","qdrant_point_id":"44d26f57-dbf0-4458-b36b-b03f947e7d1a","created_at":"2024-06-25T04:45:27.624621","updated_at":"2024-06-25T04:45:27.726763","chunk_html":"3. Supercharging Your Docs\nMintlify supports an array of advanced features like API reference docs, analytics, and versioning to accommodate any of your documentation needs. Generating API References You can easily set up your API references using an OpenAPI document. Add your openapi.yaml or openapi.json file into your docs repository or define the openapi field in mint.json with a URL. Use our scraper to autogenerate your OpenAPI endpoints files as: Finally, include the generated endpoint MDX files to your mint.json under navigation. For a complete guide on using Mintlify with OpenAPI, check out this guide . This guide explains how to configure your API authentication methods. For manual API references definition, explore our syntax. Adding a Custom Domain Integrate your docs into your website by hosting them on a custom domain. This is included even in the free Mintlify plan. Navigate to your dashboard settings to add a custom domain. Adding Analytics Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your dashboard . We also support integrations with a range of analytics providers. You can find the list of providers here.","metadata":{"breadcrumbs":["Getting Started","Quickstart"],"title":"3. Supercharging Your Docs"},"tracking_id":"quickstart-3.-Supercharging-Your-Docs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["quickstart"]},{"id":"db419417-47a4-4f00-983c-fcbc8908d391","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"b121a06f-87cc-494d-b3c8-d601114d00d6","created_at":"2024-06-25T04:45:28.083672","updated_at":"2024-06-25T04:45:28.083672","chunk_html":"Connecting it with Route53\nNow, we're going to bring the functionality of the Cloudfront distribution into your primary domain. For this section, you can also refer to AWS's official guide on Configuring\nAmazon Route 53 to route traffic to a CloudFront\ndistribution Navigate to Route53 inside the AWS console, and click into the Hosted zone for your primary domain. Click on Create record Toggle Alias and then Route traffic to the Alias to CloudFront distribution option. Click Create records. You may need to remove the existing A record if one currently exists. And voila! You should be able to have your documentation served at /docs for your primary domain.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Connecting it with Route53"},"tracking_id":"integrations/subpath/route53-cloudfront-Connecting-it-with-Route53","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"165f42de-cb5c-485f-bce4-af07f49109ee","link":"settings/global","qdrant_point_id":"9f2ede24-168d-4347-949d-719c6569d3e7","created_at":"2024-06-25T04:45:29.094246","updated_at":"2024-06-25T04:45:29.222027","chunk_html":"API Configurations\nConfiguration for API settings. Learn more about API pages at API Components. API The base url for all API endpoints. If baseUrl is an array, it will enable for multiple base url\noptions that the user can toggle. Auth The authentication strategy used for all API endpoints. The name of the authentication parameter used in the API playground. If method is basic , the format should be [usernameName]:[passwordName] The default value that's designed to be a prefix for the authentication input field. E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey. Configurations for the API playground Playground Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simple Learn more at the playground guides Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file. This behavior will soon be enabled by default, at which point this field will be deprecated. A string or an array of strings of URL(s) or relative path(s) pointing to your\nOpenAPI file. Examples:","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"API Configurations"},"tracking_id":"settings/global-API-Configurations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"869a9b70-6ed6-4989-a8ec-e82700d59e94","link":"content/components/params","qdrant_point_id":"39f3cd87-8203-4ff9-969c-1c2cfbb1b7b7","created_at":"2024-06-25T04:45:22.154214","updated_at":"2024-06-25T04:45:22.289785","chunk_html":"Parameter Fields\nParamField components help define the parameters for your APIs or SDKs. Adding a ParamField will automatically add an API Playground. An example of a parameter field","metadata":{"breadcrumbs":["API Components","Parameter Fields"],"title":"Parameter Fields"},"tracking_id":"content/components/params-Parameter-Fields","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/params"]},{"id":"2754d197-0e06-45b1-a0b5-a3b91c6db462","link":"settings/seo","qdrant_point_id":"26ab96cf-7a79-4b50-a824-1b7d6d4dec49","created_at":"2024-06-25T04:45:30.149871","updated_at":"2024-06-25T04:45:30.193191","chunk_html":"Changing meta tags on one page\nAdd your meta tags to the page's metadata like so: Meta tags with colons need to be typed with quotes around them when you put them in the page metadata.","metadata":{"breadcrumbs":["Configurations","Search Engine Optimization"],"title":"Changing meta tags on one page"},"tracking_id":"settings/seo-Changing-meta-tags-on-one-page","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/seo"]},{"id":"086e8237-2cfa-4066-95bc-f5ebbf60f58b","link":"content/components/sticky-examples","qdrant_point_id":"6eb3fd8f-611e-48e0-8c7c-eae835f9e9e1","created_at":"2024-06-25T04:45:22.680942","updated_at":"2024-06-25T04:45:22.680943","chunk_html":"Sidebar Code Examples\nDisplay code blocks at the top-right of the page on desktop devices","metadata":{"breadcrumbs":["API Components","Sidebar Code Examples"],"title":"Sidebar Code Examples"},"tracking_id":"content/components/sticky-examples-Sidebar-Code-Examples-Display-co","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/sticky-examples"]},{"id":"e00f1b07-d6eb-4a87-8d92-46442a971009","link":"development","qdrant_point_id":"0a6a1540-3654-4ddb-9c02-0d88ef768b5f","created_at":"2024-06-25T04:45:23.449008","updated_at":"2024-06-25T04:45:23.534684","chunk_html":"Mintlify Versions\nPlease note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Mintlify Versions"},"tracking_id":"development-Mintlify-Versions","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"fdf6cd81-6096-42bd-8a20-6a2fa50a2133","link":"content/components/steps","qdrant_point_id":"8dd412f1-a786-4983-bd67-5ddd2aeeaa46","created_at":"2024-06-25T04:45:22.650005","updated_at":"2024-06-25T04:45:22.650006","chunk_html":"Individual Step Props\nThe content of a step either as plain text, or components. A Font Awesome icon or SVG code in icon={} One of regular , solid , light , thin , sharp-solid , duotone , brands The title is the primary text for the step and shows up next to the indicator. The number of the step. The size of the step titles. One of p , h2 and h3.","metadata":{"breadcrumbs":["Components","Steps"],"title":"Individual Step Props"},"tracking_id":"content/components/steps-Individual-Step-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"7ddfa39c-7b05-403b-bd14-2febeb1bdb0f","link":"api-playground/openapi/setup","qdrant_point_id":"b539e095-782c-44ca-a870-fb35b35ec9c7","created_at":"2024-06-25T04:45:22.224926","updated_at":"2024-06-25T04:45:22.309298","chunk_html":"Manually generate files\nBy using the OpenAPI reference, the name, description, parameters, responses, and the API playground will be automatically generated using the specifications. If you have multiple OpenAPI files, include the name of the OpenAPI file (without the file type .json or .yaml ) to correctly map the information. The method endpoint must match the endpoint specified in the OpenAPI\nspecifications exactly. If the endpoint doesn't exist in the OpenAPI file,\nan empty page will be rendered.","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"Manually generate files"},"tracking_id":"api-playground/openapi/setup-Manually-generate-files","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"a9616be6-19f7-46cf-96f8-90d21c8f251d","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"1a6b34e0-44ca-4ff2-8515-9f345ec39400","created_at":"2024-06-25T04:45:27.819348","updated_at":"2024-06-25T04:45:27.819348","chunk_html":"Route 53 and Cloudfront\nPrerequisite : Your primary domain (company.com) is hosted on Route 53.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Route 53 and Cloudfront"},"tracking_id":"integrations/subpath/route53-cloudfront-Route-53-and-Cloudfront","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"0b413295-bdfe-4da7-9b5a-b7e77a92c718","link":"settings/global","qdrant_point_id":"a2a4d02a-c186-46fc-8334-457604f46102","created_at":"2024-06-25T04:45:28.962530","updated_at":"2024-06-25T04:45:29.071944","chunk_html":"Structure\nAn array of groups with all the pages within that group Navigation The name of the group. The relative paths to the markdown files that will serve as pages. Note: groups are recursive, so to add a sub-folder add another group object in the page array. The Fontawesome icon for the group. Note: this only applies to sub-folders. The type of Fontawesome icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin Array of names and urls of links you want to include in the topbar TopbarLink The name of the button. The url once you click on the button. Example: https://mintlify.com/contact Topbar Call to Action Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. If type is a link: What the button links to. If type is a github: Link to the repository to load GitHub information from. Text inside the button. Only required if type is a link. Array of version names. Only use this if you want to show different versions\nof docs with a dropdown in the navigation bar. An array of the anchors, includes the icon, color, and url. Anchor The Font Awesome icon used to feature the anchor. Example: comments The name of the anchor label. Example: Community The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties from and to that are each a hex color. Used if you want to hide an anchor until the correct docs version is selected. Pass true if you want to hide the anchor until you directly link someone to docs inside it. One of: \"brands\", \"duotone\", \"light\", \"sharp-solid\", \"solid\", or \"thin\" Override the default configurations for the top-most anchor. Note: if you have\ntabs configured, this does not apply. Object The name of the top-most anchor Font Awesome icon. One of: \"brands\", \"duotone\", \"light\", \"sharp-solid\", \"solid\", or \"thin\" An array of navigational tabs. Example: Tabs The name of the tab label. The start of the URL that marks what pages go in the tab. Generally, this\nis the name of the folder you put your pages in. Pass true if you want to hide the tab until you directly link someone to docs inside it. An object of social media accounts where the key:property pair represents the social media platform and the account url. Example: FooterSocials One of the following values website , facebook , x , youtube , discord , slack , github , linkedin , instagram , hacker-news Example: x The URL to the social platform. Example: https://x.com/mintlify Configurations to enable feedback buttons Feedback Enables a rating system for users to indicate whether the page has been helpful Enables a button to allow users to suggest edits via pull requests Enables a button to allow users to raise an issue about the documentation Configurations to change the search prompt Search Set the prompt for the search bar. Default is Search...","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Structure"},"tracking_id":"settings/global-Structure","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"6c8e7a59-f33f-4f51-b471-820fe2e5d5ba","link":"image-embeds","qdrant_point_id":"137b3a04-3d4a-4c50-94e3-0ad9cd55bf49","created_at":"2024-06-25T04:45:23.784234","updated_at":"2024-06-25T04:45:23.835706","chunk_html":"Using Markdown\nThe markdown syntax lets you add images using the following code Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like Cloudinary or S3 . You can then use that URL and embed.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Using Markdown"},"tracking_id":"image-embeds-Using-Markdown","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"dd9886af-8f98-4672-ab8e-d91d55ba21f7","link":"image-embeds","qdrant_point_id":"edf132d0-a140-4ca4-b6d3-0a9aa1d70207","created_at":"2024-06-25T04:45:23.854750","updated_at":"2024-06-25T04:45:23.894664","chunk_html":"Using Embeds\nTo get more customizability with images, you can also use embeds to add images.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Using Embeds"},"tracking_id":"image-embeds-Using-Embeds","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"0ebc6b77-bc54-4248-b48e-58190645732b","link":"integrations/custom/js","qdrant_point_id":"3b42a1b6-1a54-4ee7-8cd1-59638eb13866","created_at":"2024-06-25T04:45:26.284796","updated_at":"2024-06-25T04:45:26.284796","chunk_html":"Custom JS\nAdd JavaScript functionality globally","metadata":{"breadcrumbs":["Custom Scripts","Custom JS"],"title":"Custom JS"},"tracking_id":"integrations/custom/js-Custom-JS-Add-JavaScript-functio","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"e47c69ee-34b0-4673-b293-9a9f703366c1","link":"reusable-snippets","qdrant_point_id":"4df98072-a226-4d2e-ba7e-6c5aa2e71c8e","created_at":"2024-06-25T04:45:28.079834","updated_at":"2024-06-25T04:45:28.169049","chunk_html":"Reusable components\nInside your snippet file, create a component that takes in props by exporting\nyour component in the form of an arrow function. MDX does not compile inside the body of an arrow function. Stick to HTML\nsyntax when you can or use a default export if you need to use MDX. Import the snippet into your destination file and pass in the props","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Reusable components"},"tracking_id":"reusable-snippets-Reusable-components","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"8fafbe28-be43-4e83-81d4-822ed7670ca6","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"a3e0b455-bfad-453a-bc30-35b919db7086","created_at":"2024-06-25T04:45:27.875907","updated_at":"2024-06-25T04:45:27.875908","chunk_html":"Add Default Origin\nAfter creating the distribution, navigate to the Origins tab. We want to find a staging URL that mirrors where the main domain (example.com). This is highly variant depending on how your landing page is hosted. For instance, if your landing page is hosted on Webflow, you can use the\nWebflow's staging URL. It would look like .webflow.io. If you use Vercel, you use the .vercel.app domain available for every project. If you're unsure on how to get a staging URL for your landing page, contact\nsupport and we'd be happy to help Once you have the staging URL, ours for instance is mintlify-landing-page.vercel.app , create a new Origin and add it as the Origin domain. By this point, you should have two Origins - one with [SUBDOMAIN].mintlify.app and another with with staging URL.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Add Default Origin"},"tracking_id":"integrations/subpath/route53-cloudfront-Add-Default-Origin","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"77098c0b-29c3-4833-88a0-7b3bb49bcdf8","link":"settings/authentication","qdrant_point_id":"edab058f-e42d-4e38-93ae-7b332a15236c","created_at":"2024-06-25T04:45:28.374051","updated_at":"2024-06-25T04:45:28.374052","chunk_html":"Single Sign-On (SSO)\nMintlify supports single sign-on to your dashboard via SAML and OIDC. If you use Okta or Google Workspace, we have provider-specific documentation for setting up SSO, but if you use another provider, please contact us! SSO functionality is available on our enterprise plan. Contact\nus to learn more!","metadata":{"breadcrumbs":["Configurations","Single Sign-On (SSO)"],"title":"Single Sign-On (SSO)"},"tracking_id":"settings/authentication-Single-Sign-On-(SSO)","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"28cb09a8-f5d7-4df6-89d2-d6bfc2a019e2","link":"development","qdrant_point_id":"c6e80acd-a07a-420e-813f-04f103c0078b","created_at":"2024-06-25T04:45:23.344787","updated_at":"2024-06-25T04:45:23.427039","chunk_html":"Custom Ports\nBy default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the --port flag. To run Mintlify on port 3333, for instance, use this command: If you attempt to run Mintlify on a port that's already in use, it will use the next available port:","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Custom Ports"},"tracking_id":"development-Custom-Ports","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"1be5387b-ec83-46a3-8ebe-36d119cb6202","link":"content/components/tabs","qdrant_point_id":"89249d6a-cc66-40cd-9f6d-965d150d6750","created_at":"2024-06-25T04:45:23.011185","updated_at":"2024-06-25T04:45:23.011186","chunk_html":"Tab Props\nThe title of the tab. Short titles are easier to navigate.","metadata":{"breadcrumbs":["Components","Tabs"],"title":"Tab Props"},"tracking_id":"content/components/tabs-Tab-Props","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"542b1bb5-c5be-4427-820f-34cd91a7990b","link":"integrations/user-auth/overview","qdrant_point_id":"bfdc00a7-7281-453c-9ae3-3360dba7d3a7","created_at":"2024-06-27T01:19:03.206164","updated_at":"2024-06-27T01:19:03.206164","chunk_html":"Overview\nGive your users a personalized docs experience","metadata":{"breadcrumbs":["User Auth","Overview"],"title":"Overview"},"tracking_id":"integrations/user-auth/overview-Overview-Give-your-users-a-perso","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null},{"id":"e1abd475-01e1-4d0a-ba5d-1295469a6e36","link":"api-playground/mdx/authentication","qdrant_point_id":"ea5ee072-1b24-4192-8272-c9826e0195d4","created_at":"2024-06-25T04:45:21.185862","updated_at":"2024-06-25T04:45:21.273970","chunk_html":"Enabling Authentication\nYou can add an authentication method to your mint.json to enable it on every page or you can set it on a per-page basis. The page's authentication method will override mint.json if both are set.","metadata":{"breadcrumbs":["API References","Using MDX","Authentication"],"title":"Enabling Authentication"},"tracking_id":"api-playground/mdx/authentication-Enabling-Authentication","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null},{"id":"2d86f99e-af48-4dee-b692-d45ae1dd461f","link":"integrations/analytics/google-analytics","qdrant_point_id":"c6f2ceb7-7468-4627-8b00-808ab4d4d070","created_at":"2024-06-25T04:45:24.862705","updated_at":"2024-06-25T04:45:24.862705","chunk_html":"Create a Web Stream\nYou will need to create a web stream to get the Measurement ID to put into Mintlify. Click the cog at the bottom left of the Google Analytics screen. Then click on Data Streams. Create a Web Stream and put the URL of your Mintlify docs site as the stream URL. Your Measurement ID looks like G-XXXXXXX and will show up under Stream Details immediately after you create the Web Stream.","metadata":{"breadcrumbs":["Analytics","Google Analytics 4"],"title":"Create a Web Stream"},"tracking_id":"integrations/analytics/google-analytics-Create-a-Web-Stream","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/google-analytics"]},{"id":"75295be1-8fd9-45a2-a78f-4c41deae8a59","link":"integrations/analytics/plausible","qdrant_point_id":"acc62fdd-373b-4f9b-88a2-75931648c0c3","created_at":"2024-06-25T04:45:25.757972","updated_at":"2024-06-25T04:45:25.851405","chunk_html":"Plausible\nAdd your site's domain to mint.json to send analytics to Plausible. Do not include http:// or https:// with your domain.","metadata":{"breadcrumbs":["Analytics","Plausible"],"title":"Plausible"},"tracking_id":"integrations/analytics/plausible-Plausible","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/plausible"]},{"id":"fd12a416-f3bf-4854-89ae-d434d8930c3b","link":"api-playground/openapi/setup","qdrant_point_id":"0ca88481-62fa-4bca-821e-16ded5c058cf","created_at":"2024-06-25T04:45:21.939961","updated_at":"2024-06-25T04:45:21.983642","chunk_html":"In the repo\nThe most common method of setting up OpenAPI with Mintlify is to add your OpenAPI documents directly to your docs repo. You'll then add the paths to each OpenAPI document to the openapi field in your mint.json: That's it! Any endpoints in this OpenAPI document can now be referenced in your MDX files.","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"In the repo"},"tracking_id":"api-playground/openapi/setup-In-the-repo","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/setup"]},{"id":"c98bddf8-431f-4dfe-ae4b-2ab6e4e069b2","link":"quickstart","qdrant_point_id":"a4089f46-709b-4210-b65b-5e0a96365052","created_at":"2024-06-25T04:45:27.460833","updated_at":"2024-06-25T04:45:27.598229","chunk_html":"2. Updating Your Docs\nMintlify enables you to easily customize the style, structure, and content of your docs. We provide a white-glove migration service as part of our startup plan.\nInterested? Request it here Setting up Your Editing Environment Edit Locally (Recommended for Developers): Install git. Once git is installed, clone your docs repository using git clone <your-repo> . If you haven't set it up yet, now would be a good time to do so with these SSH keys. Use your favorite IDE to open the repository. Install our Mintlify CLI to preview changes with npm i -g mintlify . Learn more about this in our development guide. Editing Online: Here are two ways to edit your repository online: To edit a single file, locate and click the edit button. This will open a web editor right on Github.\nFor a more versatile online experience, open your git repository in Github's github.dev online IDE. Simply replace github.com in your repo URL with github.dev . For example, use github.dev/mintlify/docs instead of github.com/mintlify/docs. Customizing Your Brand (mint.json) Easily customize colors, logos and buttons among other configurations in our mint.json file. Start with these basic configurations: A full list of supported configurations can be found here. Adding Content Add content with simple MDX files. Initiate your pages with this template: Learn more about adding images, tables, lists, and more using the MDX syntax . We also offer a wide array of components which are listed here. Pushing Your Changes Once ready, commit and push your changes to update your docs site. Here is a guide on how to do that. If the Github app is unable to successfully deploy your changes, you can manually update your docs through our dashboard.","metadata":{"breadcrumbs":["Getting Started","Quickstart"],"title":"2. Updating Your Docs"},"tracking_id":"quickstart-2.-Updating-Your-Docs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["quickstart"]},{"id":"38717e9f-91d8-4b80-b272-a97dd06113f2","link":"integrations/analytics/google-analytics","qdrant_point_id":"9a301d09-d230-4d78-8d01-adff18e3df5e","created_at":"2024-06-25T04:45:25.003398","updated_at":"2024-06-25T04:45:25.003398","chunk_html":"Google Analytics 4\nGoogle Analytics 4\nYou will need to generate a new GA4 property to use with Mintlify. The data collected will go into the same project as your other Google Analytics data. If you are using the old version of Google Analytics, Universal Analytics, you will still be able to generate a GA4 property. GA4 data is slightly different from UA data but still gets collected in the same project.","metadata":{"breadcrumbs":["Analytics","Google Analytics 4"],"title":"Google Analytics 4"},"tracking_id":"integrations/analytics/google-analytics-Google-Analytics-4-Google-Analyt","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/analytics/google-analytics"]},{"id":"881c2a1f-6cf6-44ec-b39b-1094c69b6cd1","link":"settings/navigation","qdrant_point_id":"ecc5ffa7-01d6-4304-a69d-94193d315f8f","created_at":"2024-06-25T04:45:29.728605","updated_at":"2024-06-25T04:45:29.770975","chunk_html":"Sidebar\nOrganize your navigation by defining the navigation property in your\nmint.json, You don't need to include .mdx in page names. Once you add a page to your docs directory, you'll need to add the path to\nmint.json to add it to the sidebar. Pages do not show up automatically.","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Sidebar"},"tracking_id":"settings/navigation-Sidebar","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"3ed87fb2-8b42-411f-8799-9a751077ff3a","link":"api-playground/openapi/advanced-features","qdrant_point_id":"6a0e3efe-be7f-413a-8366-65027b5a7619","created_at":"2024-06-25T04:45:21.680661","updated_at":"2024-06-25T04:45:21.680661","chunk_html":"Advanced Features\nSupport for advanced OpenAPI features","metadata":{"breadcrumbs":["API References","Using OpenAPI","Advanced Features"],"title":"Advanced Features"},"tracking_id":"api-playground/openapi/advanced-features-Advanced-Features-Support-for-ad","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["api-playground/openapi/advanced-features"]},{"id":"36ae1a8c-3e11-4f2f-9694-fdff667b39a5","link":"integrations/sdks/speakeasy","qdrant_point_id":"e8b1c501-783e-4ce4-b58c-f8348668d050","created_at":"2024-06-25T04:45:26.984235","updated_at":"2024-06-25T04:45:26.984235","chunk_html":"Speakeasy\nAutomate your SDK usage snippets in the API playground","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Speakeasy"},"tracking_id":"integrations/sdks/speakeasy-Speakeasy-Automate-your-SDK-usag","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/sdks/speakeasy"]},{"id":"6c007d64-9d6c-442f-ac76-4aab14ee645e","link":"page","qdrant_point_id":"42f0ac93-58dc-4214-9c69-1964f40a07ba","created_at":"2024-06-25T04:45:26.558567","updated_at":"2024-06-25T04:45:26.687607","chunk_html":"The Basics\nEach page is an MDX file that should begin with the following metadata syntax\nwith --- at the start and end: Mintlify will use the name of the file if you forget to include a title. Other metadata goes in between the same --- lines. For example, this page uses\nthis metadata:","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"The Basics"},"tracking_id":"page-The-Basics","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"212fb4c6-e4cb-47cf-8e01-7aca46b46f1a","link":"integrations/sdks/speakeasy","qdrant_point_id":"c354e84a-9724-48fd-8056-99612d9bf8c5","created_at":"2024-06-25T04:45:27.237309","updated_at":"2024-06-25T04:45:27.333126","chunk_html":"Manual Set Up\nAlternatively, you can manually set up the following files in your Mintlify docs repo. Finally, make sure you add your SPEAKEASY_API_KEY as a repository secret to your Minlify repo under Settings > Secrets & Variables > Actions . Find the Speakeasy API key in the Speakeasy dashboard under the API Keys tab.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Manual Set Up"},"tracking_id":"integrations/sdks/speakeasy-Manual-Set-Up","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/sdks/speakeasy"]},{"id":"482a0fc8-dc01-4c96-8021-4fa6a28aa716","link":"quickstart","qdrant_point_id":"15fc3f98-0a1d-45e8-8b7a-bdd861ebd064","created_at":"2024-06-25T04:45:27.424623","updated_at":"2024-06-25T04:45:27.424623","chunk_html":"1. Deploying Your Docs Repository\nMintlify docs are rendered from MDX files and configurations defined in our starter template . We use Github to integrate your docs with your code, and make source control effortless. Creating Your Documentation Repository If you've created a docs repo in our onboarding, this step is complete. You can find your docs repository on your Mintlify dashboard. To create your docs repo without logging into Github, follow these instructions: Clone our starter template into a new public repo. You can make the repo private later. Get in touch with our team to deploy your repo. Installing Our Github App The next step is to install our Github app. This ensures that your updates are automatically deployed when you push changes. You can find the installation link in the dashboard , on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.","metadata":{"breadcrumbs":["Getting Started","Quickstart"],"title":"1. Deploying Your Docs Repository"},"tracking_id":"quickstart-1.-Deploying-Your-Docs-Repository","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["quickstart"]},{"id":"34a54dd5-16e6-4a04-8dba-54426039115f","link":"content/components/cards","qdrant_point_id":"03b792f1-b5b2-43f5-b129-2202a84de452","created_at":"2024-06-25T04:45:23.746541","updated_at":"2024-06-25T04:45:23.746541","chunk_html":"Cards\nHighlight main points or links with customizable icons","metadata":{"breadcrumbs":["Components","Cards"],"title":"Cards"},"tracking_id":"content/components/cards-Cards-Highlight-main-points-or-l","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/cards"]},{"id":"f73ba04a-82d5-452b-80c5-0f26d6ec740a","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"46076e5d-198f-4da7-a04d-d3d9e27c1688","created_at":"2024-06-25T04:45:27.904620","updated_at":"2024-06-25T04:45:27.904620","chunk_html":"Set Behaviors\nBehaviors in Cloudfront enables control over the subpath logic. At a high level, we're looking to create the following logic. If a user lands on /docs , go to [SUBDOMAIN].mintlify.dev If a user lands on any other page , go the current landing page We're going to create three behaviors by clicking on the Create behavior button.","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Set Behaviors"},"tracking_id":"integrations/subpath/route53-cloudfront-Set-Behaviors","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"3a1decb5-280a-4f51-b661-82406909d674","link":"settings/global","qdrant_point_id":"20c07021-96cd-44f3-9be2-cabee4156ab9","created_at":"2024-06-25T04:45:28.818679","updated_at":"2024-06-25T04:45:28.818680","chunk_html":"Global Settings\nEvery Mintlify site needs a mint.json file with the core configuration\nsettings. Learn more about the properties or from an\nexample","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Global Settings"},"tracking_id":"settings/global-Global-Settings","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"4bae2786-8cb5-464c-9e20-a378dc18026f","link":"settings/global","qdrant_point_id":"b7458058-b2a2-4a4f-a09e-92dda5e79240","created_at":"2024-06-25T04:45:29.345053","updated_at":"2024-06-25T04:45:29.386606","chunk_html":"Search Engine Optimization\nSettings for Search Engine Optimization. Example: Redirect Enables indexing pages not included in navigation.","metadata":{"breadcrumbs":["Getting Started","Global Settings"],"title":"Search Engine Optimization"},"tracking_id":"settings/global-Search-Engine-Optimization","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/global"]},{"id":"cac7ac05-2098-4c49-9a6b-2d5a7abff101","link":"content/components/sticky-examples","qdrant_point_id":"618051bd-1497-475d-9ea8-7f20d500a65c","created_at":"2024-06-25T04:45:22.758626","updated_at":"2024-06-25T04:45:22.805099","chunk_html":"Request Example\nThe <RequestExample> component works similar to CodeGroup , but displays the request content on the right sidebar. Thus, you can put multiple code blocks inside <RequestExample>. Please set a name on every code block you put inside RequestExample.","metadata":{"breadcrumbs":["API Components","Sidebar Code Examples"],"title":"Request Example"},"tracking_id":"content/components/sticky-examples-Request-Example","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/sticky-examples"]},{"id":"bc831dc9-6b4c-426d-ae33-8e350c203a61","link":"api-playground/openapi/setup","qdrant_point_id":"09bf48db-96be-452d-9df4-97fefae6fb31","created_at":"2024-06-25T04:45:21.894195","updated_at":"2024-06-25T04:45:21.894195","chunk_html":"Add an OpenAPI specification file\nTo describe your endpoints with OpenAPI, make sure you have a valid OpenAPI document in either JSON or YAML format that follows the OpenAPI specification . Your document must follow OpenAPI specification 3.0+. There are two ways to configure your docs to use your OpenAPI file:","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"Add an OpenAPI specification file"},"tracking_id":"api-playground/openapi/setup-Add-an-OpenAPI-specification-file","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/setup"]},{"id":"1cf5054c-d9f5-4b3c-a005-73c7a6292621","link":"list-table","qdrant_point_id":"5088c8b3-d73a-41e3-a1af-89dbab930a98","created_at":"2024-06-25T04:45:26.455015","updated_at":"2024-06-25T04:45:26.498116","chunk_html":"Creating a table\nThe Table component follows the official markdown syntax. To add a table, use three or more hyphens ( --- ) to create each column's header, and use pipes (| ) to separate each column. For compatibility, you should also add a pipe on either end of the row.","metadata":{"breadcrumbs":["Writing Content","Lists and Tables"],"title":"Creating a table"},"tracking_id":"list-table-Creating-a-table","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["list-table"]},{"id":"4135b149-b119-4c38-b62e-a52b4b742b9a","link":"integrations/analytics/posthog","qdrant_point_id":"34f81b42-71b0-48fd-afd5-ec466b9722a2","created_at":"2024-06-25T04:45:26.007582","updated_at":"2024-06-25T04:45:26.007582","chunk_html":"Session Recordings\nYou need to add the URL for your docs website to Posthog's \"Authorized domains for recordings\" before you can receive session recordings. The option to add your URL is in Posthog's project settings.","metadata":{"breadcrumbs":["Analytics","PostHog"],"title":"Session Recordings"},"tracking_id":"integrations/analytics/posthog-Session-Recordings","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/posthog"]},{"id":"db846043-2f72-4394-b3cc-22e943e47999","link":"integrations/user-auth/shared-session","qdrant_point_id":"3de3575c-052d-4d85-b8f2-bb4b822501c9","created_at":"2024-06-25T04:45:26.144853","updated_at":"2024-06-25T04:45:26.144853","chunk_html":"Dashboard at root, docs at root\nI have a dashboard at foo.com/dashboard , which uses cookie-based session authentication. My dashboard API routes are hosted at foo.com/api . I want to set up authentication for my docs hosted at foo.com/docs. To set up authentication with Mintlify, I create another dashboard endpoint foo.com/api/docs/user-info which identifies the user using session auth, and responds with their custom data according to Mintlify’s specification. I then go to the Mintlify dashboard settings and enter https://foo.com/api/docs/user-info for the API URL field.","metadata":{"breadcrumbs":["User Auth","Authenticating","Shared Session Auth"],"title":"Dashboard at root, docs at root"},"tracking_id":"integrations/user-auth/shared-session-Dashboard-at-root,-docs-at-root","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/shared-session"]},{"id":"de13b775-55eb-45f4-b46e-6eebcf9d1ace","link":"content/components/code","qdrant_point_id":"91c0a463-9581-41d2-9316-ad61841609bf","created_at":"2024-06-25T04:45:24.176734","updated_at":"2024-06-25T04:45:24.176734","chunk_html":"Code Blocks\nDisplay code with optional syntax highlighting","metadata":{"breadcrumbs":["Components","Code Blocks"],"title":"Code Blocks"},"tracking_id":"content/components/code-Code-Blocks-Display-code-with-op","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/code"]},{"id":"2113fed0-e89b-4829-99ff-59c277bc8470","link":"list-table","qdrant_point_id":"686301f2-ac8f-49c1-a3b0-520a8d7e9caa","created_at":"2024-06-25T04:45:26.348516","updated_at":"2024-06-25T04:45:26.397656","chunk_html":"Nested List\nAdd indents on list items to nest them First item Second item Additional item Additional item Third item Lists follow the official markdown syntax.","metadata":{"breadcrumbs":["Writing Content","Lists and Tables"],"title":"Nested List"},"tracking_id":"list-table-Nested-List","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["list-table"]},{"id":"be71d58e-3c81-4a2e-b49e-f1be68e78dc6","link":"content/components/code","qdrant_point_id":"79cdfb66-e574-43f8-8803-ead7490a261c","created_at":"2024-06-25T04:45:24.552495","updated_at":"2024-06-25T04:45:24.552495","chunk_html":"Code Groups\nWant to display multiple code examples in one code box? Check out the Code Group docs: Code Group Read the reference for the Code Group component","metadata":{"breadcrumbs":["Components","Code Blocks"],"title":"Code Groups"},"tracking_id":"content/components/code-Code-Groups","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/code"]},{"id":"0929ee69-f655-48f8-a346-9045cb71def6","link":"content/components/code","qdrant_point_id":"c7484d86-6c6d-4c14-b2c5-7b628dc84d05","created_at":"2024-06-25T04:45:24.205873","updated_at":"2024-06-25T04:45:24.205873","chunk_html":"Code Blocks\n```javascript Code Block Example\nconst hello = \"world\";\n```","metadata":{"breadcrumbs":["Components","Code Blocks"],"title":"Code Blocks"},"tracking_id":"content/components/code-Code-Blocks","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"code","num_value":null,"group_tracking_ids":["content/components/code"]},{"id":"550efff2-666e-42e8-85ed-d41b6c341dea","link":"image-embeds","qdrant_point_id":"1892af2f-9d92-489d-8dea-723c9b06abc1","created_at":"2024-06-25T04:45:23.753952","updated_at":"2024-06-25T04:45:23.753952","chunk_html":"Images, Videos, and Embeds\nMintlify supports files up to 5 MB. To use larger files, consider a storage\nservice like Cloudinary and embed in your Mintlify documentation.","metadata":{"breadcrumbs":["Writing Content","Images, Videos, and Embeds"],"title":"Images, Videos, and Embeds"},"tracking_id":"image-embeds-Images,-Videos,-and-Embeds","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["image-embeds"]},{"id":"177a1364-1d09-4960-946e-9fef677df9a7","link":"quickstart","qdrant_point_id":"43092c30-21ad-446e-9367-8ce0c1074e17","created_at":"2024-06-25T04:45:27.351705","updated_at":"2024-06-25T04:45:27.351706","chunk_html":"Quickstart\nStart building awesome documentation in under 5 minutes","metadata":{"breadcrumbs":["Getting Started","Quickstart"],"title":"Quickstart"},"tracking_id":"quickstart-Quickstart-Start-building-awesom","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["quickstart"]},{"id":"5980fea8-c950-42a8-98c1-df9f3f1776c2","link":"integrations/analytics/google-analytics","qdrant_point_id":"370b99f9-35a7-410f-98b6-525128fc9b66","created_at":"2024-06-25T04:45:24.832899","updated_at":"2024-06-25T04:45:24.832900","chunk_html":"Google Analytics 4\nYou will need to generate a new GA4 property to use with Mintlify. The data collected will go into the same project as your other Google Analytics data. If you are using the old version of Google Analytics, Universal Analytics, you will still be able to generate a GA4 property. GA4 data is slightly different from UA data but still gets collected in the same project.","metadata":{"breadcrumbs":["Analytics","Google Analytics 4"],"title":"Google Analytics 4"},"tracking_id":"integrations/analytics/google-analytics-Google-Analytics-4","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/google-analytics"]},{"id":"817cbe5d-4620-4c71-bbd0-113df5ecdc50","link":"settings/versioning","qdrant_point_id":"cc2d214c-8ff9-41d2-beea-76ce74ec0bc8","created_at":"2024-06-25T04:45:30.355170","updated_at":"2024-06-25T04:45:30.355171","chunk_html":"Versioning Options\nYou can add version values to anchors, groups, or individual pages.","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Versioning Options"},"tracking_id":"settings/versioning-Versioning-Options","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"4dea40d9-b28b-4296-b217-22f59c61997c","link":"code","qdrant_point_id":"bd88b53f-55c0-4755-b5ec-07f2446fa56a","created_at":"2024-06-25T04:45:22.843834","updated_at":"2024-06-25T04:45:22.928670","chunk_html":"Code Block\nUse fenced code blocks by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. Visit the Code Block page for more detailed docs.","metadata":{"breadcrumbs":["Writing Content","Code Blocks"],"title":"Code Block"},"tracking_id":"code-Code-Block","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["code"]},{"id":"446158c8-3ed2-4858-9d27-cdf717019ee5","link":"content/components/expandables","qdrant_point_id":"2b2df428-0f28-45e9-a17a-0ed4435764ed","created_at":"2024-06-25T04:45:24.580689","updated_at":"2024-06-25T04:45:24.580689","chunk_html":"Expandables\nToggle to display nested properties.","metadata":{"breadcrumbs":["API Components","Expandables"],"title":"Expandables"},"tracking_id":"content/components/expandables-Expandables-Toggle-to-display-ne","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/expandables"]},{"id":"5d1dffaa-1ed8-41ea-bb79-6b8d00c9d489","link":"development","qdrant_point_id":"d2f2d62c-7489-41be-8438-639e1be97b6e","created_at":"2024-06-25T04:45:23.684377","updated_at":"2024-06-25T04:45:23.684378","chunk_html":"Troubleshooting\nError: Could not load the \"sharp\" module using the darwin-arm64 runtime This may be due to an outdated version of node. Try the following: Remove the currently-installed version of mintlify: npm remove -g mintlify Upgrade to Node v19 or higher. Reinstall mintlify: npm install -g mintlify Issue: Encountering an unknown error Solution: Go to the root of your device and delete the ~/.mintlify folder. Afterwards, run mintlify dev again.","metadata":{"breadcrumbs":["Getting Started","Development"],"title":"Troubleshooting"},"tracking_id":"development-Troubleshooting","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["development"]},{"id":"af81237e-cf87-4951-afc8-92fed126209d","link":"api-playground/overview","qdrant_point_id":"beec4021-fc1c-4c14-96a5-d140e8c64dfb","created_at":"2024-06-25T04:45:22.657447","updated_at":"2024-06-25T04:45:22.657447","chunk_html":"Interactive Playground\nThe API playground is an interactive environment to make requests and preview an API endpoint. Autogenerating API pages with OpenAPI will automatically generate API\nplayground. Read more about using OpenAPI with Mintlify\nhere.","metadata":{"breadcrumbs":["API References","Interactive Playground"],"title":"Interactive Playground"},"tracking_id":"api-playground/overview-Interactive-Playground","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/overview"]},{"id":"deaed887-a21e-490e-9ca0-ea6668ad1717","link":"integrations/privacy/overview","qdrant_point_id":"de201dd5-d8ac-4255-b271-cb9935282549","created_at":"2024-06-25T04:45:26.593983","updated_at":"2024-06-25T04:45:26.593984","chunk_html":"Data Privacy Integrations\nIntegrate with a data privacy platform","metadata":{"breadcrumbs":["Privacy","Data Privacy Integrations"],"title":"Data Privacy Integrations"},"tracking_id":"integrations/privacy/overview-Data-Privacy-Integrations-Integr","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/privacy/overview"]},{"id":"aad1f152-2abc-47c5-b794-8ea948d0cbe6","link":"integrations/rest-api/overview","qdrant_point_id":"90296468-d95e-4bde-a86b-88539bf7b8ce","created_at":"2024-06-25T04:45:26.811154","updated_at":"2024-06-25T04:45:26.811154","chunk_html":"Overview\nOverview\nThe Mintlify REST API is only available on the startup plan and above. Leverage the external API to programmatically trigger an update when desired.\nThe primary use-case will be to trigger updates. We will be adding more and more\nfunctionality to the API overtime. Let us know what else you want to see in\nour community!","metadata":{"breadcrumbs":["Mintlify REST API","Overview"],"title":"Overview"},"tracking_id":"integrations/rest-api/overview-Overview-Overview-The-Mintlify-R","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/rest-api/overview"]},{"id":"83d457c5-5028-4095-b048-fc836fba9519","link":"integrations/sdks/speakeasy","qdrant_point_id":"93a2725b-cb0e-412e-830b-dcbd3adafdeb","created_at":"2024-06-25T04:45:27.056249","updated_at":"2024-06-25T04:45:27.104756","chunk_html":"Speakeasy SDK Repository Changes\nIn your Speakeasy SDK repos, add the following to the targets section of your .speakeasy/workflow.yaml file to ensure code samples are automatically produced alongside SDK generations. Code samples will be generated in the form of an OpenAPI overlay file that will be used in the Mintlify docs repository.","metadata":{"breadcrumbs":["SDKs","Speakeasy"],"title":"Speakeasy SDK Repository Changes"},"tracking_id":"integrations/sdks/speakeasy-Speakeasy-SDK-Repository-Changes","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/sdks/speakeasy"]},{"id":"8ff1dd60-9b7b-4756-93d7-1652cdf849be","link":"settings/github","qdrant_point_id":"69bee634-a80f-4261-b9e5-38f2d7e7d6ae","created_at":"2024-06-25T04:45:28.686545","updated_at":"2024-06-25T04:45:28.686545","chunk_html":"Repositories Installations\nWhen installing our GitHub app, you will be prompted to select all repositories\nor a subset of them. This selection can be changed at any time by going to the\nGitHub app settings.","metadata":{"breadcrumbs":["Configurations","GitHub"],"title":"Repositories Installations"},"tracking_id":"settings/github-Repositories-Installations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/github"]},{"id":"ab31f20e-944e-463b-9179-c257b4ecb037","link":"integrations/sdks/stainless","qdrant_point_id":"48fafad3-134f-4e10-99ff-add6580d68ba","created_at":"2024-06-25T04:45:27.386474","updated_at":"2024-06-25T04:45:27.493328","chunk_html":"Stainless\nIf you use Mintlify's OpenAPI support for your API reference documentation, add the following to your Stainless config: Configure the OpenAPI setup in your Mintlify docs. To integrate Stainless, modify the GitHub Action that uploads your OpenAPI spec to Stainless so that it pushes the Stainless-enhanced OpenAPI spec into your docs repo like so: This assumes the following secrets have been uploaded to your Github Actions Secrets: secrets.STAINLESS_API_KEY : Your Stainless API key. secrets.API_TOKEN_GITHUB : A Github Personal Access Token with permissions to push to your docs repo.","metadata":{"breadcrumbs":["SDKs","Stainless"],"title":"Stainless"},"tracking_id":"integrations/sdks/stainless-Stainless","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/sdks/stainless"]},{"id":"df1ea09d-cba7-4ef1-89db-55d98fed2f68","link":"integrations/subpath/cloudflare","qdrant_point_id":"d65e4a59-ed09-4b9a-9d84-c45bf6fbec28","created_at":"2024-06-25T04:45:27.552752","updated_at":"2024-06-25T04:45:27.552752","chunk_html":"Cloudflare\nPrerequisite : Your primary domain (company.com) is hosted on Cloudflare\nand you are on the Mintlify startup plan or\nabove.","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Cloudflare"},"tracking_id":"integrations/subpath/cloudflare-Cloudflare","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/cloudflare"]},{"id":"812c12a3-d9a9-4a34-aefb-3d313d8e927c","link":"integrations/subpath/cloudflare","qdrant_point_id":"e78fafb8-bbb1-4913-bcfa-3d9c1a05bd07","created_at":"2024-06-25T04:45:27.627391","updated_at":"2024-06-25T04:45:27.627391","chunk_html":"Add custom domain\nOnce the worker is created, click Configure worker . Navigate to the worker\nSettings > Triggers . Click on Add Custom Domain to add your desired domain\ninto the list - we reccommend you add both the version with and without www. prepended to the domain. If you have trouble setting up a custom subdirectory,\ncontact our support team and we'll walk you through\nupgrading your hosting with us.","metadata":{"breadcrumbs":["Custom Subpaths","Cloudflare"],"title":"Add custom domain"},"tracking_id":"integrations/subpath/cloudflare-Add-custom-domain","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/subpath/cloudflare"]},{"id":"0b35e75c-54c0-4d38-8d6a-17c4ace24c59","link":"settings/navigation","qdrant_point_id":"ffc83c60-cf50-419f-856a-c2156e46f5a6","created_at":"2024-06-25T04:45:29.478002","updated_at":"2024-06-25T04:45:29.478003","chunk_html":"Navigation\nOrganize your docs directory to guide your users to the information they need ","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Navigation"},"tracking_id":"settings/navigation-Navigation-Organize-your-docs-di","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"f3e91b47-e1b2-4d08-a71e-341af18b3660","link":"reusable-snippets","qdrant_point_id":"4c77a233-850d-46e1-a072-a865a89ed95b","created_at":"2024-06-25T04:45:27.865980","updated_at":"2024-06-25T04:45:27.949098","chunk_html":"Default export\nAdd content to your snippet file that you want to re-use across multiple\nlocations. Optionally, you can add variables that can be filled in via props\nwhen you import the snippet. The content that you want to reuse must be inside the snippets directory in\norder for the import to work. Import the snippet into your destination file.","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Default export"},"tracking_id":"reusable-snippets-Default-export","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["reusable-snippets"]},{"id":"677a1c62-3be6-4602-9aec-d77f62ec6690","link":"api-playground/openapi/writing-openapi","qdrant_point_id":"83609f49-9a53-481d-87d0-be5c7b3c4f8b","created_at":"2024-06-25T04:45:22.567958","updated_at":"2024-06-25T04:45:22.567959","chunk_html":"Specifying authentication\nNearly all APIs require some method of authentication. OpenAPI provides the securitySchemes field for defining the methods of authentication used throughout your API, with simple configuration for the most common authentication types - Basic , Bearer , and API Keys . To apply these authentication methods to your endpoints, OpenAPI uses the security field. The syntax for defining and applying authentication is a bit unintuitive, so definitely check out Swagger's documentation and examples on the topic. The API descriptions and API Playground will add authentication fields based on the security configurations in your OpenAPI document. If different endpoints within your API require different methods of authentication, you can override the security field for a given operation.","metadata":{"breadcrumbs":["API References","Using OpenAPI","Writing OpenAPI"],"title":"Specifying authentication"},"tracking_id":"api-playground/openapi/writing-openapi-Specifying-authentication","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/writing-openapi"]},{"id":"547cf13d-9ac8-434f-b9a2-939eb458f280","link":"integrations/user-auth/jwt","qdrant_point_id":"aa9d8e52-f8fd-491e-bd60-9f9d834dc4f8","created_at":"2024-06-25T04:45:25.485538","updated_at":"2024-06-25T04:45:25.485538","chunk_html":"JWT Auth\nIf you don’t have a dashboard, or if you want to keep your dashboard and docs completely separate, you can use your own login flow to send user info to your docs via a JWT in the URL.","metadata":{"breadcrumbs":["User Auth","Authenticating","JWT Auth"],"title":"JWT Auth"},"tracking_id":"integrations/user-auth/jwt-JWT-Auth","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/jwt"]},{"id":"ef1fd67f-c46f-4180-8438-6aaf7dd7cc6f","link":"integrations/custom/css","qdrant_point_id":"3e9ec552-d53f-4828-af27-61e258e759ee","created_at":"2024-06-25T04:45:26.145323","updated_at":"2024-06-25T04:45:26.145323","chunk_html":"Custom CSS\nCustom CSS is available on the growth plan. Add any number of CSS files to your repository and the defined class names will be applied and available across all of your MDX files.","metadata":{"breadcrumbs":["Custom Scripts","Custom CSS"],"title":"Custom CSS"},"tracking_id":"integrations/custom/css-Custom-CSS","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/custom/css"]},{"id":"7b800cdf-c432-4213-9a76-c036e179e5a6","link":"text","qdrant_point_id":"cd6fcf25-5836-42a5-87e3-6d2755e643e4","created_at":"2024-06-25T04:45:31.075834","updated_at":"2024-06-25T04:45:31.132790","chunk_html":"LaTeX\nMintlify supports in-line LaTeX by surrounding your LaTeX code with dollar signs ($). For example, $(a^2 + b^2 = c^2)$ will render as (a^2 + b^2 = c^2). Equations on their own line can be created with double dollar signs ($$): \\exists \\, x \\notin [0,1]","metadata":{"breadcrumbs":["Writing Content","Headers and Text"],"title":"LaTeX"},"tracking_id":"text-LaTeX","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["text"]},{"id":"ff942787-95fb-47d4-8c2f-442fd2260ac5","link":"integrations/custom/css","qdrant_point_id":"12737232-b0ff-42e5-9569-e2a6d7b1a46a","created_at":"2024-06-25T04:45:26.097844","updated_at":"2024-06-25T04:45:26.097845","chunk_html":"Custom CSS\nFully customize your documentation with custom CSS","metadata":{"breadcrumbs":["Custom Scripts","Custom CSS"],"title":"Custom CSS"},"tracking_id":"integrations/custom/css-Custom-CSS-Fully-customize-your-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/custom/css"]},{"id":"64002598-6303-4811-8e23-69f635cbfc41","link":"integrations/support/overview","qdrant_point_id":"2ef5e705-b719-4981-b29a-f4ca6f6280cc","created_at":"2024-06-25T04:45:25.236407","updated_at":"2024-06-25T04:45:25.279184","chunk_html":"Enabling Support Integrations\nYou can integrate widgets onto your docs for customer support. Add the integrations field into your mint.json file with your respective app ID. If you'd like to request a customer support integration, please let us know in our community.","metadata":{"breadcrumbs":["Support","Support Integrations"],"title":"Enabling Support Integrations"},"tracking_id":"integrations/support/overview-Enabling-Support-Integrations","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/support/overview"]},{"id":"0a46263a-66c8-4fd7-9d3f-eccc3536a916","link":"content/components/sticky-examples","qdrant_point_id":"056bee99-0f2f-4756-b181-8152b5b38732","created_at":"2024-06-25T04:45:22.725499","updated_at":"2024-06-25T04:45:22.725499","chunk_html":"Sidebar Code Examples\nThe <RequestExample> and <ResponseExample> stick code blocks to the top-right of a page even as you scroll. The components work on all pages even if you don't use an API playground. <RequestExample> and <ResponseExample> show up like regular code blocks on mobile.","metadata":{"breadcrumbs":["API Components","Sidebar Code Examples"],"title":"Sidebar Code Examples"},"tracking_id":"content/components/sticky-examples-Sidebar-Code-Examples","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/sticky-examples"]},{"id":"2934a072-8095-4fb6-9de1-d8e891d34909","link":"api-playground/mdx/authentication","qdrant_point_id":"cd61872d-bc3a-4d4a-9998-f31d040edb7d","created_at":"2024-06-25T04:45:21.097292","updated_at":"2024-06-25T04:45:21.097293","chunk_html":"Authentication\nYou can set authentication parameters to let users use their real API keys.","metadata":{"breadcrumbs":["API References","Using MDX","Authentication"],"title":"Authentication"},"tracking_id":"api-playground/mdx/authentication-Authentication-You-can-set-authe","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["api-playground/mdx/authentication"]},{"id":"936194fc-83c3-485a-847c-4805d9b59003","link":"content/components/icons","qdrant_point_id":"5d59f035-cf8b-4336-8442-a9523466be8d","created_at":"2024-06-25T04:45:21.756335","updated_at":"2024-06-25T04:45:21.756335","chunk_html":"Icons\n<Icon icon=\"check\" size={32} />","metadata":{"breadcrumbs":["Components","Icons"],"title":"Icons"},"tracking_id":"content/components/icons-Icons","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"code","num_value":null,"group_tracking_ids":["content/components/icons"]},{"id":"4d8f9974-d0a1-41e1-9632-2e9901aa1944","link":"content/components/code","qdrant_point_id":"926c5390-3fdd-45d1-a262-2c808a734e73","created_at":"2024-06-25T04:45:24.454213","updated_at":"2024-06-25T04:45:24.531466","chunk_html":"Names\nYou can add more text after the programming language to set the name of your code example. The text can be anything as long as its all in one line.","metadata":{"breadcrumbs":["Components","Code Blocks"],"title":"Names"},"tracking_id":"content/components/code-Names","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["content/components/code"]},{"id":"1b36e648-5296-4275-b6bc-57b550423a14","link":"integrations/analytics/amplitude","qdrant_point_id":"b224f915-3208-434e-a3df-03ecba8dc032","created_at":"2024-06-25T04:45:24.379795","updated_at":"2024-06-25T04:45:24.469165","chunk_html":"Amplitude\nAdd the following to your mint.json file to send analytics to Amplitude.","metadata":{"breadcrumbs":["Analytics","Amplitude"],"title":"Amplitude"},"tracking_id":"integrations/analytics/amplitude-Amplitude","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/amplitude"]},{"id":"363c9a1b-d6ac-44e3-8be0-db4c27768dda","link":"content/components/tabs","qdrant_point_id":"3b0416bd-e473-4940-8df5-949df5f72e34","created_at":"2024-06-25T04:45:22.901465","updated_at":"2024-06-25T04:45:22.901465","chunk_html":"Tabs\nToggle content using the Tabs component","metadata":{"breadcrumbs":["Components","Tabs"],"title":"Tabs"},"tracking_id":"content/components/tabs-Tabs-Toggle-content-using-the-Ta","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/tabs"]},{"id":"5f268295-ccfa-42f8-92bc-703c24816194","link":"integrations/support/front","qdrant_point_id":"b98a389e-0f86-47f9-8086-58dd7fe60e7c","created_at":"2024-06-25T04:45:28.121765","updated_at":"2024-06-25T04:45:28.195995","chunk_html":"Front\nAdd the following to your mint.json file to add an Front Chat widget.","metadata":{"breadcrumbs":["Support","Front"],"title":"Front"},"tracking_id":"integrations/support/front-Front","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/support/front"]},{"id":"e471e6ef-0b6c-48eb-95c7-3a1ec29d5487","link":"api-playground/openapi/setup","qdrant_point_id":"2e92484e-7ff3-4aba-a2cf-504b659469f1","created_at":"2024-06-25T04:45:22.348340","updated_at":"2024-06-25T04:45:22.442135","chunk_html":"Create MDX files for OpenAPI schemas\nMintlify also allows you to create individual pages for any OpenAPI schemas defined in an OpenAPI document's components.schemas field:","metadata":{"breadcrumbs":["API References","Using OpenAPI","OpenAPI Setup"],"title":"Create MDX files for OpenAPI schemas"},"tracking_id":"api-playground/openapi/setup-Create-MDX-files-for-OpenAPI-schemas","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/setup"]},{"id":"4530992d-f478-44a9-b7b7-385fe51cdefd","link":"text","qdrant_point_id":"6caa621a-ea81-4192-a5f4-ffb18dff2062","created_at":"2024-06-25T04:45:31.157727","updated_at":"2024-06-25T04:45:31.236651","chunk_html":"Line Breaks\nMarkdown syntax also recognizes a double enter in your MDX as a linebreak.","metadata":{"breadcrumbs":["Writing Content","Headers and Text"],"title":"Line Breaks"},"tracking_id":"text-Line-Breaks","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["text"]},{"id":"9110893c-7aa7-45a1-ab25-ddbf29d1e269","link":"integrations/custom/js","qdrant_point_id":"fd102919-7186-4578-9fb9-45d50e5185d1","created_at":"2024-06-25T04:45:26.348833","updated_at":"2024-06-25T04:45:26.399609","chunk_html":"Adding script.js\nFor example, you can add the following script.js file to enable Google Analytics across the entire documentation. Please use with caution to not introduce security vulnerabilities.","metadata":{"breadcrumbs":["Custom Scripts","Custom JS"],"title":"Adding script.js"},"tracking_id":"integrations/custom/js-Adding-script.js","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/custom/js"]},{"id":"467fadc4-99e6-4633-acbf-1a8dd696024e","link":"api-playground/mdx/authentication","qdrant_point_id":"349fb1fd-bc86-4c1a-adf4-cad633bb9309","created_at":"2024-06-25T04:45:21.299399","updated_at":"2024-06-25T04:45:21.299399","chunk_html":"Supported Authentication Methods\nbearer basic none The \"none\" authentication method is useful to disable authentication on a specific endpoint after setting a default in mint.json.","metadata":{"breadcrumbs":["API References","Using MDX","Authentication"],"title":"Supported Authentication Methods"},"tracking_id":"api-playground/mdx/authentication-Supported-Authentication-Methods","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/mdx/authentication"]},{"id":"78e4e1be-fdba-45ea-adb9-7617672e1be7","link":"api-playground/openapi/writing-openapi","qdrant_point_id":"746ea556-4e68-48d8-910a-8bf96e72f009","created_at":"2024-06-25T04:45:22.494817","updated_at":"2024-06-25T04:45:22.494817","chunk_html":"Describing your API\nThere are many great tools online for learning about and constructing OpenAPI documents. Here are our favorites: Swagger's OpenAPI Guide for familiarizing yourself with the OpenAPI syntax OpenAPI v3.1.0 Specification for all the details about the newest OpenAPI specification Swagger & OpenAPI Validator for debugging your OpenAPI document Swagger's Editor for seeing examples in action Swagger's OpenAPI Guide is for OpenAPI v3.0, but nearly all of the information is applicable to v3.1. For more information on the differences between v3.0 and v3.1, check out OpenAPI's blog post.","metadata":{"breadcrumbs":["API References","Using OpenAPI","Writing OpenAPI"],"title":"Describing your API"},"tracking_id":"api-playground/openapi/writing-openapi-Describing-your-API","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["api-playground/openapi/writing-openapi"]},{"id":"69044fe5-777f-49c1-a21a-53ebe0ad1b7d","link":"settings/navigation","qdrant_point_id":"5944aac6-9da9-4c59-9a2a-b09bd2d29f02","created_at":"2024-06-25T04:45:29.971556","updated_at":"2024-06-25T04:45:29.971557","chunk_html":"Hidden Pages\nMDX files not included in mint.json will not show up in the sidebar but are\naccessible through the search bar and by linking directly to them.","metadata":{"breadcrumbs":["Getting Started","Navigation"],"title":"Hidden Pages"},"tracking_id":"settings/navigation-Hidden-Pages","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/navigation"]},{"id":"c7b07de9-ec78-48ae-b1d2-4408e3d1d474","link":"page","qdrant_point_id":"3cf70227-dd47-4a22-adae-77ffac8c0555","created_at":"2024-06-25T04:45:26.706647","updated_at":"2024-06-25T04:45:26.834444","chunk_html":"API Pages\nAPI pages let you build interactive API playgrounds. To create an API page, you\nmust set an api or openapi property in the page metadata. Learn more about API playgrounds in our demo.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"API Pages"},"tracking_id":"page-API-Pages","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"d233a990-b434-48e8-a01e-22146848f169","link":"page","qdrant_point_id":"e5ff0304-9a65-4ec8-bebd-7d44de00ef0e","created_at":"2024-06-25T04:45:27.268269","updated_at":"2024-06-25T04:45:27.331020","chunk_html":"Search Engine Optimization\nYou can set meta tags like the image set when shared on social media by passing\nthem into your page's metadata. Meta tags with colons need to be wrapped in\nquotes. See our SEO page for all supported meta tags.","metadata":{"breadcrumbs":["Writing Content","Page Titles and Metadata"],"title":"Search Engine Optimization"},"tracking_id":"page-Search-Engine-Optimization","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["page"]},{"id":"9f48b090-5cd4-49a5-b20e-a0e45dd1f5db","link":"integrations/subpath/route53-cloudfront","qdrant_point_id":"0f698e43-5a8b-497e-8be1-54addb1423ab","created_at":"2024-06-25T04:45:27.790321","updated_at":"2024-06-25T04:45:27.790321","chunk_html":"Route 53 and Cloudfront\nHost documentation at a /docs subdirectory using AWS services","metadata":{"breadcrumbs":["Custom Subpaths","Route 53 and Cloudfront"],"title":"Route 53 and Cloudfront"},"tracking_id":"integrations/subpath/route53-cloudfront-Route-53-and-Cloudfront-Host-doc","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/subpath/route53-cloudfront"]},{"id":"fc473f92-f694-4292-9185-9e5624112abe","link":"integrations/analytics/posthog","qdrant_point_id":"c0cd946c-35a6-4e72-9ef0-f6512d7fe1c3","created_at":"2024-06-25T04:45:25.904779","updated_at":"2024-06-25T04:45:25.987545","chunk_html":"PostHog\nAdd the following to your mint.json file to send analytics to PostHog. You only need to include apiHost if you are self-hosting PostHog. We send events to https://app.posthog.com by default. Enabling PostHog analytics will disable the analytics on the Mintlify dashboard.","metadata":{"breadcrumbs":["Analytics","PostHog"],"title":"PostHog"},"tracking_id":"integrations/analytics/posthog-PostHog","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/analytics/posthog"]},{"id":"3014315d-b6f3-4b75-bc69-14f6bf50bae0","link":"reusable-snippets","qdrant_point_id":"1ded56fe-a9df-49f6-8b4b-04451f7d428e","created_at":"2024-06-25T04:45:28.190762","updated_at":"2024-06-25T04:45:28.244493","chunk_html":"Client-Side Content\nBy default, Mintlify employs server-side rendering, generating content\nat build time. For client-side content loading, ensure to verify the\ndocument object's availability before initiating the rendering process.","metadata":{"breadcrumbs":["Writing Content","Reusable Snippets"],"title":"Client-Side Content"},"tracking_id":"reusable-snippets-Client-Side-Content","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["reusable-snippets"]},{"id":"f6c7e896-e1af-4558-b942-f203527a180a","link":"settings/github","qdrant_point_id":"8eacc5cf-b8dd-4518-afc5-b08d228bc66a","created_at":"2024-06-25T04:45:28.613800","updated_at":"2024-06-25T04:45:28.613800","chunk_html":"Installation\nTo begin, you need to install the Mintlify GitHub App into the GitHub account\nwhere your docs repo resides. Installing a GitHub App requires either\norganization ownership or admin permissions in a repository. If you lack the\nnecessary permissions, the repository owner will need to approve the request.\nYou can access the installation page by logging into the\nMintlify dashboard. For GitHub Apps, you can choose to only give permissions to a single repository.\nWe highly recommend you do so as we only need access to the repository where\nyour docs are hosted.","metadata":{"breadcrumbs":["Configurations","GitHub"],"title":"Installation"},"tracking_id":"settings/github-Installation","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/github"]},{"id":"6d3e2466-27db-4d51-9fff-ed195a169cdf","link":"settings/custom-domain","qdrant_point_id":"3684422d-d773-4dbb-be97-ff69f6a491b6","created_at":"2024-06-25T04:45:28.716343","updated_at":"2024-06-25T04:45:28.716343","chunk_html":"Custom Domain\nHost the documentation at your website's custom subdomain","metadata":{"breadcrumbs":["Configurations","Custom Domain"],"title":"Custom Domain"},"tracking_id":"settings/custom-domain-Custom-Domain-Host-the-documenta","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["settings/custom-domain"]},{"id":"431f1c6b-1dd0-4e76-8742-a1f54d76c082","link":"text","qdrant_point_id":"c2135da2-8ef1-41c8-b7a2-ba94f620ea4a","created_at":"2024-06-25T04:45:30.812034","updated_at":"2024-06-25T04:45:30.855242","chunk_html":"Subtitles\nBest use to subsection headers. Each title and subtitle creates an anchor and also shows up on the table of contents on the right.","metadata":{"breadcrumbs":["Writing Content","Headers and Text"],"title":"Subtitles"},"tracking_id":"text-Subtitles","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["text"]},{"id":"bcb86188-361a-4483-bf78-288bd2924cbc","link":"settings/versioning","qdrant_point_id":"8e57bd40-9b85-4646-8664-a32026e3d661","created_at":"2024-06-25T04:45:30.455455","updated_at":"2024-06-25T04:45:30.500883","chunk_html":"Tabs\nSimilarly, you can version with tabs. In the mint.json , add version to the tab. Tabs without a version value are shown in every version.","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Tabs"},"tracking_id":"settings/versioning-Tabs","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"619a01fb-a3a0-45d5-b729-00da1e208811","link":"integrations/support/overview","qdrant_point_id":"4bb91cf6-3621-40ea-aadf-74fff98e9e84","created_at":"2024-06-25T04:45:25.168766","updated_at":"2024-06-25T04:45:25.168766","chunk_html":"Support Integrations\nIntegrate with a support widget","metadata":{"breadcrumbs":["Support","Support Integrations"],"title":"Support Integrations"},"tracking_id":"integrations/support/overview-Support-Integrations-Integrate-w","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/support/overview"]},{"id":"7127d9cb-31bd-4bcf-8f6d-4cb0f4c0b52f","link":"content/components/params","qdrant_point_id":"b65f18d3-0101-405e-a961-7f5ce5dbae5e","created_at":"2024-06-25T04:45:22.115185","updated_at":"2024-06-25T04:45:22.115185","chunk_html":"Parameter Fields\nSet path, query, and body parameters","metadata":{"breadcrumbs":["API Components","Parameter Fields"],"title":"Parameter Fields"},"tracking_id":"content/components/params-Parameter-Fields-Set-path,-query","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["content/components/params"]},{"id":"06a9d058-f6a9-482a-8d9a-e614b0c728aa","link":"settings/versioning","qdrant_point_id":"9fa0df44-5029-4e4f-bd0d-2522165006dd","created_at":"2024-06-25T04:45:30.687667","updated_at":"2024-06-25T04:45:30.687668","chunk_html":"Troubleshooting\nCommon errors and how to fix them Pages Show Up In Wrong Version You likely nested a version inside of another. For example, your group had version \"v1\" but your page had version \"v2\". We do not recommend nesting versions inside of each other because it's hard to maintain your docs later. Missing Pages If you add versions to your docs and the pages disappeared from your\nnavigation, make sure you spelled the version the same as in your versions array in mint.json.","metadata":{"breadcrumbs":["Configurations","Versioning"],"title":"Troubleshooting"},"tracking_id":"settings/versioning-Troubleshooting","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["settings/versioning"]},{"id":"1e2c5935-b7c5-4796-92fc-f21305f96bbd","link":"integrations/user-auth/overview","qdrant_point_id":"8e7c9daf-ffc2-4b98-b782-a377f7903fc8","created_at":"2024-06-27T01:19:03.383566","updated_at":"2024-06-27T01:19:03.477041","chunk_html":"Customizing MDX Content\nWhen writing content, you can use the userContext variable to access the information you have sent to your docs. Here's a simple example: Hello, userContext.name ?? 'reader'! This feature becomes even more powerful when paired with custom data about the user. Here's a real world example that allows us to give specific instructions on how to access the User Auth feature based on the customer's existing plan: User Auth is an enterprise feature. userContext.org === undefined\n    ? <>To access this feature, first create an account at the <a href=\"https://dashboard.mintlify.com/login\">Mintlify dashboard</a>.</>\n    : userContext.org.plan !== 'enterprise'\n      ? <>You are currently on the ${userContext.org.plan ?? 'free'} plan. To speak to our team about upgrading, <a href=\"mailto:[email protected]\">contact our sales team</a>.</>\n      : <>To request this feature for your enterprise org, <a href=\"mailto:[email protected]\">contact our team</a>.</>\nThe information in userContext is only available after a user has logged in. For logged out users, the value of userContext will be {} . To prevent the page from crashing for logged-out users, always use optional chaining on your userContext fields, e.g. {userContext.org?.plan}","metadata":{"breadcrumbs":["User Auth","Overview"],"title":"Customizing MDX Content"},"tracking_id":"integrations/user-auth/overview-Customizing-MDX-Content","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"","num_value":null,"group_tracking_ids":["integrations/user-auth/overview"]},{"id":"3451361c-bf83-4357-be0b-3f025b3d82b5","link":"integrations/user-auth/jwt","qdrant_point_id":"41b7429a-c638-44ce-b39f-32f3a75534ab","created_at":"2024-06-25T04:45:25.450475","updated_at":"2024-06-25T04:45:25.450475","chunk_html":"JWT Auth\nUse a customized login flow to authenticate users","metadata":{"breadcrumbs":["User Auth","Authenticating","JWT Auth"],"title":"JWT Auth"},"tracking_id":"integrations/user-auth/jwt-JWT-Auth-Use-a-customized-login-","time_stamp":null,"dataset_id":"300347ba-73e2-4359-a677-62a431d11b57","weight":0,"location":null,"image_urls":null,"tag_set":"page","num_value":null,"group_tracking_ids":["integrations/user-auth/jwt"]}]