# Sluice

## Docs

- [Agent Configuration](https://docs.sluice.sh/agent/configuration.md): Complete reference for the Sluice Go agent — all environment variables, defaults, and behaviors.
- [Authentication](https://docs.sluice.sh/api/authentication.md): How to authenticate with the Sluice API using API keys or session cookies.
- [GET /api/events/stream](https://docs.sluice.sh/api/events-stream.md): Server-Sent Events stream for real-time job, worker, and queue updates.
- [GET /api/health](https://docs.sluice.sh/api/health.md): Health check endpoint — no authentication required.
- [POST /api/ingest](https://docs.sluice.sh/api/ingest.md): Ingest events from the Sluice SDK or Go agent.
- [POST /api/jobs/bulk/retry](https://docs.sluice.sh/api/jobs/bulk-retry.md): Retry multiple failed or cancelled jobs at once.
- [POST /api/jobs/bulk/revoke](https://docs.sluice.sh/api/jobs/bulk-revoke.md): Revoke (cancel) multiple active or queued jobs at once.
- [GET /api/jobs/:id](https://docs.sluice.sh/api/jobs/get.md): Get full detail for a single job, including state history and recent executions.
- [GET /api/jobs](https://docs.sluice.sh/api/jobs/list.md): List and search jobs with filtering, sorting, and cursor-based pagination.
- [POST /api/jobs/:id/retry](https://docs.sluice.sh/api/jobs/retry.md): Retry a single failed or cancelled job.
- [POST /api/jobs/:id/revoke](https://docs.sluice.sh/api/jobs/revoke.md): Revoke (cancel) a single active, queued, or scheduled job.
- [API Overview](https://docs.sluice.sh/api/overview.md): REST API for programmatic access to your Sluice data — jobs, queues, workers, and real-time events.
- [GET /api/queues](https://docs.sluice.sh/api/queues.md): List queues with depth, throughput, failure rate, and health bar data.
- [GET /api/workers](https://docs.sluice.sh/api/workers.md): List workers with status, active job counts, and heartbeat information.
- [Celery Failure Modes](https://docs.sluice.sh/concepts/celery-failure-modes.md): The five most common failure patterns in Celery deployments and how Sluice helps detect them.
- [Data and Privacy](https://docs.sluice.sh/concepts/data-and-privacy.md): What data Sluice collects, where it's stored, and how to delete it.
- [How Sluice Works](https://docs.sluice.sh/concepts/how-it-works.md): Architecture overview — how data flows from your Celery workers to the Sluice dashboard.
- [Job States](https://docs.sluice.sh/concepts/job-states.md): The eight unified states that every job can be in, and how they map from Celery.
- [Introduction](https://docs.sluice.sh/introduction.md): Modern monitoring for Celery job queues — real-time visibility, search, retry, and alerting.
- [Quickstart — Docker Agent](https://docs.sluice.sh/quickstart/agent.md): Monitor Celery with zero code changes using the Sluice Go agent.
- [Quickstart — Python SDK](https://docs.sluice.sh/quickstart/sdk.md): Connect your Celery workers to Sluice in under 2 minutes with the Python SDK.
- [Configuration](https://docs.sluice.sh/sdk/configuration.md): Celery configuration flags that the Sluice SDK manages, and recommendations for optimal monitoring.
- [SDK Reference](https://docs.sluice.sh/sdk/reference.md): Complete reference for the Sluice Python SDK — all parameters, environment variables, and behaviors.
- [Safety Guarantees](https://docs.sluice.sh/sdk/safety.md): How the Sluice SDK protects your production Celery workers.
- [Common Errors](https://docs.sluice.sh/troubleshooting/common-errors.md): Error messages you might encounter and how to fix them — following the Sluice error format.
- [Connection Issues](https://docs.sluice.sh/troubleshooting/connection-issues.md): Troubleshooting Redis connectivity, network problems, and authentication errors.
- [No Data Appearing](https://docs.sluice.sh/troubleshooting/no-data.md): Debugging checklist when jobs aren't showing up in the Sluice dashboard.

## OpenAPI Specs

- [openapi](https://docs.sluice.sh/api-reference/openapi.json)

## Optional

- [GitHub](https://github.com/sluicehq/sluice)
- [Status](https://status.sluice.sh)