docs/docs.json
Rama master · réplica de lectura del repositorio original.
{
"$schema": "https://mintlify.com/docs.json",
"theme": "maple",
"name": "Mage AI",
"colors": {
"primary": "#6A35FF",
"light": "#00FB82",
"dark": "#148EFF"
},
"favicon": "/favicons/m1.svg",
"navigation": {
"tabs": [
{
"tab": "Mage Pro",
"groups": [
{
"group": "Adventure starts here",
"pages": [
"production/mage/pro"
]
},
{
"group": "Deployment architecture",
"pages": [
"pro-architecture/architecture-overview",
"pro-architecture/saas",
"pro-architecture/hybrid-cloud",
"pro-architecture/private-cloud",
"pro-architecture/on-prem"
]
},
{
"group": "Getting started",
"pages": [
"getting-started/cluster-management-portal",
"getting-started/mage-pro-api",
"getting-started/install-dependencies",
"guides/developer-ux/workspaces",
"getting-started/build-pro-pipeline",
"getting-started/trigger-pipeline",
"guides/best-practices"
]
},
{
"group": "Operations",
"pages": [
"guides/operations/activity"
]
},
{
"group": "CI/CD",
"pages": [
"development/git/pro-overview",
"guides/data-sync/cicd-workflow",
"guides/data-sync/git-terminal",
"guides/version-control/file-versions",
"guides/data-sync/version-control-guide",
"guides/data-sync/git-client"
]
},
{
"group": "Pro only features",
"pages": [
{
"group": "AI",
"icon": "microchip-ai",
"pages": [
"ai/blocks",
"ai/agents",
"ai/rag-pipeline",
"ai/custom-resources"
]
},
{
"group": "Blocks",
"icon": "block-brick",
"pages": [
"guides/blocks/dynamic-blocks-2",
"guides/blocks/batch-read-write"
]
},
{
"group": "Streaming",
"icon": "stream",
"pages": [
"guides/streaming/sources/oracledb",
"guides/streaming/tutorials/streaming-stateful-store"
]
},
{
"group": "Data integrations",
"icon": "link",
"pages": [
"data-integrations/sources/custom_source",
"contributing/data-integrations/adapt-existing-source",
"contributing/data-integrations/add-new-source",
"contributing/data-integrations/add-new-destination",
{
"group": "Sources",
"pages": [
"data-integrations/sources/facebook_pages",
"data-integrations/sources/instagram",
"data-integrations/sources/quickbooks",
"data-integrations/sources/xero",
"data-integrations/sources/youtube_analytics",
"data-integrations/sources/google_campaign_manager_360",
"data-integrations/sources/google_display_video_360",
"data-integrations/sources/microsoft_ads",
"data-integrations/sources/salesforce_marketing_cloud",
"data-integrations/sources/tiktok_ads"
]
},
{
"group": "Destinations",
"pages": [
"data-integrations/destinations/databricks",
"data-integrations/destinations/duckdb",
"data-integrations/destinations/iceberg_s3"
]
}
]
},
{
"group": "Developer experience",
"icon": "terminal",
"pages": [
"guides/developer-ux/pipeline-dependencies",
"guides/developer-ux/code-canvas",
"guides/developer-ux/code-browser",
"guides/developer-ux/personalize",
"guides/developer-ux/visual-studio-code"
]
}
]
},
{
"group": "Infrastructure",
"pages": [
{
"group": "Compute",
"icon": "stars",
"pages": [
"integrations/compute/spark-pro",
"integrations/compute/management",
"integrations/compute/databricks"
]
},
{
"group": "Storage",
"icon": "database",
"pages": [
"integrations/databases/Databricks",
"integrations/databases/Iceberg"
]
}
]
},
{
"group": "Migration guides",
"pages": [
"migrations/airbyte-to-mage-pro",
"migrations/airflow-to-mage-pro",
"migrations/dbt-to-mage-pro",
"migrations/estuary-to-mage-pro",
"migrations/fivetran-to-mage-pro",
"migrations/dagster-to-mage-pro",
"migrations/mage-oss-to-mage-pro",
"migrations/prefect-to-mage-pro"
]
},
{
"group": "Global hooks",
"pages": [
"extensibility/global-hooks/overview",
"extensibility/global-hooks/guides"
]
},
{
"group": "Mage Pro API",
"pages": [
"extensibility/pro-api-reference/overview",
"extensibility/pro-api-reference/deployments/overview",
"extensibility/pro-api-reference/workspaces/update-workspace"
]
},
{
"group": "Mage Agent",
"pages": [
"agent/introduction",
"agent/quickstart",
"agent/installation",
"agent/mage-agent-plugin",
"agent/authentication",
"agent/ide-integration",
"agent/sync",
"agent/mcp-tools",
"agent/cli-reference",
"agent/troubleshooting"
]
}
]
},
{
"tab": "Documentation",
"groups": [
{
"group": "Adventure starts here",
"pages": [
"introduction/overview",
"getting-started/setup",
"design/core-design-principles",
{
"group": "Abstractions",
"icon": "object-subtract",
"pages": [
"design/core-abstractions",
"design/abstractions/project-structure"
]
}
]
},
{
"group": "Concepts",
"pages": [
"design/data-pipeline-management",
{
"group": "Blocks",
"icon": "block-brick",
"pages": [
"design/blocks",
{
"group": "Types",
"pages": [
"design/blocks/callbacks",
"design/blocks/conditionals",
"design/blocks/data-exporter",
"design/blocks/data-loader",
"design/blocks/scratchpad",
"design/blocks/sensor",
"design/blocks/transformer"
]
},
"design/blocks/dynamic-blocks",
"design/blocks/remote-blocks",
{
"group": "Resources",
"pages": [
{
"group": "Data loader",
"pages": [
"design/data-loading",
"development/blocks/data_loaders/templates"
]
},
{
"group": "Transformer",
"pages": [
"development/blocks/transformers/templates"
]
},
{
"group": "Data exporter",
"pages": [
"development/blocks/data_exporters/templates"
]
},
{
"group": "Sensors",
"pages": [
"development/blocks/sensors/templates"
]
},
{
"group": "Callbacks",
"pages": [
"development/blocks/callbacks/templates"
]
},
{
"group": "Conditionals",
"pages": [
"development/blocks/conditionals/templates"
]
}
]
}
]
},
{
"group": "Data integrations",
"icon": "rotate",
"pages": [
"data-integrations/overview",
"data-integrations/configuration",
{
"group": "Sources",
"pages": [
"data-integrations/sources/overview",
"data-integrations/sources/airtable",
"data-integrations/sources/amazon_s3",
"data-integrations/sources/amplitude",
"data-integrations/sources/api",
"data-integrations/sources/azure_blob_storage",
"data-integrations/sources/bigquery",
"data-integrations/sources/chargebee",
"data-integrations/sources/commercetools",
"data-integrations/sources/couchbase",
"data-integrations/sources/datadog",
"data-integrations/sources/doris",
"data-integrations/sources/dremio",
"data-integrations/sources/dynamodb",
"data-integrations/sources/facebook_ads",
"data-integrations/sources/freshdesk",
"data-integrations/sources/front",
"data-integrations/sources/github",
"data-integrations/sources/google_ads",
"data-integrations/sources/google_analytics",
"data-integrations/sources/google_cloud_storage",
"data-integrations/sources/google_search_console",
"data-integrations/sources/google_sheets",
"data-integrations/sources/hubspot",
"data-integrations/sources/intercom",
"data-integrations/sources/knowi",
"data-integrations/sources/linkedin_ads",
"data-integrations/sources/mode",
"data-integrations/sources/monday",
"data-integrations/sources/mongodb",
"data-integrations/sources/mssql",
"data-integrations/sources/mysql",
"data-integrations/sources/outreach",
"data-integrations/sources/paystack",
"data-integrations/sources/pipedrive",
"data-integrations/sources/postgresql",
"data-integrations/sources/postmark",
"data-integrations/sources/powerbi",
"data-integrations/sources/redshift",
"data-integrations/sources/salesforce",
"data-integrations/sources/sftp",
"data-integrations/sources/snowflake",
"data-integrations/sources/stripe",
"data-integrations/sources/tableau",
"data-integrations/sources/teradata",
"data-integrations/sources/twitter_ads",
"data-integrations/sources/zendesk"
]
},
{
"group": "Destinations",
"pages": [
"data-integrations/destinations/overview",
"data-integrations/destinations/airtable",
"data-integrations/destinations/amazon_s3",
"data-integrations/destinations/bigquery",
"data-integrations/destinations/clickhouse",
"data-integrations/destinations/delta_lake_azure",
"data-integrations/destinations/delta_lake_s3",
"data-integrations/destinations/doris",
"data-integrations/destinations/elasticsearch",
"data-integrations/destinations/google_cloud_storage",
"data-integrations/destinations/kafka",
"data-integrations/destinations/mongodb",
"data-integrations/destinations/mssql",
"data-integrations/destinations/mysql",
"data-integrations/destinations/opensearch",
"data-integrations/destinations/oracledb",
"data-integrations/destinations/postgresql",
"data-integrations/destinations/redshift",
"data-integrations/destinations/salesforce",
"data-integrations/destinations/snowflake",
"data-integrations/destinations/teradata",
"data-integrations/destinations/trino"
]
},
"data-integrations/batch-pipelines"
]
},
{
"group": "Triggers",
"icon": "bolt",
"pages": [
"orchestration/triggers/triggering-pipelines",
"orchestration/triggers/configure-triggers-in-code",
"orchestration/triggers/trigger-pipeline",
"orchestration/triggers/trigger-pipeline-api",
"orchestration/triggers/schedule-pipelines",
"orchestration/triggers/database-query"
]
},
{
"group": "Pipeline runs",
"icon": "person-running-fast",
"pages": [
"orchestration/pipeline-runs/overview",
"orchestration/pipeline-runs/retrying-block-runs",
"orchestration/pipeline-runs/saving-block-output-as-csv",
"orchestration/pipeline-runs/database-query"
]
},
{
"group": "Backfills",
"icon": "clock-rotate-left",
"pages": [
"orchestration/backfills/overview",
"orchestration/backfills/guides"
]
}
]
},
{
"group": "Project",
"icon": "flask",
"pages": [
"development/project/setup",
"development/git/setting-up-git",
{
"group": "Docker",
"icon": "docker",
"pages": [
"development/docker/connecting-a-database",
"development/docker/non-root-user"
]
},
{
"group": "Variables",
"icon": "square-root-variable",
"pages": [
"development/variables/overview",
"development/variables/referencing-variables",
{
"group": "Variable Types",
"pages": [
"development/variables/environment-variables",
"getting-started/runtime-variable",
"development/variables/block-variables",
"development/variables/secrets"
]
}
]
},
{
"group": "Custom libraries",
"icon": "family",
"pages": [
"development/dependencies/requirements",
"development/dependencies/custom-files",
"development/dependencies/dependency-management"
]
},
"development/databases/default",
"development/io_config",
"development/io_config_setup",
"getting-started/kernels",
"development/project/local-timezone",
"development/project/landing-page",
"development/settings-backend",
"development/updating-mage",
"development/cli-commands",
"development/project/metadata"
]
},
{
"group": "Contributing",
"pages": [
"contributing/overview",
"contributing/development-environment",
{
"group": "Backend",
"icon": "server",
"pages": [
"contributing/backend/overview",
{
"group": "IO classes",
"pages": [
"contributing/backend/io/adding-a-class"
]
},
{
"group": "Streaming",
"pages": [
"contributing/backend/streaming/sources-and-destinations"
]
},
{
"group": "Testing",
"pages": [
"contributing/backend/testing/overview"
]
}
]
},
{
"group": "Frontend",
"icon": "browser",
"pages": [
"contributing/frontend/overview",
"contributing/charts/how-to-add",
"contributing/frontend/testing"
]
},
{
"group": "Documentation",
"icon": "book",
"pages": [
"contributing/documentation/overview"
]
}
]
},
{
"group": "About",
"icon": "info",
"pages": [
"about/code-of-conduct",
"about/statistics",
"about/frequently-asked-questions",
"about/releases"
]
}
]
},
{
"tab": "Development",
"groups": [
{
"group": "Quickstart",
"pages": [
"guides/overview",
"guides/tips-and-tricks",
"development/troubleshooting"
]
},
{
"group": "Developer experience",
"pages": [
"guides/developer-ux/code-editor",
"guides/developer-ux/block-dependency-tree",
"guides/developer-ux/file-browser",
"guides/developer-ux/sidekick"
]
},
{
"group": "Version control",
"pages": [
"guides/git/configure",
"guides/data-sync/version-control",
"guides/data-sync/git-sync",
"guides/data-sync/git-integration"
]
},
{
"group": "Blocks",
"icon": "block-brick",
"pages": [
"guides/blocks/reorder-blocks",
"guides/blocks/reuse-blocks",
"guides/blocks/user-defined-templates",
"guides/blocks/detach-blocks",
"guides/blocks/dynamic-blocks",
"guides/blocks/polars",
"guides/blocks/replicate-blocks",
"guides/blocks/transformer-blocks",
"guides/blocks/custom-blocks",
"guides/blocks/markdown-blocks",
"guides/blocks/sql-blocks",
"guides/blocks/r-blocks"
]
},
{
"group": "Pipelines",
"icon": "pipe-section",
"pages": [
"guides/load-api-data",
"guides/data-integration-pipeline",
{
"group": "Streaming",
"icon": "water",
"pages": [
"guides/streaming/introduction",
{
"group": "Sources",
"pages": [
"guides/streaming/sources/activemq",
"guides/streaming/sources/amazon-sqs",
"guides/streaming/sources/azure-event-hub",
"guides/streaming/sources/google-cloud-pubsub",
"guides/streaming/sources/influxdb",
"guides/streaming/sources/kafka",
"guides/streaming/sources/kinesis",
"guides/streaming/sources/nats",
"guides/streaming/sources/oracledb",
"guides/streaming/sources/postgres-cdc",
"guides/streaming/sources/rabbitmq",
"guides/streaming/sources/mongodb",
"guides/streaming/sources/mysql-cdc",
"guides/streaming/sources/mssql-cdc"
]
},
{
"group": "Destinations",
"pages": [
"guides/streaming/destinations/activemq",
"guides/streaming/destinations/amazon-s3",
"guides/streaming/destinations/bigquery",
"guides/streaming/destinations/clickhouse",
"guides/streaming/destinations/duckdb",
"guides/streaming/destinations/dummy",
"guides/streaming/destinations/elasticsearch",
"guides/streaming/destinations/google-cloud-pubsub",
"guides/streaming/destinations/google-cloud-storage",
"guides/streaming/destinations/influxdb",
"guides/streaming/destinations/kafka",
"guides/streaming/destinations/kinesis",
"guides/streaming/destinations/mongodb",
"guides/streaming/destinations/mssql",
"guides/streaming/destinations/mysql",
"guides/streaming/destinations/opensearch",
"guides/streaming/destinations/oracledb",
"guides/streaming/destinations/postgres",
"guides/streaming/destinations/rabbitmq",
"guides/streaming/destinations/redshift",
"guides/streaming/destinations/snowflake",
"guides/streaming/destinations/trino"
]
},
{
"group": "Tutorials",
"pages": [
"guides/streaming/tutorials/streaming-pipeline",
"guides/streaming/tutorials/magic-devcontainer",
"guides/streaming/tutorials/streaming-pipeline-rabbitmq"
]
}
]
},
"guides/pipelines/importing-pipelines",
"guides/community-examples"
]
},
{
"group": "dbt",
"icon": "arrow-progress",
"pages": [
"guides/dbt/overview",
"guides/dbt/developing-dbt-in-mage",
"guides/dbt/setup-dbt",
{
"group": "Configuration",
"icon": "screwdriver-wrench",
"pages": [
"guides/dbt/sources",
"guides/dbt/connection-profiles",
"guides/dbt/variable-interpolation",
"guides/dbt/run-dbt-spark"
]
},
{
"group": "Models",
"icon": "square-m",
"pages": [
"guides/dbt/add-existing-dbt",
"guides/dbt/incremental-models",
"guides/dbt/run-single-model",
"guides/dbt/run-selected-model"
]
},
{
"group": "Commands",
"icon": "command",
"pages": [
"guides/dbt/docs",
"guides/dbt/snapshots",
"guides/dbt/running-dbt-tests"
]
}
]
}
]
},
{
"tab": "Production",
"groups": [
{
"group": "Deployment",
"icon": "circle-check",
"pages": [
"production/ci-cd/overview",
"production/ci-cd/local-cloud/repository-setup",
"production/ci-cd/local-cloud/github-actions",
"production/ci-cd/local-cloud/gitlab-ci-cd",
"production/ci-cd/local-cloud/buildkite",
"production/ci-cd/mage/pro",
"production/configuring-production-settings/overview",
"production/configuring-production-settings/trusted-ca-certificates"
]
},
{
"group": "Cloud infrastructure",
"icon": "clouds",
"pages": [
"production/deploying-to-cloud/architecture",
{
"group": "Infrastructure as code",
"icon": "road-bridge",
"pages": [
"production/deploying-to-cloud/using-terraform",
"production/deploying-to-cloud/using-helm"
]
},
{
"group": "AWS",
"icon": "aws",
"pages": [
"production/deploying-to-cloud/aws/setup",
"production/deploying-to-cloud/aws/resources",
"production/deploying-to-cloud/aws/aws-ecs-architecture",
"production/deploying-to-cloud/aws/terraform-apply-policy",
"production/deploying-to-cloud/aws/terraform-destroy-policy",
"production/deploying-to-cloud/aws/emr-policy",
"production/deploying-to-cloud/aws-without-terraform",
"production/deploying-to-cloud/aws/code-pipeline"
]
},
{
"group": "Azure",
"icon": "microsoft",
"pages": [
"production/deploying-to-cloud/azure/setup",
"production/deploying-to-cloud/azure/resources"
]
},
{
"group": "DigitalOcean",
"icon": "digital-ocean",
"pages": [
"production/deploying-to-cloud/digitalocean/setup"
]
},
{
"group": "GCP",
"icon": "google",
"pages": [
"production/deploying-to-cloud/gcp/setup",
"production/deploying-to-cloud/gcp/resources",
"production/deploying-to-cloud/gcp/gcp-artifact-registry"
]
}
]
},
{
"group": "Compute resources",
"pages": [
"production/configuring-production-settings/compute-resource",
"production/executors/python",
"production/executors/k8",
"production/executors/spark",
"production/executors/aws",
"production/executors/azure",
"production/executors/gcp"
]
},
{
"group": "Secret manager",
"pages": [
"production/deploying-to-cloud/secrets/mage",
"production/deploying-to-cloud/secrets/AWS",
"production/deploying-to-cloud/secrets/Azure",
"production/deploying-to-cloud/secrets/Doppler",
"production/deploying-to-cloud/secrets/GCP",
"production/deploying-to-cloud/secrets/Vault"
]
},
{
"group": "Authentication",
"pages": [
"production/authentication/overview",
"production/authentication/password-reset",
"production/authentication/mfa",
"production/authentication/okta",
"production/authentication/microsoft",
"production/authentication/google",
"production/authentication/ldap",
"production/authentication/permissions/overview",
"production/authentication/permissions/roles",
"production/authentication/permissions/permissions"
]
}
]
},
{
"tab": "AI",
"groups": [
{
"group": "AI Sidekick",
"icon": "user-robot",
"pages": [
"ai/sidekick/index"
]
},
{
"group": "Development",
"icon": "microchip-ai",
"pages": [
"ai/setup",
"ai/ai-client"
]
},
{
"group": "Pipelines",
"icon": "microchip-ai",
"pages": [
"ai/ml/train-model"
]
}
]
},
{
"tab": "Observability",
"groups": [
{
"group": "Monitoring",
"icon": "eye",
"pages": [
"observability/monitoring",
"observability/data-explorer",
"observability/external/datadog",
"observability/external/metaplane",
"observability/external/newrelic",
"observability/external/opentelemetry",
"observability/external/prometheus",
"observability/external/sentry",
"observability/visualizations/analytics",
"observability/visualizations/dashboards"
]
},
{
"group": "Alerting",
"pages": [
"observability/alerting/alerting-discord",
"observability/alerting/alerting-email",
"observability/alerting/alerting-opsgenie",
"observability/alerting/alerting-slack",
"observability/alerting/alerting-teams",
"observability/alerting/alerting-telegram",
"observability/alerting/alerting-zendesk"
]
},
{
"group": "Logging",
"icon": "eye",
"pages": [
"observability/logging",
"observability/log-search-opensearch"
]
},
{
"group": "Testing",
"icon": "vial",
"pages": [
"observability/testing/data-validation",
"observability/testing/unit-tests"
]
}
]
},
{
"tab": "Integrations",
"groups": [
{
"group": "Infrastructure",
"pages": [
{
"group": "Compute",
"icon": "diamonds-4",
"pages": [
"integrations/compute/spark-pyspark"
]
},
{
"group": "Storage",
"icon": "database",
"pages": [
"integrations/databases/Algolia",
"integrations/databases/Athena",
"integrations/databases/AzureBlobStorage",
"integrations/databases/AzureDataLakeStorage",
"integrations/databases/BackblazeB2",
"integrations/databases/BigQuery",
"integrations/databases/Chroma",
"integrations/databases/ClickHouse",
"integrations/databases/Databricks",
"integrations/databases/Druid",
"integrations/databases/DuckDB",
"integrations/databases/GoogleCloudStorage",
"integrations/databases/GoogleSheets",
"integrations/databases/MicrosoftFabricWarehouse",
"integrations/databases/MicrosoftSQLServer",
"integrations/databases/MongoDB",
"integrations/databases/MotherDuck",
"integrations/databases/MySQL",
"integrations/databases/OracleDB",
"integrations/databases/Pinot",
"integrations/databases/PowerBI",
"integrations/databases/PostgreSQL",
"integrations/databases/Qdrant",
"integrations/databases/Redshift",
"integrations/databases/S3",
"integrations/databases/Snowflake",
"integrations/databases/Spark",
"integrations/databases/SQLite",
"integrations/databases/trino",
"integrations/databases/Weaviate"
]
}
]
},
{
"group": "3rd party",
"icon": "puzzle",
"pages": [
"integrations/text-editor",
{
"group": "Orchestration",
"icon": "violin",
"pages": [
{
"group": "Airflow",
"pages": [
"integrations/airflow/index",
"integrations/airflow/integrate-mage-airflow"
]
},
"integrations/prefect"
]
},
{
"group": "ETL",
"icon": "timeline-arrow",
"pages": [
"integrations/airbyte",
"integrations/stitch"
]
},
{
"group": "Reverse ETL",
"icon": "diagram-sankey",
"pages": [
"integrations/hightouch"
]
},
"integrations/dbt-cloud"
]
}
]
},
{
"tab": "Extensibility",
"groups": [
{
"group": "Environment-specific configuration",
"pages": [
"extensibility/env-config/project",
"extensibility/env-config/pipeline"
]
},
{
"group": "API",
"icon": "robot",
"pages": [
"extensibility/api-reference/overview",
{
"group": "Design",
"icon": "pencil",
"pages": [
"extensibility/api-reference/resources",
"extensibility/api-reference/policies",
"extensibility/api-reference/presenters"
]
},
{
"group": "Agents",
"icon": "user-robot",
"pages": [
"extensibility/api-reference/agents/overview",
"extensibility/api-reference/agents/read-agents",
"extensibility/api-reference/agents/create-agent",
"extensibility/api-reference/agents/update-agent",
"extensibility/api-reference/agents/delete-agent",
"extensibility/api-reference/agents/publish-agent",
"extensibility/api-reference/agents/run-agent"
]
},
{
"group": "Backfills",
"icon": "database",
"pages": [
"extensibility/api-reference/backfills/overview",
"extensibility/api-reference/backfills/read-backfills",
"extensibility/api-reference/backfills/create-backfills",
"extensibility/api-reference/backfills/update-backfill",
"extensibility/api-reference/backfills/delete-backfill"
]
},
{
"group": "Blocks",
"icon": "block-brick",
"pages": [
"extensibility/api-reference/blocks/overview",
"extensibility/api-reference/blocks/read-block",
"extensibility/api-reference/blocks/create-block",
"extensibility/api-reference/blocks/update-block",
"extensibility/api-reference/blocks/delete-block"
]
},
{
"group": "Logs",
"icon": "scroll",
"pages": [
"extensibility/api-reference/logs/overview",
"extensibility/api-reference/logs/read-logs"
]
},
{
"group": "OAuth access tokens",
"icon": "key",
"pages": [
"extensibility/api-reference/oauth-access-tokens/overview",
"extensibility/api-reference/oauth-access-tokens/read-oauth-access-tokens"
]
},
{
"group": "Pipeline runs",
"icon": "pipe-valve",
"pages": [
"extensibility/api-reference/pipeline-runs/overview",
"extensibility/api-reference/pipeline-runs/read-pipeline-runs",
"extensibility/api-reference/pipeline-runs/trigger-pipeline"
]
},
{
"group": "Pipeline schedules",
"icon": "pipe-circle-check",
"pages": [
"extensibility/api-reference/pipeline-schedules/overview",
"extensibility/api-reference/pipeline-schedules/read-pipeline-schedules",
"extensibility/api-reference/pipeline-schedules/create-pipeline-schedule"
]
},
{
"group": "Pipelines",
"icon": "pipe-collar",
"pages": [
"extensibility/api-reference/pipelines/overview",
"extensibility/api-reference/pipelines/read-pipeline",
"extensibility/api-reference/pipelines/create-pipeline",
"extensibility/api-reference/pipelines/update-pipeline",
"extensibility/api-reference/pipelines/delete-pipeline"
]
},
{
"group": "Sessions",
"icon": "window",
"pages": [
"extensibility/api-reference/sessions/overview",
"extensibility/api-reference/sessions/create-session"
]
}
]
}
]
}
]
},
"styling": {
"codeblocks": "system"
},
"logo": {
"light": "/logo/m-mage-light.svg",
"dark": "/logo/m-mage.svg"
},
"api": {
"playground": {
"display": "none"
}
},
"appearance": {
"default": "dark",
"strict": false
},
"background": {
"image": "/background.png",
"decoration": "gradient",
"color": {
"light": "#FFFFFF",
"dark": "#000000"
}
},
"navbar": {
"links": [
{
"label": "GitHub",
"href": "https://github.com/mage-ai/mage-ai"
},
{
"label": "Community",
"href": "https://www.mage.ai/chat"
},
{
"label": "Mage Pro",
"href": "https://cloud.mage.ai/sign-up?source=documentation-header"
}
],
"primary": {
"type": "button",
"label": "Get a demo",
"href": "https://mage.ai/getdemo"
}
},
"search": {
"prompt": "Omniscience... ✨"
},
"seo": {
"metatags": {
"og:image": "https://github.com/mage-ai/mage-ai/blob/master/docs/og.png?raw=True",
"og:description": "The leading framework for transforming and integrating data.",
"og:site_name": "Mage AI Documentation",
"twitter:site": "@mage_ai"
},
"indexing": "all"
},
"footer": {
"socials": {
"github": "https://www.github.com/mage-ai",
"slack": "https://www.mage.ai/chat",
"linkedin": "https://www.linkedin.com/company/magetech",
"twitter": "https://twitter.com/mage_ai"
},
"links": [
{
"header": "OSS",
"items": [
{
"label": "Code",
"href": "https://www.mage.ai.oss"
},
{
"label": "Demo playground",
"href": "https://www.mage.ai/demo"
}
]
},
{
"header": "Mage Pro",
"items": [
{
"label": "Get started for free",
"href": "https://cloud.mage.ai/sign-up"
}
]
},
{
"header": "Community",
"items": [
{
"label": "Chat",
"href": "https://www.mage.ai/chat"
},
{
"label": "Facebook",
"href": "https://www.facebook.com/mageai"
},
{
"label": "Youtube",
"href": "https://www.youtube.com/@mage_ai"
},
{
"label": "Instagram",
"href": "https://www.instagram.com/mage_ai"
},
{
"label": "Medium",
"href": "https://m.mage.ai"
}
]
}
]
},
"integrations": {
"ga4": {
"measurementId": "G-GR172GGB5V"
}
},
"fonts": {
"heading": {
"family": "Alkatra"
},
"body": {
"family": "Inter"
}
},
"redirects": [
{
"source": "/getting-started/secrets",
"destination": "/development/variables/secrets"
},
{
"source": "/development/environment-variables",
"destination": "/development/variables/environment-variables"
},
{
"source": "/contributing/code-of-conduct",
"destination": "/about/code-of-conduct"
},
{
"source": "/contributing/statistics/overview",
"destination": "/about/statistics"
},
{
"source": "/guides/streaming/contributing",
"destination": "/contributing/backend/streaming/sources-and-destinations"
},
{
"source": "/community/contributing",
"destination": "/contributing/overview"
},
{
"source": "/development/blocks/callbacks/overview",
"destination": "/design/blocks/callbacks"
},
{
"source": "/development/blocks/conditionals/overview",
"destination": "/design/blocks/conditionals"
},
{
"source": "/development/blocks/sql/trino",
"destination": "/integrations/databases/trino"
},
{
"source": "/guides/data-validation",
"destination": "/development/data-validation"
},
{
"source": "/production/observability/logging",
"destination": "/development/observability/logging"
},
{
"source": "/production/observability/monitoring",
"destination": "/development/observability/monitoring"
},
{
"source": "/development/versioning/file-versions",
"destination": "/getting-started/file-versions"
},
{
"source": "/production/configuring-production-settings/runtime-",
"destination": "/getting-started/runtime-variable"
},
{
"source": "/development/secrets/secrets",
"destination": "/development/variables/secrets"
},
{
"source": "/developing-in-the-cloud/setting-up-git",
"destination": "/getting-started/setting-up-git"
},
{
"source": "/guides/r-blocks",
"destination": "/guides/blocks/r-blocks"
},
{
"source": "/design/blocks/replicate-blocks",
"destination": "/guides/blocks/replicate-blocks"
},
{
"source": "/guides/sql-blocks",
"destination": "/guides/blocks/sql-blocks"
},
{
"source": "/guides/transformer-blocks",
"destination": "/guides/blocks/transformer-blocks"
},
{
"source": "/tutorials/examples",
"destination": "/guides/community-examples"
},
{
"source": "/tutorials/load-api-data",
"destination": "/guides/load-api-data"
},
{
"source": "/tutorials/setup-dbt",
"destination": "/guides/dbt/setup-dbt"
},
{
"source": "/tutorials/train-model",
"destination": "/guides/train-model"
},
{
"source": "/tutorials/train/complete-project",
"destination": "/guides/train/complete-project"
},
{
"source": "/production/observability/alerting-email",
"destination": "/integrations/observability/alerting-email"
},
{
"source": "/production/observability/alerting-opsgenie",
"destination": "/integrations/observability/alerting-opsgenie"
},
{
"source": "/production/observability/alerting-slack",
"destination": "/integrations/observability/alerting-slack"
},
{
"source": "/production/observability/alerting-teams",
"destination": "/integrations/observability/alerting-teams"
},
{
"source": "/production/observability/alerting-discord",
"destination": "/integrations/observability/alerting-discord"
},
{
"source": "/production/observability/alerting-telegram",
"destination": "/integrations/observability/alerting-telegram"
},
{
"source": "/production/observability/datadog",
"destination": "/integrations/observability/datadog"
},
{
"source": "/integrations/great-expectations",
"destination": "/integrations/observability/great-expectations"
},
{
"source": "/integrations/metaplane",
"destination": "/integrations/observability/metaplane"
},
{
"source": "/production/observability/newrelic",
"destination": "/integrations/observability/newrelic"
},
{
"source": "/production/observability/sentry",
"destination": "/integrations/observability/sentry"
},
{
"source": "/production/observability/prometheus",
"destination": "/integrations/observability/prometheus"
},
{
"source": "/guides/triggers/configure-triggers-in-code",
"destination": "/orchestration/triggers/configure-triggers-in-code"
},
{
"source": "/guides/triggers/events/aws",
"destination": "/orchestration/triggers/events/aws"
},
{
"source": "/guides/triggers/events/overview",
"destination": "/orchestration/triggers/events/overview"
},
{
"source": "/guides/schedule-pipelines",
"destination": "/orchestration/triggers/schedule-pipelines"
},
{
"source": "/guides/trigger-pipeline-api",
"destination": "/orchestration/triggers/trigger-pipeline-api"
},
{
"source": "/production/configuring-production-settings/secrets",
"destination": "/production/deploying-to-cloud/secrets/AWS"
},
{
"source": "/development/secrets/GCP",
"destination": "/production/deploying-to-cloud/secrets/GCP"
},
{
"source": "/developing-in-the-cloud/cloud-dev-environments/aws-ecs",
"destination": "/production/developing-in-the-cloud/cloud-dev-environments/aws-ecs"
},
{
"source": "/developing-in-the-cloud/cloud-dev-environments/cloud-run",
"destination": "/production/developing-in-the-cloud/cloud-dev-environments/cloud-run"
},
{
"source": "/developing-in-the-cloud/cloud-dev-environments/kubernetes",
"destination": "/production/developing-in-the-cloud/cloud-dev-environments/kubernetes"
},
{
"source": "/developing-in-the-cloud/cloud-dev-environments/overview",
"destination": "/production/developing-in-the-cloud/cloud-dev-environments/overview"
},
{
"source": "/developing-in-the-cloud/workspaces/kubernetes",
"destination": "/production/developing-in-the-cloud/workspaces/kubernetes"
},
{
"source": "/developing-in-the-cloud/workspaces/overview",
"destination": "/production/developing-in-the-cloud/workspaces/overview"
},
{
"source": "/streaming/destinations/amazon-s3",
"destination": "/guides/streaming/destinations/amazon-s3"
},
{
"source": "/streaming/destinations/bigquery",
"destination": "/guides/streaming/destinations/bigquery"
},
{
"source": "/streaming/destinations/clickhouse",
"destination": "/guides/streaming/destinations/clickhouse"
},
{
"source": "/streaming/destinations/duckdb",
"destination": "/guides/streaming/destinations/duckdb"
},
{
"source": "/streaming/destinations/dummy",
"destination": "/guides/streaming/destinations/dummy"
},
{
"source": "/streaming/destinations/elasticsearch",
"destination": "/guides/streaming/destinations/elasticsearch"
},
{
"source": "/streaming/destinations/kafka",
"destination": "/guides/streaming/destinations/kafka"
},
{
"source": "/streaming/destinations/kinesis",
"destination": "/guides/streaming/destinations/kinesis"
},
{
"source": "/streaming/destinations/mongodb",
"destination": "/guides/streaming/destinations/mongodb"
},
{
"source": "/streaming/destinations/mssql",
"destination": "/guides/streaming/destinations/mssql"
},
{
"source": "/streaming/destinations/mysql",
"destination": "/guides/streaming/destinations/mysql"
},
{
"source": "/streaming/destinations/opensearch",
"destination": "/guides/streaming/destinations/opensearch"
},
{
"source": "/streaming/destinations/postgres",
"destination": "/guides/streaming/destinations/postgres"
},
{
"source": "/streaming/destinations/redshift",
"destination": "/guides/streaming/destinations/redshift"
},
{
"source": "/streaming/destinations/snowflake",
"destination": "/guides/streaming/destinations/snowflake"
},
{
"source": "/streaming/destinations/trino",
"destination": "/guides/streaming/destinations/trino"
},
{
"source": "/streaming/sources/amazon-sqs",
"destination": "/guides/streaming/sources/amazon-sqs"
},
{
"source": "/streaming/sources/azure-event-hub",
"destination": "/guides/streaming/sources/azure-event-hub"
},
{
"source": "/streaming/sources/google-cloud-pubsub",
"destination": "/guides/streaming/sources/google-cloud-pubsub"
},
{
"source": "/streaming/sources/kafka",
"destination": "/guides/streaming/sources/kafka"
},
{
"source": "/streaming/sources/kinesis",
"destination": "/guides/streaming/sources/kinesis"
},
{
"source": "/streaming/sources/oracledb",
"destination": "/guides/streaming/sources/oracledb"
},
{
"source": "/guides/streaming-pipeline-rabbitmq",
"destination": "/guides/streaming/tutorials/streaming-pipeline-rabbitmq"
},
{
"source": "/data-integrations/sources/adapt-existing-source",
"destination": "/contributing/data-integrations/adapt-existing-source"
},
{
"source": "/data-integrations/sources/add-new-source",
"destination": "/contributing/data-integrations/add-new-source"
},
{
"source": "/data-integrations/destination/add-new-destination",
"destination": "/contributing/data-integrations/add-new-destination"
},
{
"source": "/development/git/generate-an-ssh-token",
"destination": "/development/git/configure#generate-ssh-token"
},
{
"source": "/development/git/configure",
"destination": "/guides/git/configure"
},
{
"source": "/production/data-sync/github",
"destination": "/production/data-sync/version-control"
}
]
}