Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cuey.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Requirements

​
Install the Package

Install the cuey package using your preferred package manager: 
npm install cuey

​
Configuration

After obtaining your API key from the dashboard, set it as an environment variable named CUEY_API_KEY:

​
Usage

Use the default cuey instance, which automatically reads the CUEY_API_KEY environment variable: 
import { cuey } from "cuey";

await cuey.schedule({ ... });
The cuey instance is a pre-configured client that uses the CUEY_API_KEY environment variable for authentication. For advanced configuration options, see the Advanced Configuration guide.

​
Next Steps

Quick Start

Follow the quick start guide to schedule your first webhook.

TypeScript SDK Overview

Learn about the client API and available methods.

Advanced Configuration

Deep dive into configuration options.

REST API

Explore the REST API documentation.