Skip to main content

​
Welcome

Welcome to the Zudu AI API documentation for external customers.
This guide will help you get started with authentication and making your first API calls.

​
Prerequisites

Before you begin, make sure you have:
  • An active organization account
  • Access to your organization portal
  • Permission to generate API keys

​
Quick Start

​
Step 1: Generate API Keys

Log in to your organization portal and navigate to Settings → API Keys.
Click Generate New API Key to create a new API key pair.

​
Step 2: Store Credentials Securely

Copy both the API key and the API secret immediately.
  • API keys start with sk_
  • API secrets start with s3cr3t_
The API secret is shown only once and cannot be retrieved later.

​
Step 3: Make Your First API Call

Use the API key and API secret in request headers to authenticate your API calls.

​
Base URL

All API endpoints are available at: https://api.zudu.ai

​
Authentication

All API requests require authentication using both headers:
  • X-API-KEY: Your API key
  • X-API-SECRET: Your API secret
The organization ID is automatically derived from the API key and secret.
You do not need to pass an organization ID explicitly.

​
Example Request

curl -X GET "https://api.zudu.ai/api/agents" \
  -H "X-API-KEY: sk_example_key" \
  -H "X-API-SECRET: s3cr3t_example_secret"

Response Format

All API responses follow a consistent structure:

{
  "message": "Operation completed successfully",
  "status": "success",
  "error": null,
  "data": {}
}