Overview

Cygnal Monitor

Monitors content for policy violations.\n\nThis endpoint is used to check if the provided text contains harmful\ncontent or violates a given set of policies.

Cygnal Completions

Create OpenAI-compatible chat completions with Cygnal protection.

Cygnal Anthropic Messages

Create Anthropic-compatible messages with Cygnal protection.

Cygnal Gemini Generate

Create Gemini-compatible generateContent responses with Cygnal protection.

Cygnal Gemini Stream Generate Content

Create Gemini-compatible streaming responses with Cygnal protection.

Cygnal Responses

Process and monitor OpenAI-compatible response requests.\n\nThis endpoint processes completion requests with monitoring capabilities,\nsimilar to the chat completions endpoint.

Get policies for an organization with pagination. By default, returns all policies (no limit). Use limit parameter for pagination. Response includes pagination metadata (total, has_more) to detect truncation.

Create Policy

Create a new policy. The policy will be created under the organization associated with the API key. Requires admin role.

Export Policies

Export all policies for an organization as JSON. Returns policies in a format suitable for import.

Get Policy By Id

Get a policy by ID.

Delete Policy

Delete a policy. Preset policies cannot be deleted. Requires admin role.

Update Policy

Update an existing policy. Only provided fields will be updated. Omit fields to leave them unchanged. Preset policies cannot be modified. Requires admin role.

Export Policy By Id

Export a single policy as JSON. Returns the policy in a format suitable for import.

Get Policy Versions

Get version history for a policy. Returns a list of all versions (metadata only) ordered by timestamp descending.

Get Policy At Version

Get the reconstructed policy state at a specific version. The policy state is reconstructed by applying version diffs in reverse.

Import Policy

Import a single policy from JSON. IDs from the import are ignored; a new ID will be generated. Requires admin role.

Bulk Import Policies

Bulk import multiple policies from JSON. IDs from the import are ignored; new IDs will be generated for each policy. Returns a summary of successful and failed imports. Requires admin role.