# Welcome

## Welcome to WinBay API Documentation

Welcome to the official documentation for WinBay API! Here, you'll find comprehensive guides and detailed references to help you start using our API effectively.

### Overview

WinBay API provides unified access to over 100 top AI models, allowing you to integrate cutting-edge AI capabilities into your applications seamlessly. Our platform is designed to be scalable, reliable, and easy to use, ensuring that you can focus on building great products without worrying about the underlying infrastructure.

### Key Features

* **Unified AI Access:** Connect to a wide range of AI models with a single API.
* **Pay-As-You-Go:** Enjoy transparent pricing with no subscriptions or long-term commitments. You only pay for what you use.
* **Enterprise-Grade Platform:** Benefit from a scalable and reliable infrastructure with enterprise-level security and 99.9% uptime.

### Getting Started

To get started with WinBay API, follow these simple steps:

1. **Sign Up:** Create an account on our platform to get your API keys.
2. **Explore the Documentation:** Browse through our guides and API references to understand how to use our services.
3. **Make Your First API Call:** Use our examples and tutorials to make your first API request and see the power of WinBay API in action.

### Support

If you have any questions or need assistance, feel free to reach out to our support team. We're here to help you make the most out of WinBay API.

Happy coding!

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Rapidapi.com</td><td>Winbay API Hub</td><td><a href="/files/fuceERdiPn1fIO44gacC">/files/fuceERdiPn1fIO44gacC</a></td><td></td><td><a href="https://rapidapi.com/organization/winbay-tech">https://rapidapi.com/organization/winbay-tech</a></td></tr><tr><td><strong>Perplexity API</strong></td><td>Perplexity X Google Search API</td><td><a href="/files/D5TRpw4UUdO2uNqh2fAR">/files/D5TRpw4UUdO2uNqh2fAR</a></td><td></td><td><a href="https://rapidapi.com/winbay-tech-ai/api/perplexity-api">https://rapidapi.com/winbay-tech-ai/api/perplexity-api</a></td></tr><tr><td>Google Search Scraper</td><td>Precise Search, Optimize Marketing Strategies</td><td><a href="/files/GtxNEStK1FIFm8qhFutm">/files/GtxNEStK1FIFm8qhFutm</a></td><td></td><td><a href="https://rapidapi.com/winbay-tech-ai/api/google-search-scraper">https://rapidapi.com/winbay-tech-ai/api/google-search-scraper</a></td></tr></tbody></table>


# Quickstart

<figure><img src="https://gitbookio.github.io/onboarding-template-images/quickstart-hero.png" alt=""><figcaption></figcaption></figure>

Beautiful documentation starts with the content you create — and GitBook makes it easy to get started with any pre-existing content.

{% hint style="info" %}
Want to learn about writing content from scratch? Head to the [Basics](/api-hub/flux-text-to-image-ai) section to learn more.
{% endhint %}

### Import

GitBook supports importing content from many popular writing tools and formats. If your content already exists, you can upload a file or group of files to be imported.

<div data-full-width="false"><figure><img src="https://gitbookio.github.io/onboarding-template-images/quickstart-import.png" alt=""><figcaption></figcaption></figure></div>

### Sync a repository

GitBook also allows you to set up a bi-directional sync with an existing repository on GitHub or GitLab. Setting up Git Sync allows you and your team to write content in GitBook or in code, and never have to worry about your content becoming out of sync.


# AI API

## WinBay AI API Documentation

### Introduction

Welcome to the WinBay API documentation. This guide will help you understand how to interact with our API to leverage over 100 AI models. Whether you're looking to integrate AI capabilities into your applications or automate workflows, our API provides a seamless experience.

### Getting Started

To start using WinBay API, follow these simple steps:

1. **Sign Up:** Register on our platform to get your API credentials.
2. **API Key:** Retrieve your API key from the dashboard.
3. **Make API Requests:** Use the API key to authenticate and start making requests to our API endpoints.

### Authentication

To authenticate API requests, include your API key in the request headers:

```http
Authorization: Bearer YOUR_API_KEY
```

Replace `YOUR_API_KEY` with your actual API key obtained from the dashboard.

### API Reference

#### Chat Endpoint

**URL:** `https://api.winbay.io/v1/chat/completions`

**Method:** `POST`

**Description:** Use this endpoint to interact with our AI models for chat-based applications.

**Request Body:**

```
{
  "model": "model_name",
  "messages": [
    {"role": "system", "content": "Your initial prompt here"},
    {"role": "user", "content": "Your message here"}
  ]
}
```

**Parameters:**

