Getting Started>Use with AI

Use with AI

Zyene Reviews is hosted, proprietary software. You do not run our codebase, you integrate from your project (Node, Python, workers, automation tools) using the public HTTP API and an API key from the dashboard. Use this page when you want Cursor, Copilot, or similar tools to follow our docs while you build.

Overview

Add our doc URLs as context in your editor.
Generate code that calls /api/v1/… on your Zyene host.
Store zy_ keys only in your secrets, never in source or chat logs.

Doc URLs

Paste into your AI tool or attach as documentation context:

bash

# API Reference ,  auth, payloads, errorshttps://zyenereviews.com/docs/api # Cookbook ,  curl recipeshttps://zyenereviews.com/docs/cookbook

What to paste

Tell the model:

To follow the API Reference for headers (X-API-Key or Bearer) and JSON bodies.
Your rules: SMS vs email, rate limits, PII handling, idempotency.
To read the real key from your environment (for example ZYENE_API_KEY), never inline a production key.

Keys & safety

Keys are bound to one business. Rotate in Integrations if a key leaks. Prefer server-to-server calls so keys never ship to browsers or client analytics.