Wazza Engine LogoWazza Engine

API Reference

v2.0.1

Complete API reference for Wazza Engine. This documentation is automatically generated from our OpenAPI specification and stays in sync with the latest API changes.

97
Total Endpoints
GET: 52
POST: 27
PUT: 9
DELETE: 9

Base URL

https://api.wazza.aiProduction

Authentication

All API requests require authentication using either JWT tokens or API keys.

JWT Authentication (User Sessions)

Authorization: Bearer YOUR_JWT_TOKEN

API Key Authentication (Service-to-Service)

X-API-Key: YOUR_API_KEY

Rate Limits

API requests are rate-limited based on your subscription tier:

TierRequests/HourCredits/Month
Free5050
Pro500500
Team2,000Custom
Enterprise10,000+Custom

API Endpoints

Browse all 97 available endpoints organized by category. Click any endpoint to view detailed documentation.

Infrastructure

GET
/

API Information

Get basic API information and version

GET
/health

Health Check (Liveness)

Basic health check for load balancer probes

GET
/health/detailed

Detailed Health Check (Readiness)

Component-level health check (database, Redis, memory)

Authentication

POST
/v1/auth/register

Register New User

Create a new user account

POST
/v1/auth/login

Login

Authenticate user and get JWT token

POST
/v1/auth/refresh

Refresh JWT Token

Refresh an expired JWT token using a valid refresh token

POST
/v1/auth/logout

Logout

Logout user and invalidate refresh token

GET
/v1/auth/google

Initiate Google OAuth

Redirect to Google OAuth consent screen with optional return URL. **Multi-Frontend Support**: Use the `state` parameter to specify where tokens should be delivered after authentication. **Example**: - Console: `GET /v1/auth/google?state=https://console.wazza.ai/dashboard` - Standalone App: `GET /v1/auth/google?state=https://app.wazza.ai/home` - No state: Redirects to `FRONTEND_URL` environment variable (default) **Security**: Only whitelisted URLs (configured in `ALLOWED_FRONTEND_URLS`) can receive tokens.

GET
/v1/auth/github

Initiate GitHub OAuth

Redirect to GitHub OAuth consent screen with optional return URL. **Multi-Frontend Support**: Use the `state` parameter to specify where tokens should be delivered after authentication. **Example**: - Console: `GET /v1/auth/github?state=https://console.wazza.ai/dashboard` - Standalone App: `GET /v1/auth/github?state=https://app.wazza.ai/home` - No state: Redirects to `FRONTEND_URL` environment variable (default) **Security**: Only whitelisted URLs (configured in `ALLOWED_FRONTEND_URLS`) can receive tokens.

POST
/v1/auth/forgot-password

Request Password Reset

Send password reset email to user

POST
/v1/auth/reset-password

Reset Password

Reset password using token from email

POST
/v1/auth/verify-email

Verify Email Address

Verify user email using token from verification email

User

GET
/v1/user/profile

Get User Profile

Get the current authenticated user profile

PUT
/v1/user/profile

Update User Profile

Update the current authenticated user profile

PUT
/v1/user/password

Change Password

Change the current authenticated user password

GET
/v1/user/preferences

Get User Preferences

Get the current authenticated user preferences

PUT
/v1/user/preferences

Update User Preferences

Update the current authenticated user preferences

Providers

GET
/v1/providers

List All Providers

Get list of all 13 registered AI providers

GET
/v1/providers/{name}

Get Provider Details

Get detailed information about a specific provider

GET
/v1/providers/{provider}/health

Check Provider Health

Get health status of a specific provider

Models

GET
/v1/models

List All Models

Get list of all 102 AI models with optional filtering

GET
/v1/models/{id}

Get Model Details

Get detailed information about a specific model

Chat Orchestrator

POST
/v1/chat

Send Message to Claude AI

Send a natural language request to Claude AI which automatically routes to the appropriate provider/model

GET
/v1/chat/sessions

Get Active Sessions

Get list of user's active chat sessions

GET
/v1/chat/sessions/{sessionId}

Get Session Information

Get details about a specific chat session

DELETE
/v1/chat/sessions/{sessionId}

Delete Session

Delete a chat session and all its history

GET
/v1/chat/sessions/{sessionId}/history

Get Conversation History

Get full conversation history for a session