* `model`: Specify the AI model you want to use.
* `messages`: An array of message objects, each with a `role` ("system", "user", or "assistant") and `content` (the message text).

**Example Request:**

```
curl -X POST https://api.winbay.io/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "model": "model_name",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello, how can you help me today?"}
  ]
}'
```

### Example Use Cases

Here are some examples of how you can use the WinBay API:

* **Customer Support Chatbot:** Automate responses to customer inquiries.
* **Content Generation:** Generate articles, summaries, or creative content.
* **Data Analysis:** Analyze and interpret complex data sets.

### Pricing

Our pricing model is pay-as-you-go. You only pay for the resources you consume. For detailed pricing information, visit our [Pricing Page](https://api.winbay.io/pricing).

### Support and FAQ

For any questions or issues, please refer to our FAQ section or contact our support team at <support@winbay.io>.


# OpenAPI

You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation.

### OpenAPI block

GitBook's OpenAPI block is powered by [Scalar](https://scalar.com/), so you can test your APIs directly from your docs.

{% openapi src="<https://petstore3.swagger.io/api/v3/openapi.json>" path="/pet" method="post" %}
<https://petstore3.swagger.io/api/v3/openapi.json>
{% endopenapi %}


# Integrations

Winbay - Fast AI Inference & Multifunctional API Platform

<figure><img src="/files/GXeEi9PhvLsQlSqWDxej" alt=""><figcaption></figcaption></figure>

### Types of integrations

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-card-target data-type="content-ref"></th><th></th><th data-hidden></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><h2>Perplexity</h2></td><td>More convenient Perplexity API</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/perplexity2">https://rapidapi.com/winbay-tech-ai/api/perplexity2</a></td><td>Our API is engineered to streamline the process of data retrieval, allowing users to effortlessly access a wealth of information from Google's vast database. Whether you're conducting market research, tracking trends, or optimizing content, our API provides the tools necessary to extract meaningful data efficiently.</td><td><p>Our API is engineered to streamline the process of data retrieval, allowing users to effortlessly access a wealth of information from Google's vast database. Whether you're conducting market research, tracking trends, or optimizing content, our API provides the tools necessary to extract meaningful data efficiently.</p><p>At the heart of our API is a sophisticated AI engine that analyzes and organizes information, identifying patterns and trends that might otherwise go unnoticed. This capability enables users to gain a deeper understanding of consumer behavior, market dynamics, and emerging opportunities. By harnessing the power of AI, our API not only simplifies data analysis but also enhances the accuracy and relevance of the insights generated.</p><p>The API is highly versatile, catering to a wide range of applications across various industries. From marketing professionals seeking to optimize their campaigns to researchers exploring societal trends, our API offers a comprehensive solution for data-driven decision-making. Its user-friendly interface and robust features make it an invaluable asset for anyone looking to leverage data to achieve their goals.</p><p>In a rapidly evolving digital landscape, staying ahead of the curve is essential. Our API equips users with the tools needed to navigate this landscape effectively, providing them with a competitive edge. By integrating our API into your workflow, you can unlock new possibilities, drive innovation, and achieve better outcomes. Experience the future of data analysis with our API and discover how it can revolutionize the way you approach information.</p><p>Perplexity X Google Search API is a powerful tool designed to help users effortlessly search and analyze Google data. With advanced AI capabilities, this API quickly organizes and analyzes information, providing valuable insights to enhance decision-making. Whether for market research, trend analysis, or content optimization, Perplexity X delivers precise data support, giving you a competitive edge in today's fast-paced digital landscape.</p></td><td><a href="/files/o9YOZ9e76uR7Nrt6Cs6g">/files/o9YOZ9e76uR7Nrt6Cs6g</a></td></tr><tr><td><h2>DeepSeek V3 API</h2></td><td>We present DeepSeek-V3, a strong Mixture-of-Experts (MoE) language model with 671B total parameters with 37B activated for each token.</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/deepseek-v3-api/playground">https://rapidapi.com/winbay-tech-ai/api/deepseek-v3-api/playground</a></td><td>We present DeepSeek-V3, a strong Mixture-of-Experts (MoE) language model with 671B total parameters with 37B activated for each token. To achieve efficient inference and cost-effective training, DeepSeek-V3 adopts Multi-head Latent Attention (MLA) and DeepSeekMoE architectures, which were thoroughly validated in DeepSeek-V2. Furthermore, DeepSeek-V3 pioneers an auxiliary-loss-free strategy for load balancing and sets a multi-token prediction training objective for stronger performance.</td><td></td><td><a href="/files/4Ny780qN27AN4ZEZIv78">/files/4Ny780qN27AN4ZEZIv78</a></td></tr><tr><td><h2>Google Search</h2></td><td>Google Search Scraper API: Elevate Your SEO and PPC Monitoring</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/google-search122">https://rapidapi.com/winbay-tech-ai/api/google-search122</a></td><td>The Google Search Scraper API provides precise, structured search data to enhance your search engine optimization and pay-per-click advertising strategies. With this powerful tool, you can effortlessly track keyword ranking changes, verify PPC ad visibility, and boost your overall SEO monitoring efforts. Whether you're a digital marketing expert or a business owner, the Google Search Scraper API helps you stand out in the competitive online market.</td><td></td><td><a href="/files/MxUQNMV3zy1fpHmQ9YkE">/files/MxUQNMV3zy1fpHmQ9YkE</a></td></tr><tr><td><h2>DeepSeek R1 API</h2></td><td>DeepSeek R1 is an open-source large language model designed specifically for reasoning-intensive tasks</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/deepseek-r1-api1">https://rapidapi.com/winbay-tech-ai/api/deepseek-r1-api1</a></td><td>DeepSeek R1 is an open-source large language model designed specifically for reasoning-intensive tasks, aiming to address complex tasks requiring logical inference, mathematical problem-solving, and real-time decision-making. It directly competes with OpenAI’s o1 model, delivering comparable performance in many reasoning tasks while operating at significantly lower costs. Built on DeepSeek’s V3 base model, R1 employs a Mixture of Experts (MoE) architecture with 671 billion parameters, activating only 37 billion parameters per forward pass, thereby improving computational efficiency.</td><td></td><td><a href="/files/4Ny780qN27AN4ZEZIv78">/files/4Ny780qN27AN4ZEZIv78</a></td></tr><tr><td><h2>OPENAI Text to Speech</h2></td><td>Voice Assistants and Chatbots: Combine with GPT models to create conversational voice assistants, similar to J.A.R.V.I.S.</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/openai-text-to-speech">https://rapidapi.com/winbay-tech-ai/api/openai-text-to-speech</a></td><td><p>Voice Assistants and Chatbots: Combine with GPT models to create conversational voice assistants, similar to J.A.R.V.I.S.</p><p>Audiobooks and Content Creation: Convert books, blogs, or articles into audio, enabling rapid creation of audiobooks or podcasts without manual recording.</p><p>Language Learning: Provide standardized pronunciation for language learners, supporting multilingual speech practice.</p><p>Accessibility Tools: Offer text-to-speech functionality for visually impaired users or generate audio for video captions.</p></td><td></td><td><a href="/files/yfYeoFZiipoWy6KzIVsM">/files/yfYeoFZiipoWy6KzIVsM</a></td></tr><tr><td><h2>Qwen3-235b-A22b</h2></td><td>The Qwen3-235B-A22B is a Mixture of Experts (MoE) model from Alibaba Cloud’s Qwen3 series, released in April 2025.</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/qwen3-235b-a22b">https://rapidapi.com/winbay-tech-ai/api/qwen3-235b-a22b</a></td><td>The Qwen3-235B-A22B is a Mixture of Experts (MoE) model from Alibaba Cloud’s Qwen3 series, released in April 2025. With a total of 235 billion parameters but only 22 billion activated during inference, it delivers top-tier performance with high efficiency. Built for advanced reasoning, multilingual tasks, and agentic workflows, it competes with models like DeepSeek-R1 and OpenAI o1.</td><td></td><td><a href="/files/AmOUIweGDTPz8qh3Y4BM">/files/AmOUIweGDTPz8qh3Y4BM</a></td></tr><tr><td><h2>OPEN AI GPT-4.1</h2></td><td>Superior Performance: Outperforms earlier models in reasoning, coding, and creative tasks, with high benchmark scores.</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/open-ai-gpt-4-1">https://rapidapi.com/winbay-tech-ai/api/open-ai-gpt-4-1</a></td><td><p>Superior Performance: Outperforms earlier models in reasoning, coding, and creative tasks, with high benchmark scores.</p><p>Versatility: Handles diverse applications, from coding to content generation to visual analysis.</p><p>Scalability: Suitable for enterprise-grade applications requiring robust processing of large datasets.</p><p>Improved Efficiency: Optimized for better accuracy and lower latency compared to GPT-4.</p><p>Developer-Friendly: Offers comprehensive documentation, SDKs, and tools for easy integration.</p></td><td></td><td><a href="/files/exhi5AFBZhslrNHVFi63">/files/exhi5AFBZhslrNHVFi63</a></td></tr><tr><td><h2>OPEN AI GPT-4.1-Mini</h2></td><td>Affordable Performance: Offers a strong balance of capability and cost, ideal for startups or small-scale projects.</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/open-ai-gpt-4-1-mini">https://rapidapi.com/winbay-tech-ai/api/open-ai-gpt-4-1-mini</a></td><td><p>Affordable Performance: Offers a strong balance of capability and cost, ideal for startups or small-scale projects.</p><p>Speed: Faster than larger models, supporting real-time applications with minimal latency.</p><p>Versatility: Handles a range of tasks, from text generation to basic image analysis, with reliable results.</p><p>Improved Reasoning: Enhanced instruction-following and reduced errors compared to earlier mini models.</p></td><td></td><td><a href="/files/exhi5AFBZhslrNHVFi63">/files/exhi5AFBZhslrNHVFi63</a></td></tr><tr><td><h2>Flux Text to image AI</h2></td><td>Text-to-Image Generation</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/flux-text-to-image-ai">https://rapidapi.com/winbay-tech-ai/api/flux-text-to-image-ai</a></td><td><p>High-Quality Output: Produces high-resolution images with rich details, suitable for professional use.</p><p>Style Customization: Specify artistic styles (e.g., realistic, cartoon, oil painting) through parameters.</p><p>Fast Response: Optimized architecture ensures rapid image generation for real-time applications.</p><p>Multilingual Support: Accepts text inputs in multiple languages, catering to global users.</p></td><td></td><td><a href="/files/VB7D9Fhwf2kdtT716Esy">/files/VB7D9Fhwf2kdtT716Esy</a></td></tr><tr><td><h2>Turbo Text to Image AI</h2></td><td>Advantages allows users to generate any type of image, including pornographic content (NSFW) or images involving internet celebrities and public figures.</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/turbo-text-to-image-ai">https://rapidapi.com/winbay-tech-ai/api/turbo-text-to-image-ai</a></td><td><p>Advantages allows users to generate any type of image, including pornographic content (NSFW) or images involving internet celebrities and public figures.</p><p>Maximum Creative Freedom: No restrictions on specific characters or legal themes, supporting diverse creative needs.</p><p>High-Quality Output: Generates visually stunning, high-resolution images comparable to professional designs.</p><p>Easy Integration: Simple API design suitable for beginners and experienced developers.</p><p>Considerations Responsible Use: Users must adhere to legal and ethical guidelines, avoiding harmful or infringing content.</p><p>Copyright Awareness: Generated images involving existing characters or brands may require permission from rights holders.</p><p>Privacy Protection: Prompts and generated images are stored locally to ensure data privacy.</p></td><td></td><td><a href="/files/4RjxdRo6wq94db8BILTu">/files/4RjxdRo6wq94db8BILTu</a></td></tr><tr><td><h2>Amazon Real Time Data Scraper</h2></td><td>API Overview Amazon Real-Time Data Scraper API: Elevate Your E-commerce Insights</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/amazon-real-time-data-scraper">https://rapidapi.com/winbay-tech-ai/api/amazon-real-time-data-scraper</a></td><td>The Amazon Real-Time Data Scraper API delivers precise, structured e-commerce data to enhance your market analysis and business strategies. With this powerful tool, you can effortlessly track product listings, monitor pricing trends, and boost your overall market monitoring efforts. Whether you're an e-commerce specialist or a business owner, the Amazon Real-Time Data Scraper API helps you stay ahead in the competitive online marketplace.</td><td></td><td><a href="/files/78TXuR1IS4vhHojJnmGV">/files/78TXuR1IS4vhHojJnmGV</a></td></tr><tr><td><h2>Google Search Scraper</h2></td><td>Google Search Scraper API: Elevate Your SEO and PPC Monitoring</td><td><a href="https://rapidapi.com/winbay-tech-ai/api/google-search-scraper">https://rapidapi.com/winbay-tech-ai/api/google-search-scraper</a></td><td>The Google Search Scraper API provides precise, structured search data to enhance your search engine optimization and pay-per-click advertising strategies. With this powerful tool, you can effortlessly track keyword ranking changes, verify PPC ad visibility, and boost your overall SEO monitoring efforts. Whether you're a digital marketing expert or a business owner, the Google Search Scraper API helps you stand out in the competitive online market.</td><td></td><td><a href="/files/MxUQNMV3zy1fpHmQ9YkE">/files/MxUQNMV3zy1fpHmQ9YkE</a></td></tr></tbody></table>


# Flux Text to image AI

{% embed url="<https://rapidapi.com/winbay-tech-ai/api/flux-text-to-image-ai>" %}

**API Overview**

Text-to-Image Generation: Input a text prompt (e.g., "A unicorn in a forest at night") to generate corresponding images.

High-Quality Output: Produces high-resolution images with rich details, suitable for professional use.

Style Customization: Specify artistic styles (e.g., realistic, cartoon, oil painting) through parameters.

Fast Response: Optimized architecture ensures rapid image generation for real-time applications.

Multilingual Support: Accepts text inputs in multiple languages, catering to global users.

The FLUX API, powered by the FLUX.1 model developed by Black Forest Labs, is a cutting-edge application programming interface designed for generating high-quality images from text prompts. Leveraging advanced diffusion models and neural networks, FLUX.1 enables developers to create vivid, detailed visuals based on natural language descriptions, making it ideal for creative design, content creation, game development, and more.

"prompt": "A photorealistic majestic deep forest landscape, towering ancient oak trees with gnarled branches covered in lush green moss, dappled sunlight streaming through dense canopies, casting golden rays on a carpet of vibrant wildflowers and ferns, a crystal-clear stream winding through the scene with gentle ripples, mist gently rising from the forest floor, distant snow-capped mountains visible through a break in the trees, serene yet awe-inspiring atmosphere, ultra-detailed textures, realistic lighting and shadows, 4K resolution"

```http
POST / HTTP/1.1
X-Rapidapi-Key: Your-X-Rapidapi-Key
X-Rapidapi-Host: flux-text-to-image-ai.p.rapidapi.com
Content-Type: application/json
Host: flux-text-to-image-ai.p.rapidapi.com
Content-Length: 92

{"prompt":"A beautiful sunset over the ocean","width":"1280","height":"720","seed":"123456"}
```

<figure><img src="/files/38CMI7iBICdy4IvxHxnp" alt=""><figcaption></figcaption></figure>

"prompt": "A photorealistic grand architectural landscape, a majestic gothic cathedral with towering spires and intricate stone gargoyles, adorned with vibrant stained glass windows glowing in the soft morning light, surrounded by a cobblestone plaza with ornate fountains and blooming cherry blossom trees, set against a backdrop of rolling hills under a vast sky with scattered clouds, detailed textures of weathered stone and polished marble, realistic reflections on water surfaces, awe-inspiring and serene atmosphere, ultra-detailed, 4K resolution"

<figure><img src="/files/VB7D9Fhwf2kdtT716Esy" alt=""><figcaption></figcaption></figure>

"prompt": "A photorealistic portrait of a stunning young woman, 25 years old, with flawless porcelain skin, long wavy chestnut hair cascading over her shoulders, expressive deep blue eyes with subtle eyeliner, wearing a delicate off-shoulder white dress with intricate lace details, standing in a sunlit garden surrounded by blooming roses and soft green foliage, golden hour lighting casting a warm glow on her face, serene and captivating atmosphere, ultra-detailed textures, realistic shadows, 4K resolution"<br>

<figure><img src="/files/YaZNn5cPbVFZpOJVV1HE" alt=""><figcaption></figcaption></figure>

"prompt": "A breathtaking anime-style fantasy sorceress, a fierce young woman with flowing silver hair adorned with glowing crystal ornaments, wearing an intricate dark purple robe with golden runes that shimmer faintly, casting a powerful magic spell with swirling arcane energy in vibrant blues and purples, standing atop a floating stone platform in a mystical forest bathed in ethereal moonlight, surrounded by glowing fireflies, ancient ruins covered in vines, and a distant dragon silhouette soaring in the starry sky, dramatic and enchanting atmosphere, hyper-detailed, vivid colors, cinematic lighting, 4K resolution"

<figure><img src="/files/Zim4mR3tOcoyVZb1rsE9" alt=""><figcaption></figcaption></figure>


# Perform Targeting

#### How to Specify Country

If you need to geo-target requests at the country level, simply append&#x20;

<pre class="language-powershell"><code class="lang-powershell"><strong>&#x3C;winbayproxy_username>-type-residential-country-&#x3C;country_code>
</strong></code></pre>

#### How to Specify State

If you need to geo-target requests at the state level, simply append `-state-<state_name>` after the `<winbayproxy_username>-country-<country_code>`.

#### How to Specify City

If you need to geo-target requests at the city level, simply append `-city-<city_name>` after the `<winbayproxy_username>-country-<country_code>`.


# Gateway & Port

## **Gateway** **EU:**

```
proxy.winbay.tech
```

## **Gateway** SG:

```
sgproxy.winbay.tech
```

## **Port:**

```
HTTP/HTTPS: 9000

SOCKS5: 11000
```