# Ylem documentation

## Ylem documentation

- [Introduction to Ylem](https://docs.ylem.co/general-information/readme.md): Ylem is a full-cycle data streaming platform.
- [Quick start guide](https://docs.ylem.co/general-information/quick-start-guide.md)
- [Release notes](https://docs.ylem.co/general-information/release-notes.md)
- [Installation](https://docs.ylem.co/open-source-edition/installation.md)
- [Usage of Apache Kafka](https://docs.ylem.co/open-source-edition/usage-of-apache-kafka.md)
- [Task processing architecture](https://docs.ylem.co/open-source-edition/task-processing-architecture.md)
- [Configuring integrations with .env variables](https://docs.ylem.co/open-source-edition/configuring-integrations-with-.env-variables.md)
- [Connecting an integration](https://docs.ylem.co/integrations/connecting-a-data-source.md)
- [Library of integrations](https://docs.ylem.co/integrations/library-of-integrations.md)
- [Amazon Redshift](https://docs.ylem.co/integrations/library-of-integrations/amazon-redshift.md)
- [Apache Kafka](https://docs.ylem.co/integrations/library-of-integrations/apache-kafka.md)
- [APIs](https://docs.ylem.co/integrations/library-of-integrations/apis.md)
- [Atlassian Jira](https://docs.ylem.co/integrations/library-of-integrations/atlassian-jira.md)
- [AWS Lambda](https://docs.ylem.co/integrations/library-of-integrations/aws-lambda.md)
- [AWS RDS](https://docs.ylem.co/integrations/library-of-integrations/aws-rds.md)
- [AWS S3](https://docs.ylem.co/integrations/library-of-integrations/aws-s3.md)
- [ClickHouse](https://docs.ylem.co/integrations/library-of-integrations/clickhouse.md)
- [ElasticSearch](https://docs.ylem.co/integrations/library-of-integrations/elasticsearch.md)
- [E-mail](https://docs.ylem.co/integrations/library-of-integrations/e-mail.md)
- [Google Big Query](https://docs.ylem.co/integrations/library-of-integrations/google-big-query.md)
- [Google Cloud SQL](https://docs.ylem.co/integrations/library-of-integrations/google-cloud-sql.md)
- [Google Pub/Sub](https://docs.ylem.co/integrations/library-of-integrations/google-pub-sub.md)
- [Google Sheets](https://docs.ylem.co/integrations/library-of-integrations/google-sheets.md)
- [Immuta](https://docs.ylem.co/integrations/library-of-integrations/immuta.md)
- [Incident.io](https://docs.ylem.co/integrations/library-of-integrations/incident.io.md)
- [Jenkins](https://docs.ylem.co/integrations/library-of-integrations/jenkins.md)
- [Hubspot](https://docs.ylem.co/integrations/library-of-integrations/hubspot.md)
- [Microsoft Azure SQL](https://docs.ylem.co/integrations/library-of-integrations/microsoft-azure-sql.md)
- [MySQL](https://docs.ylem.co/integrations/library-of-integrations/mysql.md)
- [OpenAI ChatGPT](https://docs.ylem.co/integrations/library-of-integrations/openai-chatgpt.md)
- [Opsgenie](https://docs.ylem.co/integrations/library-of-integrations/opsgenie.md)
- [PostgreSQL](https://docs.ylem.co/integrations/library-of-integrations/postgresql.md)
- [PlanetScale](https://docs.ylem.co/integrations/library-of-integrations/planetscale.md)
- [RabbitMQ](https://docs.ylem.co/integrations/library-of-integrations/rabbitmq.md)
- [Salesforce](https://docs.ylem.co/integrations/library-of-integrations/salesforce.md)
- [Slack](https://docs.ylem.co/integrations/library-of-integrations/slack.md)
- [Snowflake](https://docs.ylem.co/integrations/library-of-integrations/snowflake.md)
- [Tableau](https://docs.ylem.co/integrations/library-of-integrations/tableau.md)
- [Twilio. SMS](https://docs.ylem.co/integrations/library-of-integrations/twilio.-sms.md)
- [WhatsApp (through Twilio)](https://docs.ylem.co/integrations/library-of-integrations/whatsapp-through-twilio.md)
- [Initial demo data source](https://docs.ylem.co/integrations/trial-data-source.md)
- [Pipeline management](https://docs.ylem.co/pipelines/pipeline-management.md)
- [Tasks](https://docs.ylem.co/pipelines/tasks-ip.md)
- [Aggregator](https://docs.ylem.co/pipelines/tasks-ip/aggregator.md)
- [API Call](https://docs.ylem.co/pipelines/tasks-ip/api-call.md)
- [Code](https://docs.ylem.co/pipelines/tasks-ip/code.md)
- [Condition](https://docs.ylem.co/pipelines/tasks-ip/condition.md)
- [External trigger](https://docs.ylem.co/pipelines/tasks-ip/external-trigger.md)
- [Filter](https://docs.ylem.co/pipelines/tasks-ip/filter.md)
- [For each](https://docs.ylem.co/pipelines/tasks-ip/for-each.md)
- [GPT](https://docs.ylem.co/pipelines/tasks-ip/gpt.md)
- [Merge](https://docs.ylem.co/pipelines/tasks-ip/merge.md)
- [Notification](https://docs.ylem.co/pipelines/tasks-ip/notification.md)
- [Query](https://docs.ylem.co/pipelines/tasks-ip/query.md)
- [Pipeline runner](https://docs.ylem.co/pipelines/tasks-ip/pipeline-runner.md)
- [Processor](https://docs.ylem.co/pipelines/tasks-ip/processor.md)
- [Transformer](https://docs.ylem.co/pipelines/tasks-ip/transformers.md)
- [Running and scheduling pipelines](https://docs.ylem.co/pipelines/running-and-scheduling-workflows.md)
- [Library of templates](https://docs.ylem.co/pipelines/library-of-templates.md)
- [Environment variables](https://docs.ylem.co/pipelines/environment-variables.md)
- [Mathematical functions and operations](https://docs.ylem.co/pipelines/mathematical-functions.md)
- [Formatting of messages](https://docs.ylem.co/pipelines/formatting-of-messages.md)
- [Statistics of runs](https://docs.ylem.co/statistics-and-profiling/statistics-of-runs.md)
- [Slow tasks](https://docs.ylem.co/statistics-and-profiling/slow-tasks.md)
- [Metric management](https://docs.ylem.co/metrics/metric-management.md)
- [Using previous values of a metric](https://docs.ylem.co/metrics/using-the-average-value-of-a-metric.md)
- [Use cases](https://docs.ylem.co/use-cases/use-cases.-homepage.md)
- [Messaging patterns](https://docs.ylem.co/use-cases/messaging-patterns.md)
- [Datatype Channel](https://docs.ylem.co/use-cases/messaging-patterns/datatype-channel.md)
- [Message Dispatcher](https://docs.ylem.co/use-cases/messaging-patterns/message-dispatcher.md)
- [Messaging Bridge](https://docs.ylem.co/use-cases/messaging-patterns/messaging-bridge.md)
- [Message Bus](https://docs.ylem.co/use-cases/messaging-patterns/message-bus.md)
- [Message Filter](https://docs.ylem.co/use-cases/messaging-patterns/message-filter.md)
- [Message Router](https://docs.ylem.co/use-cases/messaging-patterns/message-router.md)
- [Point-to-Point Channel](https://docs.ylem.co/use-cases/messaging-patterns/point-to-point-channel.md)
- [Publish-Subscribe Channel](https://docs.ylem.co/use-cases/messaging-patterns/publish-subscribe-channel.md)
- [Pull-Push](https://docs.ylem.co/use-cases/messaging-patterns/pull-push.md)
- [Functional use cases](https://docs.ylem.co/use-cases/functional-use-cases.md)
- [Streaming from Apache Kafka and messaging queues](https://docs.ylem.co/use-cases/functional-use-cases/streaming-from-apache-kafka-and-messaging-queues.md): Since Ylem is a real-time streaming platform, our goal is to provide you with a tool with which you can deliver your data from one place to another as fast as possible.
- [Streaming from APIs](https://docs.ylem.co/use-cases/functional-use-cases/streaming-from-apis.md)
- [Streaming from databases](https://docs.ylem.co/use-cases/functional-use-cases/streaming-from-databases.md)
- [Data orchestration, transformation and processing](https://docs.ylem.co/use-cases/functional-use-cases/data-orchestration-transformation-and-processing.md)
- [Usage of Python and Pandas](https://docs.ylem.co/use-cases/functional-use-cases/usage-of-python-and-pandas.md)
- [KPI Monitoring](https://docs.ylem.co/use-cases/functional-use-cases/kpi-monitoring.md)
- [OKRs and custom metrics](https://docs.ylem.co/use-cases/functional-use-cases/okrs-and-custom-metrics.md)
- [Data Issues & Incidents](https://docs.ylem.co/use-cases/functional-use-cases/data-issue-monitoring.md)
- [Reporting](https://docs.ylem.co/use-cases/functional-use-cases/reporting.md)
- [Other functional use cases](https://docs.ylem.co/use-cases/functional-use-cases/other-functional-use-cases.md)
- [Industry-specific use cases](https://docs.ylem.co/use-cases/industry-specific-use-cases.md)
- [Finance and Payments](https://docs.ylem.co/use-cases/industry-specific-use-cases/finance-and-payments.md)
- [E-commerce & Logistics](https://docs.ylem.co/use-cases/industry-specific-use-cases/e-commerce.md)
- [Customer Success](https://docs.ylem.co/use-cases/industry-specific-use-cases/customer-success.md)
- [Security, Risk, and Anti-Fraud](https://docs.ylem.co/use-cases/industry-specific-use-cases/security-risk-aml-and-fraud.md)
- [Anti-Money Laundering (AML)](https://docs.ylem.co/use-cases/industry-specific-use-cases/anti-money-laundering-aml.md)
- [OAuth clients](https://docs.ylem.co/api/oauth-clients.md)
- [API Reference](https://docs.ylem.co/api/api-endpoints.md)
- [FAQ](https://docs.ylem.co/other-resources/faq.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.ylem.co/general-information/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