POST
/v1/chat/sessions/{sessionId}/clear

Clear Conversation History

Clear all messages from a session while keeping the session active

GET
/v1/chat/sessions/{sessionId}/stats

Get Session Statistics

Get statistics and analytics for a chat session

GET
/v1/chat/model

Get Model Information

Get information about the Claude orchestrator model being used

Generation

POST
/v1/generate

Create Generation Job

Generate image, video, audio, or 3D content directly. **Two Modes**: 1. **Explicit Provider/Model**: Specify `provider` and `model` for direct control 2. **Auto-Routing**: Specify `capability` and `contentType` to let Wazza choose the best provider The job is processed asynchronously. Use the returned `jobId` to check status.

GET
/v1/generate/{jobId}

Get Job Status

Check the status of a generation job and retrieve outputs when completed. **Job Statuses**: - `pending`: Job is queued, waiting to be processed - `processing`: Job is currently being generated - `completed`: Job finished successfully, outputs available - `failed`: Job failed, check error message - `cancelled`: Job was cancelled by user

DELETE
/v1/generate/{jobId}

Cancel Job

Cancel a queued or processing job. **Restrictions**: - Cannot cancel completed or failed jobs - Credits reserved for the job will be refunded

Jobs

GET
/v1/jobs

List Jobs

Get paginated list of generation jobs for the organization

GET
/v1/jobs/stats

Get Job Statistics

Get aggregated statistics about jobs for the organization

Training

GET
/v1/train

List Trained Models

Get list of available trained LoRA models for inference

GET
/v1/train/{id}

Get Training Job Details

Get detailed information about a training job

DELETE
/v1/train/{id}

Delete Trained Model

Delete a trained model and its weights

POST
/v1/train/{id}/infer

Run Inference with Trained Model

Generate images using a trained LoRA model

GET
/v1/train/{id}/progress

Get Training Progress

Get real-time training progress and status

GET
/v1/train/{id}/download

Download Trained Model

Get download URL for trained model weights

Workflows

GET
/v1/workflows

List Workflows

Get list of workflows with optional filtering

POST
/v1/workflows

Create Workflow

Create a new multi-step AI workflow

GET
/v1/workflows/{id}

Get Workflow Details

Get detailed information about a specific workflow

PUT
/v1/workflows/{id}

Update Workflow

Update an existing workflow

DELETE
/v1/workflows/{id}

Delete Workflow

Delete a workflow

POST
/v1/workflows/{id}/execute

Execute Workflow

Execute a workflow with provided inputs

POST
/v1/workflows/search

Search Workflows

Search workflows by query string and filters

POST
/v1/workflows/{id}/publish

Publish Workflow

Make a workflow public for other users

POST
/v1/workflows/{id}/versions

Create Workflow Version

Create a new version of a workflow

POST
/v1/workflows/{id}/plan

Plan Workflow Execution

Analyze workflow and return execution plan without executing

POST
/v1/workflows/{id}/validate

Validate Workflow

Validate workflow configuration and dependencies

Payments

POST
/v1/payments/subscriptions

Create Subscription

Create a new subscription for the organization

PUT
/v1/payments/subscriptions/{id}

Update Subscription

Update an existing subscription (change plan, billing cycle, etc.)

DELETE
/v1/payments/subscriptions/{id}

Cancel Subscription

Cancel an active subscription

GET
/v1/payments/plans

List Subscription Plans

Get all available subscription plans and pricing

GET
/v1/payments/credits/packages

List Credit Packages

Get all available one-time credit packages

POST
/v1/payments/credits/purchase

Purchase Credits

Create a checkout session to purchase credits

GET
/v1/payments/invoices

Get Invoices

Get list of invoices for the organization

GET
/v1/payments/history

Get Payment History

Get payment and credit transaction history

POST
/v1/payments/billing-portal

Create Billing Portal Session

Create a session for the Stripe billing portal where customers can manage subscriptions and payment methods

POST
/webhooks/stripe

Stripe Webhook

Webhook endpoint for Stripe payment events (public, no auth required). Handled events: - checkout.session.completed - Checkout session completed (credit purchases) - payment_intent.succeeded - Payment intent succeeded - customer.subscription.created - Subscription created - customer.subscription.updated - Subscription updated - customer.subscription.deleted - Subscription cancelled - invoice.paid - Invoice paid - invoice.payment_failed - Invoice payment failed

API Keys

GET
/v1/api-keys

List all API keys

Get list of all API keys for the authenticated user's organization. **OPTIMIZED**: Server-side pagination with total count. Returns paginated results and accurate total count in a single optimized query.

POST
/v1/api-keys

Create new API key

Generate a new API key for the organization. The full key is only shown once.

GET
/v1/api-keys/{id}

Get API key details

Get detailed information about a specific API key

PUT
/v1/api-keys/{id}

Update API key

Update API key metadata (name, scopes, rate limit). Cannot update the key itself.

DELETE
/v1/api-keys/{id}

Revoke API key

Revoke an API key (soft delete). The key will no longer be valid for authentication.

GET
/v1/api-keys/{id}/usage

Get API key usage

Get detailed usage statistics for an API key

Credits

GET
/v1/credits/balance

Get credit balance

Get current credit balance for the organization

GET
/v1/credits/usage

Get credit usage

Get credit usage analytics with breakdowns by date, provider, and capability

GET
/v1/credits/transactions

Get credit transactions

Get paginated list of credit transactions (purchases, consumption, refunds)

Organization

GET
/v1/organization

Get organization details

Get organization details with statistics

PUT
/v1/organization

Update organization

Update organization settings

GET
/v1/organization/usage

Get organization usage

Get organization-wide usage statistics aggregated by member, API key, and provider. Returns job statistics, credits consumed, and detailed breakdowns for the specified time period.

GET
/v1/organization/limits

Get organization limits

Get rate limits and quotas for the organization based on plan tier

Audit Logs

GET
/v1/audit-logs

Get audit logs

Get organization audit logs with filtering and pagination (enterprise feature)

Webhooks

POST
/v1/webhooks

Create webhook

Register a new webhook endpoint for receiving event notifications

GET
/v1/webhooks

List webhooks

Get list of all webhook endpoints for the organization

GET
/v1/webhooks/{id}

Get webhook details

Get detailed information about a specific webhook

PUT
/v1/webhooks/{id}

Update webhook

Update webhook endpoint configuration

DELETE
/v1/webhooks/{id}

Delete webhook

Delete a webhook endpoint

POST
/v1/webhooks/{id}/test

Test webhook

Send a test payload to the webhook endpoint to verify it works

GET
/v1/webhooks/{id}/deliveries

Get webhook deliveries

Get delivery logs for a webhook endpoint

Teams

POST
/v1/teams/members

Invite team member

Send an invitation to join the organization

GET
/v1/teams/members

List team members

Get list of all members in the organization

PUT
/v1/teams/members/{id}

Update member role

Change the role of a team member

DELETE
/v1/teams/members/{id}

Remove team member

Remove a member from the organization

GET
/v1/teams/invitations

List invitations

Get list of team invitations

DELETE
/v1/teams/invitations/{id}

Revoke invitation

Cancel a pending team invitation

POST
/v1/teams/invitations/{token}/accept

Accept invitation

Accept a team invitation and join the organization. Requires the user to be authenticated with Bearer token.

Dashboard

GET
/v1/dashboard/stats

Get dashboard statistics

Get aggregated dashboard statistics including credits, jobs, API keys, and recent activity. **OPTIMIZED**: Single-call endpoint that replaces multiple separate API calls with parallel database queries for maximum performance. Returns comprehensive stats in one request: - Credit balances (total, subscription, purchased, reserved) - Job statistics (total, completed, failed, processing, queued) - API key counts (total, active) - Recent activity (last 24 hours)

Analytics

GET
/v1/analytics/overview

Get analytics overview

Get high-level overview statistics for the dashboard

GET
/v1/analytics/usage

Get usage analytics

Get detailed usage analytics with time-series data

GET
/v1/analytics/costs

Get cost analytics

Get cost analysis and spending trends

GET
/v1/analytics/errors

Get error analytics

Get error analytics and failure breakdown

Logs

GET
/v1/logs/requests

Get API request logs

Get paginated list of API request logs with filtering

GET
/v1/logs/jobs/{jobId}

Get job logs

Get detailed logs for a specific job

More Resources

Quickstart Guide

Get started in 5 minutes

Guides & Tutorials

Deep dive into specific use cases

OpenAPI Spec

Download the full OpenAPI specification

SDKs