# Welcome to API.market

### **Buy & Sell APIs with Confidence**

API.market is your marketplace for discovering, integrating, and monetizing APIs. Whether you're a developer looking for the perfect API solution or a business wanting to sell your APIs, we've got you covered.

***

### 🎯 What is API.market?

API.market is a platform that connects **API buyers** and **API sellers** in one unified marketplace. Think of it as an app store, but for APIs.

{% hint style="info" %}
💡 **In simple terms:** Just like you browse an app store to find apps for your phone, you can browse API.market to find APIs for your projects. And if you've built an API, you can list it here for others to use.
{% endhint %}

<div data-with-frame="true"><figure><img src="/files/KGJKCp9daeKkWdQdXYJG" alt=""><figcaption></figcaption></figure></div>

#### For Developers & Businesses

✅ **Discover APIs** - Browse hundreds of APIs across different categories\
✅ **Try Before You Buy** - Most APIs offer free trials so you can test them first\
✅ **Easy Integration** - Get started quickly with clear documentation\
✅ **One Platform** - Access multiple APIs through a single account\
✅ **Transparent Pricing** - Compare APIs based on price, features, and ratings

#### For API Sellers

✅ **List Your APIs** - Reach thousands of potential customers\
✅ **Free Listings** - No upfront costs to list your API\
✅ **Flexible Pricing** - Set your own pricing plans and tiers\
✅ **Built-in Billing** - We handle payments and subscriptions for you\
✅ **Analytics** - Track usage, revenue, and customer insights

***

### 🚀 How API.market Works

API.market acts as a **gateway** between API sellers and API users. When you subscribe to an API on our platform, all requests go through API.market, which handles authentication, billing, rate limiting, and analytics automatically.

<div data-with-frame="true"><figure><img src="/files/K4T4X7iRuX4kaul8c2lf" alt=""><figcaption></figcaption></figure></div>

#### The Flow:

1. **API Sellers** import their APIs using OpenAPI specifications
2. **API.market** proxies and manages all API requests
3. **API Users** call APIs through API.market's unified interface
4. **Everyone Benefits** - Sellers get customers, buyers get reliable APIs, and API.market handles the infrastructure

{% hint style="success" %}
✅ **Key Benefit:** You don't need to worry about API keys, billing systems, or rate limiting. API.market handles all of that automatically.
{% endhint %}

***

### 📚 What are APIs?

&#x20;APIs are the building blocks that allow software applications to communicate and share functions in a secure, scalable environment..&#x20;

<div data-with-frame="true"><figure><img src="/files/hFQUGQIu2GgS5KEHLkuV" alt=""><figcaption></figcaption></figure></div>

#### Think of APIs as Bridges

APIs (Application Programming Interfaces) serve as the **bridge** between different software programs, enabling them to interact and exchange data seamlessly.

#### **Real-world examples:**

* **Payment Processing** - Stripe API lets you accept payments in your app
* **Maps & Location** - Google Maps API adds maps to your website
* **Email Sending** - SendGrid API sends emails from your application
* **AI & ML** - OpenAI API adds AI capabilities to your product
* **SMS Notifications** - Twilio API sends text messages

{% hint style="info" %}
💡 **Why use APIs?** Instead of building every feature from scratch, you can use APIs to add powerful functionality to your app in minutes. This saves time, money, and lets you focus on what makes your product unique.
{% endhint %}

***


# Getting Started

#### **Quick steps to start using API.market**

Whether you're looking to use APIs or sell your own, follow these simple steps to get started.

***

### 🎯 Choose Your Path

{% hint style="info" %}
**👤 Looking to use APIs?** Jump to For API Users

**🏢 Want to sell your APIs?** Jump to For API Sellers
{% endhint %}

***

### 🔵 For API Users

#### Get started in 4 simple steps:

**1. Browse the Marketplace**\
[Visit the marketplace](https://api.market/) and explore APIs by category or search for what you need.

**2. Try Free**\
Most APIs offer free trials. Click on any API to see plans and start testing - no credit card required.

**3. Subscribe**\
When ready, choose a pricing plan that fits your needs. Add payment details and activate instantly.

**4. Integrate**\
Get your API key from the dashboard and follow the documentation to integrate into your project.

{% hint style="success" %}
👉 [**Browse API Marketplace**](https://api.market/) to get started now
{% endhint %}

***

### 🟢 For API Sellers

#### Get started in 4 simple steps:

**1. Create Organization**\
Sign up and create your organization from the [Seller Console](https://api.market/seller/dashboard).

**2. Import Your API**\
Upload your OpenAPI specification file using the Import API Source wizard.

**3. Create Products**\
Set up pricing plans and define features for your API products.

**4. Go Live**\
Publish your products and start selling to thousands of developers.

{% hint style="success" %}
👉 [**Get Started with Seller Console**](https://api.market/seller/dashboard) to list your APIs
{% endhint %}

***

### 📖 Learn More

#### For API Users:

* [**What are API Products?**](/what-are-api-products) - Understand how API products work
* [**How to subscribe to a  API Product?**](/how-to-subscribe-to-a-api-product) - Detailed subscription guide
* [**Managing Subscriptions**](/managing-subscriptions) - Control your API subscriptions
* [**Analytics & Logs** ](/analytics-and-logs)- Monitor your API usage

#### For API Sellers:

* [**API Seller Console**](/seller-docs/api-seller-console) - Dashboard overview
* [**What is an API Product?**](/seller-docs/what-is-an-api-product) - Learn about API products
* [**Importing an API Source**](/seller-docs/importing-an-api-source) - Import your first API
* [**Creating a Product using the Wizard**](broken://pages/UZpkfJpoHRFW76k2yUoh) - Create products
* [**Testing Your APIs & Products**](/seller-docs/testing-your-apis-and-products) - Test before launch

***


# What are API Products?

API Products are core part of the api.market , follow this page to know more about it.

### 🎯 What is an API Product?

An API Product is a **complete package** that includes everything you need to use or sell an API on API.market.

{% hint style="info" %}
💡 **Think of it like this:** An API Product is like a product listing in an online store. It includes the API itself (what it does) and the pricing plans (how much it costs).
{% endhint %}

#### API Products are comprised of two parts:

**1. API Source** - The actual API specification and endpoints\
→ [Learn more about API Source](/seller-docs/importing-an-api-source)

**2. Pricing Plans** - The subscription tiers and pricing options\
→ [Learn more about Pricing Plans](/seller-docs/what-is-a-pricing-plan)

### 🛒 How to Subscribe to API Products

To use API products you first need to subscribe to any of the API . Here's how you can do it : \
\
**Step 1: Select any  API you are interested to try**

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

APIs are the building blocks that allow software applications to communicate and share functions in a secure, scalable environment. \
\
**Step 2 :  From many options available, you can choose any API Product to try.**&#x20;

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

In order to use the API Playground, a place to test & play with any API you first need to subscribe to any plan.  We recommend trying FREE plan as a starter. You can always upgrade the plan later.&#x20;

#### API Playground :&#x20;

API Playground is a Place for anyone to test out any API they have subscribed to. \
You need to be logged in and require api-key to test it out.&#x20;

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

\
\
**Step 3 :** Fill in all the required input fields in the API Playground to test the API.\
For this example, we are using the [**Object Remover API** ](https://api.market/store/magicapi/object-remover-v2) and passing the image URL and mask URL in the request body as shown below.

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

Fill out the Required fields in the API Playground before testing. The fields will have some or all details filled as an example. \
\
**Step 4: Click Run API once done.**

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

You will see the output with a successful execution code **"200"**


# How to subscribe to a  API Product?

API Product can be used by everyone after subscribing to any of the various plans available.

### :rocket: Step-by-Step Subscription Guide

#### Step 1: Browse and Select an API

Navigate to the [API Market](https://api.market/) and find an API you want to use.

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

You can:

* Browse by category (AI, Payment, Communication, etc.)
* Search for specific APIs
* Filter by pricing, ratings, or features

#### Step 2: View API Product Details

Click on any API to view its product page. Here you'll see:

* API description and features
* Available pricing plans
* Documentation and examples
* Reviews and ratings

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

#### Step 3: Choose a Pricing Plan

On the product page, you'll see different pricing plans available:

* **FREE** - Perfect for testing (recommended to start)
* **BASIC, PRO, ULTRA, MEGA** - Paid plans with more features
* **BULK** - For high-volume usage

<figure><img src="/files/ql0FE010iROjAxXP7En4" alt="" width="375"><figcaption></figcaption></figure>

{% hint style="success" %}
:white\_check\_mark: **Pro Tip:** Start with the FREE plan to test the API. You can always upgrade later!
{% endhint %}

**Plan details shown:**

* API Calls per month
* API Limit Type (HARD or SOFT)
* Total Endpoints included
* Price

***

#### Step 4: Subscribe to Your Chosen Plan

1. Click on the plan you want (e.g., "FREE" for free tier)
2. Review the plan details
3. Click the **"Subscribe"** button

<figure><img src="/files/MnH2YLHxGOWsey3ZN3RQ" alt="" width="375"><figcaption></figcaption></figure>

After subscribing, you'll:

* :white\_check\_mark: Receive confirmation of your subscription
* :white\_check\_mark: Get your API key automatically
* :white\_check\_mark: Access the API Playground to test
* :white\_check\_mark: See your subscription in the dashboard


# Managing Subscriptions

After subscribing to various API Products and playing around with them in the API Playground. You might be curious where and how to manage them. \
\
If you don't know what are API Products ( [Learn here](/what-are-api-products) ) , and if you want to learn about API Playground ( [Learn here](/what-are-api-products#api-playground) ). \
\
Api.market makes it easy to manage the subscriptions by these easy steps below. Before managing the api's you need to subscribe to at least one api. \
\
Here's how you can [subscribe to API Product](/how-to-subscribe-to-a-api-product) . <br>

### Managing Subscriptions to API Products :&#x20;

After you subscribe to various different api's on the api.market your subscriptions will be shown on the left sidebar under the option "**Subscriptions**"&#x20;

Here's the link to the Subscriptions page : <https://api.market/account/subscriptions>\
You need to be signed in to see your subscriptions page. \
\
The subscriptions page look something like this.

<figure><img src="/files/6W1HBYKxHJi9u5VFPdUw" alt=""><figcaption></figcaption></figure>

Clicking on any of the Subscriptions you have will take you to that API and there you can upgrade or [cancel Subscription](/how-can-i-cancel-my-subscription).


# Analytics & Logs

**Track and monitor your API usage with comprehensive analytics**

API.market logs every single request and response unless otherwise specified.

### 🔵 Account Analytics & Logs

Track your total usage and analytics across all subscribed APIs from one central location.

#### How to Access:

1. Click on **"Charts"** from the left sidebar on your home page
2. View analytics for all APIs you've subscribed to

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

#### What You'll See:

To check for the Account level analytics and logs click on **Analytics**. You will get to see something like this:

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

#### Key Metrics

The analytics dashboard displays the following key metrics:

* **Total API Calls** - Track all requests across all your APIs
* **Usage** - Monitor your API usage and consumption across all subscribed products
* **Average Error Rate** - Track the percentage of failed requests
* **Reported Usage** - View the usage reported by the system

#### Request Analytics Graph

The dashboard includes a "Request Analytics" graph that shows:

* **Num Requests** (Total API Requests) - All API calls made
* **Non 200 Requests** - Failed or error responses
* **Reported Usage** - System-tracked usage metrics

This graph helps you visualize your API usage patterns over time (1 hour, 3 hours, 12 hours, 24 hours, 1 week, 1 month, or 6 months).

#### Advanced Filters

You can filter the analytics data by:

* **Date Range** - Select a custom date range
* **Products** - Filter by specific products (or view all)
* **Request Methods** - Filter by HTTP method (GET, POST, etc.)

Click "Apply Filters" to update the dashboard with your selected criteria.

#### Latency Analytics

The dashboard also provides latency metrics showing:

* **Total Latency** - Overall response time including overhead
* **API Latency** - Time taken by the actual API call
* **Overhead Latency** - Additional processing time

**For logs you will see something like this :**&#x20;

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

#### API Logs Table

The API Logs table displays detailed information about each API request:

* **ID** - Unique request identifier
* **REQUEST ID** - Request tracking ID
* **DATE/TIME** - Timestamp of the request
* **PRODUCT** - Product name that was called
* **PLAN** - Pricing plan used
* **USER ID** - User who made the request
* **ENDPOINT** - API endpoint path
* **METHOD** - HTTP method (GET, POST, etc.)
* **STATUS** - Response status code


# How can I cancel my Subscription?

Subscriptions are the way we manage the use of APIs by organising them in the Subscriptions section in the left sidebar. Subscription of any API Product can be cancelled anytime by the user.\
\
Cancelled API Product can still be used until the end of the Subscription period.&#x20;

#### Cancellation of Subscription

Subscription of an API Product can be cancelled by just going to the API Product Page. To manage multiple api subscriptions go to the subscriptions page.\
\
**Step 1 : Go to the Subscriptions page**

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

From there you can go to any of API Products you have subscribed to cancel a subscription.&#x20;

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

Just Underneath the Subscribed button there's an option called "**Cancel Subscription"**\
\
After Clicking on cancel subscription this will pop-up, prompting to cancel subscription.

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

Select the cancellation reason from the dropdown and type cancel subscription to enable the **cancel subscription** button , then click on cancel subscription by doing this your plan will be cancelled , but API Product can still be used until the end of the Subscription period. <br>

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

If you have any problem with this , you can simply email us at <hello@magicapi.com> or contact us via embedded chat.


# How do I add payment details?

Payments methods are necessary on api.market only when you subscribe to a paid plan of a API. Subscribing to limited FREE Plan is available in most of the API.\
\
When a user upgrades from a FREE or BASIC Plan to paid version they need to add payment details to be able to pay for it. [Example](https://api.market/store/magicapi/domainchecker)\
\
Click on Pro Plan or any other paid plan when subscribing to an api and click subscribe, this pop-up will show. Press **"Add Payment Method"**

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

After Pressing it this page open up where you can create or add payment methods to pay for an api.

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

Create Payment Method to continue. \
click on Add new , add card details and then press on Add Payment Method, the payment method will be added and You will be able to pay for the api now.&#x20;

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


# How does API.market charges me?

### **Understanding billing and charges on API.market**

API.market offers multiple pricing plans per API product, including FREE, Basic, Pro, Ultra, Mega, and custom plans. Understanding how you're charged helps you manage costs effectively.

***

### 🎯 Key Charging Principle

**API.market only charges for successful API calls.**

{% hint style="success" %}
✅ **What counts as a charge:**

* Only API calls that return **"200 OK"** status code are charged
* Error responses (4xx, 5xx) are **NOT charged**
* Failed requests are **NOT counted** in your usage
* You only pay for successful API executions
  {% endhint %}

***

### 💳 Two Main Billing Models

#### 1. 📅 Monthly Pre-Paid Subscriptions

<figure><img src="/files/aHDv5SjjmBiz6Fv0u9zg" alt="" width="375"><figcaption></figcaption></figure>

**How it works:**

* Pay a **monthly fee upfront** (e.g., $8, $45, $89)
* Includes a specific number of API calls per month
* **Overage charges** apply if you exceed your included calls
* Billed once per month at renewal

**Billing Formula:**

```
Total Charge = Monthly Fee + Overage Charges
Overage = (API Calls Made - API Call Limit) × Price Per Call
```

**Example:**

```
Plan: Pro Plan ($49/month)
- Included: 10,000 calls/month
- Overage: $0.005 per call
- Usage: 12,000 calls
- Charge: $49 + (2,000 × $0.005) = $59.00
```

***

#### 2. ⚡ Pay-As-You-Go (PAYG) Plans

<figure><img src="/files/0vzPRmR83nEipipULTFC" alt="" width="375"><figcaption></figcaption></figure>

**How it works:**

* **No monthly fee** ($0 upfront)
* Pay only for actual API usage
* Charged based on successful calls
* Billing happens every 10 minutes (cumulative)

**Billing Formula:**

```
Total Charge = Total API Calls × Price Per Call
```

**Example:**

```
Plan: PAYG Plan
- Price Per Call: $0.02
- Usage: 500 calls
- Charge: 500 × $0.02 = $10.00
```

{% hint style="info" %}
💡 **Cumulative Billing:** PAYG uses cumulative billing to prevent double-charging. The system calculates total usage since subscription start and charges only the difference from what's already been charged.
{% endhint %}

***

### 📊 Plan Comparison

| Feature               | Monthly Pre-Paid    | Pay-As-You-Go (PAYG) |
| --------------------- | ------------------- | -------------------- |
| **Monthly Fee**       | Yes (e.g., $9-$499) | No ($0)              |
| **Included Calls**    | Yes                 | No                   |
| **Billing Frequency** | Monthly             | Every 10 minutes     |
| **Overage Charges**   | Yes (if exceeded)   | All usage charged    |
| **Best For**          | Predictable usage   | Variable usage       |

***

### 💰 Overage Charges (Monthly Plans)

If you exceed your included API calls on a monthly plan:

**Overage Calculation:**

```
Overage Calls = Total Calls Made - Included Calls
Overage Charge = Overage Calls × Price Per Call
```

**Limit Types:**

* **HARD Limit**: API stops when limit reached (no overage)
* **SOFT Limit**: API continues, overage charges apply

***

### 💳 Payment Methods

* **Stripe** - Credit/debit card payments
* **User Wallet** - Pre-loaded funds
* **Wallet Debt** - Small amounts (< $5) may become wallet debt

***

### 📊 Monitoring Your Charges

**View Usage:**

* Go to **Analytics & Logs** in your dashboard
* See total API calls and costs
* Monitor usage trends

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

**Check Billing & Transaction History:**

* Visit **Billing & Payments** page
* View transaction history
* Monitor wallet balance

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

***

### 🆘 Need Help?

* **💬 Live Chat:** Click the chat widget in the bottom right corner
* **📧 Email:** <hello@magicapi.com>
* **📅 Book a Call:** [Schedule a demo](https://calendly.com/magicapi)


# How to use Wallet?

### 💳 Wallet Feature

The Wallet is a new payment feature in API.Market designed to help you manage your subscriptions seamlessly and avoid any service interruptions.

***

#### **📍 Accessing Your Wallet**

You can access your Wallet from the top-right corner of the dashboard. Your current Wallet balance will always be visible here.

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2FScROs9k0sRGDJzn3teEU%2FYour%20wallet%20balance%20(1).png?alt=media&#x26;token=3f19708e-4670-48fa-9878-930595253181" alt=""><figcaption></figcaption></figure>

#### **🔧 How It Works**

1. **Click on Wallet**

To recharge your wallet, you must click on the Wallet Balance.

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2FLOXAjt93gU0jbnrXhApn%2FYour%20wallet%20balance%20(4).png?alt=media&#x26;token=69f82117-7b79-4e53-a032-837d25278c9d" alt=""><figcaption></figcaption></figure>

2. **Add a Card**

To start using the Wallet, you must first add a valid payment card to your account.

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2FtIjaPTLpTy29Lx9gG1lB%2FYour%20wallet%20balance%20(5).png?alt=media&#x26;token=b4e7f30f-ef9a-43cc-978f-b5eedb20f53a" alt=""><figcaption></figcaption></figure>

3. **Top Up Your Wallet**

Once your card is added, you can load your Wallet with any amount of your choice.

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2FZCbMgYpBOrTuAEwC83Vg%2FYour%20wallet%20balance%20(3).png?alt=media&#x26;token=4ccb6471-334d-46cf-a602-a4c66cb399ac" alt=""><figcaption></figcaption></figure>

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2F3AVHCkKlddWHFVTSA3ka%2FTop%20up%20wallet.png?alt=media&#x26;token=d73c6c69-f5c7-4220-ac39-06126129f569" alt=""><figcaption></figcaption></figure>

4. All wallet transactions can be seen under Wallet Transactions.

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2FXXkdJ0HPryiL5RNKHWgD%2FWallet%20txn.png?alt=media&#x26;token=9fea3d75-72a5-4306-9e26-0778c2753e09" alt=""><figcaption></figcaption></figure>

5. Subscribe to any plan for an API using your balance from the wallet and pay the balance from the card.

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2F22wDSdV4iIlUUUEg0woi%2FScreenshot%202025-06-27%20at%205.33.15%E2%80%AFPM.png?alt=media&#x26;token=456f1f23-57c4-434e-892c-52549b994faa" alt=""><figcaption></figcaption></figure>

<figure><img src="https://979396929-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FJpzXHBiEL3zWqYljGVxS%2Fuploads%2FEFfXYjEC4QDs8LHW46dY%2FYour%20wallet%20balance%20(6).png?alt=media&#x26;token=3f19cc55-281d-447d-9ded-7b0c604417d5" alt=""><figcaption></figcaption></figure>

6. **Automatic Subscription Renewals**

API.Market will automatically use your Wallet balance to keep your APIs running smoothly.

<br>


# How to Configure Auto-Pay?

**Never run out of API credits with automatic wallet top-ups**

***

### 💡 What is Auto-Pay?

Auto-Pay is a feature that **automatically adds funds to your wallet** when your balance falls below a threshold you set.

**How it works in simple terms:**

```
You set: "When my balance goes below $10, add $20"

→ Balance drops to $9
→ Auto-Pay charges your card $20
→ New balance: $29 ✅
```

This ensures your API calls **never get interrupted** due to insufficient balance.

{% hint style="info" %}
💡 **Think of it like:** Auto-refill for your phone data plan — but for API credits!
{% endhint %}

***

### 📋 Before You Start

To enable Auto-Pay, you need:

* ✅ **A saved payment method** (credit/debit card) — Learn [how to add payment details](/how-do-i-add-payment-details)
* ✅ **A minimum top-up amount of $5**

{% hint style="warning" %}
⚠️ **No Card?** Add a payment method first at **Account → Billing & Payments → Add New**
{% endhint %}

***

### 🔧 How to Configure Auto-Pay

#### Step 1: Go to Billing & Payments

Navigate to your **Account → Billing & Payments** page.

<figure><img src="/files/582BoPcf9g78PXu0D54u" alt=""><figcaption></figcaption></figure>

#### Step 2: Find the Auto-Pay Section

Scroll down to find the **"Configure Auto-Pay"** section.<br>

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

#### Step 3: Enable Auto-Pay

Click the **toggle switch** to enable Auto-Pay.

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

{% hint style="info" %}
💡 If you haven't added a payment method yet, you'll see an error: **"Please add a card before enabling AutoPay."** — Add one here
{% endhint %}

***

#### Step 4: Set Your Threshold

Configure **"When my balance falls below"** — this is your trigger point.

| Example | Meaning                                        |
| ------- | ---------------------------------------------- |
| $10     | Auto-Pay triggers when balance drops below $10 |
| $20     | Auto-Pay triggers when balance drops below $20 |
| $50     | Auto-Pay triggers when balance drops below $50 |

**Quick-fill options:** $5, $10, $20, $30, $40, $50

#### Step 5: Set the Top-Up Amount

Configure **"Automatically add"** — this is how much will be charged to your card.

| Example | Meaning                                         |
| ------- | ----------------------------------------------- |
| $10     | Wallet gets $10 added when threshold is crossed |
| $20     | Wallet gets $20 added when threshold is crossed |
| $50     | Wallet gets $50 added when threshold is crossed |

{% hint style="warning" %}
⚠️ **Minimum Amount:** The minimum Auto-Pay amount is **$5**.
{% endhint %}

#### Step 6: Save Settings

Click **"Save Autopay Settings"** to activate.

***

### 📊 Example Configuration

Here's a typical Auto-Pay setup:

```
Threshold: $10 (trigger when balance falls below)
Amount: $20 (automatically add this much)
```

**How it works:**

1. Your wallet balance is $15
2. You use $6 worth of API calls
3. Balance drops to $9 (below $10 threshold)
4. Auto-Pay automatically charges $20 to your card
5. New balance: $29 ✅

***

### ⚙️ How Auto-Pay Works Behind the Scenes

<table><thead><tr><th width="132.796875">Step</th><th>What Happens</th></tr></thead><tbody><tr><td>1</td><td>System checks wallets hourly</td></tr><tr><td>2</td><td>If balance &#x3C; threshold, payment is initiated</td></tr><tr><td>3</td><td>Your default card is charged</td></tr><tr><td>4</td><td>Credits are added to your wallet instantly</td></tr><tr><td>5</td><td>If payment fails, system retries (up to 3 times)</td></tr></tbody></table>

{% hint style="info" %}
💡 **Rate Limit:** Auto-Pay runs **maximum once per hour** to prevent excessive charges.
{% endhint %}

***

### 🔄 Managing Auto-Pay

#### To Disable Auto-Pay

Simply toggle the switch **OFF** and click **"Save Autopay Settings"**.

#### To Change Settings

1. Update threshold and/or amount values
2. Click **"Save Autopay Settings"**

#### To Change Payment Method

1. Go to **Payment Methods** section
2. Set a different card as **Default**
3. Auto-Pay will use the new default card

***

### 🎯 Why Use Auto-Pay?

| Benefit                   | Description                                           |
| ------------------------- | ----------------------------------------------------- |
| **Uninterrupted Service** | Your APIs keep working even when you forget to top up |
| **Set It & Forget It**    | Configure once, never worry about balance again       |
| **Automatic Retries**     | If payment fails, system retries up to 3 times        |
| **Email Notifications**   | Get notified if Auto-Pay fails or gets disabled       |
| **Full Control**          | You set the threshold and top-up amount               |

***

### 💡 Tips for Best Results

✅ **Set a comfortable threshold** — Give yourself buffer for high-usage periods

✅ **Match threshold to usage** — If you spend \~$15/week, set threshold around $15-20

✅ **Top-up in larger amounts** — Reduces transaction frequency and potential fees

✅ **Keep card updated** — Update before expiry to avoid service interruption

✅ **Monitor email** — Watch for Auto-Pay failure notifications

***

### 📖 Related Documentation

* [**How do I add Payment details?**](/how-do-i-add-payment-details) - Adding cards
* [**How does API.market charge me?**](/how-does-api.market-charges-me) - Billing explained
* [**How to use Wallet?**](/how-to-use-wallet) - Wallet features

***

### 🆘 Need Help?

* **💬 Live Chat:** Bottom right corner of any page
* **📧 Email:** <hello@api.market>
* **📅 Book a Call:** [Schedule a demo](https://calendly.com/magicapi)

***


# Error Code

**Error Codes**

API.market uses standard HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate a clientside error, which means that failed given the information provided (e.g., a missing parameter, unauthorized access, etc.). Codes in the 5xx range indicate an error with API.market's servers (normally this shouldn't happen at all).

If the response code is not 200, it means the operation failed somehow and you may need to take an action accordingly. You can check the response (which will be in JSON format) for a field called **'message'** that briefly explains the error reported.

| Status Code             | Explanation                                                              |
| ----------------------- | ------------------------------------------------------------------------ |
| 400 - Bad Request       | The request was unacceptable, often due to missing a required parameter. |
| 401 - Unauthorized      | No valid API key provided.                                               |
| 404 - Not Found         | The requested resource doesn't exist.                                    |
| 429 - Too many requests | API request limit exceeded. See section Rate Limiting for more info.     |
| 5xx - Server Error      | We have failed to process your request. (You can contact us anytime)     |


# API.Market MCP Server Guide

Transform every API into intelligent tools for AI agents through Model Context Protocol

### Introduction

API.Market has revolutionized how AI agents interact with external APIs by implementing **Model Context Protocol (MCP)** servers for every API in our marketplace. This means that any API available on API.Market can be seamlessly integrated into AI agents like Claude, Cursor, and other MCP-compatible tools.

#### Why MCP Matters

Traditional API integration requires:

* Manual endpoint documentation reading
* Custom code for each API
* Complex authentication handling
* Error handling and retry logic
* Response parsing and formatting

With MCP, AI agents can:

* **Automatically discover** available API endpoints
* **Understand** parameter requirements and formats
* **Execute** API calls with proper authentication
* **Handle** responses intelligently
* **Chain** multiple API calls for complex workflows

***

### What is Model Context Protocol (MCP)?

Model Context Protocol is an open standard created by Anthropic that enables AI applications to securely access external data sources and tools. It provides a standardized way for AI models to:

#### Core Capabilities

* **Tool Discovery**: Automatically find and understand available functions
* **Resource Access**: Read and manipulate external data sources
* **Interactive Prompts**: Handle complex user interactions
* **Streaming**: Support real-time data flow
* **Security**: Implement proper authentication and authorization

#### Protocol Architecture

MCP uses JSON-RPC 2.0 over various transports:

* **HTTP/HTTPS**: For web-based integrations
* **Server-Sent Events (SSE)**: For real-time streaming
* **WebSockets**: For bidirectional communication
* **Stdio**: For local process communication

***

### API.Market MCP Implementation

#### Universal MCP Servers

**Every API on API.Market is automatically an MCP server**. This means:

* ✅ **Instant Integration**: No setup required beyond configuration
* ✅ **Automatic Updates**: API changes reflect immediately in MCP tools
* ✅ **Consistent Interface**: All APIs follow the same MCP patterns
* ✅ **Authentication Handled**: Your API key works across all MCP clients

#### Endpoint Pattern

All API.Market MCP servers follow this URL pattern:

```
https://prod.api.market/api/mcp/{workspace}/{api-slug}
```

**Examples**:

* `https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image`
* `https://prod.api.market/api/mcp/magicapi/flux-8b-text-to-image`
* `https://prod.api.market/api/mcp/byteplus/seedance-image-to-video-pro`

#### Tool Generation

Each API endpoint becomes an MCP tool:

* **POST /images/generate** → `post_images_generate` tool
* **PUT /models/{id}** → `put_models_by_id` tool
* **GET /images/result** → `get_images_result` tool

#### Authentication

All MCP servers use the same authentication header:

```
x-api-market-key: YOUR_API_KEY
```

***

### Quick Start Guide

#### Prerequisites

* AI client that supports MCP (Claude Desktop, Cursor, etc.)
* Node.js 18+ (for most MCP clients)
* API.Market account with API key
* Active subscription to desired APIs

#### Step 1: Get Your API Key

1. Visit [API.Market](https://api.market)
2. Sign in to your account
3. Navigate to your dashboard
4. Copy your API key

#### Step 2: Choose Your Client

Pick your preferred MCP client:

* **Claude Desktop**: Best for conversational AI workflows
* **Cursor**: Ideal for code development with AI assistance
* **Python**: For programmatic access and automation
* **cURL**: For testing and debugging

#### Step 3: Configure MCP Server

Follow the client-specific configuration below.

***

### Client Configuration

#### Claude Desktop

**Configuration File Location**

* **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
* **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

**Single API Configuration**

```json
{
  "mcpServers": {
    "ideogram_v3_pro": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image",
        "--header",
        "x-api-market-key: ${API_MARKET_KEY}"
      ],
      "env": {
        "API_MARKET_KEY": "your_actual_api_key_here"
      }
    }
  }
}
```

**Multiple APIs Configuration**

```json
{
  "mcpServers": {
    "ideogram_v3_pro": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image",
        "--header",
        "x-api-market-key: ${API_MARKET_KEY}"
      ],
      "env": {
        "API_MARKET_KEY": "your_actual_api_key_here"
      }
    },
    "flux_8b": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://prod.api.market/api/mcp/magicapi/flux-8b-text-to-image",
        "--header",
        "x-api-market-key: ${API_MARKET_KEY}"
      ],
      "env": {
        "API_MARKET_KEY": "your_actual_api_key_here"
      }
    },
    "domain_checker": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://prod.api.market/api/mcp/magicapi/domainchecker",
        "--header",
        "x-api-market-key: ${API_MARKET_KEY}"
      ],
      "env": {
        "API_MARKET_KEY": "your_actual_api_key_here"
      }
    }
  }
}
```

**Setup Instructions**

1. Open Claude Desktop
2. Go to Settings → Developer
3. Click "Edit Config" to open the configuration file
4. Add your MCP server configurations
5. Save the file and restart Claude Desktop
6. Look for the MCP tools icon in conversations

#### Cursor IDE

**Configuration File Location**

Access via Cursor Settings → Features → Model Context Protocol

**Configuration Format**

```json
{
  "mcpServers": {
    "ideogram_v3_pro": {
      "url": "https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image",
      "headers": {
        "x-api-market-key": "your_actual_api_key_here"
      }
    }
  }
}
```

**Setup Instructions**

1. Open Cursor IDE
2. Navigate to Settings → Features → Model Context Protocol
3. Click "Add Server"
4. Paste the configuration
5. Restart Cursor
6. The API tools will be available in AI conversations

#### Python Client

**Installation**

```bash
pip install requests
```

**Implementation**

```python
import requests
import json

class APIMarketMCPClient:
    def __init__(self, api_key: str, workspace: str, api_slug: str):
        self.endpoint = f"https://prod.api.market/api/mcp/{workspace}/{api_slug}"
        self.headers = {
            "Content-Type": "application/json",
            "x-api-market-key": api_key
        }
        self.request_id = 0
    
    def _call(self, method: str, params: dict = None) -> dict:
        """Make a JSON-RPC call to the MCP server"""
        self.request_id += 1
        payload = {
            "jsonrpc": "2.0",
            "id": self.request_id,
            "method": method
        }
        if params:
            payload["params"] = params
            
        response = requests.post(
            self.endpoint, 
            json=payload, 
            headers=self.headers
        )
        return response.json()
    
    def initialize(self) -> dict:
        """Initialize the MCP connection"""
        return self._call("initialize", {
            "protocolVersion": "2024-11-05",
            "capabilities": {"tools": {}},
            "clientInfo": {"name": "Python Client", "version": "1.0.0"}
        })
    
    def list_tools(self) -> dict:
        """List all available tools"""
        return self._call("tools/list")
    
    def call_tool(self, name: str, arguments: dict) -> dict:
        """Call a specific tool"""
        return self._call("tools/call", {
            "name": name,
            "arguments": arguments
        })
    
    def list_resources(self) -> dict:
        """List available resources"""
        return self._call("resources/list")
    
    def get_resource(self, uri: str) -> dict:
        """Get a specific resource"""
        return self._call("resources/read", {"uri": uri})

# Example usage
if __name__ == "__main__":
    # Initialize client for Ideogram v3 Pro
    client = APIMarketMCPClient(
        api_key="your_api_key_here",
        workspace="magicapi",
        api_slug="ideogram-v3-pro-text-to-image"
    )
    
    # Initialize connection
    init_result = client.initialize()
    print("Initialized:", init_result)
    
    # Get available tools
    tools = client.list_tools()
    if "result" in tools and "tools" in tools["result"]:
        print("\nAvailable tools:")
        for tool in tools["result"]["tools"]:
            print(f"  - {tool['name']}: {tool.get('description', 'No description')}")
    
    # Example: Generate an image
    result = client.call_tool("createideogram_v3_qualityprediction", {
        "body": {
            "input": {
                "prompt": "A beautiful sunset over mountains",
                "aspect_ratio": "16:9"
            }
        }
    })
    print("Tool result:", result)
```

#### cURL Testing

**Initialize Connection**

```bash
curl -X POST "https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_KEY" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "initialize",
    "params": {
      "protocolVersion": "2024-11-05",
      "capabilities": {"tools": {}},
      "clientInfo": {"name": "curl", "version": "1.0.0"}
    }
  }'
```

**List Available Tools**

```bash
curl -X POST "https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_KEY" \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/list",
    "params": {}
  }'
```

**Call a Tool**

```bash
curl -X POST "https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_KEY" \
  -d '{
    "jsonrpc": "2.0",
    "id": 3,
    "method": "tools/call",
    "params": {
      "name": "createideogram_v3_qualityprediction",
      "arguments": {
        "body": {
          "input": {
            "prompt": "A professional logo design",
            "aspect_ratio": "1:1"
          }
        }
      }
    }
  }'
```

***

### API Examples

#### Image Generation APIs

**Ideogram v3 Pro - Text to Image**

**MCP Endpoint**: `https://prod.api.market/api/mcp/magicapi/ideogram-v3-pro-text-to-image`

**Available Tools**:

* `createideogram_v3_qualityprediction`: Generate images with advanced text rendering
* `getideogram_v3_qualityprediction`: Get prediction status and results

**Example Usage in Claude**:

```
Generate a professional logo for "TechFlow Solutions" with modern typography, 
blue and silver colors, suitable for both light and dark backgrounds.
```

**Flux.1 8B - Fast Text to Image**

**MCP Endpoint**: `https://prod.api.market/api/mcp/magicapi/flux-8b-text-to-image`

**Available Tools**:

* `createflux_8b_prediction`: Fast image generation
* `getflux_8b_prediction`: Get prediction results

**Example Usage in Claude**:

```
Create a product mockup of a smartphone with a sleek design, 
gradient background, professional lighting, 4K quality.
```

#### Utility APIs

**Domain Checker**

**MCP Endpoint**: `https://prod.api.market/api/mcp/magicapi/domainchecker`

**Available Tools**:

* `checkdomainavailability`: Check if domains are available for registration

**Example Usage in Claude**:

```
Check if these domains are available: techflow.com, techflow.io, techflow.ai
```

**Geocoding APIs**

**MCP Endpoint**: `https://prod.api.market/api/mcp/trueway/geocoding`

**Available Tools**:

* `forward_geocoding`: Convert addresses to coordinates
* `reverse_geocoding`: Convert coordinates to addresses

**Example Usage in Claude**:

```
Find the coordinates for "1600 Amphitheatre Parkway, Mountain View, CA"
```

#### Video Generation APIs

**SeedDance Pro - Image to Video**

**MCP Endpoint**: `https://prod.api.market/api/mcp/byteplus/seedance-image-to-video-pro`

**Available Tools**:

* `createvideo_generation`: Convert images to videos with motion

**Example Usage in Claude**:

```
Take this product image and create a 5-second video with smooth 360-degree rotation, 
professional lighting, and subtle zoom effect.
```

#### Audio APIs

**Kokoro v1.0 - Text to Speech**

**MCP Endpoint**: `https://prod.api.market/api/mcp/magicapi/kokoro-v1-text-to-speech`

**Available Tools**:

* `createtts_generation`: Generate natural-sounding speech

**Example Usage in Claude**:

```
Generate a professional voiceover for this script: "Welcome to TechFlow Solutions, 
where innovation meets efficiency."
```

***

### Advanced Usage

#### Multi-API Workflows

With multiple MCP servers configured, you can create complex workflows:

```
1. Check domain availability for "myapp.com"
2. If available, generate a logo for "MyApp" 
3. Create a product mockup showing the logo
4. Generate a promotional video from the mockup
5. Add a voiceover explaining the app's benefits
```

#### Batch Processing

```python
# Example: Generate multiple logo variations
logos = [
    {"style": "modern", "colors": "blue and white"},
    {"style": "classic", "colors": "gold and black"},
    {"style": "playful", "colors": "rainbow gradients"}
]

for logo_config in logos:
    result = client.call_tool("createideogram_v3_qualityprediction", {
        "body": {
            "input": {
                "prompt": f"Create a {logo_config['style']} logo using {logo_config['colors']} colors",
                "aspect_ratio": "1:1"
            }
        }
    })
    print(f"Generated {logo_config['style']} logo:", result)
```

#### Error Handling

```python
def safe_api_call(client, tool_name, arguments):
    try:
        result = client.call_tool(tool_name, arguments)
        if "error" in result:
            print(f"API Error: {result['error']}")
            return None
        return result["result"]
    except Exception as e:
        print(f"Network Error: {e}")
        return None
```

***

### Best Practices

#### 1. Authentication Security

* **Never hardcode API keys** in shared code
* **Use environment variables** for API keys
* **Rotate keys regularly** for security
* **Monitor usage** through API.Market dashboard

#### 2. Prompt Engineering

**For Image Generation**

```
Structure: [Subject] + [Style] + [Composition] + [Lighting] + [Technical specs]

Good: "Modern smartphone, minimalist product photography, centered composition, 
soft studio lighting, 4K resolution, white background"

Poor: "Phone picture"
```

**For API Tools**

```
Be specific about parameters:

Good: "Generate a 1920x1080 image with aspect ratio 16:9"
Poor: "Make it big"
```

#### 3. Resource Management

* **Cache results** when possible
* **Batch similar requests** together
* **Use appropriate quality settings** for different use cases
* **Monitor API quotas** and usage

#### 4. Error Handling

* **Implement retry logic** for transient failures
* **Validate inputs** before API calls
* **Handle rate limiting** gracefully
* **Log errors** for debugging

#### 5. Performance Optimization

**Choose the Right API**

* **Development**: Use faster, cheaper APIs (Flux.1 8B)
* **Production**: Use premium APIs (Ideogram v3 Pro)
* **Bulk operations**: Use volume-optimized APIs

**Optimize Requests**

```python
# Good: Specific, efficient prompt
prompt = "Professional headshot, corporate style, neutral background, high resolution"

# Poor: Vague, might require multiple attempts
prompt = "Make it look good"
```

***

### Troubleshooting

#### Common Issues

**1. MCP Server Not Connecting**

**Symptoms**:

* Claude/Cursor shows "Server not available"
* No MCP tools appearing in interface

**Solutions**:

```bash
# Check Node.js version
node --version  # Should be 18+

# Test MCP endpoint directly
curl -X POST "https://prod.api.market/api/mcp/magicapi/domainchecker" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_KEY" \
  -d '{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {}}'

# Verify API key is valid
# Check API.Market dashboard for key status
```

**2. Authentication Errors**

**Symptoms**:

* "Invalid API key" errors
* "Unauthorized" responses

**Solutions**:

1. Verify API key in API.Market dashboard
2. Check key hasn't expired
3. Ensure sufficient credits/subscription
4. Confirm key format (no extra spaces/characters)

**3. Slow Response Times**

**Symptoms**:

* Long wait times for responses
* Timeouts in MCP clients

**Solutions**:

1. Use faster APIs for testing (Flux.1 8B vs Ideogram v3 Pro)
2. Reduce image resolution for drafts
3. Simplify prompts
4. Check API.Market status page

**4. Tool Not Found Errors**

**Symptoms**:

* "Tool not available" messages
* Missing expected functionality

**Solutions**:

1. Run `tools/list` to see available tools
2. Check tool name spelling
3. Verify API subscription status
4. Restart MCP client

#### Debugging Steps

**1. Test MCP Connection**

```bash
# Test basic connectivity
curl -X POST "https://prod.api.market/api/mcp/magicapi/domainchecker" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_KEY" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "initialize",
    "params": {
      "protocolVersion": "2024-11-05",
      "capabilities": {"tools": {}},
      "clientInfo": {"name": "debug", "version": "1.0.0"}
    }
  }'
```

**2. List Available Tools**

```bash
curl -X POST "https://prod.api.market/api/mcp/magicapi/domainchecker" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_KEY" \
  -d '{
    "jsonrpc": "2.0",
    "id": 2,
    "method": "tools/list",
    "params": {}
  }'
```

**3. Validate Configuration**

```python
import json

# Validate JSON configuration
config = '''
{
  "mcpServers": {
    "domain_checker": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://prod.api.market/api/mcp/magicapi/domainchecker", "--header", "x-api-market-key: YOUR_KEY"],
      "env": {"API_MARKET_KEY": "YOUR_KEY"}
    }
  }
}
'''

try:
    parsed = json.loads(config)
    print("✅ Configuration is valid JSON")
except json.JSONDecodeError as e:
    print(f"❌ Invalid JSON: {e}")
```

***

### Cost Optimization

You must have an active subscription for the given API that you want to use in MCP. Most APIs have a generoud free plan for you to try.

#### Optimization Strategies

**1. API Selection**

```python
# Cost-effective development workflow
development_apis = {
    "quick_testing": "flux-8b-text-to-image",      # Fast & cheap
    "final_production": "ideogram-v3-pro",          # Premium quality
    "batch_processing": "seedream-text-to-image"    # Volume discounts
}
```

**2. Prompt Optimization**

```python
# Efficient: Single prompt, multiple variations
prompt = "Create 3 logo variations for TechFlow: modern, classic, and playful styles"

# Inefficient: Multiple separate calls
# "Create a modern logo for TechFlow"
# "Create a classic logo for TechFlow"  
# "Create a playful logo for TechFlow"
```

**3. Caching Strategy**

```python
import hashlib
import json

def cache_key(tool_name, arguments):
    """Generate cache key for API calls"""
    content = f"{tool_name}:{json.dumps(arguments, sort_keys=True)}"
    return hashlib.md5(content.encode()).hexdigest()

# Cache expensive operations
cache = {}
key = cache_key("createideogram_v3_qualityprediction", arguments)
if key in cache:
    return cache[key]
    
result = client.call_tool("createideogram_v3_qualityprediction", arguments)
cache[key] = result
return result
```

**4. Quality Tiers**

```python
# Development: Use lower quality for iterations
dev_settings = {
    "resolution": "512x512",
    "quality": "standard",
    "iterations": 1
}

# Production: Use premium settings for final output
prod_settings = {
    "resolution": "2048x2048", 
    "quality": "premium",
    "iterations": 4
}
```

***

### FAQ

#### General Questions

**Q: Do I need to install anything to use MCP servers?** \
A: For most clients (Claude Desktop, Cursor), you only need Node.js 18+. The MCP clients handle the rest automatically.

**Q: Can I use multiple APIs simultaneously?** \
A: Yes! You can configure multiple MCP servers and use them together in complex workflows.

**Q: Are there rate limits?** \
A: Rate limits depend on your API.Market subscription tier. Check your dashboard for current limits.

**Q: How do I know which tools are available for each API?** \
A: Use the `tools/list` method or ask your AI client "What tools do you have access to?"

#### Technical Questions

**Q: Can I use MCP servers in my own applications?** \
A: Yes! You can integrate MCP servers into any application that supports the protocol.

**Q: What happens if an API call fails?** \
A: The MCP server returns a JSON-RPC error response with details about the failure.

**Q: Can I customize the tool names?** \
A: Tool names are automatically generated from API endpoints. You can't customize them, but you can create wrapper functions.

**Q: How do I handle long-running operations?** \
A: Some APIs support async operations. Check the API documentation for polling endpoints.

#### Billing Questions

**Q: How am I charged for MCP usage?** \
A: You're charged the same rates as direct API usage. MCP doesn't add any additional fees.

**Q: Can I set spending limits?** \
A: Yes, you can set spending limits in your API.Market dashboard.

**Q: Are there volume discounts?** \
A: Volume discounts are available for high-usage scenarios. Contact support for details.

***

### Support and Resources

#### Documentation

* [API.Market Main Documentation](https://docs.api.market)
* [MCP Protocol Specification](https://modelcontextprotocol.io)
* [Individual API Documentation](https://api.market/search)

#### Support

* Email: <support@api.market>
* Live Chat: Available on api.market
* Status Page: [https://status.api.market](https://status.api.market/status/dash)

***


# Subscription Management API Documentation

APIs to upgrade, downgrade, cancel & Subscribe to various APIs on API.market.

The Subscription Management API allows users to manage their API subscriptions programmatically using API keys. This API supports creating new subscriptions, upgrading/downgrading existing plans, and canceling subscriptions.

### Authentication

All API endpoints require authentication using one of the following headers:

* `x-api-market-key: YOUR_API_KEY_HERE`

### Base URL

* Base URL: `https://api.market/`
* Clean, RESTful design
* Consistent response format

***

## API Endpoints

### 1. Get Product Details with Pricing Plans

Retrieves product information along with all available pricing plans.

**Endpoint:** `GET /api/v1/product/{workspaceSlug}/{productSlug}`

**Request:**

```bash
curl -X GET \
  'https://api.market/api/v1/product/magicapi/upscaler' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY_HERE'
```

**Response:**

````json
{
  "product": {
    "id": "clst0xf230004jr0cdi7j6ttf",
    "slug": "upscaler",
    "title": "🖼️✨Image Upscale API | Streamlined Image Upscaling for Stunning Results",
    "name": "Image Upscaler",
    "description": "# 🖼️✨Image Upscale API\n\n### 🔗 [Documentation](https://docs.api.market/api.market-apis/image-upscale-api)\n\n**Image Upscale API: Unlock High-Resolution Visuals with Ease**\n\nThe **Image Upscale API** leverages advanced super-resolution models to enhance image quality by factors of 2×, 4×, or 8×. Whether you're a developer, designer, or content creator, this service provides a convenient, cost-effective way to boost image resolution without sacrificing clarity or detail. Transform standard images into high-definition files suitable for printing, display, or machine learning datasets.\n\n- **Provider**: MagicAPI\n- **Category**: Image Processing, AI, Design\n- **Tags**: Image Upscaling, Super Resolution, Image Enhancement\n\n---\n\n## Features\n1. **Versatile Upscaling Factors** – Choose between 2×, 4×, or 8× resolution increase.\n   - 2× consumes **1 API unit** per request.\n   - 4× consumes **2 API units** per request.\n   - 8× consumes **4 API units** per request.\n2. **High-Quality Output** – Retain sharpness and detail in a standard JPEG format.\n3. **Easy Integration** – Straightforward HTTP POST requests with JSON bodies.\n4. **Streamlined Workflows** – Automate your image enhancement, saving time and resources.\n5. **Use Anywhere** – Perfect for web design, digital marketing, e-commerce, or ML data.\n\n---\n\n## Use Cases\n- **Digital Media Platforms** – Improve photo quality for online galleries or social media.\n- **E-Commerce Listings** – Present product images in crisp, clear detail.\n- **Machine Learning Datasets** – Enhance image details to improve training accuracy.\n- **Marketing Materials** – Prepare images for high-resolution printing or large displays.\n- **Design & Photography** – Bring out the best in creative assets without manual editing.\n\n---\n\n## API Documentation\n\n### Endpoints\nEach endpoint accepts a JSON body containing the image URL to upscale:\n\n- **2× Upscale**: `POST /upscale2x/`  (1 API unit per API call)\n- **4× Upscale**: `POST /upscale4x/`  (2 API units per API call)\n- **8× Upscale**: `POST /upscale8x/`  (4 API units per API call)\n\n| Parameter | Type   | Required | Description                       |\n|-----------|--------|----------|-----------------------------------|\n| `url`     | string | Yes      | The publicly accessible image URL |\n\n### cURL Example (2× Upscale)\n```bash\ncurl -X 'POST' \\\n  'https://api.magicapi.dev/api/v1/magicapi/upscaler/upscale2x/' \\\n  -H 'accept: image/jpeg' \\\n  -H 'x-api-market-key: API_KEY' \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n    \"url\": \"https://production-media.paperswithcode.com/datasets/Set5-0000002728-07a9793f_zA3bDjj.jpg\"\n}'\n```\n\n**Sample Output Image**\n<img src=\"https://blog.api.market/wp-content/uploads/2024/04/image-upscaler-product-pic.jpeg\" alt=\"Upscaled Image\"/>\n\n**Response Format**\n- **JPEG Image** – The upscaled image is returned directly in the response body.\n\n---\n\n## Status Codes\n\n| Code | Description                                                     |\n|------|-----------------------------------------------------------------|\n| 200  | The image was successfully upscaled and returned as a JPEG     |\n| 400  | Bad request – possibly missing parameters or invalid image URL  |\n| 500  | Internal server error – an unexpected error occurred            |\n\n---\n\n## SEO Keywords\nimage upscaling, super-resolution, AI image enhancement, high-resolution, photo improvement, design tools, content creation\n\n---\n\n**Elevate your visuals with the Image Upscale API**—the quickest way to turn standard images into stunning, high-definition assets. Whether you're building a photo-editing tool, improving e-commerce product listings, or preparing content for high-res displays, our API ensures you get premium results with minimal effort. Unlock new creative possibilities and deliver top-tier visuals with every request.\n\n",
    "categories": [
      "tools",
      "visual-recognition",
      "artificial-intelligence",
      "image-to-image"
    ],
    "workspace": {
      "slug": "magicapi",
      "name": "MagicAPI"
    }
  },
  "pricingPlans": [
    {
      "id": "cltivivul000clc0crn8momz5",
      "name": "Mega",
      "access": "public",
      "pricingPlanConfig": {
        "maxTPS": "100",
        "aPILimitType": "HARD",
        "apiCallLimit": "25000",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": "89"
      }
    },
    {
      "id": "cltivgy940008lc0ccgeger63",
      "name": "Ultra",
      "access": "public",
      "pricingPlanConfig": {
        "maxTPS": "100",
        "aPILimitType": "HARD",
        "apiCallLimit": "10000",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": "45"
      }
    },
    {
      "id": "cltive4k60004jm0c3yok8ig3",
      "name": "Pro",
      "access": "public",
      "pricingPlanConfig": {
        "maxTPS": "100",
        "aPILimitType": "HARD",
        "apiCallLimit": "1000",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": "8"
      }
    },
    {
      "id": "cltivkbfl000glc0chhfqt24z",
      "name": "Giga",
      "access": "public",
      "pricingPlanConfig": {
        "maxTPS": "100",
        "aPILimitType": "HARD",
        "apiCallLimit": "100000",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": "199"
      }
    },
    {
      "id": "clst0y61m0004jq0cwq4qvl7j",
      "name": "Free",
      "access": "public",
      "pricingPlanConfig": {
        "maxTPS": "100",
        "aPILimitType": "HARD",
        "apiCallLimit": "100",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": 0
      }
    }
  ]
}
````

### 2. Get Current Subscription Details

Retrieves the current subscription status for a specific product.

**Endpoint:** `GET /api/v1/subscription/{workspaceSlug}/{productSlug}`

**Request:**

```bash
curl -X GET \
  'https://api.market/api/v1/subscription/magicapi/upscaler' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY_HERE'
```

**Response (Active Subscription):**

```json
{
  "subscription": {
    "id": "cmfcerwmv0001le04krvsl2f8",
    "subscriptionStatus": "SUBSCRIBED",
    "currentPeriodStartDate": "2025-09-09T10:29:15.894Z",
    "endDate": null,
    "renewDate": "2025-10-09T10:29:15.894Z",
    "apiCallsMade": 0,
    "cancellationDate": null,
    "pricingPlan": {
      "id": "clsncx2d10004l10cjr09rj3w",
      "name": "Free",
      "pricingPlanConfig": {
        "maxTPS": "100",
        "aPILimitType": "HARD",
        "apiCallLimit": "100",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": "0"
      }
    },
    "product": {
      "slug": "faceswap",
      "title": "FaceSwap API"
    },
    "workspace": {
      "slug": "magicapi"
    }
  }
}
```

**Response (No Subscription):**

```json
{
  "subscription": null,
  "message": "No active subscription found for this product"
}
```

### 3. Create/Upgrade/Downgrade Subscription

Creates a new subscription or changes an existing subscription to a different pricing plan.

**Endpoint:** `POST /api/v1/subscription/{workspaceSlug}/{productSlug}/{pricingPlanId}`

**Request:**

```bash
curl -X POST \
  'https://api.market/api/v1/subscription/magicapi/upscaler/cltivivul000clc0crn8momz5' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY_HERE' \
  -d '{
    "additionalData": "optional",
    "isDryRun": false
  }'
```

**Request Body Parameters:**

* `additionalData` (optional): Additional information for the subscription
* `isDryRun` (optional): Set to `true` to simulate the operation without making changes

**Response (New Subscription):**

```json
{
  "subscription": {
    "id": "cmeh11x2o0000p3vx3lbt174m",
    "subscriptionStatus": "SUBSCRIBED",
    "currentPeriodStartDate": "2025-08-18T11:24:16.942Z",
    "endDate": null,
    "renewDate": "2025-09-18T11:24:16.942Z",
    "pricingPlan": {
      "id": "cltivivul000clc0crn8momz5",
      "name": "Mega",
      "pricingPlanConfig": {
        "maxTPS": 100,
        "aPILimitType": "HARD",
        "apiCallLimit": "25000",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": 89
      }
    }
  },
  "action": "subscribed"
}
```

**Response (Upgrade/Downgrade):**

```json
{
  "subscription": {
    "id": "cmeh11x2o0000p3vx3lbt174m",
    "subscriptionStatus": "SUBSCRIBED",
    "currentPeriodStartDate": "2025-08-18T11:24:16.942Z",
    "endDate": null,
    "renewDate": "2025-09-18T11:24:16.942Z",
    "pricingPlan": {
      "id": "cltivivul000clc0crn8momz5",
      "name": "Mega"
    }
  },
  "action": "upgraded",
  "previousSubscription": {
    "id": "previous-subscription-id",
    "subscriptionStatus": "CANCELLED",
    "currentPeriodStartDate": "2025-07-18T11:24:16.942Z",
    "endDate": "2025-08-18T11:24:16.942Z",
    "renewDate": "2025-08-18T11:24:16.942Z",
    "apiCallsMade": 1250,
    "cancellationDate": "2025-08-18T11:24:16.942Z",
    "pricingPlan": {
      "id": "previous-plan-id",
      "name": "Ultra",
      "pricingPlanConfig": {
        "maxTPS": 100,
        "aPILimitType": "HARD", 
        "apiCallLimit": "10000",
        "apiSoftLimitOverHead": 0.001,
        "subscriptionPricePerMonth": 45
      }
    },
    "product": {
      "slug": "upscaler",
      "name": "Image Upscaler"
    },
    "workspace": {
      "slug": "magicapi"
    }
  }
}
```

**Action Types:**

* `subscribed`: First-time subscription
* `resubscribed`: Re-subscribing to the same plan
* `upgraded`: Moving to a higher-priced plan
* `downgraded`: Moving to a lower-priced plan
* `unchanged`: Same price, different plan
* `changed`: Plan changed but price comparison failed

### 4. Cancel Subscription

Cancels the current subscription for a product.

**Endpoint:** `DELETE /api/v1/subscription/{workspaceSlug}/{productSlug}`

**Request:**

```bash
curl -X DELETE \
  'https://api.market/api/v1/subscription/magicapi/upscaler' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY_HERE' \
  -d '{
    "cancelImmediately": false,
    "reason": "No longer needed"
  }'
```

**Request Body Parameters:**

* `cancelImmediately` (optional): Set to `true` to cancel immediately, `false` to cancel at period end
* `reason` (optional): Reason for cancellation

**Response:**

```json
{
  "subscription": {
    "id": "cmeh11x2o0000p3vx3lbt174m",
    "subscriptionStatus": "CANCELLED",
    "cancellationDate": "2025-08-18T11:26:59.422Z",
    "endDate": "2025-09-18T11:24:16.942Z",
    "pricingPlan": {
      "id": "cltivivul000clc0crn8momz5",
      "name": "Mega"
    },
    "product": {
      "slug": "upscaler",
      "title": "Image Upscaler"
    },
    "workspace": {
      "slug": "magicapi"
    }
  },
  "message": "Subscription cancelled successfully",
  "cancelledImmediately": false
}
```

***

## Error Handling

### HTTP Status Codes

* **200**: Success
* **400**: Bad Request (missing parameters, invalid data)
* **401**: Unauthorized (invalid or missing API key)
* **403**: Forbidden (insufficient permissions)
* **404**: Not Found (product, pricing plan, or subscription not found)
* **405**: Method Not Allowed
* **409**: Conflict (subscription already exists, invalid state transition)
* **500**: Internal Server Error

### Error Response Format

```json
{
  "error": "Error message description"
}
```

***

## Rate Limiting

* API calls are subject to rate limiting based on your subscription plan
* Rate limits are enforced per API key
* Exceeding limits will result in 429 (Too Many Requests) responses

***

## Best Practices

### 1. Always Check Current Subscription

Before making changes, retrieve the current subscription to understand the current state.

### 2. Use Dry Run for Testing

Set `isDryRun: true` in the request body to simulate operations without making actual changes.

### 3. Handle Errors Gracefully

Implement proper error handling for all API responses, especially for network failures.

### 4. Monitor Subscription Changes

Track subscription changes in your application to provide users with real-time updates.

***

## Example Integration

```javascript
class SubscriptionManager {
  constructor(apiKey, baseUrl = 'https://api.market') {
    this.apiKey = apiKey;
    this.baseUrl = baseUrl;
  }

  async getProductDetails(workspaceSlug, productSlug) {
    const response = await fetch(
      `${this.baseUrl}/api/v1/product/${workspaceSlug}/${productSlug}`,
      {
        headers: {
          'x-api-market-key': this.apiKey,
          'accept': 'application/json'
        }
      }
    );
    return response.json();
  }

  async getCurrentSubscription(workspaceSlug, productSlug) {
    const response = await fetch(
      `${this.baseUrl}/api/v1/subscription/${workspaceSlug}/${productSlug}`,
      {
        headers: {
          'x-api-market-key': this.apiKey,
          'accept': 'application/json'
        }
      }
    );
    return response.json();
  }

  async createSubscription(workspaceSlug, productSlug, pricingPlanId, options = {}) {
    const response = await fetch(
      `${this.baseUrl}/api/v1/subscription/${workspaceSlug}/${productSlug}/${pricingPlanId}`,
      {
        method: 'POST',
        headers: {
          'x-api-market-key': this.apiKey,
          'Content-Type': 'application/json'
        },
        body: JSON.stringify({
          isDryRun: options.dryRun || false,
          additionalData: options.additionalData || ''
        })
      }
    );
    return response.json();
  }

  async cancelSubscription(workspaceSlug, productSlug, options = {}) {
    const response = await fetch(
      `${this.baseUrl}/api/v1/subscription/${workspaceSlug}/${productSlug}`,
      {
        method: 'DELETE',
        headers: {
          'x-api-market-key': this.apiKey,
          'Content-Type': 'application/json'
        },
        body: JSON.stringify({
          cancelImmediately: options.immediate || false,
          reason: options.reason || ''
        })
      }
    );
    return response.json();
  }
}

// Usage
const manager = new SubscriptionManager('your-api-key');

// Get product details
const product = await manager.getProductDetails('magicapi', 'upscaler');

// Check current subscription
const subscription = await manager.getCurrentSubscription('magicapi', 'upscaler');

// Create new subscription
const newSubscription = await manager.createSubscription(
  'magicapi', 
  'upscaler', 
  'cltivivul000clc0crn8momz5',
  { dryRun: false }
);

// Cancel subscription
const cancelResult = await manager.cancelSubscription(
  'magicapi', 
  'upscaler',
  { reason: 'No longer needed', immediate: false }
);
```

***

## Support

For technical support or questions about the Subscription Management API:

* **Documentation**: [docs.api.market](https://docs.api.market)
* **API Status**: [status.api.market](https://status.api.market)
* **Support Email**: <support@api.market>


# API.market Usage API Documentation

API .market already shows usage analytics in the dashboard, but many teams prefer to pull the same numbers into their own scripts and observability pipelines. The **Usage API** gives every subscriber a simple, read-only REST endpoint that returns quota, calls made, and renewal dates for each active plan. Because usage metering is part of the core platform, the same pattern works for any product listed on API .market—from a 3D asset generator to FaceSwap V2. ([docs.api.market](https://docs.api.market/?utm_source=chatgpt.com), [docs.api.market](https://docs.api.market/seller-docs/analytics-and-logs?utm_source=chatgpt.com))

#### Base URL

```
https://prod.api.market
```

All paths below are appended to this base.

#### Authentication

Pass your personal or workspace API key in the custom x-api-market-key request header. This keyed-header scheme follows the same convention used by AWS API Gateway and other major providers. ([Swagger](https://swagger.io/docs/specification/v3_0/authentication/api-keys/?utm_source=chatgpt.com), [Stoplight](https://blog.stoplight.io/api-keys-best-practices-to-authenticate-apis?utm_source=chatgpt.com))

```
x-api-market-key: YOUR_API_MARKET_KEY
```

> **Keep keys secret.** They grant full metered access to every subscription under the issuing account.

#### Standard Headers

| Header           | Value                               | Purpose                                                                                                                                                                                                                                                         |
| ---------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Accept`         | `application/json`                  | Request JSON only ([MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept?utm_source=chatgpt.com), [Microsoft Learn](https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design?utm_source=chatgpt.com)) |
| `Content-Type`\* | `application/x-www-form-urlencoded` | Kept for historical parity; payload-less GETs ignore it                                                                                                                                                                                                         |

\*Sent for completeness, although GET bodies are ignored per HTTP spec.

***

### Endpoint 1 – Usage for a Single Subscription

|                   |                                                                           |
| ----------------- | ------------------------------------------------------------------------- |
| **Method**        | `GET`                                                                     |
| **Path**          | `/user/usage/{storeSlug}/{apiProduct}/`                                   |
| **Auth Required** | Yes – x-api-market-key                                                    |
| **Rate Limit**    | 30 requests / minute (burst up to 60)                                     |
| **Success Code**  | `200 OK`                                                                  |
| **Error Codes**   | `401` (invalid key) · `404` (unknown subscription) · `429` (rate-limited) |

#### Path Parameters

| Name         | Example       | Description                                                                                                                      |
| ------------ | ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `storeSlug`  | `magicapi`    | The marketplace “store” that owns the product                                                                                    |
| `apiProduct` | `faceswap-v2` | Product slug shown in the URL and dashboard ([API.market](https://api.market/store/magicapi/faceswap-v2?utm_source=chatgpt.com)) |

#### Example Request (cURL)

```bash
curl -X GET \
  'https://prod.api.market/api/v1/user/usage/magicapi/faceswap-v2/' \
  -H 'x-api-market-key: YOUR_API_MARKET_KEY' \
  -H 'accept: application/json'
```

#### Example Response

```json
{
  "apiName": "magicapi/faceswap-v2",
  "store": "magicapi",
  "apiProduct": "faceswap-v2",
  "quota": 10000,
  "apiCallsLeft": 4158,
  "apiCallsMade": 5842,
  "startDate": "2025-04-30T19:11:38.010Z",
  "renewDate": "2025-05-30T19:11:38.010Z",
  "endDate": null
}
```

**Field Reference**

| Field          | Type             | Notes                                                       |
| -------------- | ---------------- | ----------------------------------------------------------- |
| `apiName`      | string           | `<store>/<product>` canonical identifier                    |
| `store`        | string           | Slug of the provider store                                  |
| `apiProduct`   | string           | Slug of the pricing plan / product                          |
| `quota`        | int              | Monthly (or plan) call allowance                            |
| `apiCallsLeft` | int              | Remaining calls in current period                           |
| `apiCallsMade` | int              | Calls consumed so far                                       |
| `startDate`    | ISO-8601         | Billing cycle start                                         |
| `renewDate`    | ISO-8601         | Next automatic renewal/refresh                              |
| `endDate`      | ISO-8601 \| null | Expiry date for one-off plans; usually `null` for recurring |

#### Quick-start Code

```python
import requests, os

API_KEY = os.getenv("API_MARKET_KEY")
url = "https://prod.api.market/api/v1/user/usage/magicapi/faceswap-v2/"
headers = {
    "x-api-market-key": API_KEY,
    "accept": "application/json"
}
resp = requests.get(url, headers=headers, timeout=10)
resp.raise_for_status()
print(resp.json()["apiCallsLeft"])
```

```js
const res = await fetch(
  "https://prod.api.market/api/v1/user/usage/magicapi/faceswap-v2/",
  {
    method: "GET",
    headers: {
      "x-api-market-key": process.env.API_MARKET_KEY,
      "accept": "application/json"
    }
  }
);

if (!res.ok) throw new Error(`HTTP ${res.status}`);
const data = await res.json();
console.log(`Calls left: ${data.apiCallsLeft}`);
```

***

### Endpoint 2 – Usage for **All** Active Subscriptions

|                   |                |
| ----------------- | -------------- |
| **Method**        | `GET`          |
| **Path**          | `/user/usage/` |
| **Auth Required** | Yes            |
| **Success Code**  | `200 OK`       |

#### Example Request

```bash
curl -X GET 'https://prod.api.market/api/v1/user/usage/' \
  -H 'x-api-market-key: YOUR_API_MARKET_KEY' \
  -H 'accept: application/json'
```

#### Example Response (truncated)

```json
{
  "usageData": [
    {
      "apiName": "magicapi/3d-asset-generator-api",
      "quota": 20,
      "apiCallsLeft": 18,
      "apiCallsMade": 2,
      "startDate": "2025-05-15T08:13:46.412Z",
      "renewDate": "2025-06-15T08:13:46.412Z",
      "endDate": null
    },
    {
      "apiName": "magicapi/faceswap-capix",
      "quota": 100,
      "apiCallsLeft": 87,
      "apiCallsMade": 13,
      "startDate": "2025-05-14T17:17:46.260Z",
      "renewDate": "2025-06-14T17:17:46.260Z",
      "endDate": null
    }
    /* …additional items… */
  ]
}
```

The response is an object with a single key, `usageData`, which is an array of the per-product schema described above.

***

### Error Handling

| Status                  | Meaning                                      | Sample Payload                       |
| ----------------------- | -------------------------------------------- | ------------------------------------ |
| `401 Unauthorized`      | Missing or invalid `x-api-market-key`.       | `{"error":"invalid_api_key"}`        |
| `404 Not Found`         | No subscription matches the path.            | `{"error":"subscription_not_found"}` |
| `429 Too Many Requests` | Rate-limit exceeded. Retry-After header set. | `{"error":"rate_limited"}`           |
| `5xx`                   | Upstream or gateway fault.                   | `{"error":"server_error"}`           |

***

### Best Practices & Tips

* **Cache locally**: Usage numbers change only when you make calls; polling every few minutes is sufficient for most dashboards.
* **Sync with UI analytics**: Results match the figures displayed under **Analytics → Account Usage** in the web console. ([docs.api.market](https://docs.api.market/analytics-and-logs?utm_source=chatgpt.com))
* **Custom Usage adjustments**: If a seller overrides usage via custom headers or the override endpoint, those changes are reflected instantly in this API. ([docs.api.market](https://docs.api.market/seller-docs/custom-usage?utm_source=chatgpt.com))
* **Rotate keys**: Treat the `x-api-market-key` like a password; rotate periodically and immediately on suspected compromise. ([Stack Overflow](https://stackoverflow.com/questions/43209924/rest-api-use-the-accept-application-json-http-header?utm_source=chatgpt.com))
* **Follow REST conventions** when embedding the endpoint in client SDKs for long-term stability. ([Stack Overflow Blog](https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/?utm_source=chatgpt.com))

***

#### Changelog

| Date           | Change                 |
| -------------- | ---------------------- |
| **2025-05-17** | Initial public release |

***

**Happy building!**


# API Seller Console

The **Seller Console** is your home base on api.market. It is where you connect your API, turn it into a product, set your prices, and track your sales — all from one place.

<div data-with-frame="true"><figure><img src="/files/OhCTg0Rb77ene5MXNgcj" alt=""><figcaption><p>Seller Console dashboard with the setup checklist</p></figcaption></figure></div>

{% hint style="info" %}
💡 **New here?** This guide walks you through setup one step at a time. You do not have to finish in one sitting — your progress is saved, so you can pick up where you left off.
{% endhint %}

### 🚀 How api.market works

api.market sits between your API and the developers who use it. You publish your API once, and the platform handles the hard parts — sign-up, API keys, billing, rate limits, and routing — so you can focus on building.

<div data-with-frame="true"><figure><img src="/files/xAODaBnLyUtHjPFmoVJb" alt=""><figcaption></figcaption></figure></div>

api.market takes care of:

* **Authentication** — customers generate and manage their own API keys
* **Billing** — invoices, payments, and payouts run through Stripe
* **Analytics** — usage tracking across every product and customer
* **User Portal** — a ready-made portal where developers self-serve
* **API Proxy** — requests are securely routed to your backend

### 🏢 Step 1 — Create your organization

Your **organization** is your store on api.market. Every product you sell lives inside it, so you need one before you can import an API.

1. On the Seller Console, click **Start** next to **Create organization** — or use **+ Create Organization** in the sidebar.
2. Enter a name for your store (for example, SmartAPI). Keep it under 16 characters.
3. Click **Create Organization**.

<div data-with-frame="true"><figure><img src="/files/ykCbt0VkMILYA4AVf5Kl" alt=""><figcaption></figcaption></figure></div>

Once created, you land inside your new store. Your organization name shows in the sidebar dropdown, so you can switch stores if you run more than one.

### 📊 Your Store Overview

Inside your organization, the **Overview** page is a quick snapshot of how your store is doing:

| Card                     | What it shows                             |
| ------------------------ | ----------------------------------------- |
| **Products**             | How many API products you have created    |
| **Published**            | Products that are live on the marketplace |
| **Users**                | Developers who have subscribed            |
| **Active subscriptions** | Customers currently paying                |
| **Total revenue**        | Your earnings so far                      |
| **API calls**            | Total usage across your products          |

<div data-with-frame="true"><figure><img src="/files/LvktWBegldZg1qES3dLv" alt=""><figcaption></figcaption></figure></div>

This becomes your day-to-day dashboard once setup is done.

### 🗺️ Your setup journey

Work through these pages in order. Each one explains a step in detail with screenshots.

1. [**Importing an API Source**](/seller-docs/importing-an-api-source) — upload your OpenAPI (Swagger) file so api.market knows how to reach your backend.
2. [**What Is an API Product**](/what-are-api-products) — turn your source into a listing with a title, description, and the URL customers call.
3. [**What Are Pricing Plans**](/seller-docs/what-is-a-pricing-plan) — decide how customers pay: a monthly subscription or pay-as-you-go.
4. [**Submitting for Review**](/seller-docs/submitting-for-review) — send your finished product to the api.market team for approval.
5. [**Adding Payout Details** ](/seller-docs/adding-payout-details)— add your bank or PayPal details so you get paid.
6. [**Adding Store Details**](/seller-docs/adding-store-details) — name and brand your store so customers recognize you.

{% hint style="info" %}
💡 **Tip:** Use the sidebar links under **Manage APIs**, **Sales**, and **Settings** to jump straight to each step.
{% endhint %}

### ✅ You are all set

When every step is done, the Seller Console shows **"Your store setup is complete."**

<div data-with-frame="true"><figure><img src="/files/ztjcHs1RglKECgRnIghG" alt=""><figcaption></figcaption></figure></div>

{% hint style="success" %}
🎉 **Congratulations!** Your store is live. Developers can now discover and subscribe to your API.
{% endhint %}

### ❓ Need help?

* 📖 **Docs** — link on your store Overview page
* 💬 **Chat support** — the blue chat bubble in the bottom-right corner
* 📅 **Schedule a call** — from the Seller Console welcome card

***

**Next →** [Importing an API Source](/seller-docs/importing-an-api-source)


# Importing an API Source

Import an OpenAPI spec to create an API Source

To create an API store, you first connect your APIs to [API.market](https://api.market/). When a user calls API.market, the platform calls your API using the API Source you define and its configuration.

#### 🎯 Overview

The **API Source** is the OpenAPI specification that connects your APIs to API.market. API.market acts as an API gateway, making your API available through a unified platform.

{% hint style="info" %}
💡 **How it works:** API.market proxies requests to your API using the OpenAPI specification. This lets API.market handle authentication, billing, analytics, and rate limiting automatically.
{% endhint %}

#### 📋 Prerequisites

Before you begin, you will need:

✅ An OpenAPI specification file (YAML or JSON)\
✅ Your API's base URL\
✅ Authentication details (if required)

{% hint style="warning" %}
⚠️ **Don't have an OpenAPI spec yet?** You can create one using ChatGPT. Follow our guide: [Create OpenAPI spec using ChatGPT](/fundamentals/create-openapi-spec-using-chatgpt)
{% endhint %}

#### 🚀 Step-by-step guide

**Step 1 — Open "OpenAPI Specs"**

Go to the Seller Console and select your organization from the dropdown. Then click **"Manage APIs"** in the left sidebar and select **"OpenAPI Specs"**.<br>

<div data-with-frame="true"><figure><img src="/files/AGcQN0gYyCcBqI0xE6wT" alt=""><figcaption></figcaption></figure></div>

***

**Step 2 — Import the OpenAPI YAML or JSON file**

Upload or drag and drop your OpenAPI specification file. You should see the paths imported from the file.

<div data-with-frame="true"><figure><img src="/files/I50h0mSkT3wSQ29CBMox" alt=""><figcaption></figcaption></figure></div>

**Step 3 — Configure custom headers**

Next, add any custom headers that should be included in every API request to your backend.

1. Enter a JSON object in the text area.
2. Format: `{"Header-Name": "header-value"}`
3. Example:

```json
{
  "Content-Type": "application/json",
  "Accept": "application/json",
  "X-Custom-Header": "custom-value"
}
```

{% hint style="info" %}
💡 **No custom headers?** Leave this as `{}` (an empty JSON object) and continue.
{% endhint %}

<div data-with-frame="true"><figure><img src="/files/IlzMIhrnlIf2V5DUj5FT" alt=""><figcaption></figcaption></figure></div>

**Step 4 — Configure base path URL**

Set the base URL for all API requests. This is the root address API.market will call.

1. The field may be pre-filled if a `servers` entry was detected in your OpenAPI spec.
2. Review or enter your API's base URL.
3. Format: `https://api.example.com/v1`
4. This URL is used as the base for every API request.

**Example:**

```
https://api.example.com/v1
```

<div data-with-frame="true"><figure><img src="/files/acg5ph2csSt1zO02CObq" alt=""><figcaption></figcaption></figure></div>

**Step 5 — Configure authentication**

Choose how API.market authenticates with your backend when it forwards a request. You have five options.

**Option 1 — No authentication**

* Select the **"None"** tab.
* No authentication is used when making API requests.

<div data-with-frame="true"><figure><img src="/files/1jBd2jdBAOvZUYkCrBLF" alt=""><figcaption></figcaption></figure></div>

**Option 2 — API Key**

* Select the **"API Key"** tab.
* Enter the **Header Name** (e.g. `X-API-Key`, `Authorization`).
* Enter the **API Key Value** (masked for security).
* The API key is sent in the specified header with each request.

*Example —* Header Name: `X-API-Key` · API Key Value: `your-secret-api-key`

<div data-with-frame="true"><figure><img src="/files/3309hhgB6CddZzjoKXKC" alt=""><figcaption></figcaption></figure></div>

**Option 3 — Bearer Token**

* Select the **"Bearer Token"** tab.
* Enter your bearer token (masked for security).
* The token is sent in the `Authorization` header as `Bearer <token>`.

*Example —* Token: `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`&#x20;

<div data-with-frame="true"><figure><img src="/files/j6AzrGD8jiIUh3mkMuZE" alt=""><figcaption></figcaption></figure></div>

**Option 4 — Basic Auth**

* Select the **"Basic Auth"** tab.
* Enter your **Username** and **Password** (masked for security).
* Credentials are base64 encoded and sent in the `Authorization` header.

*Example —* Username: `myuser` · Password: `mypassword`&#x20;

<div data-with-frame="true"><figure><img src="/files/R210x2i0goCIWF78YtIs" alt=""><figcaption></figcaption></figure></div>

**Option 5 — Query Parameter**

* Select the **"Query Param"** tab.
* Enter the **Parameter Key** (e.g. `api_key`, `token`).
* Enter the **Parameter Value** (masked for security).
* The parameter is added to the query string of each request.

*Example —* Param Key: `api_key` · Param Value: `your-api-key-value`

<div data-with-frame="true"><figure><img src="/files/DsueaMCIi4CCQZpujeDe" alt=""><figcaption></figcaption></figure></div>

{% hint style="warning" %}
🔒 **Security:** Your backend credentials are stored securely and never shown to your customers. Customers authenticate with API.market using their own key.
{% endhint %}

**Step 6 — Review summary and create**

Review all your configuration before creating the API Source. The summary shows:

* **API Source Name** — the detected or entered name
* **API Version** — the detected version
* **Base URL** — the configured base URL
* **Custom Headers** — the JSON object of custom headers
* **Authentication** — the selected method and configuration
* **Endpoints** — the list of all detected endpoints

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

**Review checklist:**

* ✅ API name and version are correct
* ✅ Base URL is correct
* ✅ Custom headers are properly formatted
* ✅ Authentication is configured correctly
* ✅ All expected endpoints are listed

Then click **"Create API Source"**. Your API Source is created and you are taken back to the API Sources list, where you should see it appear.

{% hint style="success" %}
🎉 **Success!** Your API Source is ready to use when creating products.
{% endhint %}

***

#### ✅ What's next?

After importing your API Source, you can:

1. **Create products** — use your API Source to create API products
2. **Configure pricing plans** — set up pricing for your endpoints
3. **Test your APIs** — use the API Playground to test your endpoints
4. **View analytics** — monitor usage and performance

***

#### 🛠️ Troubleshooting

**"No endpoints found"**\
Check that your OpenAPI spec has a `paths` object with at least one endpoint defined.

**"Invalid JSON/YAML"**\
Validate your OpenAPI spec with an online tool such as [Swagger Editor](https://editor.swagger.io/).

**"Base URL not detected"**\
Make sure your spec includes a `servers` array with at least one URL, or enter it manually in Step 5.

**"Authentication not working"**\
Verify your credentials are correct, check that the header name matches what your API expects, and confirm the authentication type matches your API's requirements.

***

#### 💡 Best practices

1. **Validate your OpenAPI spec** — use tools like Swagger Editor before importing.
2. **Test authentication** — after creating your source, test it with a sample request.
3. **Use descriptive names** — pick clear API Source names you can identify later.
4. **Document custom headers** — keep track of what headers you use and why.
5. **Version your APIs** — use semantic versioning (e.g. `1.0.0`, `2.1.3`).

***

**Next →** [What Is an API Product](/what-are-api-products)


# What is an API Product?

An **API product** is the listing customers see and subscribe to on api.market. Your API source is the technical connection to your backend; the product is the public page — with a name, description, pricing, and the endpoints you choose to expose.

### 🔄 Source vs. product

|             | API Source                             | API Product                           |
| ----------- | -------------------------------------- | ------------------------------------- |
| What it is  | Your OpenAPI spec + backend connection | The marketplace listing               |
| Who sees it | Only you                               | Customers on api.market               |
| Contains    | All endpoints from your spec           | Selected endpoints, pricing, and copy |

You always import a **source** first, then create one or more **products** from it.

### 🛠️ Create a product

You can start two ways:

* From **API Sources**, click **Create Product** on the green banner.
* From **Manage APIs → API Products**, click **Create Product**.

#### 🔗 Choose your product slug

The **API prefix / product slug** becomes part of the URL customers call. Use lowercase letters, numbers, and hyphens, and keep it short and descriptive.

<div data-with-frame="true"><figure><img src="/files/qGgzWK0yaBaRJ4O0Ohhy" alt=""><figcaption></figcaption></figure></div>

{% hint style="warning" %}
⚠️ **Important:** You cannot change the slug after the product is created, so choose it carefully.
{% endhint %}

### 📝 Fill in the product details

After creating the product you land on **Product Settings**. A **publishing checklist** at the top tracks what is left to do:

| Step                 | Requirement                      |
| -------------------- | -------------------------------- |
| 1. Product details   | Title, subtitle, and description |
| 2. Pricing plans     | At least one plan                |
| 3. Submit for review | Unlocks after steps 1 and 2      |
|                      |                                  |

<div data-with-frame="true"><figure><img src="/files/Na1xSR3sHrS6aHETSQT4" alt=""><figcaption></figcaption></figure></div>

Fill in:

* **Title** — a clear, catchy headline for your product page.
* **Subtitle** — a one-line summary (max 160 characters).
* **Description** — the full product page, written in markdown. Add features, examples, and FAQs, or click **Generate with AI** for a starting draft.

{% hint style="info" %}
💡 **Tip:** Use **Preview Product** (top right) to see exactly how your listing looks to customers, and click **Save** as you go.
{% endhint %}

When your details are filled in, step 1 of the checklist turns green.

***

**Next →** [What Are Pricing Plans](/seller-docs/what-is-a-pricing-plan)


# What is a Pricing Plan

Products are the basic unit at api.market that you use to sell APIs. Each Product needs to have **one or more Pricing Plans**.

Pricing Plan Config allows you to offer different types of Products suited for your Business Use-Case. You can offer a limited FREE version or offer a pay-per-use Plan.

{% hint style="info" %}
:bulb: **Flexible Configuration:** A Pricing Plan can be configured in many different ways to match your business needs. The examples below show some of the more frequently used configurations.
{% endhint %}

<div data-with-frame="true"><figure><img src="/files/5VyO6qB235jGmiEbp2FV" alt=""><figcaption><p>Pricing Plans</p></figcaption></figure></div>

### :moneybag: Various Types of Pricing Plans

These plans are not really types but various examples of the Pricing Plan configured differently. You can configure the Pricing Plan of a Product in whatever way you may like.

**1. FREE**

**Settings:**

* **Pricing:** $0/month
* **Limited API Calls**
* **Hard LIMIT**
* **No Credit Card Required**

This Pricing Plan allows API Sellers to offer a free product that enables users to experience the platform without providing credit card information. Typically, this plan is limited to a few hundred API calls per month.

{% hint style="success" %}
:white\_check\_mark: **Best for:** Getting users to try your API without barriers. Great for onboarding and building trust.
{% endhint %}

**2. Pay Per User (Pay-As-You-Go)**

**Settings:**

* **Pricing:** $0/month
* **Large number of API Calls**
* **Soft LIMIT with Overage Charges**
* **Credit Card Required**

This Pricing Plan allows API Sellers to offer a product where charges are incurred at the end of the subscription cycle based on usage, calculated as the number of API Calls multiplied by the Cost per API Call.

{% hint style="info" %}
:bulb: **How it works:** Customers pay only for what they use. Charges are calculated at the end of each billing cycle.
{% endhint %}

**3. Subscription**

**Settings:**

* **Pricing:** Greater than $0/month
* **Defined Number of API Calls**
* **Hard LIMIT with No Overage Charges**
* **Credit Card Required**

This Pricing Plan enables API Sellers to provide a straightforward subscription product. Once the customer reaches the allocated quota of API calls, they will receive a 429 error.

{% hint style="warning" %}
:warning: **Note:** When customers hit their quota, they'll receive a 429 (Too Many Requests) error until the next billing cycle.
{% endhint %}

**4. Subscription with Overage**

**Settings:**

* **Pricing:** Greater than $0/month
* **Defined Number of API Calls**
* **Soft LIMIT with Overage Charges**
* **Credit Card Required**

This Pricing Plan allows API Sellers to provide a subscription product where customers are charged based on the overage amount once they exceed the allocated quota of API calls.

{% hint style="info" %}
:bulb: **Best for:** Customers who want predictable monthly costs but may occasionally need more capacity.
{% endhint %}

### 📍 Where to add plans

1. Open your product under **Manage APIs → API Products**.
2. Open the **Manage Pricing Plans** tab.
3. Click **Add Pricing Plans**.

<div data-with-frame="true"><figure><img src="/files/HrslYtfNj3woVjXr5LQc" alt=""><figcaption></figcaption></figure></div>

Adding a plan opens a short wizard.

#### 1️⃣ Details

Set the basics for the plan.

| Field             | What to enter                                          |
| ----------------- | ------------------------------------------------------ |
| **Plan name**     | A short label, max 5 characters (e.g. FREE, PRO, BULK) |
| **API source**    | The source you imported                                |
| **Base path URL** | Usually inherited from the source                      |

<div data-with-frame="true"><figure><img src="/files/bTMZEf0OBF3pFmc9qlDP" alt=""><figcaption></figcaption></figure></div>

#### 2️⃣ API routes

Choose which endpoints this plan includes. Use **Select All** or pick individual routes.

<div data-with-frame="true"><figure><img src="/files/X6T2pWAx67O1jvtWVota" alt=""><figcaption></figcaption></figure></div>

{% hint style="info" %}
💡 **Tip:** Different plans can expose different endpoints — for example, a free tier with one endpoint and a pro tier with all of them.
{% endhint %}

#### 3️⃣ Pricing model

Pick how customers are billed.

**Subscription** — a monthly fee with an included call quota.

<div data-with-frame="true"><figure><img src="/files/pC1oNiMG2iisKJsKaTS9" alt=""><figcaption></figcaption></figure></div>

| Field                | Description                                         |
| -------------------- | --------------------------------------------------- |
| Price per month      | Monthly charge (use 0 for a free plan)              |
| Call limit per month | Included API calls                                  |
| Limit type           | A hard limit blocks calls once the quota is reached |
| Rate limit           | Maximum requests per second                         |

**Pay-as-you-go** — no monthly fee; customers pay per call.

<div data-with-frame="true"><figure><img src="/files/bvMxbz10DlhTzYotGbUu" alt=""><figcaption></figcaption></figure></div>

#### 4️⃣ Access

Choose who can see and subscribe to the plan.

| Option      | Behavior                                     |
| ----------- | -------------------------------------------- |
| **Public**  | Listed on the catalog — anyone can subscribe |
| **Private** | Hidden — customers need an invitation        |

<div data-with-frame="true"><figure><img src="/files/SQeeP06wAX05vCFAe8Y5" alt=""><figcaption></figcaption></figure></div>

Review the summary and finish. Your plan now appears on the **Manage Pricing Plans** tab, and the publishing checklist moves forward.

{% hint style="info" %}
💡 **Tip:** Start with a free tier to lower the barrier for developers to try your API, then add paid plans for heavier usage.
{% endhint %}

***

**Next →** [Submitting for Review](/seller-docs/submitting-for-review)


# Submitting for Review

Before your product appears on the public catalog, the api.market team reviews it. This keeps listings accurate and working correctly. Once approved, your product goes live and developers can subscribe.

### ✅ The publishing checklist

All three steps must be complete before you can submit:

| Step                 | Requirement                                                   |
| -------------------- | ------------------------------------------------------------- |
| 1. Product details   | Title, subtitle, and description, categories and other fields |
| 2. Pricing plans     | At least one plan                                             |
| 3. Submit for review | Click **Send for Review**                                     |

When all three are done, the bar shows **3/3 complete** and the status changes to **In Review**.

<div data-with-frame="true"><figure><img src="/files/u6pPYxl6AzWvaCgz1if3" alt=""><figcaption></figcaption></figure></div>

### 🔎 Before you submit

* Your **title** clearly says what the API does.
* Your **subtitle** is filled in (under 160 characters).
* Your **description** is detailed, ideally with examples and cURLs.
* At least **one pricing plan** exists.
* **Preview Product** looks the way you want.
* **Test it well** on api playground

### 📤 How to submit

1. Open your product under **Manage APIs → API Products**.
2. Confirm the checklist shows **3/3 complete**.
3. Click **Send for Review**.

{% hint style="warning" %}
⚠️ **Note:** The **Send for Review** button stays disabled until both product details and pricing are done. If it is greyed out, check which step is still pending.
{% endhint %}

### ⏳ What happens next

The team checks your listing quality, confirms your endpoints respond correctly through the api.market proxy, and reviews your pricing and content against the marketplace guidelines. Review usually takes **1–3 business days**, and you are notified by email.

| Status          | Meaning                                            |
| --------------- | -------------------------------------------------- |
| In Review       | Submitted and waiting for the team                 |
| Approved        | Live on the marketplace                            |
| Action Required | Changes needed — see the note on your product page |

{% hint style="success" %}
🎉 **Approved?** Your product is now live on api.market and customers can subscribe to your plans.
{% endhint %}

***

**Next →** [Adding Payout Details](/seller-docs/adding-payout-details)


# Adding Payout Details

To receive your earnings, tell api.market where to send the money. Payout details include your personal or business information and your preferred payment method — bank transfer or PayPal.

### 📍 Where to go

In the sidebar, go to **Sales → Payout Settings**. You can also reach it from the **Add payout details** step on the main setup checklist.

### 👤 Basic information

Fill in your details. Fields marked with \* are required.

<div data-with-frame="true"><figure><img src="/files/HIV5xxmzfGN4GoeR1BgW" alt=""><figcaption></figcaption></figure></div>

| Field           | Description                                   |
| --------------- | --------------------------------------------- |
| Full Name \*    | Your legal name or business representative    |
| Phone Number \* | Include the country code                      |
| Full Address \* | Street, city, state, ZIP                      |
| Account Type \* | Personal or Business                          |
| Tax ID          | Tax ID / VAT number, if you have one          |
| Purpose code    | 4-digit code for international bank transfers |

{% hint style="info" %}
💡 **Tip:** Use the same name that is on your bank or PayPal account to avoid payout delays.
{% endhint %}

### 💳 Payout method

Choose how you want to be paid.

| Method            | Description                        |
| ----------------- | ---------------------------------- |
| **Bank Transfer** | Wire transfer to your bank account |
| **PayPal**        | Payment to your PayPal email       |
|                   |                                    |

If you choose **PayPal**, enter the email linked to your PayPal account.

<div data-with-frame="true"><figure><img src="/files/D0Lsbao7pSUDVnUSK9Ij" alt=""><figcaption></figcaption></figure></div>

If you choose **Bank Transfer**, extra fields appear for your account number, routing number, and SWIFT/BIC. Fill these in carefully — incorrect details can delay payouts.

### 📅 Payout schedule

{% hint style="info" %}
💰 **Schedule:** Payouts are processed monthly, 30 days after the earning period ends. The minimum payout is **$50 USD**.
{% endhint %}

If your balance is under $50, it rolls over to the next month until it reaches the threshold. Click **Save Payout Details** when you are done.

***

**Next →** [Adding Store Details](/seller-docs/adding-store-details)


# Adding Store Details

The last step is branding your store. Store details are the name, URL slug, and appearance customers see when they browse your products on api.market.

### 📍 Where to go

In the sidebar, go to **Settings → Store Settings**. You can also reach it from the **Add store details** step on the main setup checklist.

<div data-with-frame="true"><figure><img src="/files/GWYJr5Z1QfQe4VuK2H0Z" alt=""><figcaption></figcaption></figure></div>

### 🏷️ Store identity

* **API Store ID** — a system identifier for your store. Use the copy button when working with admin APIs. This cannot be changed.
* **API Store Name** — your store's display name (max 16 characters). Click **Save** after editing.
* **API Store Slug** — the URL-friendly name that appears in every product URL (max 16 characters, hyphenated letters and numbers). Click **Save** after editing.

{% hint style="warning" %}
⚠️ **Important:** Changing your slug changes all of your product URLs. Choose it carefully and avoid changing it after you have shared links publicly.
{% endhint %}

### 🎨 Store appearance

Use **Edit API Store Appearance** to add your logo, a short store description, and other branding. Then click **View your store on API.market** to preview how customers see it.

### ✅ Setup complete

When all the steps are done, the Seller Console shows your store is ready:

<div data-with-frame="true"><figure><img src="/files/f6E7bP4H2yZbn8QZvMaS" alt=""><figcaption></figcaption></figure></div>

{% hint style="success" %}
🎉 **Your store setup is complete!** You are ready to sell. From here you can watch your **Overview** dashboard, check **Analytics & Logs**, and add more products at any time.
{% endhint %}

***

**← Back to** API Seller Console


# Testing Your APIs & Products

To enable easy testing for yourself and for your users, we recommend creating a Free product with this config:

* Price: $0/month
* API Calls: 100
* Limit Type: HARD

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

To test your product follow these steps:

1. **Browse to the Product Page**: Navigate to the product page on your API store (e.g., from the marketplace or search results).
2. **Subscribe to the Product**:
   * On the product page, select the "FREE" pricing plan (or any plan you want to test)
   * Click the "Subscribe" button to subscribe to the product
   * Complete the subscription process if payment is required (for free plans, this is usually instant)
3. **Access API Playground**:
   * After subscribing, you'll see the "API Playground (Try the APIs)" section on the product page
   * This section displays all available endpoints for the product
   * You can view endpoint details, request/response schemas, and test endpoints directly
4. **Copy the Endpoint URL**:
   * From the API Playground, find the endpoint you want to call
   * Copy the full endpoint URL (e.g., `https://prod.api.market/api/v1/{workspace-slug}/{product-slug}/{endpoint-path}`)

**Example:**

For an endpoint that looks like this, you can send a POST request using any of the methods described below:

{% tabs %}
{% tab title="Shell" %}

```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/gpt-5/chat/completions" \
-H "Content-Type: application/json" \
-H "x-api-market-key: YOUR_API_MARKET_KEY" \
-d '{
  "model": "gpt-5",
  "messages": [
    {
      "role": "user",
      "content": "What is the capital of France?"
    }
  ]
}'

```

{% endtab %}

{% tab title="Javascript" %}

```bash
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/gpt-5";

async function getCompletion(messages) {
  try {
    const response = await fetch(`${baseUrl}/chat/completions`, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "x-api-market-key": apiKey
      },
      body: JSON.stringify({ model: "gpt-5", messages: messages })
    });

    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(`API error: ${response.status} ${errorData.error.message}`);
    }

    return await response.json();
  } catch (error) {
    console.error("Error:", error);
    throw error;
  }
}


// Example usage
const messages = [{"role": "user", "content": "Hello, how are you?"}];
getCompletion(messages)
  .then(completion => console.log(completion))
  .catch(error => console.error(error));



```

{% endtab %}

{% tab title="Python" %}

```bash
# Python example
import requests

API_KEY = "YOUR_API_MARKET_KEY"
BASE_URL = "https://prod.api.market/api/v1/magicapi/gpt-5"

def get_completion(messages):
    headers = {
        "Content-Type": "application/json",
        "x-api-market-key": API_KEY
    }
    
    response = requests.post(
        f"{BASE_URL}/chat/completions",
        headers=headers,
        json={"model": "gpt-5", "messages": messages}
    )
    
    if response.status_code != 200:
        error_data = response.json()
        raise Exception(f"API error: {response.status_code} {error_data['error']['message']}")
    
    return response.json()


# Example usage:
messages = [{"role": "user", "content": "Translate 'Hello, how are you?' to French."}]
try:
    completion = get_completion(messages)
    print(completion)
except Exception as e:
    print(f"An error occurred: {e}")

```

{% endtab %}
{% endtabs %}

**You can use tools like Postman to test your API as well:**

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

PostMan request for api.market


# Analytics & Logs

[Api.market](https://api.market) logs every single request and response unless otherwise specified.

#### Admin Analytics <a href="#admin-analytics" id="admin-analytics"></a>

You can track the total usage and analytics by clicking on **"Analytics & Charts"** from the left Sidebar on seller .

You can see the total API calls per day, week or months.

You can also check the average analytics for your APIs.

#### Usage Analytics :

<figure><img src="/files/slTePI3PD9lnmlXi2jlV" alt=""><figcaption><p>Example of Usage Analytics</p></figcaption></figure>

#### Latency Analytics:

<figure><img src="/files/M0kD3v6AOriU8PskiNFa" alt=""><figcaption><p>Example Of Latency Analytics </p></figcaption></figure>

#### API Request Logs: <a href="#admin-logs" id="admin-logs"></a>

You can check the request and response for each request made by all of your users.

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

<figure><img src="/files/6HERXywn1zAh8yPGnkR7" alt=""><figcaption><p>Example Of API Request Logs</p></figcaption></figure>

#### Product Specific Analytics & Logs :&#x20;

For product specified logs you need to go to the seller console, a place where APIs are launched on the api.market . Here's how you can do it : \
\
Click on the API seller console to go the seller console for Analytics & Logs regarding specific Product\
Here's the seller console : <https://api.market/seller>\
\
In Seller Console , analytics are available under "**API Products"** Page. \
This is what it looks like when you come to seller console.&#x20;

<figure><img src="/files/3ux6toLmqaAZ0yut2V2C" alt=""><figcaption></figcaption></figure>

Click on the **"API Products"** under "**Manage APIs"** Sectio&#x6E;**.** \
\
After clicking on it choose any product you want to see Analytics & logs fo&#x72;**.** \
\
After clicking on it the Product settings page will show up. This is what looks like

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

Click on Analytics & Logs to see analytics related to Specific API Product

#### What You'll See:

**Product Analytics Dashboard:**

* :white\_check\_mark: **Total API Calls** - Total requests for this specific product
* :white\_check\_mark: **Average Error Rate** - Success vs failure rate for this product
* :white\_check\_mark: **Latency Analytics** - Response time metrics
* :white\_check\_mark: **Request Logs** - Detailed log of all API requests

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

<figure><img src="/files/7XrpcL8r95ZCEObVxsTQ" alt=""><figcaption></figcaption></figure>

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


# Custom Usage

[api.market](https://api.market/) allows you to set custom Usage reported by your backend. These changes need to be made in your API backend. Hence when [api.market](https://api.market/) calls your API backend, then that backend must add this header to the response.

Please make sure you mention this clearly in your Product description on [api.market](https://api.market/). You must also include this in your docs.

### Default Behavior:

By default, each request consumes "1" API call for the given Pricing Plan. Hence the default header is added to all requests:

```
X-Magicapi-Billing: API=1;
```

### Allow "unlimited" calls for certain endpoints <a href="#allow-unlimited-calls-for-certain-endpoints" id="allow-unlimited-calls-for-certain-endpoints"></a>

If you wish to make certain endpoints "FREE". i.e. To NOT reduce the API usage when a user requests those endpointPaths. Then you can simply pass this header:

```
X-Magicapi-Billing: API=0;
```

This will not "increase" the total API calls used in the given plan.

### Charge more than "1" API unit for a request <a href="#charge-more-than-1-api-unit-for-a-request" id="charge-more-than-1-api-unit-for-a-request"></a>

Similarly to charge more than "one" unit per request, you can update this header to the custom usage and send it as a response in your API.

```
X-Magicapi-Billing: API=3;
```


# Overriding Custom Usage on Result Retrieval

Update Usage on Result Retrieval: This guide explains how to override initial API usage by passing custom headers when users call for the result, ensuring precise usage tracking.

MagicAPI now offers a way to **override custom usage** during result retrieval. This is an extension of the existing custom usage support, designed for scenarios where the actual usage cannot be determined during the initial API request. This is especially useful for use cases like AI agents or background jobs where processing takes time, and the final resource consumption is known only when the results are ready.

This guide covers the two methods for API developers to adjust API usage after a request has been made using MagicAPI. These methods ensure precise tracking of resource consumption, especially when actual usage cannot be determined during the initial request. The two methods are:

1. **Overriding Usage on Result Retrieval** (using custom headers).
2. **Overwriting Usage with the `/[apiStoreSlug]/overrideCustomUsage` endpoint**.

### Method 1: Update Usage on Result Retrieval

This method allows API developers to adjust the usage at the time when results are retrieved by the user. It is ideal for use cases where the initial request consumption is uncertain, such as AI agents or background jobs, where the actual resources used become apparent only after processing is completed.

#### **Use Case:** <a href="#use-case" id="use-case"></a>

When an API user initiates a job (e.g., starting an AI process), the default usage is recorded as **1 unit**. If the job consumes more resources, you can update the usage when the result is retrieved using override headers.

**How to Implement:**

1. **Initiating a Job**:
   * When a user calls MagicAPI to start a job, MagicAPI forwards the request to your API and includes a unique `x-request-id` in the headers.
   * This `x-request-id` acts as a unique identifier for the request, allowing you to adjust the usage when the job is completed.
2. **Overriding Usage on Result Retrieval**:
   * Once the job is completed and the user requests the result via a `/result` or similar endpoint, override the initial usage using the following headers in your response:
     * `"override-request-id": "Original-Request-Id"`
     * `"override-x-magicapi-billing": "UsageAmount"`
   * Here:
     * **`override-request-id`**: Must match the `x-request-id` from the original job initiation request.
     * **`override-x-magicapi-billing`**: Specifies the updated usage value (e.g., `519` units) based on the actual resources used.

#### **Example:** <a href="#example" id="example"></a>

**Step 1: Original Request** User starts an API job:

Copy

```bash
curl --location 'https://prod.api.market/api/v1/pipfeed/parse/extract' \
--header 'accept: application/json' \
--header 'x-api-market-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "url": "https://techcrunch.com/2022/04/18/web-scraping-legal-court/"
}'
```

**Headers Sent by MagicAPI to Your API:**

Copy

```json
{
  "x-request-id": "f8e1d576-a460-4847-8683-c31b88c4a958",
  "host": "localhost:4000",
  "connection": "keep-alive",
  "accept": "application/json",
  "content-type": "application/json",
  "x-invoke-path": "/api/v1/pipfeed/parse/extract",
  "x-magicapi-user": "cll8kolno0000l808v6p3xvax",
  "x-magicapi-plan": "Private",
  "content-length": "74"
}
```

**Note**: The critical header here is `"x-request-id"`.

**Step 2: Overriding Usage with Result**

When the job completes and the user retrieves the result:

* Include these headers in your response:

Copy

```
{
  "override-request-id": "f8e1d576-a460-4847-8683-c31b88c4a958",
  "override-x-magicapi-billing": "API=519;"
}
```

This response updates the recorded usage for `x-request-id` **`f8e1d576-a460-4847-8683-c31b88c4a958`** from **1 unit** to **519 units**.

**Important Notes:**

* Override headers are internal to MagicAPI and are not visible to end users.
* Ensure that `override-request-id` it matches the original `x-request-id`.
* This method allows fine-tuning billing based on actual resource consumption, providing accurate tracking when results are available.

***

### Method 2: Overwriting Usage with /\[apiStoreSlug]/overrideCustomUsage

This method provides an alternative way to adjust API usage after the initial request using a dedicated endpoint. It is best suited when the final resource usage is known after the processing is complete.

**Endpoint Details:**

* **Endpoint:** `/[apiStoreSlug]/overrideCustomUsage`
* **Method:** `POST`
* **Availability:** Restricted to API store creators.
* **Update Window:** The update must be made within 6 hours after the initial request.
* ADMIN\_API\_KEY: You can find you Admin API Key at -> [https://api.market/seller/\[YourAPIStoreSlug\]/apiKeys](https://api.market/seller/dashboard)&#x20;

**Example Request:**

```bash
curl --location 'https://prod.api.market/api/v2/pipfeed/overrideCustomUsage' \
--header 'accept: application/json' \
--header 'x-api-market-key: ADMIN_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "overrideRequestId": "f8e1d576-a460-4847-8683-c31b88c4a958",
        "overrideCustomUsage": "API=812;"
    }
}'
```

**Parameters:**

* **`overrideRequestId`**: The ID of the original request to update. This should match the `x-request-id` from the initial request.
* **`overrideCustomUsage`**: A string specifying the new usage value (e.g., `API=8.1;`). This updates the recorded usage to reflect the actual resources consumed by the request.

**Use Case:** This method is particularly useful when the job’s final resource consumption becomes clear after some time, such as after processing a complex background job or AI task. It allows API store creators to adjust the recorded usage without needing a user-triggered result retrieval.

**Potential Errors:**

* **Unauthorized Access:** If the request is made by a user other than the API store creator.
* **Time Limit Exceeded:** If the override is attempted after the 2-hour window.
* **Invalid Input:** Issues like missing parameters or incorrect data format.

**Additional Condition:** Records can only be updated for API calls made within the last 6 hours. If an attempt is made to override usage for a request that was initiated more than 6 hours ago, the request will fail. This restriction ensures that updates remain timely and relevant, preventing adjustments for outdated requests.

**Key Considerations:**

* Only API store creators can access this endpoint, ensuring control over usage adjustments.
* Adjustments must be made within a 6-hour window from the original request time.
* Provides flexibility to adjust billing based on actual usage, maintaining transparency with API consumers.

***

#### Summary

MagicAPI offers two methods to adjust API usage after an initial request, ensuring accurate billing for varying use cases:

1. **Overriding Usage on Result Retrieval:** Adjust usage when a user retrieves the result, using custom headers for precision.
2. **Overwriting Usage via `/overrideCustomUsage` Endpoint:** Directly update usage through a secure endpoint, ideal for scenarios where the final usage is determined after processing.

Both methods allow API developers and sellers to fine-tune billing based on real-world resource consumption, enhancing transparency and fairness in API usage tracking.

***

***


# What is the Referral Program?

## What is the Referral Program?

**Earn rewards by inviting friends to API.market**

The Referral Program lets you earn commissions by sharing API.market with others. When someone signs up using your link, they get $2.50 credit and you earn commissions on their purchases.

***

### 🎯 How It Works

1. **Share Your Link** → Get your unique referral link from the dashboard
2. **They Sign Up** → New users get $2.50 credit in their wallet
3. **They Subscribe** → When they purchase a paid API plan, you earn commission
4. **You Get Paid** → Commissions are credited to your account

{% hint style="success" %}
✅ **It's Free!** Every API.market user automatically gets a referral program. No signup required.
{% endhint %}

***

### 💰 Benefits

#### For You (Referrer):

| Benefit         | Basic Track           | Partner Track           |
| --------------- | --------------------- | ----------------------- |
| Commission Rate | 5%                    | 10%                     |
| Earnings go to  | Wallet Credits        | Cash via Stripe         |
| Payout Method   | Use for API purchases | Bank transfer ($25 min) |

#### For Your Friends (Referred Users):

* ✅ **$2.50 Signup Bonus** - Added to wallet automatically
* ✅ **30-Day Validity** - Use credit within 30 days
* ✅ **Full Access** - No restrictions on API usage

***

### 🔵 Basic vs Partner Track

#### Basic Track (Default)

Everyone starts here. Perfect for casual referrers.

* **5% commission** on referred sales
* Earnings credited to your **wallet balance**
* Use credits for **API purchases**
* No payout setup required

#### Partner Track (Upgrade)

For serious affiliates who want cash payouts.

* **10% commission** on referred sales
* Connect **Stripe** for direct payouts
* Cash out to your **bank account**
* Minimum payout: **$25**
* Priority support

{% hint style="info" %}
💡 **Upgrade anytime** from your Referral Dashboard by clicking "Upgrade to Partner"
{% endhint %}

***

### 🔗 How to Get Your Referral Link

#### Step 1: Go to Referrals Page

Navigate to **Account** → **Referrals** from your dashboard sidebar.

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

#### Step 2: View Your Referral Dashboard

Your referral program is created automatically. You'll see your unique code and stats.

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

**Your Link Format:**

```
https://api.market?ref=YOURCODE
```

**To copy:**

1. Click the **Copy** button next to your link
2. Link is copied to clipboard
3. Share via email, chat, social media, etc.

***

#### Step 4: Share on Social Media (Optional)

Use the built-in share buttons for quick sharing:

* **Twitter** - Opens Twitter with pre-filled message
* **LinkedIn** - Opens LinkedIn sharing dialog

***

### 📊 Understanding Your Stats

Your Referral Dashboard shows key metrics:

| Metric                | What It Means                     |
| --------------------- | --------------------------------- |
| **Total Referrals**   | Users who signed up via your link |
| **Conversions**       | Referrals who made a purchase     |
| **Total Earnings**    | Your total commission earned      |
| **Conversion Rate**   | % of signups that converted       |
| **Total Clicks**      | Number of link clicks             |
| **Pending Referrals** | Signups who haven't purchased yet |

***

### 📖 Next Steps

Ready to learn more?

* [**How Referrals Work & Tracking**](broken://pages/4N0Z6SK1BRN3SvofOhsq) **→** - Complete flow, rewards, partner program
* [**How to use Wallet?**](broken://pages/OOXOMbrnQlRSq5kaisVP) - Understand wallet credits

***

### 🆘 Need Help?

* **💬 Live Chat:** go to [api.market](https://api.market/) Bottom right corner
* **📧 Email:** <hello@api.market>


# How Referrals Work & Tracking

**Complete guide to referral flow, rewards, and partner program**

{% hint style="info" %}
💡 **New to Referrals?** Start with: [What is the Referral Program?](/referral-program/what-is-the-referral-program)
{% endhint %}

***

### 🔄 The Referral Flow

Here's exactly what happens when you share your referral link:

#### Step 1: You Share Your Link

Share your unique link: `https://api.market?ref=YOURCODE`

**Where to share:**

* Social media (Twitter, LinkedIn)
* Blog posts and tutorials
* Email newsletters
* Developer communities
* Direct messages

***

#### Step 2: Someone Clicks Your Link

When they click:

* ✅ Click is tracked and attributed to you
* ✅ A session cookie is set (valid for **7 days**)
* ✅ They can browse and explore the platform

***

#### Step 3: They Sign Up

When they create an account:

* ✅ They're linked to your referral code
* ✅ **$2.50 credit** is added to their wallet automatically
* ✅ Status changes to: **SIGNED\_UP**

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

{% hint style="warning" %}
⚠️ **Credit Validity:** The $2.50 signup bonus is valid for **30 days**. If not used, it expires.
{% endhint %}

#### Step 4: They Make a Purchase

When they subscribe to a paid API plan:

* ✅ Status changes to: **CONVERTED**
* ✅ Commission is calculated based on their spend
* ✅ Commission becomes eligible after **30 days**

***

#### Step 5: You Earn Commission

After the 30-day eligibility period:

* ✅ Commission is paid to your wallet (Basic) or referral balance (Partner)
* ✅ Transaction appears in your Ledger

### 💰 Referral Rewards & Credits

#### For Referred Users: $2.50 Signup Bonus

| Detail         | Value                         |
| -------------- | ----------------------------- |
| **Amount**     | $2.50 USD                     |
| **Added When** | Upon signup via referral link |
| **Validity**   | 30 days from signup           |
| **Usage**      | Any paid API subscription     |

***

#### For Referrers: Commission Structure

| Track       | Commission Rate        | Minimum Purchase |
| ----------- | ---------------------- | ---------------- |
| **Basic**   | 5% of purchase amount  | $1.00            |
| **Partner** | 10% of purchase amount | $1.00            |

**Commission Eligibility:**

* Commissions become eligible **30 days** after the purchase
* Only successful purchases (200 OK responses) count
* Refunded purchases don't generate commission

**Example:**

```
Your referral purchases a $50/month API plan
- Basic Track: $50 × 5% = $2.50 commission
- Partner Track: $50 × 10% = $5.00 commission
```

***

### 📈 Tracking Your Referrals

#### Referral Stats Card

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

**Key Metrics:**

| Metric                | Description                              |
| --------------------- | ---------------------------------------- |
| **Total Referrals**   | Users who signed up using your link      |
| **Conversions**       | Referrals who made a qualifying purchase |
| **Total Earnings**    | Total commission earned to date          |
| **Conversion Rate**   | Percentage of signups that converted     |
| **Total Clicks**      | Number of times your link was clicked    |
| **Pending Referrals** | Signed up but haven't purchased yet      |

***

#### Referred Users Table

Track each referred user's status:

<figure><img src="/files/8a8c0PWtVx3GsA5ezl7j" alt=""><figcaption></figcaption></figure>

| Status            | Meaning                                             |
| ----------------- | --------------------------------------------------- |
| **Not Signed Up** | Clicked link but didn't create account              |
| **Signed Up**     | Created account, hasn't purchased                   |
| **Made a Spend**  | Made a qualifying purchase (you earned commission!) |

***

#### Referral Ledger

View all your commission transactions:

**Columns:**

* **Date** - When commission was earned
* **User Email** - Referred user's email
* **Commission Earned** - Your commission amount
* **Status** - PENDING, ELIGIBLE, PAID

**Features:**

* Export to CSV for your records
* Filter and track earnings over time

***

### 🚀 Partner Program

Upgrade to Partner for higher commissions and cash payouts.

#### How to Upgrade

1. Go to **Referrals** dashboard
2. Click **"Upgrade to Partner"** button
3. Review and accept the Partner Agreement
4. Sign with your digital signature

#### Connect Stripe for Payouts

After upgrading, connect Stripe to receive cash payouts:

1. Click **"Connect Stripe"** in the Payouts section
2. Complete Stripe onboarding (enter bank details)
3. Wait for account verification

***

#### Request Payout

Once Stripe is connected and you have sufficient balance:

**Payout Requirements:**

* ✅ Stripe account connected and verified
* ✅ Minimum balance: **$25.00**
* ✅ Account ready for payouts (no missing requirements)

**Payout Timeline:**

* Processing time: **2-7 business days**
* Email confirmation sent when processed
* Stripe fees may apply

***

#### Partner Benefits Summary

| Feature           | Basic          | Partner              |
| ----------------- | -------------- | -------------------- |
| Commission Rate   | 5%             | 10%                  |
| Earnings Location | Wallet Credits | Referral Balance     |
| Cash Withdrawals  | ❌ No           | ✅ Yes (via Stripe)   |
| Minimum Payout    | N/A            | $25.00               |
| Stripe Connect    | N/A            | Required for payouts |

***

### ❓ FAQ

**Q: How long is my referral link valid?** A: Your link is permanent. The tracking session lasts 7 days after someone clicks.

**Q: Can I refer myself?** A: No, self-referrals are not allowed.

**Q: When do I receive commissions?** A: Commissions become eligible 30 days after the referred user's purchase, then processed based on your track type.

**Q: What if my referral gets a refund?** A: Refunded purchases don't generate commissions. If commission was already paid, it may be reversed.

**Q: Can I switch back from Partner to Basic?** A: Yes, click "Convert to Basic" on your dashboard. You'll need zero balance and no pending commissions.

***

### 💡 Tips for Success

✅ **Be authentic** - Share with people who genuinely need APIs \
✅ **Target developers** - They're your best audience \
✅ **Explain the bonus** - Highlight the $2.50 signup credit \
✅ **Use social media** - Built-in Twitter/LinkedIn sharing \
✅ **Create content** - Tutorials, reviews, comparisons \
✅ **Monitor stats** - Track what's working

***

### 📖 Related Documentation

* [**What is the Referral Program?**](/referral-program/what-is-the-referral-program) - Getting started
* [**How to use Wallet?**](broken://pages/OOXOMbrnQlRSq5kaisVP) - Wallet credits
* [**How do I add Payment details?**](/how-do-i-add-payment-details) - Stripe setup

***


# Convert Postman Collection to OpenAPI Yaml

If you have never converted Postman Collection to OpenAPI Yaml before it can be a bit daunting task. Just follow the below simple steps to convert.

1. **Download the tool**:

   * Before you begin, you'll need to install a tool called **`postman-to-openapi`**. This tool will help you convert your Postman Collection to OpenAPI YAML format. You can install it using **npm**, a package manager for JavaScript.
   * Open your command line interface (CLI) and run the following command:

   ```bash
   npm i postman-to-openapi -g
   ```

   * This command will install the **`postman-to-openapi`** tool globally on your system, allowing you to use it from any directory.
2. **Export your Postman Collection as JSON**:
   * Open Postman and locate the collection you want to convert.
   * Click on the collection, then click on the "Export" button.
   * Choose "Export as JSON" from the options. This will download your Postman Collection in JSON format to your local machine.
3. **Run the conversion command**:

   * Navigate to the directory where you downloaded your Postman Collection JSON file using the CLI.
   * Once you're in the directory, run this command:

   ```bash
   p2o ./path/to/PostmanCollection.json -f ./out_openapi_.yml
   ```

   Replace `./path/to/PostmanCollection.json` with the actual path to your Postman Collection JSON file. Replace `./out_openapi_.yml` with the desired output file path for your OpenAPI YAML file. This is the file where the converted schema will be saved.
4. **Update the YAML file**:
   * Once the conversion process is complete, navigate to the directory where you saved the output OpenAPI YAML file.
   * Open the file using a text editor of your choice.
   * In the YAML file, you may need to update certain sections such as **`basePathUrl`** and any other variables to match your specific API configuration. These are typically found at the beginning of the YAML file and may include details like the base URL of your API and other parameters.
5. **Save your changes**:
   * After making any necessary updates to the YAML file, save the file in your text editor.

By following these steps, you should be able to successfully convert your Postman Collection to OpenAPI YAML format and make any necessary adjustments to the resulting file.


# Create OpenAPI spec using ChatGPT

If you have never worked with OpenAPI spec then creating one can look like a daunting task but it is actually very easy. You can auto-generate an OpenAPI YAML using ChatGPT. Just Follow this tutorial.

You can easily create openapi.yaml using ChatGPT with few simple prompts.&#x20;

\
Example Prompt to create OpenAPI spec YAML using ChatGPT:

```bash
Using the request and response below, create a detailed OpenAPI specification.

Request:
curl -X 'POST' \
  'https://prod.api.market/api/v1/pipfeed/parse/extract' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://techcrunch.com/2022/04/18/web-scraping-legal-court/"
}'


Response:
{
  "url": "https://techcrunch.com/2022/04/18/web-scraping-legal-court/",
  "title": "Web scraping is legal, US appeals court reaffirms | TechCrunch",
  "author": "Zack Whittaker",
  "html": "<div class=\"page\" id=\"readability-page-1\"><div>\n\t\t\t\t<p id=\"speakable-summary\">Good news for archivists, academics, researchers and journalists: Scraping publicly accessible data is legal, according to a U.S. appeals court ruling.</p>\n<p>The landmark ruling by the U.S. Ninth Circuit of Appeals is the latest in a long-running legal battle brought by LinkedIn aimed at stopping a rival company from web scraping personal information from users’ public profiles. The case <a href=\"https://techcrunch.com/2021/06/14/supreme-court-revives-linkedin-bid-to-protect-user-data-from-web-scrapers/\">reached the U.S. Supreme Court</a> last year but was sent back to the Ninth Circuit for the original appeals court to re-review the case.</p>\n<p>In its second ruling on Monday, the Ninth Circuit reaffirmed its original decision and found that scraping data that is publicly accessible on the internet is not a violation of <a href=\"https://techcrunch.com/2020/11/29/supreme-court-van-buren-hacking/\">the Computer Fraud and Abuse Act</a>, or CFAA, which governs what constitutes computer hacking under U.S. law.</p>\n<p>The Ninth Circuit’s decision is a major win for archivists, academics, researchers and journalists who use tools to mass collect, or scrape, information that is publicly accessible on the internet. Without a ruling in place, long-running projects to archive websites no longer online and using publicly accessible data for academic and research studies have been left in legal limbo.</p>\n<p>But there have been egregious cases of web scraping that have sparked privacy and security concerns. Facial recognition startup Clearview AI claims to have scraped billions of social media profile photos, prompting <a href=\"https://techcrunch.com/2021/04/21/data-brokers-bill-wyden-paul-privacy-clearview/\">several tech giants to file lawsuits</a> against the startup. Several companies, including <a href=\"https://techcrunch.com/2019/09/04/facebook-phone-numbers-exposed/\">Facebook</a>, Instagram, <a href=\"https://techcrunch.com/2021/01/11/scraped-parler-data-is-a-metadata-goldmine/\">Parler</a>, <a href=\"https://techcrunch.com/2019/06/16/millions-venmo-transactions-scraped/\">Venmo</a>&nbsp;and Clubhouse have all had users’ data scraped over the years.</p>\n<p>The case before the Ninth Circuit was originally brought by LinkedIn against Hiq Labs, a company that uses public data to analyze employee attrition. LinkedIn said Hiq’s mass web scraping of LinkedIn user profiles was against its terms of service, amounted to hacking and was therefore a violation of the CFAA. LinkedIn first lost <a href=\"https://techcrunch.com/2016/08/15/linkedin-sues-scrapers/\">the case against Hiq</a> in 2019 after the Ninth Circuit found that the CFAA does not bar anyone from scraping data that’s publicly accessible.</p>\n<p>On its second pass of the case, the Ninth Circuit said it relied on <a href=\"https://techcrunch.com/2021/06/03/supreme-court-hacking-cfaa-ruling/\">a Supreme Court decision</a> last June, during which the U.S. top court took its first look at the decades-old CFAA. In its ruling, the Supreme Court narrowed what constitutes a violation of the CFAA as those who gain unauthorized access to a computer system — rather than a broader interpretation of exceeding existing authorization, which the court argued could have attached criminal penalties to “a breathtaking amount of commonplace computer activity.” Using a “gate-up, gate-down” analogy, the Supreme Court said that when a computer or website’s gates are up — and therefore information is publicly accessible — no authorization is required.</p>\n<p>The Ninth Circuit, in referencing the Supreme Court’s “gate-up, gate-down” analogy, ruled that “the concept of ‘without authorization’ does not apply to public websites.”</p>\n<p>“We’re disappointed in the court’s decision. This is a preliminary ruling and the case is far from over,” said LinkedIn spokesperson Greg Snapper in a statement. “We will continue to fight to protect our members’ ability to control the information they make available on LinkedIn. When your data is taken without permission and used in ways you haven’t agreed to, that’s not okay. On LinkedIn, our members trust us with their information, which is why we prohibit unauthorized scraping on our platform.”</p>\n\n\t\t\t</div></div>",
  "text": "\n\t\t\t\tGood news for archivists, academics, researchers and journalists: Scraping publicly accessible data is legal, according to a U.S. appeals court ruling.\nThe landmark ruling by the U.S. Ninth Circuit of Appeals is the latest in a long-running legal battle brought by LinkedIn aimed at stopping a rival company from web scraping personal information from users’ public profiles. The case reached the U.S. Supreme Court last year but was sent back to the Ninth Circuit for the original appeals court to re-review the case.\nIn its second ruling on Monday, the Ninth Circuit reaffirmed its original decision and found that scraping data that is publicly accessible on the internet is not a violation of the Computer Fraud and Abuse Act, or CFAA, which governs what constitutes computer hacking under U.S. law.\nThe Ninth Circuit’s decision is a major win for archivists, academics, researchers and journalists who use tools to mass collect, or scrape, information that is publicly accessible on the internet. Without a ruling in place, long-running projects to archive websites no longer online and using publicly accessible data for academic and research studies have been left in legal limbo.\nBut there have been egregious cases of web scraping that have sparked privacy and security concerns. Facial recognition startup Clearview AI claims to have scraped billions of social media profile photos, prompting several tech giants to file lawsuits against the startup. Several companies, including Facebook, Instagram, Parler, Venmo and Clubhouse have all had users’ data scraped over the years.\nThe case before the Ninth Circuit was originally brought by LinkedIn against Hiq Labs, a company that uses public data to analyze employee attrition. LinkedIn said Hiq’s mass web scraping of LinkedIn user profiles was against its terms of service, amounted to hacking and was therefore a violation of the CFAA. LinkedIn first lost the case against Hiq in 2019 after the Ninth Circuit found that the CFAA does not bar anyone from scraping data that’s publicly accessible.\nOn its second pass of the case, the Ninth Circuit said it relied on a Supreme Court decision last June, during which the U.S. top court took its first look at the decades-old CFAA. In its ruling, the Supreme Court narrowed what constitutes a violation of the CFAA as those who gain unauthorized access to a computer system — rather than a broader interpretation of exceeding existing authorization, which the court argued could have attached criminal penalties to “a breathtaking amount of commonplace computer activity.” Using a “gate-up, gate-down” analogy, the Supreme Court said that when a computer or website’s gates are up — and therefore information is publicly accessible — no authorization is required.\nThe Ninth Circuit, in referencing the Supreme Court’s “gate-up, gate-down” analogy, ruled that “the concept of ‘without authorization’ does not apply to public websites.”\n“We’re disappointed in the court’s decision. This is a preliminary ruling and the case is far from over,” said LinkedIn spokesperson Greg Snapper in a statement. “We will continue to fight to protect our members’ ability to control the information they make available on LinkedIn. When your data is taken without permission and used in ways you haven’t agreed to, that’s not okay. On LinkedIn, our members trust us with their information, which is why we prohibit unauthorized scraping on our platform.”\n\n\t\t\t",
  "length": 3456,
  "description": "The landmark web scraping case was bounced back to the Ninth Circuit by the U.S. Supreme Court.",
  "siteName": "TechCrunch",
  "topImage": "https://techcrunch.com/wp-content/uploads/2022/04/GettyImages-1303427084-reworked.jpg",
  "date": "2022-04-18T19:16:57+00:00",
  "keywords": "",
  "summary": [
    "The landmark ruling by the U.S.",
    "The case reached the U.S.",
    "Supreme Court last year but was sent back to the Ninth Circuit for the original appeals court to re-review the case.",
    "But there have been egregious cases of web scraping that have sparked privacy and security concerns.",
    "When your data is taken without permission and used in ways you haven’t agreed to, that’s not okay."
  ],
  "sentiment": {
    "score": 26,
    "comparative": 0.04684684684684685,
    "calculation": [
      {
        "prohibit": -1
      },
      {
        "trust": 1
      },
      {
        "agreed": 1
      },
      {
        "ability": 2
      },
      {
        "protect": 1
      },
      {
        "fight": -1
      },
      {
        "disappointed": -2
      },
      {
        "supreme": 4
      },
      {
        "no": -1
      },
      {
        "accessible": 1
      },
      {
        "supreme": 4
      },
      {
        "breathtaking": 5
      },
      {
        "criminal": -3
      },
      {
        "gain": 2
      },
      {
        "violation": -2
      },
      {
        "supreme": 4
      },
      {
        "top": 2
      },
      {
        "supreme": 4
      },
      {
        "accessible": 1
      },
      {
        "lost": -3
      },
      {
        "violation": -2
      },
      {
        "lawsuits": -2
      },
      {
        "recognition": 2
      },
      {
        "legal": 1
      },
      {
        "accessible": 1
      },
      {
        "no": -1
      },
      {
        "accessible": 1
      },
      {
        "win": 4
      },
      {
        "abuse": -3
      },
      {
        "fraud": -4
      },
      {
        "violation": -2
      },
      {
        "accessible": 1
      },
      {
        "supreme": 4
      },
      {
        "reached": 1
      },
      {
        "stopping": -1
      },
      {
        "battle": -1
      },
      {
        "legal": 1
      },
      {
        "landmark": 2
      },
      {
        "legal": 1
      },
      {
        "accessible": 1
      },
      {
        "good": 3
      }
    ],
    "postive": [
      "trust",
      "agreed",
      "ability",
      "protect",
      "supreme",
      "accessible",
      "supreme",
      "breathtaking",
      "gain",
      "supreme",
      "top",
      "supreme",
      "accessible",
      "recognition",
      "legal",
      "accessible",
      "accessible",
      "win",
      "accessible",
      "supreme",
      "reached",
      "legal",
      "landmark",
      "legal",
      "accessible",
      "good"
    ],
    "negative": [
      "prohibit",
      "fight",
      "disappointed",
      "no",
      "criminal",
      "violation",
      "lost",
      "violation",
      "lawsuits",
      "no",
      "abuse",
      "fraud",
      "violation",
      "stopping",
      "battle"
    ]
  }
}

```

This will generate a file like this:

```bash
openapi: 3.0.0
info:
  title: PipFeed News Article Extract and Summarization API
  version: 1.0.0
servers:
  - url: https://prod.api.market/api/v1/
paths:
  /extract:
    post:
      summary: Extract and summarize news article data
      description: |
        This endpoint extracts and summarizes information from a given news article URL.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The URL of the news article to extract and summarize.
              required:
                - url
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    description: The URL of the news article.
                  title:
                    type: string
                    description: The title of the news article.
                  author:
                    type: string
                    description: The author of the news article.
                  html:
                    type: string
                    description: The HTML content of the news article.
                  text:
                    type: string
                    description: The plain text content of the news article.
                  length:
                    type: integer
                    description: The length of the news article.
                  description:
                    type: string
                    description: A brief description of the news article.
                  siteName:
                    type: string
                    description: The name of the news site.
                  topImage:
                    type: string
                    format: uri
                    description: The URL of the top image associated with the news article.
                  date:
                    type: string
                    format: date-time
                    description: The publication date of the news article.
                  keywords:
                    type: string
                    description: Keywords associated with the news article.
                  summary:
                    type: array
                    items:
                      type: string
                    description: Summarized content of the news article.
                  sentiment:
                    type: object
                    properties:
                      score:
                        type: integer
                        description: The sentiment score.
                      comparative:
                        type: number
                        description: The comparative sentiment score.
                      calculation:
                        type: array
                        items:
                          type: object
                          properties:
                            prohibit:
                              type: integer
                              description: Prohibit sentiment factor.
                            trust:
                              type: integer
                              description: Trust sentiment factor.
                        description: Sentiment calculation factors.
                      positive:
                        type: array
                        items:
                          type: string
                        description: Positive sentiment keywords.
                      negative:
                        type: array
                        items:
                          type: string
                        description: Negative sentiment keywords.

```

If you have more paths, you can simply ask ChatGPT to update the YAML using the example prompt:

```
Update the above YAML and add additional paths based on the below requests and responses.

Request:
<Your curl request>


Response:
<Your JSON response>
```


# About Us

**Introduction**

My name is Shashank Agarwal, and I used to run a company called Pipfeed, a news-reading mobile app that utilized user behavior to recommend articles. Unfortunately, due to high customer acquisition costs, the app didn't succeed, and I had to shut it down. However, I realized that some of the services I had created could be valuable to others. So, I deployed these services to AWS, resulting in a URL parsing API.

**Early Struggles and Progress**

In the initial six months, the earnings were meager, just around 10 dollars per month. But gradually, the API gained traction, and I am now making over $1500 per month. To monetize the API, I decided to use RapidAPI, a marketplace for various APIs, even though it takes a 20% commission, leaving me with $1200 from the $1500 earnings. Nonetheless, the profit margin remains at approximately 90% on the $1200, with the main cost being RapidAPI's commission.

**Creating the Metering Platform**

To reduce this cost, I decided to develop a simple metering platform for my API. However, the process proved challenging, with many components needing scaling. Recognizing this as a substantial project that would require significant time investment, I thought about offering this platform to other API providers. To test this idea, I asked Arjun to reach out to other API providers on RapidAPI, and our intuition proved right.

**Promising Demand and Customer Selection**

More than 25 API providers joined the waiting list by filling out a form detailing their average monthly API calls, total users, etc. From this list, we selected ten customers with substantial API call volumes. After calculating their monthly earnings using their public pricing plans, we were surprised to find that these ten customers collectively earned over $50,000 per month, using only the cheapest plan.

**Scalability and Revenue Projections**

With this promising demand, we determined how much money we could make and how to go about it. To ensure low server costs, we designed the system to scale easily. The total API calls for these ten customers amounted to over a billion API calls per month.

MagicAPI's servers were load-tested at 13K TPS, capable of handling at least 36 billion API calls at peak loads.

Overall, it's an exciting prospect, and I'm looking forward to what the future holds for MagicAPI.


# MagicAPI

<https://api.market/store/magicapi>


# Screenshot API

A simple way to take a screenshot of a website by providing its URL.

**Developer portal :** [**https://api.market/store/magicapi/screenshot-api**](https://api.market/store/magicapi/screenshot-api)

### About

Introducing our Screenshot API – your gateway to effortless webpage capture and transformation. Designed for developers and businesses alike, this robust tool simplifies the process of capturing screenshots of webpages, enabling you to extract valuable visual information with ease.

With just a few lines of code, you can harness the full potential of our API to capture webpage screenshots in various formats, whether you need them for analysis, documentation, or presentation purposes.

Using our API is straightforward. Simply integrate it into your application or workflow, and you're ready to go. Whether you're capturing screenshots of URLs or local files, our endpoints make it effortless to obtain high-quality images on demand. Need to capture a screenshot of a webpage hosted online? Utilize the 'api/screenshot/' endpoint. Want to capture a screenshot of a webpage from a locally stored HTML file? The '/api/screenshot/' endpoint is at your service.

But why choose our Screenshot API? . By automating the screenshot capture process, our API saves you valuable time and resources. Say goodbye to manual screenshotting tasks and hello to streamlined webpage capture. Whether you're building visual testing tools, monitoring web page changes, or creating dynamic reports, our API empowers you to unlock the full potential of webpage screenshots.

And what about the output? Our API provides screenshots in various formats, including PNG, JPEG, or even PDF, depending on your requirements. With support for customizable resolution and format options, our API ensures flexibility and compatibility with a wide range of use cases.

In summary, our Screenshot API is the ultimate solution for simplifying webpage capture tasks. Whether you're a developer seeking to streamline workflows or a business aiming to enhance visual documentation, our API provides the tools you need to succeed. Experience effortless webpage capture and transformation today with our Screenshot API.

### Curl Request and Response

#### Request

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/screenshot-api/api/screenshot?resX=1280&resY=900&outFormat=jpg&waitTime=100&isFullPage=false&dismissModals=false&url=https%3A%2F%2Fapi.market%2F' \
  -H 'accept: image/jpeg' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="NodeJS" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/magicapi/screenshot-api/api/screenshot?resX=1280&resY=900&outFormat=jpg&waitTime=100&isFullPage=false&dismissModals=false&url=https%3A%2F%2Fapi.market%2F';

let options = {method: 'GET', headers: {'x-api-market-key': 'SOME_STRING_VALUE'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

headers = { 'x-api-market-key': "SOME_STRING_VALUE" }

conn.request("GET", "/api/v1/magicapi/screenshot-api/api/screenshot?resX=1280&resY=900&outFormat=jpg&waitTime=100&isFullPage=false&dismissModals=false&url=https%3A%2F%2Fapi.market%2F", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/magicapi/screenshot-api/api/screenshot?resX=1280&resY=900&outFormat=jpg&waitTime=100&isFullPage=false&dismissModals=false&url=https%3A%2F%2Fapi.market%2F")
  .get()
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}

{% tab title="PHP" %}

```bash
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod.api.market/api/v1/magicapi/screenshot-api/api/screenshot?resX=1280&resY=900&outFormat=jpg&waitTime=100&isFullPage=false&dismissModals=false&url=https%3A%2F%2Fapi.market%2F",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-market-key: SOME_STRING_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

{% endtab %}
{% endtabs %}

#### Response&#x20;

<figure><img src="/files/1XY4sT1WbXngxZ4j9fnp" alt=""><figcaption></figcaption></figure>


# Domain Availability Checker API

Domain Availability Checker API is a powerful tool designed to check 500 domain extensions to see if domain name is taken or available.

Developer Portal : <https://api.market/store/magicapi/domainchecker>

### About

Our Domain Availability API simplifies the process of checking domain name availability across 500 domain extensions. Designed for developers and businesses, this API provides a quick and efficient way to determine whether a domain name is taken or available.

Integrating our API into your application or workflow is straightforward. Simply send a POST request to the '/check\_domains/' endpoint with the desired domain name in the request body. The API then checks the availability of the domain name across multiple extensions simultaneously.

The output format of the API response is a JSON object, categorizing domain names as either 'available' or 'taken'. This structured format allows for easy parsing and integration with your applications.

Use cases for our Domain Availability API include domain registration platforms, brand protection services, and market research tools. By automating the domain availability check process, our API saves valuable time and resources, enabling you to make informed decisions quickly.

Whether you're building a domain search tool, enhancing your brand's online presence, or conducting market analysis, our API provides the functionality you need to succeed. Streamline your domain availability checks and stay ahead of the competition with our Domain Availability API.

### Curl Request and Response :&#x20;

#### Request

{% tabs %}
{% tab title="CURL" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/domainchecker/check_domains/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API-KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain_name": "google"
}'
```

{% endtab %}

{% tab title="NodeJS" %}

```javascript
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/magicapi/domainchecker/check_domains/';

let options = {
  method: 'POST',
  headers: {'x-api-market-key': 'SOME_STRING_VALUE', 'content-type': 'application/json'},
  body: '{"domain_name":"google"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

payload = "{\"domain_name\":\"google\"}"

headers = {
    'x-api-market-key': "SOME_STRING_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/magicapi/domainchecker/check_domains/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"domain_name\":\"google\"}");
Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/magicapi/domainchecker/check_domains/")
  .post(body)
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}

{% tab title="PHP" %}

```bash
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod.api.market/api/v1/magicapi/domainchecker/check_domains/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"domain_name\":\"google\"}",
  CURLOPT_HTTPHEADER => [
    "content-type: application/json",
    "x-api-market-key: SOME_STRING_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

{% endtab %}
{% endtabs %}

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/domainchecker/check_domains/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain_name": "google"
}'
```

{% endcode %}

#### Response&#x20;

```json
{
  "available": [
    "google.design",
    "google.bz",
    "google.city",
    "google.studio",
    "google.style",
    "google.cn.com",
    "google.br.com",
    "google.jpn.com",
    "google.eu.com",
    "google.sa.com",
    "google.us.com",
    "google.ru.com",
    "google.za.com",
    "google.uk.com"
  ],
  "taken": [
    "google.shop",
    "google.jp",
    "google.de",
    "google.li",
    "google.lt",
    "google.hn",
    "google.fashion",
    "google.direct",
    "google.ai",
    "google.chat",
    "google.games",
    "google.cm",
    "google.immo",
    "google.life",
    "google.market",
    "google.money",
    "google.gr",
    "google.dev",
    "google.mx",
    "google.lc",
    "google.app",
    "google.health",
    "google.ae",
    "google.net.au",
    "google.vip",
    "google.au",
    "google.org.au",
    "google.com.ar",
    "google.ph",
    "google.id.au",
    "google.in",
    "google.cl",
    "google.es",
    "google.com.au",
    "google.pe",
    "google.page",
    "google.at",
    "google.as",
    "google.ch",
    "google.berlin",
    "google.accountant",
    "google.co.uk",
    "google.career",
    "google.be",
    "google.brussels",
    "google.ca",
    "google.co",
    "google.beer",
    "google.nl",
    "google.eu",
    "google.gg",
    "google.biz",
    "google.apartments",
    "google.club",
    "google.name",
    "google.sg",
    "google.actor",
    "google.cx",
    "google.accountants",
    "google.gay",
    "google.org",
    "google.mu",
    "google.codes",
    "google.builders",
    "google.boutique",
    "google.lat",
    "google.cards",
    "google.cheap",
    "google.gmail",
    "google.com.sg",
    "google.online",
    "google.center",
    "google.net",
    "google.bingo",
    "google.adult",
    "google.charity",
    "google.band",
    "google.coffee",
    "google.contact",
    "google.cab",
    "google.company",
    "google.associates",
    "google.attorney",
    "google.construction",
    "google.condos",
    "google.diamonds",
    "google.exchange",
    "google.computer",
    "google.democrat",
    "google.store",
    "google.careers",
    "google.academy",
    "google.contractors",
    "google.capital",
    "google.futbol",
    "google.engineer",
    "google.fan",
    "google.fish",
    "google.coach",
    "google.fail",
    "google.consulting",
    "google.flights",
    "google.energy",
    "google.cool",
    "google.community",
    "google.exposed",
    "google.dating",
    "google.fund",
    "google.haus",
    "google.gifts",
    "google.je",
    "google.is",
    "google.dog",
    "google.email",
    "google.discount",
    "google.koeln",
    "google.kaufen",
    "google.qa",
    "google.ryukyu",
    "google.claims",
    "google.fitness",
    "google.healthcare",
    "google.casino",
    "google.international",
    "google.it",
    "google.church",
    "google.to",
    "google.cafe",
    "google.boston",
    "google.dance",
    "google.okinawa",
    "google.bargains",
    "google.org.uk",
    "google.care",
    "google.gives",
    "google.lawyer",
    "google.marketing",
    "google.com",
    "google.wf",
    "google.engineering",
    "google.am",
    "google.se",
    "google.pm",
    "google.tech",
    "google.ltd",
    "google.hamburg",
    "google.clinic",
    "google.cc",
    "google.expert",
    "google.casa",
    "google.jetzt",
    "google.foundation",
    "google.guru",
    "google.catering",
    "google.holiday",
    "google.gen.nz",
    "google.site",
    "google.im",
    "google.clothing",
    "google.house",
    "google.website",
    "google.football",
    "google.co.nz",
    "google.space",
    "google.kiwi.nz",
    "google.school.nz",
    "google.forsale",
    "google.realestate",
    "google.cologne",
    "google.save",
    "google.events",
    "google.live",
    "google.agency",
    "google.jewelry",
    "google.blog",
    "google.ac.nz",
    "google.geek.nz",
    "google.farm",
    "google.cam",
    "google.cleaning",
    "google.gallery",
    "google.furniture",
    "google.com.sb",
    "google.fi",
    "google.lease",
    "google.lv",
    "google.ws",
    "google.ngo",
    "google.institute",
    "google.uk",
    "google.maison",
    "google.mba",
    "google.loans",
    "google.delivery",
    "google.re",
    "google.graphics",
    "google.estate",
    "google.guide",
    "google.financial",
    "google.me.uk",
    "google.fans",
    "google.vlaanderen",
    "google.fm",
    "google.florist",
    "google.cash",
    "google.credit",
    "google.cricket",
    "google.hospital",
    "google.digital",
    "google.directory",
    "google.nu",
    "google.land",
    "google.deals",
    "google.paris",
    "google.gold",
    "google.giving",
    "google.io",
    "google.ae.org",
    "google.pl",
    "google.dentist",
    "google.fyi",
    "google.cz",
    "google.degree",
    "google.net.nz",
    "google.ong",
    "google.wien",
    "google.build",
    "google.org.nz",
    "google.us",
    "google.mortgage",
    "google.bet",
    "google.tw",
    "google.pink",
    "google.enterprises",
    "google.business",
    "google.london",
    "google.best",
    "google.media",
    "google.fr",
    "google.date",
    "google.blue",
    "google.compare",
    "google.ag",
    "google.auction",
    "google.la",
    "google.bond",
    "google.garden",
    "google.host",
    "google.properties",
    "google.fit",
    "google.download",
    "google.earth",
    "google.fishing",
    "google.ac",
    "google.hair",
    "google.osaka",
    "google.miami",
    "google.melbourne",
    "google.moe",
    "google.photo",
    "google.menu",
    "google.nyc",
    "google.me",
    "google.faith",
    "google.archi",
    "google.homes",
    "google.review",
    "google.bayern",
    "google.tattoo",
    "google.racing",
    "google.select",
    "google.ink",
    "google.luxe",
    "google.wedding",
    "google.cooking",
    "google.one",
    "google.men",
    "google.win",
    "google.sydney",
    "google.surf",
    "google.vodka",
    "google.buzz",
    "google.science",
    "google.stream",
    "google.study",
    "google.rodeo",
    "google.work",
    "google.tv",
    "google.yoga",
    "google.wiki",
    "google.party",
    "google.porn",
    "google.horse",
    "google.courses",
    "google.trade",
    "google.tube",
    "google.taipei",
    "google.maori.nz",
    "google.soy",
    "google.qpon",
    "google.wales",
    "google.lu",
    "google.press",
    "google.mom",
    "google.camp",
    "google.how",
    "google.express",
    "google.bar",
    "google.mn",
    "google.eco",
    "google.lol",
    "google.dk",
    "google.tf",
    "google.gl",
    "google.capetown",
    "google.xyz",
    "google.education",
    "google.college",
    "google.nz",
    "google.global",
    "google.top",
    "google.click",
    "google.kim",
    "google.pw",
    "google.durban",
    "google.africa",
    "google.rest",
    "google.wang",
    "google.day",
    "google.finance",
    "google.scot",
    "google.joburg",
    "google.love",
    "google.legal",
    "google.domains",
    "google.pics",
    "google.asia",
    "google.immobilien",
    "google.kiwi",
    "google.yt",
    "google.mobi",
    "google.link",
    "google.art",
    "google.sx",
    "google.vg",
    "google.skin",
    "google.gift",
    "google.fun",
    "google.black",
    "google.beauty",
    "google.quest",
    "google.tokyo",
    "google.help",
    "google.gd",
    "google.onl",
    "google.co.za",
    "google.group",
    "google.quebec",
    "google.rent",
    "google.uno",
    "google.bio",
    "google.tc",
    "google.boats",
    "google.cloud",
    "google.tel",
    "google.parts",
    "google.news",
    "google.bid",
    "google.id",
    "google.glass",
    "google.red",
    "google.doctor",
    "google.watch",
    "google.video",
    "google.gs",
    "google.ec",
    "google.ms",
    "google.ht",
    "google.gy",
    "google.investments",
    "google.kitchen",
    "google.plus",
    "google.industries",
    "google.management",
    "google.moda",
    "google.repair",
    "google.memorial",
    "google.plumbing",
    "google.rehab",
    "google.pro",
    "google.lighting",
    "google.promo",
    "google.info",
    "google.photos",
    "google.place",
    "google.pictures",
    "google.pub",
    "google.partners",
    "google.ninja",
    "google.reisen",
    "google.recipes",
    "google.organic",
    "google.photography",
    "google.salon",
    "google.bike",
    "google.sc",
    "google.reviews",
    "google.family",
    "google.rip",
    "google.shopping",
    "google.green",
    "google.schule",
    "google.sarl",
    "google.school",
    "google.tours",
    "google.camera",
    "google.solutions",
    "google.productions",
    "google.software",
    "google.singles",
    "google.pet",
    "google.sh",
    "google.social",
    "google.rocks",
    "google.report",
    "google.shiksha",
    "google.hockey",
    "google.team",
    "google.poker",
    "google.lgbt",
    "google.vc",
    "google.insure",
    "google.tennis",
    "google.training",
    "google.vacations",
    "google.vin",
    "google.pt",
    "google.limited",
    "google.supply",
    "google.services",
    "google.toys",
    "google.tips",
    "google.technology",
    "google.support",
    "google.solar",
    "google.restaurant",
    "google.dental",
    "google.villas",
    "google.equipment",
    "google.surgery",
    "google.supplies",
    "google.town",
    "google.sale",
    "google.rentals",
    "google.coupons",
    "google.limo",
    "google.tax",
    "google.tools",
    "google.tienda",
    "google.zone",
    "google.wtf",
    "google.soccer",
    "google.vet",
    "google.pizza",
    "google.holdings",
    "google.works",
    "google.vision",
    "google.systems",
    "google.gripe",
    "google.today",
    "google.network",
    "google.golf",
    "google.vegas",
    "google.ventures",
    "google.voyage",
    "google.ski",
    "google.trading",
    "google.shoes",
    "google.show",
    "google.university",
    "google.wine",
    "google.theater",
    "google.world",
    "google.tl",
    "google.run",
    "google.vote"
  ]
}
```


# WhoIS API

A powerful tool designed to provide detailed WHOIS information for domains worldwide

**Developer Portal** : <https://api.market/store/magicapi/whois>

### About

Welcome to the Whois API documentation! This API allows you to retrieve WHOIS information for a given domain name. WHOIS is a widely-used protocol for querying databases to obtain information about registered domain names, including details about the organization that registered the domain, registration dates, and contact information.

To use this API, simply make a GET request to the **/whois/{domain}** endpoint, where {domain} is the domain name you want to look up. For example, to get WHOIS information for the domain "google.com", you would send a request to /whois/google.com.

The API responds with a JSON object containing various pieces of WHOIS information. This includes the organization name associated with the domain, the raw WHOIS data, a list of WHOIS servers that responded to the query, and, if available, the address range associated with the domain.

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

### Request and Response

Developer Portal : <https://api.market/store/magicapi/whois>

#### Request

{% tabs %}
{% tab title="CURL" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/whois/whois/google.com' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="NodeJS" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/magicapi/whois/whois/google.com';

let options = {
  method: 'GET',
  headers: {
    'x-api-market-key': 'SOME_STRING_VALUE',
    Authorization: 'Basic REPLACE_BASIC_AUTH'
  }
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

headers = {
    'x-api-market-key': "SOME_STRING_VALUE",
    'Authorization': "Basic REPLACE_BASIC_AUTH"
    }

conn.request("GET", "/api/v1/magicapi/whois/whois/google.com", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/magicapi/whois/whois/google.com")
  .get()
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .addHeader("Authorization", "Basic REPLACE_BASIC_AUTH")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}

{% tab title="PHP" %}

```bash
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod.api.market/api/v1/magicapi/whois/whois/google.com",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic REPLACE_BASIC_AUTH",
    "x-api-market-key: SOME_STRING_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

{% endtab %}
{% endtabs %}

#### Response

{% code overflow="wrap" %}

```bash
{
  "OrganizationName": null,
  "Raw": "   Domain Name: GOOGLE.COM\r\n   Registry Domain ID: 2138514_DOMAIN_COM-VRSN\r\n   Registrar WHOIS Server: whois.markmonitor.com\r\n   Registrar URL: http://www.markmonitor.com\r\n   Updated Date: 2019-09-09T15:39:04Z\r\n   Creation Date: 1997-09-15T04:00:00Z\r\n   Registry Expiry Date: 2028-09-14T04:00:00Z\r\n   Registrar: MarkMonitor Inc.\r\n   Registrar IANA ID: 292\r\n   Registrar Abuse Contact Email: abusecomplaints@markmonitor.com\r\n   Registrar Abuse Contact Phone: +1.2086851750\r\n   Domain Status: clientDeleteProhibited https://icann.org/epp#clientDeleteProhibited\r\n   Domain Status: clientTransferProhibited https://icann.org/epp#clientTransferProhibited\r\n   Domain Status: clientUpdateProhibited https://icann.org/epp#clientUpdateProhibited\r\n   Domain Status: serverDeleteProhibited https://icann.org/epp#serverDeleteProhibited\r\n   Domain Status: serverTransferProhibited https://icann.org/epp#serverTransferProhibited\r\n   Domain Status: serverUpdateProhibited https://icann.org/epp#serverUpdateProhibited\r\n   Name Server: NS1.GOOGLE.COM\r\n   Name Server: NS2.GOOGLE.COM\r\n   Name Server: NS3.GOOGLE.COM\r\n   Name Server: NS4.GOOGLE.COM\r\n   DNSSEC: unsigned\r\n   URL of the ICANN Whois Inaccuracy Complaint Form: https://www.icann.org/wicf/\r\n>>> Last update of whois database: 2024-05-10T07:04:20Z <<<\r\n\r\nFor more information on Whois status codes, please visit https://icann.org/epp\r\n\r\nNOTICE: The expiration date displayed in this record is the date the\r\nregistrar's sponsorship of the domain name registration in the registry is\r\ncurrently set to expire. This date does not necessarily reflect the expiration\r\ndate of the domain name registrant's agreement with the sponsoring\r\nregistrar.  Users may consult the sponsoring registrar's Whois database to\r\nview the registrar's reported date of expiration for this registration.\r\n\r\nTERMS OF USE: You are not authorized to access or query our Whois\r\ndatabase through the use of electronic processes that are high-volume and\r\nautomated except as reasonably necessary to register domain names or\r\nmodify existing registrations; the Data in VeriSign Global Registry\r\nServices' (\"VeriSign\") Whois database is provided by VeriSign for\r\ninformation purposes only, and to assist persons in obtaining information\r\nabout or related to a domain name registration record. VeriSign does not\r\nguarantee its accuracy. By submitting a Whois query, you agree to abide\r\nby the following terms of use: You agree that you may use this Data only\r\nfor lawful purposes and that under no circumstances will you use this Data\r\nto: (1) allow, enable, or otherwise support the transmission of mass\r\nunsolicited, commercial advertising or solicitations via e-mail, telephone,\r\nor facsimile; or (2) enable high volume, automated, electronic processes\r\nthat apply to VeriSign (or its computer systems). The compilation,\r\nrepackaging, dissemination or other use of this Data is expressly\r\nprohibited without the prior written consent of VeriSign. You agree not to\r\nuse electronic processes that are automated and high-volume to access or\r\nquery the Whois database except as reasonably necessary to register\r\ndomain names or modify existing registrations. VeriSign reserves the right\r\nto restrict your access to the Whois database in its sole discretion to ensure\r\noperational stability.  VeriSign may restrict or terminate your access to the\r\nWhois database for failure to abide by these terms of use. VeriSign\r\nreserves the right to modify these terms at any time.\r\n\r\nThe Registry database contains ONLY .COM, .NET, .EDU domains and\r\nRegistrars.\r\n",
  "RespondedServers": [
    "whois.iana.org",
    "whois.verisign-grs.com"
  ],
  "AddressRange": null
}
```

{% endcode %}


# PDF Conversion API

PDF Conversion API is a powerful tool designed to extract Text or HTML from URL or File.

Developer Portal : <https://api.market/store/magicapi/pdf-extract>

### About

Designed for developers and businesses alike, this powerful tool simplifies the extraction of valuable information from PDF documents. With just a few lines of code, you can harness the full potential of our API to convert PDF files into easily accessible text or HTML formats.

Using our API is a breeze. Simply integrate it into your application or workflow, and you're ready to go. Whether you're working with URLs or file uploads, our endpoints make it effortless to convert PDFs on the fly. Need to extract text from a PDF hosted online? Use the '/pdf-to-text-url/' endpoint. Want to convert a PDF file stored locally? The '/pdf-to-text-file/' endpoint has you covered. Similarly, if you're looking to generate HTML from PDFs, our '/pdf-to-html-url/' and '/pdf-to-html-file/' endpoints are at your service.

But why use our PDF Conversion API? The answer lies in its unparalleled efficiency and versatility. By automating the conversion process, our API saves you valuable time and resources. Say goodbye to manual extraction tasks and hello to streamlined document processing. Whether you're building content analysis tools, enhancing search functionality, or creating dynamic web pages, our API empowers you to unlock the full potential of your PDF documents.

And what about the output? When you convert a PDF to text, our API delivers plain text content in structured JSON format, making it easy to parse, analyse, or integrate into your applications. On the other hand, converting to HTML preserves the document's formatting, structure, and styling, allowing for seamless web publishing or content repurposing. With support for both text and HTML output formats, our API ensures flexibility and compatibility with a wide range of use cases.

### Curl Request and Response :

#### For `/pdf-to-html-url/` endpoint, the data would be :

#### Request :&#x20;

{% tabs %}
{% tab title="CURL" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-html-url/' \
  -H 'accept: text/html' \
  -H 'x-api-market-key: API-KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "pdf_url": "https://www.cedarville.edu/-/media/Files/PDF/Web-Development-Services/SamplePDF.pdf?la=en&hash=1B9D390C8225C1DDE2155F786C6515A3CEF9D4EC"
}'
```

{% endtab %}

{% tab title="NodeJS" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-html-url/';

let options = {
  method: 'POST',
  headers: {'x-api-market-key': 'SOME_STRING_VALUE', 'content-type': 'application/json'},
  body: '{"pdf_url":"https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

payload = "{\"pdf_url\":\"https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf\"}"

headers = {
    'x-api-market-key': "SOME_STRING_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/magicapi/pdf-extract/pdf-to-html-url/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"pdf_url\":\"https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf\"}");
Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-html-url/")
  .post(body)
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

#### Response :

{% code overflow="wrap" %}

```json
{
  "html": "<html><head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n</head><body>\n<span style=\"position:absolute; border: gray 1px solid; left:0px; top:50px; width:612px; height:792px;\"></span>\n<div style=\"position:absolute; top:50px;\"><a name=\"1\">Page 1</a></div>\n<span style=\"position:absolute; border: black 1px solid; left:0px; top:50px; width:612px; height:792px;\"></span>\n<span style=\"position:absolute; border: black 1px solid; left:0px; top:50px; width:612px; height:792px;\"></span>\n<span style=\"position:absolute; border: black 1px solid; left:0px; top:50px; width:612px; height:792px;\"></span>\n<span style=\"position:absolute; border: black 1px solid; left:0px; top:122px; width:612px; height:720px;\"></span>\n<span style=\"font-family: ArialMT; font-size:11px\">Sample PDF  This is a sample PDF file that I will use to test the Sitecore publishing. "
}
```

{% endcode %}

#### For `/pdf-to-text-url/` endpoint , the data would be :

#### Request :

{% tabs %}
{% tab title="CURL" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-text-url/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: clu2mnx050001l40cyq5h09t8' \
  -H 'Content-Type: application/json' \
  -d '{
  "pdf_url": "https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf"
}'
```

{% endtab %}

{% tab title="NodeJS" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-text-url/';

let options = {
  method: 'POST',
  headers: {'x-api-market-key': 'SOME_STRING_VALUE', 'content-type': 'application/json'},
  body: '{"pdf_url":"https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

payload = "{\"pdf_url\":\"https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf\"}"

headers = {
    'x-api-market-key': "SOME_STRING_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/magicapi/pdf-extract/pdf-to-text-url/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"pdf_url\":\"https://www.sbs.ox.ac.uk/sites/default/files/2019-01/cv-template.pdf\"}");
Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-text-url/")
  .post(body)
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

#### Response :&#x20;

{% code overflow="wrap" %}

```json
{
  "text": "Sample PDF\n \n \nThis is a sample PDF file that I will use to test the Sitecore publishing.\n "
}
```

{% endcode %}

#### For `/pdf-to-text-file/` endpoint, the data would be :&#x20;

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/pdf-extract/pdf-to-text-file/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API-KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@TestPDFfile.pdf;type=application/pdf'
```

#### Response :

{% code overflow="wrap" %}

```json
{
    "text": "This is a test PDF file "
}
```

{% endcode %}

#### For `/pdf-to-html-file/` endpoint, the data would be :

#### CURL :&#x20;

```bash
curl -X 'POST' \
  'https://prod.aoi.market/api/v1/magicapi/pdf-extract/pdf-to-html-file/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API-KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'pdf_file=@TestPDFfile.pdf;type=application/pdf'
```

#### Response :&#x20;

{% code overflow="wrap" %}

```json
{
    "html": "<html><head>\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n</head><body>\n<span style=\"position:absolute; border: gray 1px solid; left:0px; top:50px; width:612px; height:792px;\"></span>\n<div style=\"position:absolute; top:50px;\"><a name=\"1\">Page 1</a></div>\n<span style=\"font-family: Calibri; font-size:11px\">This is a test PDF file "
}
```

{% endcode %}


# Image Upscale API

Image Upscale API is a powerful tool designed to upscale the resolution and size of an image by 2x , 4x and 8x.

### About

Our Image Upscaling API streamlines the process of enhancing image resolution and size by factors of 2x, 4x, and 8x using advanced Super-Resolution models. Tailored for developers, designers, and content creators, this API offers a convenient solution for improving image quality without compromising details.

Integrating our API into your workflow is seamless. Simply send a POST request to the respective endpoint—`/upscale2x/`, `/upscale4x/`, or `/upscale8x/`—with the URL of the image to be upscaled in the request body. The API then applies the chosen upscaling factor to enhance the image resolution.

The output format of the API response is a JPEG image, preserving the upscaled version of the input image. This standardized format ensures compatibility with a wide range of applications and platforms, facilitating easy integration into your projects.

Use cases for our Image Upscaling API encompass various scenarios, including:

* Enhancing image quality for digital media platforms
* Preparing images for high-definition displays or printing
* Improving image details for machine learning training datasets
* Enhancing visual content for marketing materials and presentations

By automating the image upscaling process, our API saves valuable time and resources, empowering you to deliver visually stunning content efficiently. Whether you're developing a photo editing application, optimizing website images, or enhancing machine learning datasets, our Image Upscaling API provides the functionality you need to achieve exceptional results. Elevate your image processing capabilities and unlock new possibilities with our Image Upscaling API.

### CURL and Response

#### Request

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/upscaler/upscale2x/' \
  -H 'accept: image/jpeg' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://production-media.paperswithcode.com/datasets/Set5-0000002728-07a9793f_zA3bDjj.jpg"
}'
```

{% endtab %}

{% tab title="NodeJS" %}

```bash
const fetch = require('node-fetch');

let url = 'https://api.magicapi.dev/api/v1/magicapi/upscaler/upscale2x/';

let options = {
  method: 'POST',
  headers: {'x-magicapi-key': 'SOME_STRING_VALUE', 'content-type': 'application/json'},
  body: '{"url":"https://production-media.paperswithcode.com/datasets/Set5-0000002728-07a9793f_zA3bDjj.jpg"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

payload = "{\"url\":\"https://production-media.paperswithcode.com/datasets/Set5-0000002728-07a9793f_zA3bDjj.jpg\"}"

headers = {
    'x-magicapi-key': "SOME_STRING_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/magicapi/upscaler/upscale2x/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"url\":\"https://production-media.paperswithcode.com/datasets/Set5-0000002728-07a9793f_zA3bDjj.jpg\"}");
Request request = new Request.Builder()
  .url("https://api.magicapi.dev/api/v1/magicapi/upscaler/upscale2x/")
  .post(body)
  .addHeader("x-magicapi-key", "SOME_STRING_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}

{% tab title="PHP" %}

```bash
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.magicapi.dev/api/v1/magicapi/upscaler/upscale2x/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"url\":\"https://production-media.paperswithcode.com/datasets/Set5-0000002728-07a9793f_zA3bDjj.jpg\"}",
  CURLOPT_HTTPHEADER => [
    "content-type: application/json",
    "x-magicapi-key: SOME_STRING_VALUE"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

{% endtab %}
{% endtabs %}

#### Responses :

### For `/upscale2x/`&#x20;

<div align="center"><figure><img src="/files/WkQ0zfeESYoxfuz7c3e7" alt=""><figcaption><p>Original</p></figcaption></figure></div>

<figure><img src="/files/oStKKieim4AoccUMHhQu" alt=""><figcaption><p>Upscaled-2x</p></figcaption></figure>

<figure><img src="/files/tImWn3P7koH5vhGbAgCX" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/CMQ0lqWT2A0YitmDi43g" alt=""><figcaption><p>Upscaled-2x</p></figcaption></figure>

<figure><img src="/files/lXHZpXg5K2poBHfVrK0f" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/xVZ3zIFCYjdQVGQElC5z" alt=""><figcaption><p>Upscaled-2x</p></figcaption></figure>

### For `/upscale4x/`

<figure><img src="/files/WkQ0zfeESYoxfuz7c3e7" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/QidH3t71OPUHnVeQsqiw" alt=""><figcaption><p>Upscaled-4x</p></figcaption></figure>

<figure><img src="/files/tImWn3P7koH5vhGbAgCX" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/zbuVJ0GEFYA5uIFO1iXB" alt=""><figcaption><p>Upscaled-4x</p></figcaption></figure>

<figure><img src="/files/lXHZpXg5K2poBHfVrK0f" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/oPWa7R0oNSoZDNykLE1o" alt=""><figcaption><p>Upscaled-4x</p></figcaption></figure>

### For `/upscale8x/`

<figure><img src="/files/WkQ0zfeESYoxfuz7c3e7" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/UvgL1pi31lBENDAr02nI" alt=""><figcaption><p>Upscaled-8x</p></figcaption></figure>

<figure><img src="/files/tImWn3P7koH5vhGbAgCX" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/Py4NSMSAoasUn1xs0sFN" alt=""><figcaption><p>Upscaled-8x</p></figcaption></figure>

<figure><img src="/files/VZJaBLvf83eiMDxFNcxr" alt=""><figcaption><p>Original</p></figcaption></figure>

<figure><img src="/files/JcsWklMXG0dFS7VJbbNp" alt=""><figcaption><p>Upscaled-8x</p></figcaption></figure>


# DNS Checker API

The DNS Checker API is a powerful tool designed to facilitate easy access to comprehensive DNS (Domain Name System) information for a given domain.

### **About**

It offers developers, network administrators, and cybersecurity professionals a straightforward means to retrieve various DNS records associated with a domain name.

By leveraging the DNS Checker API, users can obtain detailed insights into a domain's DNS configuration, including A (IPv4 address), AAAA (IPv6 address), HTTPS, MX (Mail Exchange), NS (Name Server), SOA (Start of Authority), TXT (Text), HINFO (Host Information) and many other records.

The API returns the DNS records in a structured JSON format, allowing for easy integration into applications, scripts, and tools. Each record type is accompanied by its corresponding values, enabling users to quickly interpret and utilize the information as needed.

Whether it's verifying DNS configurations, diagnosing network issues, conducting security assessments, or monitoring DNS changes over time, the DNS Checker API offers versatile functionality to address a wide range of use cases effectively.

With its user-friendly interface and comprehensive data coverage, the DNS Checker API serves as a valuable resource for enhancing DNS management and analysis tasks.

#### Developer Portal:[ ](https://api.market/store/magicapi/dnschecker)<https://api.market/store/magicapi/dnschecker>

### Curl Requests and Responses

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/dnschecker/dnschecker' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "domain": "api.market"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'domain': 'api.market',
}

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/dnschecker/dnschecker', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/dnschecker/dnschecker');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"domain\": \"api.market\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/dnschecker/dnschecker',
  {
    'domain': 'api.market'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/dnschecker/dnschecker', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'domain': 'api.market'
  })
});
```

{% endtab %}
{% endtabs %}

#### The response would be like this <a href="#the-response-would-be-like-this" id="the-response-would-be-like-this"></a>

```json
[
    {
        "record_type": "A",
        "value": [
            "172.67.194.239",
            "104.21.90.42"
        ]
    },
    {
        "record_type": "AAAA",
        "value": [
            "2606:4700:3035::6815:5a2a",
            "2606:4700:3034::ac43:c2ef"
        ]
    },
    {
        "record_type": "HTTPS",
        "value": [
            "1 . alpn=\"h3,h2\" ipv4hint=\"104.21.90.42,172.67.194.239\" ipv6hint=\"2606:4700:3034::ac43:c2ef,2606:4700:3035::6815:5a2a\""
        ]
    },
    {
        "record_type": "MX",
        "value": [
            "0 api-market.mail.protection.outlook.com."
        ]
    },
    {
        "record_type": "NS",
        "value": [
            "lee.ns.cloudflare.com.",
            "roxy.ns.cloudflare.com."
        ]
    },
    {
        "record_type": "SOA",
        "value": [
            "lee.ns.cloudflare.com. dns.cloudflare.com. 2336594289 10000 2400 604800 1800"
        ]
    },
    {
        "record_type": "TXT",
        "value": [
            "\"v=spf1 include:spf.protection.outlook.com -all\"",
            "\"MS=ms30007217\"",
            "\"google-site-verification=W-7F4ksUW4DMk3-PRLpk940D6-5HD1WseH4EtpywD_c\""
        ]
    },
    {
        "record_type": "HINFO",
        "value": [
            "RFC8482 "
        ]
    }
]
```


# Ageify API

The Ageify API offers a unique and innovative solution for image manipulation, specifically tailored to altering the perceived age of faces within images

### About

By seamlessly integrating with your existing applications or platforms, this API empowers developers and users alike to transform static images into dynamic, engaging GIFs that showcase the future appearance of individuals depicted.

At its core, the Ageify API utilizes advanced facial recognition and age progression algorithms to accurately predict and render how a person's facial features may evolve over time. With just a simple input of an image containing a human face, the API works its magic, generating captivating GIFs that illustrate the potential aging process of the individual in the image.

This powerful functionality opens up a myriad of creative possibilities across various industries and use cases. From entertainment and social media applications to marketing campaigns and personalized content creation, the Ageify API adds a compelling visual element that resonates with audiences and users on a profound level.

Imagine the impact of being able to visualize the future appearance of oneself or loved ones with just a few clicks. Whether it's for entertainment purposes, such as generating amusing GIFs to share with friends and family, or for more practical applications, such as simulating the effects of aging for educational or healthcare purposes, the Ageify API offers an unparalleled level of versatility and utility.

Moreover, the seamless integration capabilities of the API ensure a smooth and hassle-free implementation process for developers, enabling them to effortlessly incorporate age progression functionality into their applications or services without the need for extensive coding or technical expertise.

In summary, the Ageify API represents a cutting-edge solution for image manipulation, leveraging advanced facial recognition and age progression technology to create captivating GIFs that provide a glimpse into the future appearance of individuals. With its wide-ranging applications and user-friendly interface, the API opens up new avenues for creativity, engagement, and innovation across various industries and use cases.

#### Developer Portal: [ ](https://api.market/store/magicapi/period)<https://api.market/store/magicapi/period>

![image](https://replicate.delivery/mgxm/eb97d0ed-1d6c-4460-ba34-0e265a720974/output.gif)

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

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

### Curl Requests and Responses

**Process the image**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/period/period' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": IMAGE_URL,
  "target_age": "default"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

data = '{\n  "image": IMAGE_URL,\n  "target_age": "default"\n}'

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/period/period', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/period/period');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": IMAGE_URL,\n  \"target_age\": \"default\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/period/period',
  '{\n  "image": IMAGE_URL,\n  "target_age": "default"\n}',
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/period/period', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: '{\n  "image": IMAGE_URL,\n  "target_age": "default"\n}'
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/period/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
}

response = requests.get('https://api.magicapi.dev/api/v1/magicapi/period/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/period/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://api.magicapi.dev/api/v1/magicapi/period/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/period/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```

***

#### Data Handling and Security Practices

Our API does not store customer data on our servers. While the results of API requests may reference the URL of an image, the image itself is temporarily stored on our cloud infrastructure, managed through a highly reputable global cloud provider used by numerous Fortune 500 companies. This ensures that we maintain full control over the service and its operations. The image is stored securely for no more than one hour, after which it is permanently deleted. We implement stringent security protocols to ensure this data is never accessible to unauthorized parties and is handled with the highest standards of confidentiality. Under no circumstances do we sell, share, or use customer data for any purpose beyond fulfilling the specific API request. We are committed to maintaining your trust by safeguarding your privacy and following industry-leading practices to protect your data at all times.


# Image Restoration API

The Image Restoration API effortlessly restores and enhances images, revitalizing old or damaged photos with advanced algorithms.

### About

Step into the future of image enhancement with our Image Restoration API, marking a paradigm shift in visual refinement. Seamlessly integrating cutting-edge technology, this solution effortlessly elevates your visual content to new heights, ensuring unparalleled clarity and vibrancy.

Integrating our API into your existing workflows is seamless. Whether you're a seasoned professional photographer, a medical practitioner seeking precise imaging solutions, or an e-commerce platform aiming to showcase products in their best light, our intuitive RESTful endpoints ensure effortless integration with minimal hassle.

From photographs to medical imaging and beyond, our API caters to a diverse array of use cases. Whether you're seeking to eliminate noise, restore lost details, or correct colors to perfection, our versatile solution adapts to meet your every need.

Tailor our API to your unique specifications with customizable parameters and flexible integration options, ensuring it aligns perfectly with your vision. Rest assured, your data is safeguarded with utmost care. Our robust encryption and data protection measures guarantee security and reliability at every step.

#### Developer Portal: <https://api.market/store/magicapi/restoration>

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

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

<figure><img src="/files/2zIsmUyjKgcrjF970GFm" alt=""><figcaption></figcaption></figure>

### Curl Requests and Responses

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/restoration/restoration' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "img": IMAGE_URL,
  "scale": 0, // default value
  "version": "v1.4" // default value
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

data = '{\n  "img": IMAGE_URL,\n  "scale": 0, // default value\n  "version": "v1.4" // default value\n}'

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/restoration/restoration', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/restoration/restoration');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"img\": IMAGE_URL,\n  \"scale\": 0, // default value\n  \"version\": \"v1.4\" // default value\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/restoration/restoration',
  '{\n  "img": IMAGE_URL,\n  "scale": 0, // default value\n  "version": "v1.4" // default value\n}',
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/restoration/restoration', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: '{\n  "img": IMAGE_URL,\n  "scale": 0, // default value\n  "version": "v1.4" // default value\n}'
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/restoration/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
}

response = requests.get('https://api.magicapi.dev/api/v1/magicapi/restoration/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/restoration/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://api.magicapi.dev/api/v1/magicapi/restoration/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}
{% code fullWidth="false" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/restoration/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endcode %}
{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# Toon Me API

The Toonme API is a powerful tool that transforms ordinary images into fun cartoon-style images with just a few clicks.

### About

With its advanced algorithms and cutting-edge technology, the Toonme API can help businesses and individuals add a touch of creativity and playfulness to their digital content effortlessly.

Introducing the Toonme API, a powerful image-processing tool that transforms your photos into cartoon-style illustrations in seconds! With our API, you can easily integrate the Toonme technology into your own software, app, or website and offer your users a fun and unique way to enhance their photos.

Our state-of-the-art algorithm uses advanced machine learning techniques to analyze and identify the key features of your images and then applies a range of cartoon effects to create stunning illustrations that are sure to impress. From simple line drawings to full-color cartoons, the Toonme API offers a wide range of styles and effects to choose from, giving your users the flexibility to create the perfect look for their images.

Our API is incredibly easy to use, with simple and intuitive methods that allow you to quickly integrate our technology into your existing software. Whether you’re building a photo editing app, a social media platform, or a website that allows users to upload and share images, the Toonme API is the perfect tool to add a touch of creativity and fun.

**Some of the key features of the Toonme API include:**

* Fast and reliable image processing
* A wide range of cartoon styles and effects to choose from
* Simple and intuitive API methods for easy integration
* Scalable and flexible architecture that can handle large volumes of requests
* Robust error handling and support for a variety of image formats
* With the Toonme API, you can give your users a powerful and fun tool to enhance their photos and express their creativity. So why wait? Sign up today and start exploring the possibilities of the Toonme API!

### Curl Requests and Responses <a href="#api-documentation" id="api-documentation"></a>

Process the image

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'id=EFFECT_ID&image_url=IMAGE_URL'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'id': 'EFFECT_ID',
    'image_url': 'IMAGE_URL',
}

response = requests.post('https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'id=EFFECT_ID&image_url=IMAGE_URL');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/',
  new URLSearchParams({
    'id': 'EFFECT_ID',
    'image_url': 'IMAGE_URL'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'id': 'EFFECT_ID',
    'image_url': 'IMAGE_URL'
  })
});
```

{% endtab %}
{% endtabs %}

Response

```json
{
  "image_process_response": {
    "request_id": "81d8eafc-05ad-4af8-b511-c9709c00748c",
    "status": "OK",
    "description": null,
    "err_code": "0"
  }
}
```

**Get Result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/result/' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: cltfo5s0b0001l308yrlcifh9' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'request_id=5d5a7286-7c81-4c41-9899-094c3f7af35a'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'cltfo5s0b0001l308yrlcifh9',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'request_id': '5d5a7286-7c81-4c41-9899-094c3f7af35a',
}

response = requests.post('https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/result/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/result/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: cltfo5s0b0001l308yrlcifh9',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'request_id=5d5a7286-7c81-4c41-9899-094c3f7af35a');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/result/',
  new URLSearchParams({
    'request_id': '5d5a7286-7c81-4c41-9899-094c3f7af35a'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'cltfo5s0b0001l308yrlcifh9'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/toonme-api/toonify/toonme/v1/result/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'cltfo5s0b0001l308yrlcifh9'
  },
  body: new URLSearchParams({
    'request_id': '5d5a7286-7c81-4c41-9899-094c3f7af35a'
  })
});
```

{% endtab %}
{% endtabs %}

Response

```json
{
  "image_process_response": {
    "request_id": "5d5a7286-7c81-4c41-9899-094c3f7af35a",
    "status": "OK",
    "duration": "2.585622667s",
    "total_duration": "2.606477093s",
    "result_url": "http://worker-images-8.ws.pho.to/i1/9D87C39C-E9AF-11EE-8875-122AD1B8A069.jpg",
    "masks": {
      "mask": {
        "@index": "1",
        "@name": "body",
        "#text": "http://worker-images-5.ws.pho.to/i2/4771c8fd24621d44a586a0da73284ad51e8c0607_result.png"
      }
    },
    "answers": null
  }
}
```

### Available Styles

You can choose any style by passing "id" in the toonify request.

|                                    Image                                   | Filter Id |
| :------------------------------------------------------------------------: | :-------: |
|        ![Image](http://plassets.ws.pho.to/e/6472/result_square.jpeg)       |    6472   |
|        ![Image](http://plassets.ws.pho.to/e/4511/result_square.gif)        |    4511   |
|        ![Image](https://plassets.ws.pho.to/e/6611/result_square.jpg)       |    6611   |
|        ![Image](https://plassets.ws.pho.to/e/3690/result_square.jpg)       |    3690   |
|        ![Image](https://plassets.ws.pho.to/e/6632/result_square.jpg)       |    6632   |
|        ![Image](https://plassets.ws.pho.to/e/2275/result_square.jpg)       |    2275   |
|        ![Image](https://plassets.ws.pho.to/e/7088/result_square.jpg)       |    7088   |
|        ![Image](https://plassets.ws.pho.to/e/6032/result_square.jpg)       |    6032   |
|        ![Image](https://plassets.ws.pho.to/e/2257/result_square.gif)       |    2257   |
|        ![Image](https://plassets.ws.pho.to/e/3858/result_square.jpg)       |    3858   |
|        ![Image](https://plassets.ws.pho.to/e/5076/result_square.jpg)       |    5076   |
|        ![Image](https://plassets.ws.pho.to/e/4652/result_square.jpg)       |    4652   |
|        ![Image](https://plassets.ws.pho.to/e/2218/result_square.jpg)       |    2218   |
|       ![Image](https://plassets.ws.pho.to/e/3086/result_square1.jpg)       |    3086   |
|        ![Image](https://plassets.ws.pho.to/e/1715/result_square.gif)       |    1715   |
|        ![Image](https://plassets.ws.pho.to/e/2351/result_square.jpg)       |    2351   |
|  ![Image](https://plassets.ws.pho.to/e/5058/result_square_v1620923887.gif) |    5058   |
|        ![Image](https://plassets.ws.pho.to/e/2341/result_square.jpg)       |    2341   |
|        ![Image](https://plassets.ws.pho.to/e/2169/result_square.jpg)       |    2169   |
|        ![Image](https://plassets.ws.pho.to/e/2254/result_square.jpg)       |    2254   |
|        ![Image](https://plassets.ws.pho.to/e/2116/result_square.jpg)       |    2116   |
| ![Image](https://plassets.ws.pho.to/e/3616/result_square_v1590067327.jpeg) |    3616   |
|        ![Image](https://plassets.ws.pho.to/e/2260/result_square.jpg)       |    2260   |
|      ![Image](https://plassets.ws.pho.to/e/3694/result_square_v1.jpg)      |    3694   |
|        ![Image](https://plassets.ws.pho.to/e/2122/result_square.jpg)       |    2122   |
|        ![Image](https://plassets.ws.pho.to/e/1067/result_square.jpg)       |    1067   |
|        ![Image](https://plassets.ws.pho.to/e/950/result_square.jpg)        |    950    |
|        ![Image](https://plassets.ws.pho.to/e/2797/result_square.jpg)       |    2797   |
|        ![Image](https://plassets.ws.pho.to/e/1911/result_square.jpg)       |    1911   |
|        ![Image](https://plassets.ws.pho.to/e/1850/result_square.jpg)       |    1850   |
|        ![Image](https://plassets.ws.pho.to/e/1344/result_square.jpg)       |    1344   |
|        ![Image](https://plassets.ws.pho.to/e/782/result_square.jpg)        |    782    |
|       ![Image](https://plassets.ws.pho.to/e/1915/result_square1.jpg)       |    1915   |
|        ![Image](https://plassets.ws.pho.to/e/7004/result_square.jpg)       |    7004   |
|        ![Image](https://plassets.ws.pho.to/e/3757/result_square.jpg)       |    3757   |
|        ![Image](https://plassets.ws.pho.to/e/1826/result_square.jpg)       |    1826   |
|        ![Image](https://plassets.ws.pho.to/e/1106/result_square.jpg)       |    1106   |
|        ![Image](https://plassets.ws.pho.to/e/952/result_square.jpg)        |    952    |
|        ![Image](https://plassets.ws.pho.to/e/1061/result_square.jpg)       |    1061   |
|        ![Image](https://plassets.ws.pho.to/e/953/result_square.jpg)        |    953    |
|        ![Image](https://plassets.ws.pho.to/e/7007/result_square.jpg)       |    7007   |
|        ![Image](https://plassets.ws.pho.to/e/976/result_square.gif)        |    976    |
|        ![Image](https://plassets.ws.pho.to/e/1705/result_square.gif)       |    1705   |
|        ![Image](https://plassets.ws.pho.to/e/3804/result_square.jpg)       |    3804   |
|        ![Image](https://plassets.ws.pho.to/e/2961/result_square.jpg)       |    2961   |
|        ![Image](https://plassets.ws.pho.to/e/1060/result_square.jpg)       |    1060   |
|        ![Image](https://plassets.ws.pho.to/e/1097/result_square.jpg)       |    1097   |
|        ![Image](https://plassets.ws.pho.to/e/2344/result_square.jpg)       |    2344   |
|        ![Image](https://plassets.ws.pho.to/e/2349/result_square.jpg)       |    2349   |
|        ![Image](https://plassets.ws.pho.to/e/2354/result_square.jpg)       |    2354   |
|        ![Image](https://plassets.ws.pho.to/e/1693/result_square.gif)       |    1693   |
|        ![Image](https://plassets.ws.pho.to/e/1926/result_square.jpg)       |    1926   |
|        ![Image](https://plassets.ws.pho.to/e/1312/result_square.jpg)       |    1312   |
|        ![Image](https://plassets.ws.pho.to/e/1355/result_square.jpg)       |    1355   |
|  ![Image](https://plassets.ws.pho.to/e/1954/result_v1582902180_square.jpg) |    1954   |
|        ![Image](https://plassets.ws.pho.to/e/1828/result_square.jpg)       |    1828   |
|       ![Image](https://plassets.ws.pho.to/e/1511/result_square.jpeg)       |    1511   |
|        ![Image](https://plassets.ws.pho.to/e/2114/result_square.jpg)       |    2114   |
|       ![Image](https://plassets.ws.pho.to/e/1776/result_square.jpeg)       |    1776   |
|        ![Image](https://plassets.ws.pho.to/e/2105/result_square.jpg)       |    2105   |
|           ![Image](https://plassets.ws.pho.to/e/1942/result.jpg)           |    1942   |
|           ![Image](https://plassets.ws.pho.to/e/1840/result.jpeg)          |    1840   |
|        ![Image](https://plassets.ws.pho.to/e/1668/result_square.jpg)       |    1668   |
|        ![Image](https://plassets.ws.pho.to/e/949/result_square.jpg)        |    949    |
|        ![Image](https://plassets.ws.pho.to/e/986/result_square.jpg)        |    986    |
|        ![Image](https://plassets.ws.pho.to/e/1552/result_square.jpg)       |    1552   |
|        ![Image](https://plassets.ws.pho.to/e/956/result_square.jpg)        |    956    |
|         ![Image](https://plassets.ws.pho.to/e/1716/result_320.gif)         |    1716   |
|        ![Image](https://plassets.ws.pho.to/e/1847/result_square.jpg)       |    1847   |
|        ![Image](https://plassets.ws.pho.to/e/1854/result_square.jpg)       |    1854   |
|        ![Image](https://plassets.ws.pho.to/e/2182/result_square.jpg)       |    2182   |
|           ![Image](https://plassets.ws.pho.to/e/1798/result.jpeg)          |    1798   |
|        ![Image](https://plassets.ws.pho.to/e/1120/result_square.jpg)       |    1120   |
|         ![Image](https://plassets.ws.pho.to/e/1723/result_320.gif)         |    1723   |
|        ![Image](https://plassets.ws.pho.to/e/1445/result_square.jpg)       |    1445   |
|        ![Image](https://plassets.ws.pho.to/e/1193/result_square.jpg)       |    1193   |
|        ![Image](https://plassets.ws.pho.to/e/1096/result_square.jpg)       |    1096   |
|           ![Image](https://plassets.ws.pho.to/e/1958/result.jpg)           |    1958   |
|        ![Image](https://plassets.ws.pho.to/e/2179/result_square.jpg)       |    2179   |
|        ![Image](https://plassets.ws.pho.to/e/2241/result_square.jpg)       |    2241   |
|       ![Image](https://plassets.ws.pho.to/e/1673/result_square.jpeg)       |    1673   |
|        ![Image](https://plassets.ws.pho.to/e/2173/result_square.jpg)       |    2173   |
|        ![Image](https://plassets.ws.pho.to/e/1700/result_square.gif)       |    1700   |
|        ![Image](https://plassets.ws.pho.to/e/2120/result_square.jpg)       |    2120   |
|        ![Image](https://plassets.ws.pho.to/e/770/result_square.jpg)        |    770    |
|        ![Image](https://plassets.ws.pho.to/e/2246/result_square.jpg)       |    2246   |
|        ![Image](https://plassets.ws.pho.to/e/1772/result_square.jpg)       |    1772   |
|        ![Image](https://plassets.ws.pho.to/e/1036/result_square.jpg)       |    1036   |
|        ![Image](https://plassets.ws.pho.to/e/462/result_square.jpg)        |    462    |
|        ![Image](https://plassets.ws.pho.to/e/2301/result_square.jpg)       |    2301   |
|        ![Image](https://plassets.ws.pho.to/e/1055/result_square.jpg)       |    1055   |
|        ![Image](https://plassets.ws.pho.to/e/2231/result_square.jpg)       |    2231   |
|        ![Image](https://plassets.ws.pho.to/e/2310/result_square.jpg)       |    2310   |
|        ![Image](https://plassets.ws.pho.to/e/1054/result_square.jpg)       |    1054   |
|        ![Image](https://plassets.ws.pho.to/e/1276/result_square.jpg)       |    1276   |
|        ![Image](https://plassets.ws.pho.to/e/2202/result_square.jpg)       |    2202   |
|        ![Image](https://plassets.ws.pho.to/e/2221/result_square.jpg)       |    2221   |
|        ![Image](https://plassets.ws.pho.to/e/1059/result_square.jpg)       |    1059   |
|        ![Image](https://plassets.ws.pho.to/e/2277/result_square.jpg)       |    2277   |
|        ![Image](https://plassets.ws.pho.to/e/2174/result_square.jpg)       |    2174   |
|        ![Image](https://plassets.ws.pho.to/e/2230/result_square.jpg)       |    2230   |
|        ![Image](https://plassets.ws.pho.to/e/1862/result_square.jpg)       |    1862   |
|        ![Image](https://plassets.ws.pho.to/e/2274/result_square.jpg)       |    2274   |
|        ![Image](https://plassets.ws.pho.to/e/1068/result_square.jpg)       |    1068   |
|        ![Image](https://plassets.ws.pho.to/e/2248/result_square.jpg)       |    2248   |
|        ![Image](https://plassets.ws.pho.to/e/2556/result_square.jpg)       |    2556   |
|        ![Image](https://plassets.ws.pho.to/e/1136/result_square.jpg)       |    1136   |
|        ![Image](https://plassets.ws.pho.to/e/973/result_square.jpg)        |    973    |
|        ![Image](https://plassets.ws.pho.to/e/779/result_square.jpg)        |    779    |
|        ![Image](https://plassets.ws.pho.to/e/2684/result_square.jpg)       |    2684   |
|        ![Image](https://plassets.ws.pho.to/e/2237/result_square.jpg)       |    2237   |
|        ![Image](https://plassets.ws.pho.to/e/2352/result_square.jpg)       |    2352   |
|        ![Image](https://plassets.ws.pho.to/e/2667/result_square.jpg)       |    2667   |
|        ![Image](https://plassets.ws.pho.to/e/268/result_square.jpg)        |    268    |
|        ![Image](https://plassets.ws.pho.to/e/433/result_square.jpg)        |    433    |
|        ![Image](https://plassets.ws.pho.to/e/2176/result_square.jpg)       |    2176   |
|        ![Image](https://plassets.ws.pho.to/e/3017/result_square.jpg)       |    3017   |
|        ![Image](https://plassets.ws.pho.to/e/2887/result_square.jpg)       |    2887   |
|        ![Image](https://plassets.ws.pho.to/e/1555/result_square.jpg)       |    1555   |
|        ![Image](https://plassets.ws.pho.to/e/8216/result_square.jpg)       |    8216   |
|        ![Image](https://plassets.ws.pho.to/e/2157/result_square.jpg)       |    2157   |
|        ![Image](https://plassets.ws.pho.to/e/2345/result_square.jpg)       |    2345   |
|           ![Image](https://plassets.ws.pho.to/e/2603/result.jpg)           |    2603   |
|        ![Image](https://plassets.ws.pho.to/e/1027/result_square.jpg)       |    1027   |
|        ![Image](https://plassets.ws.pho.to/e/3102/result_square.jpg)       |    3102   |
|        ![Image](https://plassets.ws.pho.to/e/2245/result_square.jpg)       |    2245   |
|           ![Image](https://plassets.ws.pho.to/e/1829/result.jpeg)          |    1829   |
|        ![Image](https://plassets.ws.pho.to/e/1062/result_square.jpg)       |    1062   |
|        ![Image](https://plassets.ws.pho.to/e/2570/result_square.jpg)       |    2570   |
|        ![Image](https://plassets.ws.pho.to/e/3113/result_square.jpg)       |    3113   |
|        ![Image](https://plassets.ws.pho.to/e/1101/result_square.jpg)       |    1101   |
|        ![Image](https://plassets.ws.pho.to/e/2589/result_square.jpg)       |    2589   |
|        ![Image](https://plassets.ws.pho.to/e/1787/result_square.jpg)       |    1787   |
|        ![Image](https://plassets.ws.pho.to/e/2962/result_square.jpg)       |    2962   |
|        ![Image](https://plassets.ws.pho.to/e/3122/result_square.gif)       |    3122   |
|        ![Image](https://plassets.ws.pho.to/e/3271/result_square.jpg)       |    3271   |
|        ![Image](https://plassets.ws.pho.to/e/2493/result_square.jpg)       |    2493   |
|        ![Image](https://plassets.ws.pho.to/e/2507/result_square.jpg)       |    2507   |
|        ![Image](https://plassets.ws.pho.to/e/2350/result_square.jpg)       |    2350   |
|        ![Image](https://plassets.ws.pho.to/e/3689/result_square.jpg)       |    3689   |
|        ![Image](https://plassets.ws.pho.to/e/2516/result_square.jpg)       |    2516   |
|        ![Image](https://plassets.ws.pho.to/e/3762/result_square.jpg)       |    3762   |
|        ![Image](https://plassets.ws.pho.to/e/2860/result_square.jpg)       |    2860   |
|        ![Image](https://plassets.ws.pho.to/e/3251/result_square.jpg)       |    3251   |
|        ![Image](https://plassets.ws.pho.to/e/2357/result_square.jpg)       |    2357   |
|        ![Image](https://plassets.ws.pho.to/e/3693/result_square.jpg)       |    3693   |
|        ![Image](https://plassets.ws.pho.to/e/1025/result_square.jpg)       |    1025   |
|        ![Image](https://plassets.ws.pho.to/e/2235/result_square.jpg)       |    2235   |
|        ![Image](https://plassets.ws.pho.to/e/4268/result_square.jpg)       |    4268   |
|          ![Image](https://plassets.ws.pho.to/e/607/result_320.gif)         |    607    |
|        ![Image](https://plassets.ws.pho.to/e/2228/result_square.jpg)       |    2228   |
|        ![Image](https://plassets.ws.pho.to/e/2289/result_square.jpg)       |    2289   |
|        ![Image](https://plassets.ws.pho.to/e/1695/result_square.gif)       |    1695   |
|        ![Image](https://plassets.ws.pho.to/e/1992/result_square.jpg)       |    1992   |
|        ![Image](https://plassets.ws.pho.to/e/951/result_square.jpg)        |    951    |
|        ![Image](https://plassets.ws.pho.to/e/3097/result_square.gif)       |    3097   |
|        ![Image](https://plassets.ws.pho.to/e/2671/result_square.jpg)       |    2671   |
|        ![Image](https://plassets.ws.pho.to/e/3177/result_square.jpg)       |    3177   |
|        ![Image](https://plassets.ws.pho.to/e/2806/result_square.jpg)       |    2806   |
|        ![Image](https://plassets.ws.pho.to/e/2348/result_square.jpg)       |    2348   |
|        ![Image](https://plassets.ws.pho.to/e/4080/result_square.jpg)       |    4080   |
|        ![Image](https://plassets.ws.pho.to/e/3663/result_square.jpg)       |    3663   |
|        ![Image](https://plassets.ws.pho.to/e/2494/result_square.jpg)       |    2494   |
|           ![Image](https://plassets.ws.pho.to/e/2542/result.jpeg)          |    2542   |
|       ![Image](https://plassets.ws.pho.to/e/3854/result_square.jpeg)       |    3854   |
|        ![Image](https://plassets.ws.pho.to/e/2859/result_square.jpg)       |    2859   |
|  ![Image](https://plassets.ws.pho.to/e/3735/result_square_v1594915890.jpg) |    3735   |
|        ![Image](https://plassets.ws.pho.to/e/1026/result_square.jpg)       |    1026   |
|        ![Image](https://plassets.ws.pho.to/e/1853/result_square.jpg)       |    1853   |
|        ![Image](https://plassets.ws.pho.to/e/3152/result_square.jpg)       |    3152   |
|       ![Image](https://plassets.ws.pho.to/e/3018/result_square1.jpg)       |    3018   |
|        ![Image](https://plassets.ws.pho.to/e/3718/result_square.jpg)       |    3718   |
|        ![Image](https://plassets.ws.pho.to/e/3699/result_square.jpg)       |    3699   |
|       ![Image](https://plassets.ws.pho.to/e/2573/result_square1.jpg)       |    2573   |
|        ![Image](https://plassets.ws.pho.to/e/2375/result_square.jpg)       |    2375   |


# Coding Assistant

The Coding Assistant API is a powerful tool designed to streamline coding workflows and enhance developer productivity.

### About

With this API, developers can seamlessly integrate various coding assistance functionalities into their applications, enabling users to write cleaner, more efficient code with ease.

This API provides a range of features tailored to support developers throughout the coding process. From code suggestion and autocomplete to syntax highlighting and error detection, the Coding Assistant API offers comprehensive support for multiple programming languages and frameworks.

Developers can leverage the API to implement intelligent code completion, enabling users to quickly find relevant suggestions as they type, thereby reducing errors and speeding up development. Additionally, the API offers syntax highlighting capabilities, making code easier to read and understand.

Furthermore, the Coding Assistant API includes features for detecting and highlighting errors in code, helping developers identify and address issues early in the development process. By providing real-time feedback on potential errors and suggesting corrections, the API helps improve code quality and reduce debugging time.

The Coding Assistant API empowers developers to build more robust and efficient applications by providing advanced coding assistance features. With its comprehensive functionality and support for multiple programming languages, the API is a valuable asset for any development workflow.

#### Developer Portal:  <https://api.market/store/magicapi/coder>

![image](https://telegra.ph/file/a69e6ca481fab26ce2c8a.png)

### Curl Requests and Responses <a href="#curl-requests-and-responses" id="curl-requests-and-responses"></a>

**Process the image**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/coder/coder' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "top_k": 250,
  "top_p": 0.95,
  "prompt": "Write a javascript function that calculates euclidean distance between two coordinates of any dimension",
  "max_tokens": 500,
  "temperature": 0.95,
  "system_prompt": "string",
  "repeat_penalty": 1.1,
  "presence_penalty": 0,
  "frequency_penalty": 0
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'top_k': 250,
    'top_p': 0.95,
    'prompt': 'Write a javascript function that calculates euclidean distance between two coordinates of any dimension',
    'max_tokens': 500,
    'temperature': 0.95,
    'system_prompt': 'string',
    'repeat_penalty': 1.1,
    'presence_penalty': 0,
    'frequency_penalty': 0,
}

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/coder/coder', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/coder/coder');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"top_k\": 250,\n  \"top_p\": 0.95,\n  \"prompt\": \"Write a javascript function that calculates euclidean distance between two coordinates of any dimension\",\n  \"max_tokens\": 500,\n  \"temperature\": 0.95,\n  \"system_prompt\": \"string\",\n  \"repeat_penalty\": 1.1,\n  \"presence_penalty\": 0,\n  \"frequency_penalty\": 0\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/coder/coder',
  {
    'top_k': 250,
    'top_p': 0.95,
    'prompt': 'Write a javascript function that calculates euclidean distance between two coordinates of any dimension',
    'max_tokens': 500,
    'temperature': 0.95,
    'system_prompt': 'string',
    'repeat_penalty': 1.1,
    'presence_penalty': 0,
    'frequency_penalty': 0
  },
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```
fetch('https://api.magicapi.dev/api/v1/magicapi/coder/coder', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'top_k': 250,
    'top_p': 0.95,
    'prompt': 'Write a javascript function that calculates euclidean distance between two coordinates of any dimension',
    'max_tokens': 500,
    'temperature': 0.95,
    'system_prompt': 'string',
    'repeat_penalty': 1.1,
    'presence_penalty': 0,
    'frequency_penalty': 0
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/coder/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
}

response = requests.get('https://api.magicapi.dev/api/v1/magicapi/coder/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/coder/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://api.magicapi.dev/api/v1/magicapi/coder/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/coder/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# 🎭 FaceSwap API: Instantaneous replaces face with one another

The Faceswap API is a testament to the power of artificial intelligence and deep learning.

> Seamlessly Swap Faces Between Images in Seconds Instantly create captivating face swaps: Our cutting-edge API lets you seamlessly blend two faces.

### About

The FaceSwap API provides a robust and efficient solution for developers looking to integrate face-swapping capabilities into their applications. By simply providing URLs of two images, this API can swap the faces between them, producing a new image that combines elements of both originals.

**Key Features:**

* **Fast and Reliable:** Our API consistently returns results in under 30 seconds, ensuring a smooth and efficient user experience.
* **Cost-Effective:** Designed with efficiency in mind, this API offers competitive pricing, making it accessible for projects of all sizes.
* **High-Quality Outputs:** Utilize advanced algorithms to ensure high-quality face swaps with natural-looking results.
* **Content Filtering:** The API automatically filters out NSFW content, ensuring that it is not processed.

**Content Restrictions:** Please note that the FaceSwap API does not process nude or NSFW (Not Safe For Work) images. If you encounter any errors or if the API incorrectly flags some of your images as NSFW, please contact our support team for assistance. We are committed to providing accurate and efficient service, and we will help resolve your issues promptly.

**Example Use Case:** Imagine swapping the face of Elon Musk onto the image of Shahrukh Khan. Provide the API with URLs for both images, and within seconds, receive a new image where Elon Musk's face is seamlessly integrated onto Shahrukh Khan's body.

**Example Request:**

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/faceswap/' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: you-api-key' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "swap_image": "https://blog.api.market/wp-content/uploads/2024/06/Elon_Musk.png",
    "target_image": "https://blog.api.market/wp-content/uploads/2024/06/Shahrukh_khan.png"
  }
}'
```

**Example Response:**

```json
{
    "output": "https://blog.api.market/wp-content/uploads/2024/06/face_swap_elon_shahrukh.jpeg"
}
```

**Visual Examples:**

Input Images:

* ![Elon Musk](https://blog.api.market/wp-content/uploads/2024/06/Elon_Musk.png)
* ![Shahrukh Khan](https://blog.api.market/wp-content/uploads/2024/06/Shahrukh_khan.png)

Resulting Image:

* ![Result](https://blog.api.market/wp-content/uploads/2024/06/face_swap_elon_shahrukh.jpeg)

**Why Choose FaceSwap API?** Unlike other face-swapping technologies, our API is not only fast but also reliably returns results within a 30-second window, regardless of the server load. This makes it an excellent choice for applications requiring real-time processing and consistent performance. The added security of automatic NSFW content filtering ensures that your application remains appropriate for all users.

Integrate the FaceSwap API into your application today to add a fun and engaging element that impresses your users with both speed and quality!

#### Developer Portal: <https://api.market/store/magicapi/faceswap>

![image](https://telegra.ph/file/d427250819148c80e0875.png)

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

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

### Curl Requests and Responses

Process the image

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/faceswap/faceswap' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "swap_image": "SWAP_IMAGE",
  "target_image": "TARGET_IMAGE"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'swap_image': 'SWAP_IMAGE',
    'target_image': 'TARGET_IMAGE',
}

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/faceswap/faceswap', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/faceswap/faceswap');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"swap_image\": \"SWAP_IMAGE\",\n  \"target_image\": \"TARGET_IMAGE\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/faceswap/faceswap',
  {
    'swap_image': 'SWAP_IMAGE',
    'target_image': 'TARGET_IMAGE'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/faceswap/faceswap', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'swap_image': 'SWAP_IMAGE',
    'target_image': 'TARGET_IMAGE'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "output": "https://d3tx3wg2jy0sui.cloudfront.net/ca645194-a94d-4727-b543-a56ab0cfb76c.jpg"
}
```


# 🏞️ Image Upload API

Free, Effortless Image Upload and Retrieval Service upto 7 Days.

**Developer Protal :** <https://api.market/store/magicapi/image-upload>

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

The Image Upload API provides a free and efficient solution for uploading images and retrieving secure URLs to access these images once uploaded. This service is designed for rapid deployment and ease of use, ideal for developers and businesses requiring a no-cost solution for temporary image hosting.

**Key Features:**

* **No Cost**: This API is completely free to use, making it accessible to developers and businesses of all sizes.
* **Automatic Deletion**: Images are automatically deleted after 7 days from the date of upload, ensuring that storage is managed efficiently without manual intervention.
* **Secure Uploads**: Each request must be authenticated using an API key, ensuring that only authorized users can upload images.
* **Immediate Access**: Upon successful upload, the API immediately provides a URL to access the uploaded image, facilitating instant use in user applications.
* **Scalability**: Designed to handle high volumes of requests without degradation in performance, suitable for both small projects and large-scale operations.
* **Calls:** This API gives 1,000,000 Calls/Month and Free of cost that means it almost never runs out for any developer who needs to store their Image free of cost and access it through an URL.

**How to Use the API:**

1. **Set Up Authentication**: Ensure you have your API key (hidden for security purposes), which is required to authenticate your upload requests. Include this API key in the header of each request.\
   \
   For Example - `'x-magicapi-key: YourAPIKeyHere'`<br>
2. **Upload an Image**: Use the following `curl` command to upload an image file. Replace `path_to_image.png` with the path to the image you want to upload:

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/image-upload/upload' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: YourAPIKeyHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'filename=@"/path_to_image.png;type=image/png"'
```

\
**Example**: If you're uploading a screenshot named `Screenshot 2024-06-17 at 3.00.57 PM.png` located on your desktop, your command would look like this:

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/image-upload/upload' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: YourAPIKeyHere' \
  -H 'Content-Type: multipart/form-data' \
  -F 'filename=@"/Users/yourusername/Desktop/Screenshot 2024-06-17 at 3.00.57 PM.png;type=image/png"'
```

**Handle the Response**: A successful upload will return a JSON object containing the URL of the uploaded image. Here's an example of what the response might look like:

```json
{
  "url": "https://d3tx3wg2jy0sui.cloudfront.net/4870f6f90c624419a57d917048584d80.png"
}
```

You can use this URL in your application to display the image or link to it. Remember that the image will be deleted automatically after 7 days.

**Security Considerations**:

* Always keep your API key confidential to prevent unauthorized access.
* Monitor usage to detect any abnormal activities, which may indicate security issues.

This API is a powerful tool for developers needing a reliable and efficient way to manage image uploads and retrievals, providing robust functionality with minimal setup, all at no cost.

Try out this API and store and use your images through a URL here at <https://api.market/store/magicapi/image-upload>


# Deblurer API

The Deblurer API revolutionizes the way developers handle blurred images, offering a cutting-edge solution that restores clarity and detail with unparalleled precision.

### About

Powered by state-of-the-art deep learning techniques and sophisticated image processing algorithms, this API delivers exceptional results across various scenarios, from mitigating motion blur in action shots to refining focus errors in portraits.

With its simple yet robust RESTful interface, integrating the Deblurer API into your applications is effortless, allowing you to seamlessly enhance user experience and elevate the quality of visual content. Whether you're building a photo editing app, a security surveillance system, or a medical imaging tool, this API empowers you to effortlessly enhance the quality of blurred images, providing users with sharper, more visually appealing results.

By leveraging the Deblurer API, developers can unlock a myriad of possibilities, including improving the accuracy of image analysis algorithms, enhancing the effectiveness of object recognition systems, and enabling clearer visual communication in various domains. Experience the transformative power of the Deblurer API and unlock new opportunities for innovation and creativity in image processing.

#### Developer Portal: <https://api.market/store/magicapi/deblurer>

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

![image](https://telegra.ph/file/859d44e2fdaed47afa286.png)

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

### Curl Requests and Responses <a href="#curl-requests-and-responses" id="curl-requests-and-responses"></a>

**Process the image**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/deblurer/deblurer' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": "https://replicate.delivery/mgxm/e7a66188-34c6-483b-813f-be5c96a3952b/blurry-reds-0.jpg"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'image': 'https://replicate.delivery/mgxm/e7a66188-34c6-483b-813f-be5c96a3952b/blurry-reds-0.jpg',
}

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/deblurer/deblurer', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/deblurer/deblurer');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": \"https://replicate.delivery/mgxm/e7a66188-34c6-483b-813f-be5c96a3952b/blurry-reds-0.jpg\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/deblurer/deblurer',
  {
    'image': 'https://replicate.delivery/mgxm/e7a66188-34c6-483b-813f-be5c96a3952b/blurry-reds-0.jpg'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/deblurer/deblurer', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'image': 'https://replicate.delivery/mgxm/e7a66188-34c6-483b-813f-be5c96a3952b/blurry-reds-0.jpg'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/deblurer/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
}

response = requests.get('https://api.magicapi.dev/api/v1/magicapi/deblurer/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/deblurer/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://api.magicapi.dev/api/v1/magicapi/deblurer/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/deblurer/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# Hair Changer API

The Hair Changer API offers developers a versatile tool to seamlessly integrate hair modification capabilities into their applications.

### About

This API empowers users to effortlessly explore various hairstyles, experiment with hair colors, and virtually try out different haircuts, all through simple API endpoints.

With the Hair Changer API, developers can enable users to upload their images and apply desired changes to their hairstyles or hair colors in real-time. By leveraging this API, developers can enhance user experiences by providing them with personalized and interactive features related to hair styling.

This API supports essential functionalities such as changing hairstyles, modifying hair colors, and trying virtual haircuts. Developers can integrate these features into a wide range of applications, including virtual makeover apps, beauty salon booking platforms, or fashion styling tools.

Users can access the Hair Changer API securely through authentication using API keys, ensuring data privacy and security. Additionally, the API incorporates rate limits to manage usage and prevent abuse, promoting fair and efficient utilization.

For developers seeking to enhance their applications with hair modification capabilities, the Hair Changer API offers comprehensive documentation, error handling support, and dedicated customer assistance. Get started today and bring dynamic hair styling functionalities to your applications with ease.

#### Developer Portal: <https://api.market/store/magicapi/hair>

![image](https://telegra.ph/file/62fd9ab2924175f8fa14e.png)

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

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

### Curl Requests and Responses <a href="#curl-requests-and-responses" id="curl-requests-and-responses"></a>

**Process the image**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/magicapi/hair/hair' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": "https://replicate.delivery/mgxm/b8be17a7-abcb-4421-80f2-e6a1e3fe38c7/MarkZuckerberg.jpg",
  "editing_type": "both",
  "color_description": "blond",
  "hairstyle_description": "hi-top fade hairstyle"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'image': 'https://replicate.delivery/mgxm/b8be17a7-abcb-4421-80f2-e6a1e3fe38c7/MarkZuckerberg.jpg',
    'editing_type': 'both',
    'color_description': 'blond',
    'hairstyle_description': 'hi-top fade hairstyle',
}

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/hair/hair', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/hair/hair');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": \"https://replicate.delivery/mgxm/b8be17a7-abcb-4421-80f2-e6a1e3fe38c7/MarkZuckerberg.jpg\",\n  \"editing_type\": \"both\",\n  \"color_description\": \"blond\",\n  \"hairstyle_description\": \"hi-top fade hairstyle\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/hair/hair',
  {
    'image': 'https://replicate.delivery/mgxm/b8be17a7-abcb-4421-80f2-e6a1e3fe38c7/MarkZuckerberg.jpg',
    'editing_type': 'both',
    'color_description': 'blond',
    'hairstyle_description': 'hi-top fade hairstyle'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/hair/hair', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'image': 'https://replicate.delivery/mgxm/b8be17a7-abcb-4421-80f2-e6a1e3fe38c7/MarkZuckerberg.jpg',
    'editing_type': 'both',
    'color_description': 'blond',
    'hairstyle_description': 'hi-top fade hairstyle'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/hair/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
}

response = requests.get('https://api.magicapi.dev/api/v1/magicapi/hair/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/hair/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://api.magicapi.dev/api/v1/magicapi/hair/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/hair/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```

### Parameters

`color_description` would be -  purple, red, orange, yellow, green, blue, gray, brown, black, white, blond, pink

`hairstyle_description` would be these:

```
afro hairstyle
bob cut hairstyle
bowl cut hairstyle
braid hairstyle
caesar cut hairstyle
chignon hairstyle
cornrows hairstyle
crew cut hairstyle
crown braid hairstyle
curtained hair hairstyle
dido flip hairstyle
dreadlocks hairstyle
extensions hairstyle
fade hairstyle
fauxhawk hairstyle
finger waves hairstyle
french braid hairstyle
frosted tips hairstyle
full crown hairstyle
harvard clip hairstyle
high and tight hairstyle
hime cut hairstyle
hi-top fade hairstyle
jewfro hairstyle
jheri curl hairstyle
liberty spikes hairstyle
marcel waves hairstyle
mohawk hairstyle
pageboy hairstyle
perm hairstyle
pixie cut hairstyle
psychobilly wedge hairstyle
quiff hairstyle
regular taper cut hairstyle
ringlets hairstyle
shingle bob hairstyle
short hair hairstyle
slicked-back hairstyle
spiky hair hairstyle
surfer hair hairstyle
taper cut hairstyle
the rachel hairstyle
undercut hairstyle
updo hairstyle
```


# 🤳🏻🤖AI Qr Code Generator API

Generate customized, scalable QR codes: Integrate our API for efficient and reliable QR code implementation.

**Developer Portal :** [**https://api.market/store/magicapi/aiqrcode**](https://api.market/store/magicapi/aiqrcode)

The **AI QR Code Generator API** enables developers to create visually stunning, AI-generated QR codes with customizable designs and content. Built on a **modified Stable Diffusion ControlNet AI model**, the API delivers unparalleled artistic flexibility while ensuring functional QR code readability.

Our **ControlNet AI models** are trained on a large dataset of **150,000 QR code and QR code artwork pairs**, providing a robust foundation for generating aesthetically pleasing QR code-based artwork that retains its core functionality. The API is designed for industries such as marketing, events, ticketing, and inventory management, with scalable performance and seamless integration.

***

### Use Cases

* **Marketing Campaigns**\
  Generate AI-driven, branded QR codes that grab user attention with unique designs.
* **Event Management**\
  Design custom QR codes for scannable tickets or event passes with artistic elements.
* **E-Commerce**\
  Integrate AI-enhanced QR codes into packaging for improved branding and engagement.
* **Digital Art and NFTs**\
  Create collectible QR code-based artwork for galleries or NFT projects.
* **Inventory Management**\
  Use visually enhanced QR codes for inventory tracking that blends aesthetics with function.

***

### Features

#### **AI-Powered QR Code Generation**

* Uses **Stable Diffusion ControlNet AI models** trained on 150,000 QR code artwork pairs.
* Generates **high-quality artistic QR codes** while maintaining scannability.

#### **Customization Options**

* Define **size**, **color**, **border**, and **background** for tailored designs.
* Add **prompts** to influence artistic styles (e.g., surrealism, minimalism, or futuristic).

#### **Scalability and Speed**

* Optimized for **high-throughput environments**, supporting concurrent API calls.

#### **Performance Metrics**

* Logs detailed processing steps and provides **predict\_time** metrics.

#### **Advanced Error Handling**

* Robust error responses with clear debugging guidance.

#### **Developer-Friendly Integration**

* RESTful API with **comprehensive documentation** for rapid implementation.

***

### Endpoints

#### `POST /predictions`

**Overview**

Generates an AI-designed QR code using customizable parameters and an artistic prompt.

**Request**

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/aiqrcode/predictions' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "seed": 7649977190,
    "width": 768,
    "border": 2,
    "height": 768,
    "prompt": "surreal futuristic house floating on a cloud...",
    "qr_code_content": "https://api.market",
    "qrcode_background": "white",
    "num_outputs": 1,
    "num_inference_steps": 40,
    "guidance_scale": 5.7,
    "controlnet_conditioning_scale": 1.11,
    "negative_prompt": "ugly, low quality, blurry"
  }
}'
```

**Response**

```json
{
  "id": "z1wgjngbhsrga0ck7vrapddq6c",
  "input": { /* input parameters */ },
  "logs": "",
  "output": null,
  "error": null,
  "status": "starting",
  "created_at": "2024-11-18T11:02:19.278Z"
}
```

***

#### `GET /status/{request_id}`

**Overview**

Retrieve the status and output of a QR code generation request.

**Request**

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/aiqrcode/status/{request_id}' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

**Response**

* **Processing Example**

```json
{
  "id": "z1wgjngbhsrga0ck7vrapddq6c",
  "status": "starting",
  "logs": "Processing logs..."
}
```

* **Completed Example**

```json
{
  "id": "z1wgjngbhsrga0ck7vrapddq6c",
  "status": "succeeded",
  "output": [
    "https://replicate.delivery/czjl/XQSAqUBpvHJGOF7Azl4fSWOzXnegXqmNDKYzYanAlpTZDNyTA/output-0.png"
  ]
}
```

***

### FAQs

#### **How does the AI model ensure QR code readability?**

The **ControlNet AI models** are fine-tuned on QR code datasets, ensuring that the QR codes remain scannable while achieving artistic quality.

#### **What input prompts work best for artistic QR codes?**

Prompts describing specific themes, artistic styles, or visual effects (e.g., "futuristic," "minimalistic") yield the best results.

#### **Can the AI handle large-scale requests?**

Yes, the API is designed for high scalability, making it suitable for bulk QR code generation.

#### **What happens if the output is invalid or incomplete?**

The API provides detailed error messages and logs to assist in troubleshooting.

#### **How secure is the content in the QR code?**

All processing is handled securely, and QR code content is not stored permanently.

***

### Response Codes

| **Code** | **Description**                               |
| -------- | --------------------------------------------- |
| `200`    | Request succeeded.                            |
| `400`    | Bad request. Check input parameters.          |
| `401`    | Unauthorized. Invalid or missing API key.     |
| `404`    | Resource not found.                           |
| `500`    | Internal server error. Retry after some time. |

***

### AI Technology Overview

This API leverages **Stable Diffusion ControlNet AI models** trained on an extensive dataset of 150,000 QR code artwork pairs. By preserving the structural integrity of the QR code, the model ensures functionality while applying intricate artistic designs.

#### **Key Highlights**

* Fine-tuned for maintaining **QR code readability**.
* Supports **multi-style artistic rendering**.
* Designed for high-performance **image generation pipelines**.

***

### Integration Tips

* Use **negative prompts** to exclude unwanted elements (e.g., blurry or low-quality designs).
* Combine **guidance scale** with artistic prompts to fine-tune output quality.
* Poll the **GET /status/{request\_id}** endpoint to handle asynchronous processing efficiently.

![image](https://pbxt.replicate.delivery/itZjM66RJgKmMVQX6m2m6mq0WdaT2m8s6qDvL6W9hKsEvxaE/output-0.png)

**Developer Portal :** [**https://api.market/store/magicapi/aiqrcode**](https://api.market/store/magicapi/aiqrcode)


# Whisper API

Whisper API, also known as Audio Scripter, is a powerful tool designed to streamline audio transcription and scripting processes.

### About

With its intuitive interface and robust functionality, Whisper API enables developers to effortlessly integrate audio transcription capabilities into their applications. Whether you're building a voice recognition system, developing a podcasting platform, or enhancing accessibility features, Whisper API provides the tools you need to convert audio files into accurate and editable text.

Using advanced machine learning algorithms, Whisper API delivers precise transcriptions with high accuracy, even for challenging audio recordings. Developers can customize transcription settings to optimize results for different languages, accents, and audio quality levels. With support for various audio formats, including MP3, WAV, and more, Whisper API ensures compatibility with a wide range of media sources.

Beyond transcription, Whisper API offers powerful scripting features to enhance the usability of transcribed text. Developers can segment audio transcripts into logical sections, add timestamps for easy navigation, and annotate content with metadata for organization and analysis purposes. With these scripting capabilities, developers can create rich, interactive experiences that leverage the insights extracted from audio content.

Whisper API is built with scalability and reliability in mind, allowing developers to process large volumes of audio data efficiently. With flexible pricing plans and straightforward integration options, Whisper API empowers developers to focus on building innovative audio-driven applications without worrying about the complexities of transcription technology.

Whether you're developing voice-enabled applications, conducting research, or creating multimedia content, Whisper API provides the foundation you need to unlock the potential of audio data. With its comprehensive features and developer-friendly design, Whisper API is the ideal solution for audio transcription and scripting needs.

#### Developer Portal:  <https://api.market/store/magicapi/whisper>

![image](https://telegra.ph/file/abb3a14db85ba00bdcf86.png)

### Curl Requests and Responses <a href="#curl-requests-and-responses" id="curl-requests-and-responses"></a>

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/whisper/whisper' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "audio": "https://replicate.delivery/mgxm/e5159b1b-508a-4be4-b892-e1eb47850bdc/OSR_uk_000_0050_8k.wav",
  "model": "large-v3",
  "translate": false,
  "temperature": 0,
  "transcription": "plain text",
  "suppress_tokens": "-1",
  "logprob_threshold": -1,
  "no_speech_threshold": 0.6,
  "condition_on_previous_text": true,
  "compression_ratio_threshold": 2.4,
  "temperature_increment_on_fallback": 0.2
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'audio': 'https://replicate.delivery/mgxm/e5159b1b-508a-4be4-b892-e1eb47850bdc/OSR_uk_000_0050_8k.wav',
    'model': 'large-v3',
    'translate': False,
    'temperature': 0,
    'transcription': 'plain text',
    'suppress_tokens': '-1',
    'logprob_threshold': -1,
    'no_speech_threshold': 0.6,
    'condition_on_previous_text': True,
    'compression_ratio_threshold': 2.4,
    'temperature_increment_on_fallback': 0.2,
}

response = requests.post('https://api.magicapi.dev/api/v1/magicapi/whisper/whisper', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.magicapi.dev/api/v1/magicapi/whisper/whisper');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-magicapi-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"audio\": \"https://replicate.delivery/mgxm/e5159b1b-508a-4be4-b892-e1eb47850bdc/OSR_uk_000_0050_8k.wav\",\n  \"model\": \"large-v3\",\n  \"translate\": false,\n  \"temperature\": 0,\n  \"transcription\": \"plain text\",\n  \"suppress_tokens\": \"-1\",\n  \"logprob_threshold\": -1,\n  \"no_speech_threshold\": 0.6,\n  \"condition_on_previous_text\": true,\n  \"compression_ratio_threshold\": 2.4,\n  \"temperature_increment_on_fallback\": 0.2\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://api.magicapi.dev/api/v1/magicapi/whisper/whisper',
  {
    'audio': 'https://replicate.delivery/mgxm/e5159b1b-508a-4be4-b892-e1eb47850bdc/OSR_uk_000_0050_8k.wav',
    'model': 'large-v3',
    'translate': false,
    'temperature': 0,
    'transcription': 'plain text',
    'suppress_tokens': '-1',
    'logprob_threshold': -1,
    'no_speech_threshold': 0.6,
    'condition_on_previous_text': true,
    'compression_ratio_threshold': 2.4,
    'temperature_increment_on_fallback': 0.2
  },
  {
    headers: {
      'accept': 'application/json',
      'x-magicapi-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://api.magicapi.dev/api/v1/magicapi/whisper/whisper', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-magicapi-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'audio': 'https://replicate.delivery/mgxm/e5159b1b-508a-4be4-b892-e1eb47850bdc/OSR_uk_000_0050_8k.wav',
    'model': 'large-v3',
    'translate': false,
    'temperature': 0,
    'transcription': 'plain text',
    'suppress_tokens': '-1',
    'logprob_threshold': -1,
    'no_speech_threshold': 0.6,
    'condition_on_previous_text': true,
    'compression_ratio_threshold': 2.4,
    'temperature_increment_on_fallback': 0.2
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://api.magicapi.dev/api/v1/magicapi/whisper/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/whisper/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/whisper/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/whisper/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/whisper/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# Image Colorizer API

This API colorizes old grayscale images by using Machine Learning models.

### About

Our Image colorizer API is a cutting-edge tool designed to provide users with a fast, accurate, and easy-to-use solution for adding color to black and white images. With this API, you can quickly and easily transform your old or historical photos into vibrant, colorful images that bring your memories to life.

Our API utilizes state-of-the-art algorithms to analyze and recognize image features, patterns, and textures, which enables it to add color to black and white images in a way that is both natural and realistic. Our technology is based on deep learning, which means that it continually learns from the data it processes, making it more accurate and efficient with each use.

With our Image colorizer API, you can easily integrate our advanced colorization technology into your existing applications, software, or workflow. Our API is available in a variety of programming languages, making it easy to use and integrate into your development environment.

Whether you're a professional photographer, a digital artist, or simply someone who wants to add color to their old photos, our Image colorizer API is the perfect tool for you. With its ease of use, accuracy, and speed, you can quickly and easily transform your black and white images into vibrant and colorful masterpieces. So why wait? Try our Image colorizer API today and bring your memories to life!

#### Developer Portal:  <https://api.market/store/magicapi/colorizer>

<figure><img src="/files/2nIJ9MzmNFsRnjdqN2jU" alt=""><figcaption></figcaption></figure>

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

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

### Curl Requests and Responses <a href="#curl-requests-and-responses" id="curl-requests-and-responses"></a>

**Process the image**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/colorizer/colorizer' \
  -H 'accept: application/json' \
  -H 'x-api-market-kay: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": IMAGE_URL
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

data = '{\n  "image": IMAGE_URL\n}'

response = requests.post('https://prod.api.market/api/v1/magicapi/colorizer/colorizer', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/colorizer/colorizer');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": IMAGE_URL\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/colorizer/colorizer',
  '{\n  "image": IMAGE_URL\n}',
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/colorizer/colorizer', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: '{\n  "image": IMAGE_URL\n}'
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/colorizer/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/colorizer/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/colorizer/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/colorizer/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/colorizer/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# OpenJourney API

The OpenJourney API offers a revolutionary approach to merging textual data with visually compelling imagery.

### About

This powerful tool provides customizable styles, allowing users to choose from a variety of predefined visual styles or tailor the output to match specific branding guidelines. From minimalist elegance to vibrant expressiveness, the API offers flexibility in visual representation.

Users can seamlessly incorporate images, icons, and graphics to enhance the visual narrative and create impactful compositions that resonate with the audience. Additionally, the API supports multiple languages and character sets, ensuring global accessibility without compromising accuracy or quality.

Built on a robust and scalable infrastructure, the OpenJourney API delivers high-performance image generation capabilities, capable of handling large volumes of requests with minimal latency. It seamlessly integrates with existing applications and workflows through well-documented APIs and SDKs, making it easy to incorporate image generation functionality into a wide range of software solutions.

Applications of the OpenJourney API span diverse industries and use cases, including content creation, e-commerce, education and training, and data visualization. Whether it's generating eye-catching visuals for social media, creating product images for e-commerce, or transforming educational content into interactive presentations, the OpenJourney API empowers users to unleash the full potential of their textual content through visually stunning images.

#### Developer Portal:  <https://api.market/store/magicapi/openjourney>

![image](https://telegra.ph/file/8569c0ff5b15f5c734834.png)

### Curl Requests and Responses

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/openjourney/openjourney' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "width": 512,
  "height": 512,
  "prompt": "Yellow car in the garden",
  "scheduler": "DPMSolverMultistep",
  "num_outputs": 1,
  "guidance_scale": 7,
  "prompt_strength": 0.8,
  "num_inference_steps": 50
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'width': 512,
    'height': 512,
    'prompt': 'Yellow car in the garden',
    'scheduler': 'DPMSolverMultistep',
    'num_outputs': 1,
    'guidance_scale': 7,
    'prompt_strength': 0.8,
    'num_inference_steps': 50,
}

response = requests.post('https://prod.api.market/api/v1/magicapi/openjourney/openjourney', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/openjourney/openjourney');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"width\": 512,\n  \"height\": 512,\n  \"prompt\": \"Yellow car in the garden\",\n  \"scheduler\": \"DPMSolverMultistep\",\n  \"num_outputs\": 1,\n  \"guidance_scale\": 7,\n  \"prompt_strength\": 0.8,\n  \"num_inference_steps\": 50\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/openjourney/openjourney',
  {
    'width': 512,
    'height': 512,
    'prompt': 'Yellow car in the garden',
    'scheduler': 'DPMSolverMultistep',
    'num_outputs': 1,
    'guidance_scale': 7,
    'prompt_strength': 0.8,
    'num_inference_steps': 50
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/openjourney/openjourney', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'width': 512,
    'height': 512,
    'prompt': 'Yellow car in the garden',
    'scheduler': 'DPMSolverMultistep',
    'num_outputs': 1,
    'guidance_scale': 7,
    'prompt_strength': 0.8,
    'num_inference_steps': 50
  })
});
```

{% endtab %}
{% endtabs %}

```
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/openjourney/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/openjourney/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/openjourney/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/openjourney/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/openjourney/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# Object Remover API

This API removes selected parts from the images.

### About

The Object Remover API is a powerful and flexible solution that allows users to remove unwanted objects or elements from images. Whether you need to remove unwanted people, logos, text, or any other object from your photos, this API can help you achieve a professional and polished look quickly and easily.

This API utilizes advanced algorithms and machine learning techniques to identify and remove objects seamlessly from images without any visible traces. It's also designed to work with a wide range of image formats, including JPEG, PNG, BMP, and GIF, making it a versatile solution that can be integrated into various applications and workflows.

The Object Remover API is easy to use and can be integrated with any programming language or platform, including Python, Java, PHP, and Node.js. With just a few lines of code, you can add this powerful image processing tool to your applications and start removing unwanted objects in real-time.

This API is ideal for a wide range of use cases, including e-commerce product photo editing, image manipulation, and content creation. It can also be used in automated workflows and batch processing tasks, allowing you to streamline your image editing tasks and save time and effort.

In summary, the Object Remover API is a robust and reliable solution for removing unwanted objects from images quickly and easily. Its advanced algorithms and machine learning techniques make it one of the most powerful and versatile object removal tools available in the market today.

#### Developer Portal:  <https://api.market/store/magicapi/objectremover>

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

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

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

### Curl Requests and Responses <a href="#curl-requests-and-responses" id="curl-requests-and-responses"></a>

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api-market/api/v1/magicapi/objectremover/objectremover' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "mask": "https://replicate.delivery/pbxt/JEd3XamngYYznrLZH70ecBlkKm5ga11IMtKEuKkT6uZ3JkyV/mask_1.png",
  "image": "https://replicate.delivery/pbxt/JEd3XXLFAJBo7XiG4aK6BViXwnXRsIO9B32jEoooLJtSzLlp/dog.png"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'mask': 'https://replicate.delivery/pbxt/JEd3XamngYYznrLZH70ecBlkKm5ga11IMtKEuKkT6uZ3JkyV/mask_1.png',
    'image': 'https://replicate.delivery/pbxt/JEd3XXLFAJBo7XiG4aK6BViXwnXRsIO9B32jEoooLJtSzLlp/dog.png',
}

response = requests.post('https://prod.api.market/api/v1/magicapi/objectremover/objectremover', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/objectremover/objectremover');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"mask\": \"https://replicate.delivery/pbxt/JEd3XamngYYznrLZH70ecBlkKm5ga11IMtKEuKkT6uZ3JkyV/mask_1.png\",\n  \"image\": \"https://replicate.delivery/pbxt/JEd3XXLFAJBo7XiG4aK6BViXwnXRsIO9B32jEoooLJtSzLlp/dog.png\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/objectremover/objectremover',
  {
    'mask': 'https://replicate.delivery/pbxt/JEd3XamngYYznrLZH70ecBlkKm5ga11IMtKEuKkT6uZ3JkyV/mask_1.png',
    'image': 'https://replicate.delivery/pbxt/JEd3XXLFAJBo7XiG4aK6BViXwnXRsIO9B32jEoooLJtSzLlp/dog.png'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/objectremover/objectremover', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'mask': 'https://replicate.delivery/pbxt/JEd3XamngYYznrLZH70ecBlkKm5ga11IMtKEuKkT6uZ3JkyV/mask_1.png',
    'image': 'https://replicate.delivery/pbxt/JEd3XXLFAJBo7XiG4aK6BViXwnXRsIO9B32jEoooLJtSzLlp/dog.png'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/objectremover/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/objectremover/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/objectremover/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/objectremover/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/objectremover/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_URL"
}
```


# Image Captioner API

Introducing our cutting-edge Image Captioner API, a powerful tool designed to provide accurate and contextually relevant descriptions for your images.

### About

With advanced machine learning algorithms at its core, this API seamlessly analyzes visual content and generates concise and natural language captions to enhance understanding and accessibility.

Whether you're managing a vast image library, developing applications for the visually impaired, or seeking to enrich user experiences, our Image Captioner API offers unparalleled versatility and reliability. By leveraging state-of-the-art deep learning techniques, it can identify objects, scenes, activities, and more within images, crafting descriptive captions that capture the essence of each visual moment.

Our API prioritizes both accuracy and fluency, ensuring that generated captions not only reflect the content of the image but also resonate with human-like comprehension. From everyday scenes to complex compositions, it excels in capturing the nuances and details that define each image, enabling seamless integration into various applications across industries.

Experience the power of AI-driven image understanding with our Image Captioner API, and unlock new possibilities for enriching content, improving accessibility, and enhancing user engagement.

#### Developer Portal:  <https://api.market/store/magicapi/captioner>

![image](https://telegra.ph/file/e4a72c3fc980534f4eb45.png)

### Curl Requests and Responses

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/captioner/captioner' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": "https://telegra.ph/file/e4a72c3fc980534f4eb45.png",
  "task": "image_captioning"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'image': 'https://telegra.ph/file/e4a72c3fc980534f4eb45.png',
    'task': 'image_captioning',
}

response = requests.post('https://prod.api.market/api/v1/magicapi/captioner/captioner', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/captioner/captioner');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": \"https://telegra.ph/file/e4a72c3fc980534f4eb45.png\",\n  \"task\": \"image_captioning\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/captioner/captioner',
  {
    'image': 'https://telegra.ph/file/e4a72c3fc980534f4eb45.png',
    'task': 'image_captioning'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javscript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/captioner/captioner', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api.market': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'image': 'https://telegra.ph/file/e4a72c3fc980534f4eb45.png',
    'task': 'image_captioning'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/captioner/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/captioner/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/captioner/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/captioner/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javscript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/captioner/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": "RESULT_DESCRIPTION"
}
```


# Object Detector API

The Object Detector API is a powerful tool designed to identify objects within images based on specific keywords.

### About

Leveraging state-of-the-art machine learning algorithms, this API offers seamless integration for developers seeking to incorporate object detection functionality into their applications.

With the Object Detector API, users can submit images along with a list of keywords corresponding to the objects they wish to identify. The API then processes the image using advanced computer vision techniques to locate and label objects matching the provided keywords. Whether you need to detect common items like "car," "dog," or "tree," or more specialized objects such as "cell phone" or "umbrella," the Object Detector API delivers accurate and reliable results.

Developers can integrate this API into a wide range of applications across various industries, including e-commerce, automotive, healthcare, and more. By accurately identifying objects within images, developers can enhance user experiences, automate tasks, and extract valuable insights from visual data.

#### Developer Portal:  <https://api.market/store/magicapi/objectdetector>

<figure><img src="/files/2ZSGdafFBTKbk9BKTbGj" alt=""><figcaption></figcaption></figure>

### Curl Requests and Responses

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/objectdetector/objectdetector' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": "https://replicate.delivery/mgxm/36b04aec-efe2-4dea-9c9d-a5faca68b2b2/000000039769.jpg",
  "text": "a photo of a dog | a cat | two cats with remote controls"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'image': 'https://replicate.delivery/mgxm/36b04aec-efe2-4dea-9c9d-a5faca68b2b2/000000039769.jpg',
    'text': 'a photo of a dog | a cat | two cats with remote controls',
}

response = requests.post(
    'https://prod.api.market/api/v1/magicapi/objectdetector/objectdetector',
    headers=headers,
    json=json_data,
)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/objectdetector/objectdetector');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": \"https://replicate.delivery/mgxm/36b04aec-efe2-4dea-9c9d-a5faca68b2b2/000000039769.jpg\",\n  \"text\": \"a photo of a dog | a cat | two cats with remote controls\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/objectdetector/objectdetector',
  // '{\n  "image": "https://replicate.delivery/mgxm/36b04aec-efe2-4dea-9c9d-a5faca68b2b2/000000039769.jpg",\n  "text": "a photo of a dog | a cat | two cats with remote controls"\n}',
  {
    'image': 'https://replicate.delivery/mgxm/36b04aec-efe2-4dea-9c9d-a5faca68b2b2/000000039769.jpg',
    'text': 'a photo of a dog | a cat | two cats with remote controls'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/objectdetector/objectdetector', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api.market.key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'image': 'https://replicate.delivery/mgxm/36b04aec-efe2-4dea-9c9d-a5faca68b2b2/000000039769.jpg',
    'text': 'a photo of a dog | a cat | two cats with remote controls'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "request_id": REQUEST_ID
}
```

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/magicapi/objectdetector/predictions/REQUEST_ID' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/objectdetector/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/objectdetector/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/objectdetector/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/objectdetector/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": [
    3.860912656250548e-8,
    0.0000025217079837602796,
    0.9999974966049194
  ]
}
```


# NSFW API

The NSFW (Not Safe For Work)

### About

The NSFW (Not Safe For Work) Detector API serves as a sophisticated tool meticulously crafted to scrutinize and categorize images, videos, or textual content for potentially inappropriate or explicit material. Empowered by cutting-edge machine learning algorithms, this API delivers precise and dependable detection of NSFW content, empowering developers to foster safer online environments and shield users from exposure to unsuitable material.

One of the API's standout features lies in its versatility, accommodating analysis across a wide array of media formats, including images, videos, and text. Through its advanced machine learning models, the API swiftly categorizes content into safe or NSFW classifications, equipping developers with actionable insights to tailor their responses accordingly.

In today's fast-paced digital landscape, real-time processing is paramount. The NSFW Detector API rises to the occasion, boasting efficient processing capabilities that ensure swift and timely identification of NSFW material. Moreover, developers enjoy the flexibility of customizable thresholds, enabling them to fine-tune detection parameters to align with the specific needs of their applications.

Underpinning the API's performance is its scalable infrastructure, adept at accommodating varying workloads and catering to applications with diverse user bases. With robust security measures in place, the API guarantees the confidentiality and integrity of analyzed content, safeguarding user privacy and upholding stringent data protection standards.

Integrating the NSFW Detector API into applications, websites, or content moderation systems presents an opportunity to bolster user safety and fortify the online experience. Whether employed for filtering explicit content, enforcing community guidelines, or ensuring compliance with regulatory frameworks, this API furnishes a comprehensive solution for the detection and management of NSFW material, thereby ushering in a new era of digital content moderation.

#### Developer Portal:  <https://api.market/store/magicapi/nsfw>

![image](https://telegra.ph/file/dda34f62b4fff12e9aedc.png)

### Curl Requests and Responses

**Process the API**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/nsfw/nsfw' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "image": IMAGE_URL
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

data = '{\n  "image": IMAGE_URL\n}'

response = requests.post('https://prod.api.market/api/v1/magicapi/nsfw/nsfw', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/nsfw/nsfw');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"image\": IMAGE_URL\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/nsfw/nsfw',
  '{\n  "image": IMAGE_URL\n}',
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/nsfw/nsfw', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: '{\n  "image": IMAGE_URL\n}'
});
```

{% endtab %}
{% endtabs %}

{% code fullWidth="false" %}

```json
{
  "request_id": REQUEST_ID
}
```

{% endcode %}

**Get the result**

{% tabs %}
{% tab title="Curl" %}

```bash
fetch('https://prod.api.market/api/v1/magicapi/nsfw/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
}

response = requests.get('https://prod.api.market/api/v1/magicapi/nsfw/predictions/REQUEST_ID', headers=headers)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/nsfw/predictions/REQUEST_ID');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
]);

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.get('https://prod.api.market/api/v1/magicapi/nsfw/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/nsfw/predictions/REQUEST_ID', {
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  }
});
```

{% endtab %}
{% endtabs %}

```json
{
  "status": "succeeded",
  "result": RESULT_DATA
}
```


# Crunchbase API

crunchbase.com: Discover innovative companies and the people behind them

### About

The Crunchbase API is a robust tool that provides developers with seamless access to an extensive database of business information, empowering them to enrich their applications with comprehensive company profiles, financial insights, and industry trends.

By integrating with the Crunchbase API, developers can leverage real-time updates and a wealth of data on companies and professionals to enhance the functionality and value proposition of their applications. Whether it's for market research, competitive analysis, or networking purposes, the Crunchbase API offers a versatile solution that facilitates informed decision-making and drives business growth.

With its user-friendly interface and powerful capabilities, the Crunchbase API serves as a valuable resource for developers seeking to build innovative solutions that require access to reliable and up-to-date business information.

#### Developer Portal:  <https://api.market/store/magicapi/crunchbase>

### Curl Requests and Responses

#### For `/autocompletes` endpoint, data would be:

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/crunchbase/autocompletes' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "query": "openAI"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'query': 'openAI',
}

response = requests.post('https://prod.api.market/api/v1/magicapi/crunchbase/autocompletes', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/crunchbase/autocompletes');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"query\": \"openAI\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/crunchbase/autocompletes',
  {
    'query': 'openAI'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod..api.market/api/v1/magicapi/crunchbase/autocompletes', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'query': 'openAI'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "count": 1008,
  "entities": [
    {
      "facet_ids": [
        "contact",
        "siftery",
        "investor",
        "ipqwery",
        "aberdeen",
        "apptopia",
        "semrush",
        "company",
        "rank",
        "builtwith",
        "bombora",
        "key_event"
      ],
      "identifier": {
        "uuid": "cf2c678c-b81a-80c3-10d1-9c5e76448e51",
        "value": "OpenAI",
        "image_id": "jjykwqqhsscreywea4gb",
        "permalink": "openai",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAI is an AI research and deployment company that conducts research and implements machine learning."
    },
    {
      "facet_ids": [
        "ipqwery",
        "semrush",
        "company",
        "rank",
        "builtwith"
      ],
      "identifier": {
        "uuid": "30658435-66e6-4d4a-bcce-5ac474713ef1",
        "value": "OpenAi",
        "image_id": "zrafm9hariyl22gfnzkq",
        "permalink": "openai-3ef1",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAi provides solutions for artificial intelligence and social media management."
    },
    {
      "facet_ids": [
        "contact",
        "siftery",
        "apptopia",
        "semrush",
        "company",
        "rank",
        "builtwith",
        "bombora",
        "ai_insight"
      ],
      "identifier": {
        "uuid": "d24dda07-4d9a-43b3-9727-75efca750551",
        "value": "OpenAirlines",
        "image_id": "bt82qrftpaedzlqqthgi",
        "permalink": "openairlines",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAirlines is a needs of airlines to optimize their flight operations and reduce their costs."
    },
    {
      "facet_ids": [
        "contact",
        "siftery",
        "privco",
        "semrush",
        "company",
        "rank",
        "builtwith"
      ],
      "identifier": {
        "uuid": "10e8efa8-507b-6f4e-b8d3-bfe485835503",
        "value": "OpenAirplane",
        "image_id": "v1407318707/swjo9wihuxwqoofwarzg.jpg",
        "permalink": "openairplane",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAirplane is an online platform that enables users to find, book, and pay for aircraft rental."
    },
    {
      "facet_ids": [
        "contact",
        "siftery",
        "semrush",
        "company",
        "rank",
        "builtwith",
        "bombora"
      ],
      "identifier": {
        "uuid": "092b685a-1afb-8978-af6b-13c4b5a83e19",
        "value": "OpenAir",
        "image_id": "v1397188029/a0d27d09a4d1052ab3bf2e653af0f887.png",
        "permalink": "openair",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAir offers web-based software that includes timesheets, expense reports and project management for professional service firms."
    },
    {
      "facet_ids": [
        "contact",
        "investor",
        "ipqwery",
        "rank",
        "builtwith",
        "bombora"
      ],
      "identifier": {
        "uuid": "3cd1af13-24f2-a320-bdf7-5141d3021277",
        "value": "OPENAIR Equity Partners",
        "image_id": "v1397178873/6cf0ffb28b0f07b72c141b17b81480f7.jpg",
        "permalink": "openair-ventures",
        "entity_def_id": "organization"
      },
      "short_description": "OPENAIR Equity Partners is a venture capital firm focused on early stage investments in mobile/wireless and connected device startups."
    },
    {
      "facet_ids": [
        "company",
        "rank",
        "builtwith",
        "semrush"
      ],
      "identifier": {
        "uuid": "17df168a-0e25-4e6b-af49-3e49424f592c",
        "value": "Openair Frauenfeld",
        "image_id": "mr0dyq6tkhsvx5ycxmhv",
        "permalink": "openair-frauenfeld",
        "entity_def_id": "organization"
      },
      "short_description": "Openair Frauenfeld is an event management company."
    },
    {
      "facet_ids": [
        "company",
        "rank",
        "builtwith"
      ],
      "identifier": {
        "uuid": "0d6045fa-bf3e-415f-a652-4cbfe523d602",
        "value": "OpenAILab",
        "image_id": "bgxty0nzuacklfzgxf8z",
        "permalink": "openailab",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAILab provides artificial intelligence solutions."
    },
    {
      "facet_ids": [
        "company",
        "rank",
        "builtwith"
      ],
      "identifier": {
        "uuid": "2fff822c-5112-4743-8798-047d0a72d799",
        "value": "OpenAIMP",
        "image_id": "ozdhhm5tkrdzu7k0jc8n",
        "permalink": "openaimp",
        "entity_def_id": "organization"
      },
      "short_description": "Bringing Innovation and Automation for Businesses"
    },
    {
      "facet_ids": [
        "contact",
        "siftery",
        "aberdeen",
        "semrush",
        "company",
        "rank",
        "builtwith",
        "bombora"
      ],
      "identifier": {
        "uuid": "a15e6159-36d6-4745-8ad9-e3043ac0e866",
        "value": "OpenAir",
        "image_id": "clfocaavaxpts7qbctq6",
        "permalink": "openair-e866",
        "entity_def_id": "organization"
      },
      "short_description": "OpenAir offers charter planes, training, aircraft management, emergency cargo, hazardous goods transportation, and acquisition services."
    }
  ]
}
```

#### For `/entities/organizations` endpoint, data would be:

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/crunchbase/entities/organizations' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: api_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "entity_id": "cf2c678c-b81a-80c3-10d1-9c5e76448e51"
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'api_API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'entity_id': 'cf2c678c-b81a-80c3-10d1-9c5e76448e51',
}

response = requests.post(
    'https://prod.api.market/api/v1/magicapi/crunchbase/entities/organizations',
    headers=headers,
    json=json_data,
)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/crunchbase/entities/organizations');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: api_API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n  \"entity_id\": \"cf2c678c-b81a-80c3-10d1-9c5e76448e51\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/crunchbase/entities/organizations',
  {
    'entity_id': 'cf2c678c-b81a-80c3-10d1-9c5e76448e51'
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'api_API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javscript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/crunchbase/entities/organizations', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'api_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    'entity_id': 'cf2c678c-b81a-80c3-10d1-9c5e76448e51'
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "properties": {
    "identifier": {
      "uuid": "cf2c678c-b81a-80c3-10d1-9c5e76448e51",
      "value": "OpenAI",
      "image_id": "jjykwqqhsscreywea4gb",
      "permalink": "openai",
      "entity_def_id": "organization"
    }
  }
}
```

#### For **/searches/organizations** endpoint, data would be:

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/magicapi/crunchbase/searches/organizations' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "field_ids": [
        "identifier",
        "location_identifiers",
        "short_description",
        "rank_org"
    ],
    "limit": 50,
    "order": [
        {
            "field_id": "rank_org",
            "sort": "asc"
        }
    ],
    "query": [
        {
            "field_id": "location_identifiers",
            "operator_id": "includes",
            "type": "predicate",
            "values": [
                "6106f5dc-823e-5da8-40d7-51612c0b2c4e"
            ]
        },
        {
            "field_id": "facet_ids",
            "operator_id": "includes",
            "type": "predicate",
            "values": [
                "company"
            ]
        }
    ]
}'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json',
}

json_data = {
    'field_ids': [
        'identifier',
        'location_identifiers',
        'short_description',
        'rank_org',
    ],
    'limit': 50,
    'order': [
        {
            'field_id': 'rank_org',
            'sort': 'asc',
        },
    ],
    'query': [
        {
            'field_id': 'location_identifiers',
            'operator_id': 'includes',
            'type': 'predicate',
            'values': [
                '6106f5dc-823e-5da8-40d7-51612c0b2c4e',
            ],
        },
        {
            'field_id': 'facet_ids',
            'operator_id': 'includes',
            'type': 'predicate',
            'values': [
                'company',
            ],
        },
    ],
}

response = requests.post(
    'https://prod.api.market/api/v1/magicapi/crunchbase/searches/organizations',
    headers=headers,
    json=json_data,
)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/magicapi/crunchbase/searches/organizations');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n    \"field_ids\": [\n        \"identifier\",\n        \"location_identifiers\",\n        \"short_description\",\n        \"rank_org\"\n    ],\n    \"limit\": 50,\n    \"order\": [\n        {\n            \"field_id\": \"rank_org\",\n            \"sort\": \"asc\"\n        }\n    ],\n    \"query\": [\n        {\n            \"field_id\": \"location_identifiers\",\n            \"operator_id\": \"includes\",\n            \"type\": \"predicate\",\n            \"values\": [\n                \"6106f5dc-823e-5da8-40d7-51612c0b2c4e\"\n            ]\n        },\n        {\n            \"field_id\": \"facet_ids\",\n            \"operator_id\": \"includes\",\n            \"type\": \"predicate\",\n            \"values\": [\n                \"company\"\n            ]\n        }\n    ]\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/magicapi/crunchbase/searches/organizations',
  {
    'field_ids': [
      'identifier',
      'location_identifiers',
      'short_description',
      'rank_org'
    ],
    'limit': 50,
    'order': [
      {
        'field_id': 'rank_org',
        'sort': 'asc'
      }
    ],
    'query': [
      {
        'field_id': 'location_identifiers',
        'operator_id': 'includes',
        'type': 'predicate',
        'values': [
          '6106f5dc-823e-5da8-40d7-51612c0b2c4e'
        ]
      },
      {
        'field_id': 'facet_ids',
        'operator_id': 'includes',
        'type': 'predicate',
        'values': [
          'company'
        ]
      }
    ]
  },
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/json'
    }
  }
);
```

{% endtab %}

{% tab title="Javscript" %}

```javascript
fetch('https://prod.api.market/api/v1/magicapi/crunchbase/searches/organizations', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/json'
  },
    'field_ids': [
      'identifier',
      'location_identifiers',
      'short_description',
      'rank_org'
    ],
    'limit': 50,
    'order': [
      {
        'field_id': 'rank_org',
        'sort': 'asc'
      }
    ],
    'query': [
      {
        'field_id': 'location_identifiers',
        'operator_id': 'includes',
        'type': 'predicate',
        'values': [
          '6106f5dc-823e-5da8-40d7-51612c0b2c4e'
        ]
      },
      {
        'field_id': 'facet_ids',
        'operator_id': 'includes',
        'type': 'predicate',
        'values': [
          'company'
        ]
      }
    ]
  })
});
```

{% endtab %}
{% endtabs %}

```json
{
  "count": 910847,
  "entities": [
    {
      "uuid": "e1a29c26-a6c2-b208-6ee4-165cf83b1656",
      "properties": {
        "identifier": {
          "permalink": "ubs",
          "image_id": "ztkevgrmluxzily4gs8e",
          "uuid": "e1a29c26-a6c2-b208-6ee4-165cf83b1656",
          "entity_def_id": "organization",
          "value": "UBS"
        },
        "short_description": "UBS is a global financial services company that engages in wealth management, investment banking, asset management, and retail banking.",
        "rank_org": 2,
        "location_identifiers": [
          {
            "permalink": "zürich-zurich",
            "uuid": "bd22efa4-4815-cf8e-e8c5-668079240b6c",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Zürich"
          },
          {
            "permalink": "zurich-switzerland",
            "uuid": "d63a3c1e-d300-da22-915c-69b7b8138f75",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Zurich"
          },
          {
            "permalink": "switzerland",
            "uuid": "078d9679-a862-02a2-57c8-8337e9a1eec8",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Switzerland"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "00e32424-3cc3-4798-8361-78914c212fb0",
      "properties": {
        "identifier": {
          "permalink": "mistral-ai",
          "image_id": "ekqxvomyil4eprfmiu6j",
          "uuid": "00e32424-3cc3-4798-8361-78914c212fb0",
          "entity_def_id": "organization",
          "value": "Mistral AI"
        },
        "short_description": "Mistral AI is an AI startup that provides developers and businesses access to open and portable generative AI solutions.",
        "rank_org": 3,
        "location_identifiers": [
          {
            "permalink": "paris-ile-de-france",
            "uuid": "5805284c-00a4-f0aa-b811-5843398ff2bb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Paris"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "8483fc50-b82d-5ffa-5f92-6c72ac4bdaff",
      "properties": {
        "identifier": {
          "permalink": "siemens",
          "image_id": "mky0fkibqswnxfbvhk3i",
          "uuid": "8483fc50-b82d-5ffa-5f92-6c72ac4bdaff",
          "entity_def_id": "organization",
          "value": "Siemens"
        },
        "short_description": "Siemens is a technology company that offers cybersecurity, digital consulting, and business services.",
        "rank_org": 10,
        "location_identifiers": [
          {
            "permalink": "munich-bayern",
            "uuid": "6469af1b-6dbf-1e9e-17d9-e4f39a86aa95",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Munich"
          },
          {
            "permalink": "bayern-germany",
            "uuid": "eec7d129-caca-eeae-1bd7-d8449e855904",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Bayern"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "a90a2792-7fc3-c23e-836b-7b6271ec772d",
      "properties": {
        "identifier": {
          "permalink": "sanofi",
          "image_id": "vr2uvmci007wmyazkjac",
          "uuid": "a90a2792-7fc3-c23e-836b-7b6271ec772d",
          "entity_def_id": "organization",
          "value": "Sanofi"
        },
        "short_description": "Sanofi is a healthcare company that provides treatments and the protection of life-saving vaccines.",
        "rank_org": 16,
        "location_identifiers": [
          {
            "permalink": "paris-ile-de-france",
            "uuid": "5805284c-00a4-f0aa-b811-5843398ff2bb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Paris"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "dfdddecb-c719-02ec-56f6-da4f071ab6e6",
      "properties": {
        "identifier": {
          "permalink": "ericsson",
          "image_id": "cmazrdxlkfgyxjax4p3x",
          "uuid": "dfdddecb-c719-02ec-56f6-da4f071ab6e6",
          "entity_def_id": "organization",
          "value": "Ericsson"
        },
        "short_description": "Ericsson is an information and communications technology company that offers network services.",
        "rank_org": 24,
        "location_identifiers": [
          {
            "permalink": "kista-stockholms-lan",
            "uuid": "6c794b41-49c6-816e-b20f-6f1e36b00066",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Kista"
          },
          {
            "permalink": "stockholms-lan-sweden",
            "uuid": "374fe002-81bd-de17-f595-2da924209ec6",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Stockholms Lan"
          },
          {
            "permalink": "sweden",
            "uuid": "38bdadf8-c28c-6689-5a01-924f0a63442e",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Sweden"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "315e1e59-3784-ab73-9c4a-447d2616ae82",
      "properties": {
        "identifier": {
          "permalink": "sap",
          "image_id": "v1488420037/xyqlcefn45ijfegxxih8.png",
          "uuid": "315e1e59-3784-ab73-9c4a-447d2616ae82",
          "entity_def_id": "organization",
          "value": "SAP"
        },
        "short_description": "SAP provides enterprise application software to various industries, including consumer, discrete manufacturing, public services.",
        "rank_org": 29,
        "location_identifiers": [
          {
            "permalink": "walldorf-baden-wurttemberg",
            "uuid": "f61a5458-0622-97b2-bc92-8dd82fb5efdb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Walldorf"
          },
          {
            "permalink": "baden-wurttemberg-germany",
            "uuid": "635e079b-43d8-c89d-403a-7fbc14055f8b",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Baden-Wurttemberg"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "393a50c8-102c-5fb0-0c75-f88756e297d8",
      "properties": {
        "identifier": {
          "permalink": "roche",
          "image_id": "v1488355550/sj1kq9pbdhrkiccodapz.png",
          "uuid": "393a50c8-102c-5fb0-0c75-f88756e297d8",
          "entity_def_id": "organization",
          "value": "Roche"
        },
        "short_description": "Roche is a pharmaceutical and diagnostics company that focuses on improving people’s lives.",
        "rank_org": 35,
        "location_identifiers": [
          {
            "permalink": "basel-basel-stadt",
            "uuid": "6da0d74a-7033-c89e-4ae3-974e54a2eaed",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Basel"
          },
          {
            "permalink": "basel-stadt-switzerland",
            "uuid": "6664754b-543f-6588-9266-2f4e4ae56a58",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Basel-Stadt"
          },
          {
            "permalink": "switzerland",
            "uuid": "078d9679-a862-02a2-57c8-8337e9a1eec8",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Switzerland"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "2339d639-581b-690d-668d-f11ad904471d",
      "properties": {
        "identifier": {
          "permalink": "astrazeneca",
          "image_id": "v1492084539/k70fkhka0bgkud4cecpz.png",
          "uuid": "2339d639-581b-690d-668d-f11ad904471d",
          "entity_def_id": "organization",
          "value": "AstraZeneca"
        },
        "short_description": "AstraZeneca is a pharmaceutical company that discovers, develops, manufactures, and markets prescription medicines.",
        "rank_org": 39,
        "location_identifiers": [
          {
            "permalink": "cambridge-cambridgeshire",
            "uuid": "f2e1d95c-c47d-8e7f-90eb-5c2ff71599e2",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Cambridge"
          },
          {
            "permalink": "cambridgeshire-united-kingdom",
            "uuid": "5038b7a6-2cef-2259-1b8e-66df18858d06",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Cambridgeshire"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "1a8d429b-c1a2-4788-fe84-1eb0975dbc60",
      "properties": {
        "identifier": {
          "permalink": "abb",
          "image_id": "xm9iefpmwxyyhwfhsqhn",
          "uuid": "1a8d429b-c1a2-4788-fe84-1eb0975dbc60",
          "entity_def_id": "organization",
          "value": "ABB"
        },
        "short_description": "ABB provides electrification and automation solutions for various industries.",
        "rank_org": 42,
        "location_identifiers": [
          {
            "permalink": "zürich-zurich",
            "uuid": "bd22efa4-4815-cf8e-e8c5-668079240b6c",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Zürich"
          },
          {
            "permalink": "zurich-switzerland",
            "uuid": "d63a3c1e-d300-da22-915c-69b7b8138f75",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Zurich"
          },
          {
            "permalink": "switzerland",
            "uuid": "078d9679-a862-02a2-57c8-8337e9a1eec8",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Switzerland"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "eee223d0-8c2e-3195-820c-f9864460c548",
      "properties": {
        "identifier": {
          "permalink": "european-bank-for-reconstruction-and-development-ebrd",
          "image_id": "v1397178995/580a609b55a90adc51e8a8d5ad6bb70e.gif",
          "uuid": "eee223d0-8c2e-3195-820c-f9864460c548",
          "entity_def_id": "organization",
          "value": "European Bank for Reconstruction and Development"
        },
        "short_description": "European Bank for Reconstruction and Development is an investing firm.",
        "rank_org": 47,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "99cc593e-96ee-48fe-824a-0ebc12a94a63",
      "properties": {
        "identifier": {
          "permalink": "bitscrunch",
          "image_id": "kfmrcw4rpjm5fujg2cqe",
          "uuid": "99cc593e-96ee-48fe-824a-0ebc12a94a63",
          "entity_def_id": "organization",
          "value": "bitsCrunch"
        },
        "short_description": "bitsCrunch is an AI enhanced decentralised Blockchain analytics and forensics company that aims to secure the blockchain space.",
        "rank_org": 48,
        "location_identifiers": [
          {
            "permalink": "munich-bayern",
            "uuid": "6469af1b-6dbf-1e9e-17d9-e4f39a86aa95",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Munich"
          },
          {
            "permalink": "bayern-germany",
            "uuid": "eec7d129-caca-eeae-1bd7-d8449e855904",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Bayern"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "d4acadc5-534f-496d-bddc-f6aac43a5730",
      "properties": {
        "identifier": {
          "permalink": "pennylane",
          "image_id": "x7rv4wgu7ze5nhamu832",
          "uuid": "d4acadc5-534f-496d-bddc-f6aac43a5730",
          "entity_def_id": "organization",
          "value": "Pennylane"
        },
        "short_description": "Pennylane is a fintech startup that develops a financial operating system designed for small and medium-sized businesses.",
        "rank_org": 53,
        "location_identifiers": [
          {
            "permalink": "paris-ile-de-france",
            "uuid": "5805284c-00a4-f0aa-b811-5843398ff2bb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Paris"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "9185a077-c260-ac40-2678-fef9e645591b",
      "properties": {
        "identifier": {
          "permalink": "monzo",
          "image_id": "bdjef4gbpwxynfcvvngr",
          "uuid": "9185a077-c260-ac40-2678-fef9e645591b",
          "entity_def_id": "organization",
          "value": "Monzo"
        },
        "short_description": "Monzo is a digital-only bank platform and marketplace that allows customers to access a range of products and services.",
        "rank_org": 71,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "b762c7e1-7212-5b8f-b315-5757d6a20338",
      "properties": {
        "identifier": {
          "permalink": "telefonica",
          "image_id": "kfedwiwwhttnk2nc183p",
          "uuid": "b762c7e1-7212-5b8f-b315-5757d6a20338",
          "entity_def_id": "organization",
          "value": "Telefonica"
        },
        "short_description": "Telefonica is a diversified telecommunications group that provides fixed line and mobile telephone services.",
        "rank_org": 73,
        "location_identifiers": [
          {
            "permalink": "madrid-madrid",
            "uuid": "a52d6b48-d278-6417-5b55-a48d24ad580c",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Madrid"
          },
          {
            "permalink": "madrid-spain",
            "uuid": "9a50db39-921a-c06f-c84e-e84084c94381",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Madrid"
          },
          {
            "permalink": "spain",
            "uuid": "3f66b02a-78e2-aca0-2da4-e7e1eed94671",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Spain"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "c1a672fb-98fb-5284-1236-bdfa905a982e",
      "properties": {
        "identifier": {
          "permalink": "nokia",
          "image_id": "jjtqbnef2f7wiw7ilf4h",
          "uuid": "c1a672fb-98fb-5284-1236-bdfa905a982e",
          "entity_def_id": "organization",
          "value": "Nokia"
        },
        "short_description": "Nokia is a Finnish multinational communications corporation engaged in the manufacturing of mobile devices and network infrastructure.",
        "rank_org": 86,
        "location_identifiers": [
          {
            "permalink": "espoo-southern-finland",
            "uuid": "f982e9c2-1446-dab8-db00-9f5fbca9f532",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Espoo"
          },
          {
            "permalink": "southern-finland-finland",
            "uuid": "2291746f-af26-cd75-e9b5-b64e9df61781",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Southern Finland"
          },
          {
            "permalink": "finland",
            "uuid": "46a87674-f040-2806-b4bb-e9b83efe1070",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Finland"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "1af189ee-90a6-502a-8627-f69079b996f4",
      "properties": {
        "identifier": {
          "permalink": "standard-chartered-bank",
          "image_id": "m9qc8yhqsk3du4nrmvfm",
          "uuid": "1af189ee-90a6-502a-8627-f69079b996f4",
          "entity_def_id": "organization",
          "value": "Standard Chartered Bank"
        },
        "short_description": "Standard Chartered Bank provides current accounts, savings accounts, credit cards, and loans.",
        "rank_org": 91,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "75d88e2b-258a-b0c8-e980-38855b56a2bc",
      "properties": {
        "identifier": {
          "permalink": "vodafone",
          "image_id": "ek3tox2iveh8psrqc3tw",
          "uuid": "75d88e2b-258a-b0c8-e980-38855b56a2bc",
          "entity_def_id": "organization",
          "value": "Vodafone"
        },
        "short_description": "Vodafone is a mobile telecommunications company that offers voice, messaging, and cellular data services.",
        "rank_org": 95,
        "location_identifiers": [
          {
            "permalink": "newbury-west-berkshire",
            "uuid": "9c804fd4-eced-66e1-8e5e-9d4ac8c9a416",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Newbury"
          },
          {
            "permalink": "west-berkshire-united-kingdom",
            "uuid": "54815444-7de6-0785-36e3-0d07ad4d712e",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "West Berkshire"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "f1b80af8-5b99-b05f-3a96-e7d33cd626e2",
      "properties": {
        "identifier": {
          "permalink": "onfido",
          "image_id": "y3wigxuofzf5isylyegg",
          "uuid": "f1b80af8-5b99-b05f-3a96-e7d33cd626e2",
          "entity_def_id": "organization",
          "value": "Onfido"
        },
        "short_description": "Onfido is a provider of automated digital identity verification.",
        "rank_org": 118,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "d53020f6-8a56-9b9a-764d-bf209256b5b3",
      "properties": {
        "identifier": {
          "permalink": "bae-systems",
          "image_id": "za464dq3cds1batnu9i9",
          "uuid": "d53020f6-8a56-9b9a-764d-bf209256b5b3",
          "entity_def_id": "organization",
          "value": "BAE Systems"
        },
        "short_description": "BAE Systems is a defense, security, and aerospace company that provides its products and services to military and commercial customers.",
        "rank_org": 124,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "a687d060-62ee-65e1-ec20-35aa967e36ed",
      "properties": {
        "identifier": {
          "permalink": "Ōura",
          "image_id": "ssh8s1gm7yaej5jltmnv",
          "uuid": "a687d060-62ee-65e1-ec20-35aa967e36ed",
          "entity_def_id": "organization",
          "value": "Oura"
        },
        "short_description": "Oura is a health technology company that makes and designs wellness wearable rings to track and improve sleep and performance.",
        "rank_org": 133,
        "location_identifiers": [
          {
            "permalink": "oulu-oulu",
            "uuid": "98a6e390-cc42-04b1-c05a-6b0dc0799dbb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Oulu"
          },
          {
            "permalink": "oulu-finland",
            "uuid": "acfbe77f-34a7-b6c8-2b97-9188b38955ce",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Oulu"
          },
          {
            "permalink": "finland",
            "uuid": "46a87674-f040-2806-b4bb-e9b83efe1070",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Finland"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "e8764ba0-1e48-4750-858f-d9252c003bb9",
      "properties": {
        "identifier": {
          "permalink": "monite",
          "image_id": "nv3dowvcronly54hzcjt",
          "uuid": "e8764ba0-1e48-4750-858f-d9252c003bb9",
          "entity_def_id": "organization",
          "value": "Monite"
        },
        "short_description": "Monite is an add invoicing and payables automation management platform.",
        "rank_org": 140,
        "location_identifiers": [
          {
            "permalink": "berlin-berlin",
            "uuid": "e61662e5-c5c2-c4d9-2a31-d0e6d6453375",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "berlin-germany",
            "uuid": "dcc0539e-638a-fda2-0229-07d53b4e96a9",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "bb4c183f-07cc-44f9-9ac5-a45ca6ad057c",
      "properties": {
        "identifier": {
          "permalink": "bioptimus",
          "image_id": "vieurykwwnmtkdszswwo",
          "uuid": "bb4c183f-07cc-44f9-9ac5-a45ca6ad057c",
          "entity_def_id": "organization",
          "value": "Bioptimus"
        },
        "short_description": "Bioptimus is a developer of a universal AI foundation model for biology.",
        "rank_org": 144,
        "location_identifiers": [
          {
            "permalink": "paris-ile-de-france",
            "uuid": "5805284c-00a4-f0aa-b811-5843398ff2bb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Paris"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "f98ebb57-d509-440c-b8d1-66d3169025f9",
      "properties": {
        "identifier": {
          "permalink": "glycanage",
          "image_id": "o76oojxnoc9hsluahsqv",
          "uuid": "f98ebb57-d509-440c-b8d1-66d3169025f9",
          "entity_def_id": "organization",
          "value": "GlycanAge"
        },
        "short_description": "Making preventive healthcare a reality",
        "rank_org": 147,
        "location_identifiers": [
          {
            "permalink": "newcastle-upon-tyne-newcastle-upon-tyne",
            "uuid": "5901d08f-27fa-99b4-21e6-2b6568166a46",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Newcastle Upon Tyne"
          },
          {
            "permalink": "newcastle-upon-tyne-united-kingdom",
            "uuid": "98fd6a20-8fb5-153e-ab04-99e18126e657",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Newcastle upon Tyne"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "31fc3998-a1f1-2e5b-6358-f8d068fa9f71",
      "properties": {
        "identifier": {
          "permalink": "delivery-hero",
          "image_id": "ukohmgkajgq82w5tbulk",
          "uuid": "31fc3998-a1f1-2e5b-6358-f8d068fa9f71",
          "entity_def_id": "organization",
          "value": "Delivery Hero"
        },
        "short_description": "Delivery Hero is a network of online food ordering sites with over 100 restaurant partners worldwide.",
        "rank_org": 163,
        "location_identifiers": [
          {
            "permalink": "berlin-berlin",
            "uuid": "e61662e5-c5c2-c4d9-2a31-d0e6d6453375",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "berlin-germany",
            "uuid": "dcc0539e-638a-fda2-0229-07d53b4e96a9",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "d8e28320-ab09-43f5-a248-12a058a6b9be",
      "properties": {
        "identifier": {
          "permalink": "unseenlabs",
          "image_id": "ufsnbtnl7qtjvucparpk",
          "uuid": "d8e28320-ab09-43f5-a248-12a058a6b9be",
          "entity_def_id": "organization",
          "value": "Unseenlabs"
        },
        "short_description": "Unseenlabs offers maritime surveillance via space-based RF detection, tracking ships worldwide by electromagnetic signatures.",
        "rank_org": 170,
        "location_identifiers": [
          {
            "permalink": "rennes-bretagne",
            "uuid": "ee8e3f34-7d7c-0709-f54f-affb9d37adc6",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Rennes"
          },
          {
            "permalink": "bretagne-france",
            "uuid": "5dfebc7f-5989-29fe-531f-552d5e55d2e8",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Bretagne"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "8a27a3e3-84d5-4d6f-9f43-7823bd9381d6",
      "properties": {
        "identifier": {
          "permalink": "zyber-365",
          "image_id": "penupujnxubu6we9p2cr",
          "uuid": "8a27a3e3-84d5-4d6f-9f43-7823bd9381d6",
          "entity_def_id": "organization",
          "value": "ZYBER 365"
        },
        "short_description": "ZYBER 365 develops a sustainable AI chain for a cyber-secure Web3 OS.",
        "rank_org": 173,
        "location_identifiers": [
          {
            "permalink": "covent-garden-essex",
            "uuid": "af630939-552c-1be3-39e0-dab03b39027d",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Covent Garden"
          },
          {
            "permalink": "essex-united-kingdom",
            "uuid": "ceeb2b94-5d71-cf51-6aa4-aaeccace8a4f",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Essex"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "039dcb21-89b9-66eb-363c-6efa303373f8",
      "properties": {
        "identifier": {
          "permalink": "farfetch",
          "image_id": "wko3ka42ewzfyanrvm9h",
          "uuid": "039dcb21-89b9-66eb-363c-6efa303373f8",
          "entity_def_id": "organization",
          "value": "Farfetch"
        },
        "short_description": "Farfetch is a global marketplace for the luxury fashion industry.",
        "rank_org": 184,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "c683360d-9535-9172-583f-8023d7ff9ab9",
      "properties": {
        "identifier": {
          "permalink": "bt",
          "image_id": "ml82n2518pxycr6ekahh",
          "uuid": "c683360d-9535-9172-583f-8023d7ff9ab9",
          "entity_def_id": "organization",
          "value": "BT"
        },
        "short_description": "BT is a telecommunications provider offering fixed-line, mobile, broadband, IT, and digital services to both businesses and consumers.",
        "rank_org": 190,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "03099c0f-ed6a-d0ea-bf12-1347b36ed611",
      "properties": {
        "identifier": {
          "permalink": "koninklijke-philips",
          "image_id": "ywj40y0t0fpjpslrfjay",
          "uuid": "03099c0f-ed6a-d0ea-bf12-1347b36ed611",
          "entity_def_id": "organization",
          "value": "Philips"
        },
        "short_description": "Philips is a technology company that operates in various fields, including healthcare, consumer electronics, lighting, and home appliances.",
        "rank_org": 200,
        "location_identifiers": [
          {
            "permalink": "amsterdam-noord-holland",
            "uuid": "2d7466f6-ddb1-9f20-4f02-8b4b5d283d9f",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Amsterdam"
          },
          {
            "permalink": "noord-holland-the-netherlands",
            "uuid": "6ea93e7d-3475-b197-f395-0f8819baf8e2",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Noord-Holland"
          },
          {
            "permalink": "the-netherlands",
            "uuid": "4ae9a82d-35d9-be0c-ea9d-366afba8f8f0",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "The Netherlands"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "cda242b8-f043-836f-f5fa-f49e3ba23dea",
      "properties": {
        "identifier": {
          "permalink": "ubisoft",
          "image_id": "qn5cacgpedi2oulron67",
          "uuid": "cda242b8-f043-836f-f5fa-f49e3ba23dea",
          "entity_def_id": "organization",
          "value": "Ubisoft"
        },
        "short_description": "Ubisoft is a producer, publisher, and distributor of interactive entertainment products. ",
        "rank_org": 222,
        "location_identifiers": [
          {
            "permalink": "montreuil-sous-bois-ile-de-france",
            "uuid": "af14c67b-6625-86c4-1f17-fb869ec1553c",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Montreuil-sous-bois"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "5f543728-d9a4-c9e4-dc0f-48ffd232b353",
      "properties": {
        "identifier": {
          "permalink": "graphcore",
          "image_id": "v1500650562/y4x9o7jydzzx50tqeuza.png",
          "uuid": "5f543728-d9a4-c9e4-dc0f-48ffd232b353",
          "entity_def_id": "organization",
          "value": "Graphcore"
        },
        "short_description": "Graphcore develops a microprocessor designed for AI and machine learning applications.",
        "rank_org": 224,
        "location_identifiers": [
          {
            "permalink": "bristol-bristol,-city-of",
            "uuid": "53843210-8e2b-8bb3-25c1-4deb3ffbaf34",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Bristol"
          },
          {
            "permalink": "bristol,-city-of-united-kingdom",
            "uuid": "f7d37f0a-7d0a-5c4d-bbc5-c3819f7e1f43",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Bristol, City of"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "a40d0a1f-f32c-a1e9-1bbd-a10bb0eca2e7",
      "properties": {
        "identifier": {
          "permalink": "deliveroo",
          "image_id": "acqngligw3ahy0ykgtjk",
          "uuid": "a40d0a1f-f32c-a1e9-1bbd-a10bb0eca2e7",
          "entity_def_id": "organization",
          "value": "Deliveroo"
        },
        "short_description": "Deliveroo is an online food delivery service that allows users to order restaurant meals using the web and mobile.",
        "rank_org": 233,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "152b9184-5cc9-fd83-b532-807e78053c4a",
      "properties": {
        "identifier": {
          "permalink": "societe-generale",
          "image_id": "otydo5yf9rj953ptmxkt",
          "uuid": "152b9184-5cc9-fd83-b532-807e78053c4a",
          "entity_def_id": "organization",
          "value": "Societe Generale"
        },
        "short_description": "Societe Generale is a financial services organization that offers retail, corporate, and investment banking services.",
        "rank_org": 236,
        "location_identifiers": [
          {
            "permalink": "paris-ile-de-france",
            "uuid": "5805284c-00a4-f0aa-b811-5843398ff2bb",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Paris"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "9306c230-e735-6ac4-e94b-ca5d495b7bd3",
      "properties": {
        "identifier": {
          "permalink": "novonordisk",
          "image_id": "v1474364282/sapsornyr3mmugckln0q.jpg",
          "uuid": "9306c230-e735-6ac4-e94b-ca5d495b7bd3",
          "entity_def_id": "organization",
          "value": "Novo Nordisk"
        },
        "short_description": "Novo Nordisk is a healthcare company that produces and distributes insulin and other diabetes drugs to treat chronic diseases.",
        "rank_org": 239,
        "location_identifiers": [
          {
            "permalink": "bagsværd-hovedstaden",
            "uuid": "0e6b4219-b414-4a40-f3d8-951e7f9548d4",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Bagsværd"
          },
          {
            "permalink": "hovedstaden-denmark",
            "uuid": "cfa7addd-6b5f-8fb3-9968-c6f3ad20b487",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Hovedstaden"
          },
          {
            "permalink": "denmark",
            "uuid": "f593ac31-624a-2ccd-a203-ddb04c319a79",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Denmark"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "a0350af1-0869-d550-8103-cacc3a9b9ef8",
      "properties": {
        "identifier": {
          "permalink": "orange",
          "image_id": "v1492706266/y1cfeyrrw1oliuxnocgu.png",
          "uuid": "a0350af1-0869-d550-8103-cacc3a9b9ef8",
          "entity_def_id": "organization",
          "value": "Orange"
        },
        "short_description": "Orange is a digital operator that offers mobile and internet services in Europe and Africa, and corporate telecommunication services.",
        "rank_org": 242,
        "location_identifiers": [
          {
            "permalink": "arcueil-ile-de-france",
            "uuid": "1165003e-924e-d965-f5b1-b1c0fa4fee12",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Arcueil"
          },
          {
            "permalink": "ile-de-france-france",
            "uuid": "104bf883-3a61-03f9-b51a-ba1d9a4d2c62",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Ile-de-France"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "de7c1608-59de-46f6-8902-3aa91d881470",
      "properties": {
        "identifier": {
          "permalink": "aleph-alpha",
          "image_id": "sociiodqvwamgl1nynbp",
          "uuid": "de7c1608-59de-46f6-8902-3aa91d881470",
          "entity_def_id": "organization",
          "value": "Aleph Alpha"
        },
        "short_description": "Aleph Alpha specializes in researching, developing, and implementing AI-based technologies for both public and private sectors.",
        "rank_org": 250,
        "location_identifiers": [
          {
            "permalink": "heidelberg-baden-wurttemberg",
            "uuid": "548bd517-fc1a-669c-7c65-a5ebf2a12cc4",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Heidelberg"
          },
          {
            "permalink": "baden-wurttemberg-germany",
            "uuid": "635e079b-43d8-c89d-403a-7fbc14055f8b",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Baden-Wurttemberg"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "1426e9e4-063d-a044-449b-680095f22084",
      "properties": {
        "identifier": {
          "permalink": "glovo-app",
          "image_id": "v1507123252/nm0ghsa5erm2ffuqatvi.png",
          "uuid": "1426e9e4-063d-a044-449b-680095f22084",
          "entity_def_id": "organization",
          "value": "Glovo"
        },
        "short_description": "Glovo is a courier service that purchases, picks up, and delivers products ordered through its mobile application.",
        "rank_org": 268,
        "location_identifiers": [
          {
            "permalink": "barcelona-catalonia",
            "uuid": "eead2c0c-b178-ad33-4e6d-6c813c955e99",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Barcelona"
          },
          {
            "permalink": "catalonia-spain",
            "uuid": "d1cdb4c4-3409-cf3a-48f6-e6777c6b4663",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Catalonia"
          },
          {
            "permalink": "spain",
            "uuid": "3f66b02a-78e2-aca0-2da4-e7e1eed94671",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Spain"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "e0ad4447-c0a9-268d-8870-b1bc8f82d47c",
      "properties": {
        "identifier": {
          "permalink": "hellofresh",
          "image_id": "tsj8z2mnp5knckadyb6y",
          "uuid": "e0ad4447-c0a9-268d-8870-b1bc8f82d47c",
          "entity_def_id": "organization",
          "value": "HelloFresh"
        },
        "short_description": "HelloFresh is a food subscription company that sends pre-portioned ingredients to users’ doorstep each week.",
        "rank_org": 271,
        "location_identifiers": [
          {
            "permalink": "berlin-berlin",
            "uuid": "e61662e5-c5c2-c4d9-2a31-d0e6d6453375",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "berlin-germany",
            "uuid": "dcc0539e-638a-fda2-0229-07d53b4e96a9",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "7e4865f2-4812-3f44-c34d-9763ccae604a",
      "properties": {
        "identifier": {
          "permalink": "pleo-company",
          "image_id": "ndzn657lsrgrvfol1vmv",
          "uuid": "7e4865f2-4812-3f44-c34d-9763ccae604a",
          "entity_def_id": "organization",
          "value": "Pleo"
        },
        "short_description": "Pleo offers smart payment cards for employees to buy work-related products while keeping the company in control of spending.",
        "rank_org": 272,
        "location_identifiers": [
          {
            "permalink": "copenhagen-hovedstaden",
            "uuid": "c0723e0a-84b4-231e-3cf7-f3be235af6d4",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Copenhagen"
          },
          {
            "permalink": "hovedstaden-denmark",
            "uuid": "cfa7addd-6b5f-8fb3-9968-c6f3ad20b487",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Hovedstaden"
          },
          {
            "permalink": "denmark",
            "uuid": "f593ac31-624a-2ccd-a203-ddb04c319a79",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Denmark"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "02c2820e-ecb3-0fc7-adc3-a2db990b82cc",
      "properties": {
        "identifier": {
          "permalink": "thoughtmachine",
          "image_id": "bx6nxang3fzxztbwum9i",
          "uuid": "02c2820e-ecb3-0fc7-adc3-a2db990b82cc",
          "entity_def_id": "organization",
          "value": "Thought Machine"
        },
        "short_description": "Thought Machine is a Fintech company that builds cloud-native technology to revolutionize core banking.",
        "rank_org": 284,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "f920b05d-6cd5-4f69-ad49-d4b4e99e4264",
      "properties": {
        "identifier": {
          "permalink": "datasnipper",
          "image_id": "oi1wp6upvdiecczlywak",
          "uuid": "f920b05d-6cd5-4f69-ad49-d4b4e99e4264",
          "entity_def_id": "organization",
          "value": "DataSnipper"
        },
        "short_description": "DataSnipper is a financial audit company that provides an AI-powered intelligent automation platform in Excel.",
        "rank_org": 285,
        "location_identifiers": [
          {
            "permalink": "amsterdam-noord-holland",
            "uuid": "2d7466f6-ddb1-9f20-4f02-8b4b5d283d9f",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Amsterdam"
          },
          {
            "permalink": "noord-holland-the-netherlands",
            "uuid": "6ea93e7d-3475-b197-f395-0f8819baf8e2",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Noord-Holland"
          },
          {
            "permalink": "the-netherlands",
            "uuid": "4ae9a82d-35d9-be0c-ea9d-366afba8f8f0",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "The Netherlands"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "cd66c9c5-a8ff-4348-a13f-843d08c9d5d2",
      "properties": {
        "identifier": {
          "permalink": "numgenius-ai",
          "image_id": "bt0zanfflhbgrblxfdog",
          "uuid": "cd66c9c5-a8ff-4348-a13f-843d08c9d5d2",
          "entity_def_id": "organization",
          "value": "NumGenius Ai"
        },
        "short_description": "NumGenius Ai is the market leader in low-cost cloud GPU rental.Investors have enabled NumGenius AI to expand rapidly through NumGenius AI.",
        "rank_org": 291,
        "location_identifiers": [
          {
            "permalink": "antwerpen-antwerpen",
            "uuid": "7463284c-671f-081a-46ed-5cf4efa7f979",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Antwerpen"
          },
          {
            "permalink": "antwerpen-belgium",
            "uuid": "68f99cf4-1980-9f86-644f-4c9e0c6168d7",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Antwerpen"
          },
          {
            "permalink": "belgium",
            "uuid": "0bb46ca5-38e7-3977-5d09-34dd1143a806",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Belgium"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "d7fe24a4-78aa-5363-a460-5d024016e6f8",
      "properties": {
        "identifier": {
          "permalink": "odoo",
          "image_id": "ahnrggkezugpsohibkkk",
          "uuid": "d7fe24a4-78aa-5363-a460-5d024016e6f8",
          "entity_def_id": "organization",
          "value": "Odoo"
        },
        "short_description": "Odoo offers an integrated suite of business apps built through an open-source development model.",
        "rank_org": 294,
        "location_identifiers": [
          {
            "permalink": "grand-rosière-brabant-wallon",
            "uuid": "4a5d1a76-d723-2da4-7bed-ab91700b3187",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Grand-rosière"
          },
          {
            "permalink": "brabant-wallon-belgium",
            "uuid": "1580517b-6b25-1543-f162-97fa4bbf1c45",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Brabant Wallon"
          },
          {
            "permalink": "belgium",
            "uuid": "0bb46ca5-38e7-3977-5d09-34dd1143a806",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Belgium"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "fe088d9d-3892-e0d5-9c27-cb0e0fdce561",
      "properties": {
        "identifier": {
          "permalink": "arcelormittal",
          "image_id": "saaq3luuwlbfw1xfrbmy",
          "uuid": "fe088d9d-3892-e0d5-9c27-cb0e0fdce561",
          "entity_def_id": "organization",
          "value": "ArcelorMittal"
        },
        "short_description": "ArcelorMittal is a mining and steel manufacturing company that produces iron ore and metallurgical coal.",
        "rank_org": 295,
        "location_identifiers": [
          {
            "permalink": "luxembourg-luxembourg",
            "uuid": "0d3a83bd-0c64-04b5-bd58-79fec26d544a",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Luxembourg"
          },
          {
            "permalink": "luxembourg-luxembourg-1bf1",
            "uuid": "1bf1e5fe-1475-95aa-d0be-a7f1cf43ca7e",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Luxembourg"
          },
          {
            "permalink": "luxembourg",
            "uuid": "c8a6d9b7-d70d-91c6-6e97-419a4a1276c3",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Luxembourg"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "ee9e4a72-5406-4d33-8cdd-b9e51a9e1d9b",
      "properties": {
        "identifier": {
          "permalink": "zetachain",
          "image_id": "wx6cdcfdwctv7vf3jvyu",
          "uuid": "ee9e4a72-5406-4d33-8cdd-b9e51a9e1d9b",
          "entity_def_id": "organization",
          "value": "ZetaChain"
        },
        "short_description": "ZetaChain is to create the most secure, simple, and cost-effective means to transmit value and information across blockchains and layers.",
        "rank_org": 296,
        "location_identifiers": [
          {
            "permalink": "us-picardie",
            "uuid": "7d544b3e-5833-e3db-2bd9-12257a0b3af0",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Us"
          },
          {
            "permalink": "picardie-france",
            "uuid": "b77c9761-f10e-2e5b-d405-e1b759fd3a3f",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Picardie"
          },
          {
            "permalink": "france",
            "uuid": "f134827e-36a1-fd31-a82f-950489e103ef",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "France"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "4f1e84f4-01f8-4ab5-beec-f4fc6c061860",
      "properties": {
        "identifier": {
          "permalink": "embat",
          "image_id": "pyf7rub6uqqmgbcvmfub",
          "uuid": "4f1e84f4-01f8-4ab5-beec-f4fc6c061860",
          "entity_def_id": "organization",
          "value": "Embat"
        },
        "short_description": "Embat automates treasury with AI for accounting, payments, and cash forecasting.",
        "rank_org": 310,
        "location_identifiers": [
          {
            "permalink": "madrid-madrid",
            "uuid": "a52d6b48-d278-6417-5b55-a48d24ad580c",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Madrid"
          },
          {
            "permalink": "madrid-spain",
            "uuid": "9a50db39-921a-c06f-c84e-e84084c94381",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Madrid"
          },
          {
            "permalink": "spain",
            "uuid": "3f66b02a-78e2-aca0-2da4-e7e1eed94671",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Spain"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "988b8953-a085-8de4-babb-fae5bb895761",
      "properties": {
        "identifier": {
          "permalink": "foodpanda",
          "image_id": "blc2nkqwabrditk9bjyg",
          "uuid": "988b8953-a085-8de4-babb-fae5bb895761",
          "entity_def_id": "organization",
          "value": "Foodpanda"
        },
        "short_description": "foodpanda is a online food delivery marketplace that enables users to place orders at local restaurants via its website or mobile app.",
        "rank_org": 345,
        "location_identifiers": [
          {
            "permalink": "berlin-berlin",
            "uuid": "e61662e5-c5c2-c4d9-2a31-d0e6d6453375",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "berlin-germany",
            "uuid": "dcc0539e-638a-fda2-0229-07d53b4e96a9",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Berlin"
          },
          {
            "permalink": "germany",
            "uuid": "6085b4bf-b18a-1763-a04e-fdde3f6aba94",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Germany"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "c2e67ce9-32d7-50d4-2592-ed2e5acfa3f9",
      "properties": {
        "identifier": {
          "permalink": "daedalean-ag",
          "image_id": "n1pjinbfmnacdndscyp5",
          "uuid": "c2e67ce9-32d7-50d4-2592-ed2e5acfa3f9",
          "entity_def_id": "organization",
          "value": "Daedalean"
        },
        "short_description": "Daedalean is building autonomous piloting software systems for civil aircraft of today and advanced aerial mobility of tomorrow.",
        "rank_org": 345,
        "location_identifiers": [
          {
            "permalink": "zürich-zurich",
            "uuid": "bd22efa4-4815-cf8e-e8c5-668079240b6c",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Zürich"
          },
          {
            "permalink": "zurich-switzerland",
            "uuid": "d63a3c1e-d300-da22-915c-69b7b8138f75",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Zurich"
          },
          {
            "permalink": "switzerland",
            "uuid": "078d9679-a862-02a2-57c8-8337e9a1eec8",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Switzerland"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "c741247a-3231-49f6-9a18-fb85047b7be6",
      "properties": {
        "identifier": {
          "permalink": "pento",
          "image_id": "ofagnyzshucb7qytm44i",
          "uuid": "c741247a-3231-49f6-9a18-fb85047b7be6",
          "entity_def_id": "organization",
          "value": "Pento"
        },
        "short_description": "Pento makes payroll painless, empowering HR & Finance teams by streamlining automation, calculation, payments, compliance & reporting.",
        "rank_org": 350,
        "location_identifiers": [
          {
            "permalink": "london-england",
            "uuid": "aad17950-576b-8c44-8fd4-f44dbeb59220",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "London"
          },
          {
            "permalink": "england-united-kingdom",
            "uuid": "79eb923b-9e93-e0db-2fe0-75f0c430c2cb",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "England"
          },
          {
            "permalink": "united-kingdom",
            "uuid": "a30e342c-1742-6b1c-66e9-461de680e54b",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "United Kingdom"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    },
    {
      "uuid": "bcc20f39-5ada-44dd-9c11-d747ecba8e0b",
      "properties": {
        "identifier": {
          "permalink": "tuum",
          "image_id": "kjor4v6hxgqin2l08whm",
          "uuid": "bcc20f39-5ada-44dd-9c11-d747ecba8e0b",
          "entity_def_id": "organization",
          "value": "Tuum"
        },
        "short_description": "Tuum is a cloud-native banking platform that allows any business to offer tailored financial services to their customers.",
        "rank_org": 388,
        "location_identifiers": [
          {
            "permalink": "tallinn-harjumaa",
            "uuid": "43fb1c88-17b1-8aa6-b9ac-42c0fea70f41",
            "location_type": "city",
            "entity_def_id": "location",
            "value": "Tallinn"
          },
          {
            "permalink": "harjumaa-estonia",
            "uuid": "0f48d843-cbea-eed1-3bb3-2a40f3b24bca",
            "location_type": "region",
            "entity_def_id": "location",
            "value": "Harjumaa"
          },
          {
            "permalink": "estonia",
            "uuid": "c0771ac6-45dc-7060-e8e5-4fad1098f695",
            "location_type": "country",
            "entity_def_id": "location",
            "value": "Estonia"
          },
          {
            "permalink": "europe",
            "uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e",
            "location_type": "continent",
            "entity_def_id": "location",
            "value": "Europe"
          }
        ]
      }
    }
  ]
}
```


# Pipfeed's Extract API Developer Documentation

Extract data from online news & articles. Get full metadata with content, images, authors, summary, category, keywords, topics, and more.

Developer Portal: <https://api.market/store/pipfeed/parse>

Replit : <https://replit.com/@hello737/Pipfeed-article-extract>

Github Repo : <https://github.com/imshashank/pipfeed-article-extract-demo>

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

Extract data from online news & articles. Get full metadata with content, images, authors, summary, category, keywords, topics, and more.

### **Use Cases of Pipfeed API**

#### Avoid months of development time building your custom URL extractor <a href="#avoid-months-of-development-time-building-your-custom-url-extractor" id="avoid-months-of-development-time-building-your-custom-url-extractor"></a>

We have spent months fine-tuning each small part of our article extract API so you don't have to. One API can help you achieve various use cases. These are some of the use-cases our customers Pipfeed's API help enable:

* **Add "Reader Mode" to your apps.**
* **Send "summarized" content to your readers.**
* **Use parsed data in training AI models.**
* **Allow readers to download the content and read it offline.**

### Endpoint <a href="#endpoint" id="endpoint"></a>

* **URL**: `https://prod.api.market/api/v1/pipfeed/parse/extract`
* **Method**: `POST`

#### **Headers:**

* `x-api-market-key`: Your unique API key.&#x20;

&#x20;**Note:** Do not share this key publicly.

* `Content-Type`: Must be set to `application/json`.

#### Authentication <a href="#authentication" id="authentication"></a>

To use the Pipfeed's Extract API, you must include your API key in the request header.

Header Name: `x-api-market-key` Value: `your-api-key`

If you just want to test then sign up for the "FREE" plan. This plan allows you to send 1000 API requests per month at no charge or credit card.

#### Request Payload <a href="#request-payload" id="request-payload"></a>

* `url` (required): The URL of the article you wish to extract data from.

{% code overflow="wrap" %}

```bash
{
  "url": "https://www.wsj.com/tech/the-underground-network-sneaking-nvidia-chips-into-china-f733aaa6?mod=hp_lead_pos3"
}
```

{% endcode %}

#### Response Data <a href="#response-data" id="response-data"></a>

The API will return the following data:

* **url**: The original URL of the article.
* **title**: The title of the article.
* **author**: The author's name.
* **html**: The article's HTML content.
* **text**: The plaintext version of the article.
* **length**: The number of characters in the text content.
* **description**: A brief description or sub-title of the article.
* **siteName**: The website or source name.
* **topImage**: The URL of the main image of the article.
* **date**: The published date of the article.
* **keywords**: Keywords related to the article.
* **summary**: An array of summarized points or sentences from the article.
* **sentiment**: A sentiment analysis of the article's content.

#### Sentiment Analysis <a href="#sentiment-analysis" id="sentiment-analysis"></a>

The sentiment analysis object contains:

* **score**: A numerical score representing the overall sentiment. Positive numbers indicate positive sentiment, and negative numbers indicate negative sentiment.
* **comparative**: A normalized score by length.
* **calculation**: An array of words and their corresponding sentiment scores.
* **positive**: An array of positive words found in the article.
* **negative**: An array of negative words found in the article.

### Curl and Response

#### Example Request <a href="#example-curl-request" id="example-curl-request"></a>

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/pipfeed/parse/extract' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://techcrunch.com/2022/04/18/web-scraping-legal-court/"
}'
```

{% endtab %}

{% tab title="NodeJS" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/pipfeed/parse/extract';

let options = {
  method: 'POST',
  headers: {'x-api-market-key': 'SOME_STRING_VALUE', 'content-type': 'application/json'},
  body: '{"url":"https://techcrunch.com/2022/04/18/web-scraping-legal-court/"}'
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

payload = "{\"url\":\"https://techcrunch.com/2022/04/18/web-scraping-legal-court/\"}"

headers = {
    'x-api-market-key': "SOME_STRING_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v1/pipfeed/parse/extract", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"url\":\"https://techcrunch.com/2022/04/18/web-scraping-legal-court/\"}");
Request request = new Request.Builder()
  .url("https://api.magicapi.dev/api/v1/pipfeed/parse/extract")
  .post(body)
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

#### Example Response <a href="#example-javascript-fetch-request" id="example-javascript-fetch-request"></a>

{% code overflow="wrap" %}

```json
{
  "url": "https://techcrunch.com/2022/04/18/web-scraping-legal-court/",
  "title": "Web scraping is legal, US appeals court reaffirms | TechCrunch",
  "author": "Zack Whittaker",
  "html": "<div class=\"page\" id=\"readability-page-1\"><div><p id=\"speakable-summary\">Good news for archivists, academics, researchers and journalists: Scraping publicly accessible data is legal, according to a U.S. appeals court ruling.</p>\n<p>The landmark ruling by the U.S. Ninth Circuit of Appeals is the latest in a long-running legal battle brought by LinkedIn aimed at stopping a rival company from web scraping personal information from users’ public profiles. The case <a href=\"https://techcrunch.com/2021/06/14/supreme-court-revives-linkedin-bid-to-protect-user-data-from-web-scrapers/\">reached the U.S. Supreme Court</a> last year but was sent back to the Ninth Circuit for the original appeals court to re-review the case.</p>\n\t\n\t\n\n\n<p>In its second ruling on Monday, the Ninth Circuit reaffirmed its original decision and found that scraping data that is publicly accessible on the internet is not a violation of <a href=\"https://techcrunch.com/2020/11/29/supreme-court-van-buren-hacking/\">the Computer Fraud and Abuse Act</a>, or CFAA, which governs what constitutes computer hacking under U.S. law.</p>\n<p>The Ninth Circuit’s decision is a major win for archivists, academics, researchers and journalists who use tools to mass collect, or scrape, information that is publicly accessible on the internet. Without a ruling in place, long-running projects to archive websites no longer online and using publicly accessible data for academic and research studies have been left in legal limbo.</p>\n\t\n\t\n\n\n<p>But there have been egregious cases of web scraping that have sparked privacy and security concerns. Facial recognition startup Clearview AI claims to have scraped billions of social media profile photos, prompting <a href=\"https://techcrunch.com/2021/04/21/data-brokers-bill-wyden-paul-privacy-clearview/\">several tech giants to file lawsuits</a> against the startup. Several companies, including <a href=\"https://techcrunch.com/2019/09/04/facebook-phone-numbers-exposed/\">Facebook</a>, Instagram, <a href=\"https://techcrunch.com/2021/01/11/scraped-parler-data-is-a-metadata-goldmine/\">Parler</a>, <a href=\"https://techcrunch.com/2019/06/16/millions-venmo-transactions-scraped/\">Venmo</a>&nbsp;and Clubhouse have all had users’ data scraped over the years.</p>\n<p>The case before the Ninth Circuit was originally brought by LinkedIn against Hiq Labs, a company that uses public data to analyze employee attrition. LinkedIn said Hiq’s mass web scraping of LinkedIn user profiles was against its terms of service, amounted to hacking and was therefore a violation of the CFAA. LinkedIn first lost <a href=\"https://techcrunch.com/2016/08/15/linkedin-sues-scrapers/\">the case against Hiq</a> in 2019 after the Ninth Circuit found that the CFAA does not bar anyone from scraping data that’s publicly accessible.</p>\n<p>On its second pass of the case, the Ninth Circuit said it relied on <a href=\"https://techcrunch.com/2021/06/03/supreme-court-hacking-cfaa-ruling/\">a Supreme Court decision</a> last June, during which the U.S. top court took its first look at the decades-old CFAA. In its ruling, the Supreme Court narrowed what constitutes a violation of the CFAA as those who gain unauthorized access to a computer system — rather than a broader interpretation of exceeding existing authorization, which the court argued could have attached criminal penalties to “a breathtaking amount of commonplace computer activity.” Using a “gate-up, gate-down” analogy, the Supreme Court said that when a computer or website’s gates are up — and therefore information is publicly accessible — no authorization is required.</p>\n\t\n\t\n\n\n\n<p>The Ninth Circuit, in referencing the Supreme Court’s “gate-up, gate-down” analogy, ruled that “the concept of ‘without authorization’ does not apply to public websites.”</p>\n\t\n\t\n\n\n<p>“We’re disappointed in the court’s decision. This is a preliminary ruling and the case is far from over,” said LinkedIn spokesperson Greg Snapper in a statement. “We will continue to fight to protect our members’ ability to control the information they make available on LinkedIn. When your data is taken without permission and used in ways you haven’t agreed to, that’s not okay. On LinkedIn, our members trust us with their information, which is why we prohibit unauthorized scraping on our platform.”</p>\n<blockquote data-secret=\"ILEgjf6kYo\"><p><a href=\"https://techcrunch.com/2021/06/03/supreme-court-hacking-cfaa-ruling/\">Supreme Court limits US hacking law in landmark CFAA ruling</a></p></blockquote>\n\n</div></div>",
  "text": "Good news for archivists, academics, researchers and journalists: Scraping publicly accessible data is legal, according to a U.S. appeals court ruling.\nThe landmark ruling by the U.S. Ninth Circuit of Appeals is the latest in a long-running legal battle brought by LinkedIn aimed at stopping a rival company from web scraping personal information from users’ public profiles. The case reached the U.S. Supreme Court last year but was sent back to the Ninth Circuit for the original appeals court to re-review the case.\n\t\n\t\n\n\nIn its second ruling on Monday, the Ninth Circuit reaffirmed its original decision and found that scraping data that is publicly accessible on the internet is not a violation of the Computer Fraud and Abuse Act, or CFAA, which governs what constitutes computer hacking under U.S. law.\nThe Ninth Circuit’s decision is a major win for archivists, academics, researchers and journalists who use tools to mass collect, or scrape, information that is publicly accessible on the internet. Without a ruling in place, long-running projects to archive websites no longer online and using publicly accessible data for academic and research studies have been left in legal limbo.\n\t\n\t\n\n\nBut there have been egregious cases of web scraping that have sparked privacy and security concerns. Facial recognition startup Clearview AI claims to have scraped billions of social media profile photos, prompting several tech giants to file lawsuits against the startup. Several companies, including Facebook, Instagram, Parler, Venmo and Clubhouse have all had users’ data scraped over the years.\nThe case before the Ninth Circuit was originally brought by LinkedIn against Hiq Labs, a company that uses public data to analyze employee attrition. LinkedIn said Hiq’s mass web scraping of LinkedIn user profiles was against its terms of service, amounted to hacking and was therefore a violation of the CFAA. LinkedIn first lost the case against Hiq in 2019 after the Ninth Circuit found that the CFAA does not bar anyone from scraping data that’s publicly accessible.\nOn its second pass of the case, the Ninth Circuit said it relied on a Supreme Court decision last June, during which the U.S. top court took its first look at the decades-old CFAA. In its ruling, the Supreme Court narrowed what constitutes a violation of the CFAA as those who gain unauthorized access to a computer system — rather than a broader interpretation of exceeding existing authorization, which the court argued could have attached criminal penalties to “a breathtaking amount of commonplace computer activity.” Using a “gate-up, gate-down” analogy, the Supreme Court said that when a computer or website’s gates are up — and therefore information is publicly accessible — no authorization is required.\n\t\n\t\n\n\n\nThe Ninth Circuit, in referencing the Supreme Court’s “gate-up, gate-down” analogy, ruled that “the concept of ‘without authorization’ does not apply to public websites.”\n\t\n\t\n\n\n“We’re disappointed in the court’s decision. This is a preliminary ruling and the case is far from over,” said LinkedIn spokesperson Greg Snapper in a statement. “We will continue to fight to protect our members’ ability to control the information they make available on LinkedIn. When your data is taken without permission and used in ways you haven’t agreed to, that’s not okay. On LinkedIn, our members trust us with their information, which is why we prohibit unauthorized scraping on our platform.”\nSupreme Court limits US hacking law in landmark CFAA ruling\n\n",
  "length": 3533,
  "description": "The landmark web scraping case was bounced back to the Ninth Circuit by the U.S. Supreme Court.",
  "siteName": "TechCrunch",
  "topImage": "https://techcrunch.com/wp-content/uploads/2022/04/GettyImages-1303427084-reworked.jpg",
  "date": "2022-04-18T19:16:57+00:00",
  "keywords": "",
  "summary": [
    "The landmark ruling by the U.S.",
    "The case reached the U.S.",
    "Supreme Court last year but was sent back to the Ninth Circuit for the original appeals court to re-review the case.",
    "But there have been egregious cases of web scraping that have sparked privacy and security concerns.",
    "Supreme Court limits US hacking law in landmark CFAA ruling"
  ],
  "sentiment": {
    "score": 31,
    "comparative": 0.05486725663716814,
    "calculation": [
      {
        "landmark": 2
      },
      {
        "limits": -1
      },
      {
        "supreme": 4
      },
      {
        "prohibit": -1
      },
      {
        "trust": 1
      },
      {
        "agreed": 1
      },
      {
        "ability": 2
      },
      {
        "protect": 1
      },
      {
        "fight": -1
      },
      {
        "disappointed": -2
      },
      {
        "supreme": 4
      },
      {
        "no": -1
      },
      {
        "accessible": 1
      },
      {
        "supreme": 4
      },
      {
        "breathtaking": 5
      },
      {
        "criminal": -3
      },
      {
        "gain": 2
      },
      {
        "violation": -2
      },
      {
        "supreme": 4
      },
      {
        "top": 2
      },
      {
        "supreme": 4
      },
      {
        "accessible": 1
      },
      {
        "lost": -3
      },
      {
        "violation": -2
      },
      {
        "lawsuits": -2
      },
      {
        "recognition": 2
      },
      {
        "legal": 1
      },
      {
        "accessible": 1
      },
      {
        "no": -1
      },
      {
        "accessible": 1
      },
      {
        "win": 4
      },
      {
        "abuse": -3
      },
      {
        "fraud": -4
      },
      {
        "violation": -2
      },
      {
        "accessible": 1
      },
      {
        "supreme": 4
      },
      {
        "reached": 1
      },
      {
        "stopping": -1
      },
      {
        "battle": -1
      },
      {
        "legal": 1
      },
      {
        "landmark": 2
      },
      {
        "legal": 1
      },
      {
        "accessible": 1
      },
      {
        "good": 3
      }
    ],
    "postive": [
      "landmark",
      "supreme",
      "trust",
      "agreed",
      "ability",
      "protect",
      "supreme",
      "accessible",
      "supreme",
      "breathtaking",
      "gain",
      "supreme",
      "top",
      "supreme",
      "accessible",
      "recognition",
      "legal",
      "accessible",
      "accessible",
      "win",
      "accessible",
      "supreme",
      "reached",
      "legal",
      "landmark",
      "legal",
      "accessible",
      "good"
    ],
    "negative": [
      "limits",
      "prohibit",
      "fight",
      "disappointed",
      "no",
      "criminal",
      "violation",
      "lost",
      "violation",
      "lawsuits",
      "no",
      "abuse",
      "fraud",
      "violation",
      "stopping",
      "battle"
    ]
  }
}
```

{% endcode %}

#### Considerations <a href="#considerations" id="considerations"></a>

* Always keep your API.market key confidential.
* Respect the terms of use for the websites you are extracting information from.
* Ensure you handle the data you obtain responsibly and ethically.

By utilizing this API, you can quickly gather rich data from articles and further analyze or display the extracted information as per your application's needs.

Try out this API for 1000 FREE calls here at <https://api.market/store/pipfeed/parse>


# Migrating from Capix FaceSwap API to magicapi/faceswap-capix API

This guide provides focused instructions to help you migrate your applications from the old Capix FaceSwap API to the new magicapi/faceswap-capix API by API.market.

> ### **You can try the new API here ->** [**https://api.market/store/magicapi/faceswap-capix**](https://api.market/store/magicapi/faceswap-capix)

**Why Migrate?**

The Capix FaceSwap API is scheduled for a platform-wide shutdown on **Wednesday, May 21st, 2025**. Our new `magicapi/faceswap-capix` API is an enhanced, in-house replacement designed for better performance and clarity.

### Summary of Key Differences

The primary changes you need to be aware of are:

1. **No `/upload/` Endpoint:** The new API requires you to provide public URLs for your `target_url` and `swap_url` directly. File uploads via a dedicated endpoint are no longer supported.
2. **New Base URL:** The base URL for the service has changed.
3. **New Endpoint Paths for Submitting Jobs:** The paths for initiating image and video faceswaps are new.
4. **Separate Result Endpoints:** Previously, you might have used a single `/result/` endpoint. Now, there are distinct endpoints for fetching image results (`/image/result/`) and video results (`/video/result/`).

Other aspects like authentication (using `x-api-market-key`) and the core parameters for `target_url` and `swap_url` remain conceptually similar, though the new API introduces an optional `target_face_index`.

### Step-by-Step Migration

#### 1. Update API Base URLs and Endpoint Paths

This is the most critical part of the migration.

* **Old Capix API Base URL (example):** `https://prod.api.market/api/v1/capix/faceswap`
* **New `magicapi/faceswap-capix` API Base URL:** `https://prod.api.market/api/v1/magicapi/faceswap-capix`

### **Endpoint Changes:**

* **Submitting Image FaceSwap:**
  * **Old:** `POST {OLD_BASE_URL}/faceswap/v1/image`
  * **New:** `POST {NEW_BASE_URL}/image/run`
    * *Key Change:* Base URL and path. Functionality is similar (takes `target_url`, `swap_url`).
* **Getting Image FaceSwap Result:**
  * **Old:** `POST {OLD_BASE_URL}/result/` (with `request_id` for an image job)
  * **New:** `POST {NEW_BASE_URL}/image/result/` (with `request_id`)
    * *Key Change:* Base URL and a dedicated path for image results.
* **Submitting Video FaceSwap:**
  * **Old:** `POST {OLD_BASE_URL}/faceswap/v1/video`
  * **New:** `POST {NEW_BASE_URL}/video/run`
    * *Key Change:* Base URL and path. Functionality is similar (takes `target_url`, `swap_url`). Response structure is the same as the new image run endpoint.
* **Getting Video FaceSwap Result:**
  * **Old:** `POST {OLD_BASE_URL}/result/` (with `request_id` for a video job)
  * **New:** `POST {NEW_BASE_URL}/video/result/` (with `request_id`)
    * *Key Change:* Base URL and a dedicated path for video results. Response structure is the same as the new image result endpoint.

#### 2. Adapt to the Absence of `/upload/` Endpoint

If you were using the `/upload/` endpoint in the old API, you must now ensure your image and video files are accessible via public URLs before calling the new `/image/run` or `/video/run` endpoints. The new API expects `target_url` and `swap_url` parameters to be direct public links.

**Alternative for Uploading:** If you require a way to upload your images to get a public URL, API.market provides a free, managed Image Upload API that you can use: <https://api.market/store/magicapi/image-upload>. This service can help you host your images and obtain the necessary public URLs for the `magicapi/faceswap-capix` API.

#### 3. Review Request Parameters

* The core parameters `target_url` and `swap_url` remain.
* The new API introduces an optional `target_face_index` (integer, default: 0) for both `/image/run` and `/video/run` if you need to specify which face to target in media with multiple faces.

#### 4. Understand Response Structures

The new API provides well-defined JSON responses. The `/run` endpoints immediately return a `request_id`. The `/result/` endpoints provide status and, upon completion, a `result_url`.

* **Important Note:** For video operations (`/video/run` and `/video/result/`), the main JSON response object key is `image_process_response`, the same as for image operations. Adapt your parsing logic accordingly.

If you have questions or need assistance with the migration, please contact API.market support.


# BridgeML

<https://api.market/store/bridgeml>


# Meta-Llama-3-8B-Instruct

Meta developed and released the Meta Llama 3 family of large language models (LLMs), a collection of pretrained and instruction tuned generative text models in 8 and 70B sizes.

**Developer Portal** : <https://api.market/store/bridgeml/meta-llama3-8b>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/llama.jpeg" alt=""><figcaption><p>Llama 3</p></figcaption></figure>

This cheap LLM API was developed by Meta and released the Meta Llama 3 family of large language models (LLMs), a collection of pre-trained and instruction-tuned generative text models in 8 and 70B sizes. The Llama 3 instruction-tuned models are optimized for dialogue use cases and outperform many of the available open-source chat models on common industry benchmarks.&#x20;

**Input:** Models input text only.

**Output:** Models generate text and code only.

**Model Architecture:** Llama 3 is an auto-regressive language model that uses an optimized transformer architecture. The tuned versions use supervised fine-tuning (SFT) and reinforcement learning with human feedback (RLHF) to align with human preferences for helpfulness and safety.

<table><thead><tr><th width="108">Params</th><th width="144">Context length</th><th width="124">Token count</th><th align="center">Knowledge cutoff</th></tr></thead><tbody><tr><td>8B</td><td>8K</td><td>15T+</td><td align="center">March, 2023</td></tr></tbody></table>

**Intended Use Cases** Llama 3 is intended for commercial and research use in English. Instruction-tuned models are intended for assistant-like chat, whereas pre-trained models can be adapted for a variety of natural language generation tasks. This is an easy-to-use LLM API and cheap LLM with cost of $0.18 per million tokens.&#x20;

**Carbon Footprint Pretraining utilized a cumulative** 7.7M GPU hours of computation on hardware of type H100-80GB (TDP of 700W). Estimated total emissions were 2290 tCO2eq, 100% of which were offset by Meta’s sustainability program.

<table><thead><tr><th width="178">Time (GPU hours)</th><th>Power Consumption (W)</th><th>Carbon Emitted(tCO2eq)</th></tr></thead><tbody><tr><td>1.3M</td><td>700</td><td>390</td></tr></tbody></table>

### Training Data

**Overview** Llama 3 was pre-trained on over 15 trillion tokens of data from publicly available sources. The fine-tuning data includes publicly available instruction datasets, as well as over 10M human-annotated examples. Neither the pretraining nor the fine-tuning datasets include Meta user data.

**Data Freshness** The pretraining data has a cutoff of March 2023 for the 8B and December 2023 for the 70B models respectively.

### Request and Response&#x20;

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/meta-llama3-8b/bridgeml/meta-llama3-8b' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "As a senior copywriter, write a long-form blog on why they should integrate LLM APIs from api.market into their existing offerings and how LLAMA LLM API can handle customer support, documentation and help reduce overall costs"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'

```

{% endcode %}

#### Response

{% code overflow="wrap" %}

```bash
{
  "id": "meta-llama/Meta-Llama-3-8B-Instruct-5da290c5-bec1-4631-b635-0bd35017c520",
  "object": "text_completion",
  "created": 1718707039,
  "model": "meta-llama/Meta-Llama-3-8B-Instruct",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "**Unlock the Power of Language Models: How LLM APIs Can Revolutionize Your Business**\n\nIn today's digital age, the importance of effective communication cannot be overstated. From customer support to documentation, language plays a crucial role in shaping the user experience. However, managing language-based interactions can be a daunting task, especially for businesses with limited resources. This is where Large Language Model (LLM) APIs come into play. In this blog, we'll explore the benefits of integrating LLM APIs from api.market into your existing offerings and how LLAMA LLM API can help you streamline customer support, documentation, and more.\n\n**What are LLM APIs?**\n\nLLM APIs are pre-trained language models that can be integrated into your applications to automate language-based tasks. These models are trained on vast amounts of text data and can understand the nuances of human language, allowing them to generate human-like responses to user inputs. LLM APIs are not only accurate but also scalable, which makes them an attractive solution for businesses looking to improve their language-based interactions.\n\n**Benefits of Integrate LLM APIs**\n\nIntegrating LLM APIs from api.market into your existing offerings can bring numerous benefits, including:\n\n1. **Improved Customer Support**: LLM APIs can help your customer support team",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "length",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 60,
    "completion_tokens": 256,
    "total_tokens": 316
  }
}

```

{% endcode %}

This is a cheap and easy to use LLM API which you can try out at <https://api.market/store/bridgeml/meta-llama3-8b>


# Meta-Llama-3-70B-Instruct

Meta developed and released the Meta Llama 3 family of large language models (LLMs), a collection of pretrained and instruction tuned generative text models in 8 and 70B sizes.

**Developer Portal :** [**https://api.market/store/bridgeml/meta-llama3-70b**](https://api.market/store/bridgeml/meta-llama3-70b)

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/llama.jpeg" alt=""><figcaption><p>LLama 3 - 70B</p></figcaption></figure>

This cheap LLM API was developed by Meta and released the Meta Llama 3 family of large language models (LLMs), a collection of pre-trained and instruction-tuned generative text models in 8 and 70B sizes. The Llama 3 instruction-tuned models are optimized for dialogue use cases and outperform many of the available open-source chat models on common industry benchmarks.&#x20;

**Input:** Models input text only.

**Output:** Models generate text and code only.

**Model Architecture:** Llama 3 is an auto-regressive language model that uses an optimized transformer architecture. The tuned versions use supervised fine-tuning (SFT) and reinforcement learning with human feedback (RLHF) to align with human preferences for helpfulness and safety.

<table><thead><tr><th width="108">Params</th><th width="144">Context length</th><th width="124">Token count</th><th align="center">Knowledge cutoff</th></tr></thead><tbody><tr><td>70B</td><td>8K</td><td>15T+</td><td align="center">December, 2023</td></tr></tbody></table>

**Intended Use Cases** Llama 3 is intended for commercial and research use in English. Instruction-tuned models are intended for assistant-like chat, whereas pre-trained models can be adapted for a variety of natural language generation tasks. This is an easy-to-use LLM API and cheap LLM with cost of $1.20 per million tokens.&#x20;

**Carbon Footprint Pretraining utilized a cumulative** 7.7M GPU hours of computation on hardware of type H100-80GB (TDP of 700W). Estimated total emissions were 2290 tCO2eq, 100% of which were offset by Meta’s sustainability program.

<table><thead><tr><th width="178">Time (GPU hours)</th><th>Power Consumption (W)</th><th>Carbon Emitted(tCO2eq)</th></tr></thead><tbody><tr><td>6.4M</td><td>700</td><td>1900</td></tr></tbody></table>

### Training Data

**Overview** Llama 3 was pre-trained on over 15 trillion tokens of data from publicly available sources. The fine-tuning data includes publicly available instruction datasets, as well as over 10M human-annotated examples. Neither the pretraining nor the fine-tuning datasets include Meta user data.

**Data Freshness** The pretraining data has a cutoff of March 2023 for the 8B and December 2023 for the 70B models respectively.

### Request and Response&#x20;

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/meta-llama3-70b/bridgeml/meta-llama3-70b' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "As a senior software engineer create a AWS python lambda that calls an API with the given curl request and returns a response, take the input from the function parameters called events, example curl request:\r\ncurl -X GET \\\r\n  '\''https://api.magicapi.dev/api/v1/magicapi/whois/whois/google.com'\'' \\\r\n  -H '\''accept: application/json'\'' \\\r\n  -H '\''x-magicapi-key: api-key"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'

```

{% endcode %}

#### Response

{% code overflow="wrap" %}

````bash
{
  "id": "meta-llama/Meta-Llama-3-70B-Instruct-afc4c52e-ebab-4e8a-bebf-108ecf511758",
  "object": "text_completion",
  "created": 1718783159,
  "model": "meta-llama/Meta-Llama-3-70B-Instruct",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "Here is an example of an AWS Python Lambda function that calls the API with the given curl request and returns a response:\n```\nimport boto3\nimport json\nimport requests\n\ndef lambda_handler(event, context):\n    # Extract the API key from the environment variables\n    api_key = 'YOUR_API_KEY_HERE'\n\n    # Extract the domain from the event\n    domain = event['domain']\n\n    # Construct the API URL\n    url = f'https://api.magicapi.dev/api/v1/magicapi/whois/whois/{domain}'\n\n    # Set the headers\n    headers = {\n        'accept': 'application/json',\n        'x-magicapi-key': api_key\n    }\n\n    # Make the GET request\n    response = requests.get(url, headers=headers)\n\n    # Check if the response was successful\n    if response.status_code == 200:\n        # Return the response as JSON\n        return {\n            'statusCode': 200,\n            'body': json.dumps(response.json())\n        }\n    else:\n        # Return an error message\n        return {\n            'statusCode': response.status_code,\n            'body': json.dumps({'error': 'API request failed'})\n        }\n```\nHere's an explanation of the code:\n\n*",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "length",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 105,
    "completion_tokens": 256,
    "total_tokens": 361
  }
}
````

{% endcode %}

You can try this cheap and easy to use LLM API out here at <https://api.market/store/bridgeml/meta-llama3-70b>


# Mistral-7B-Instruct-v0.1

The Mistral-7B-Instruct-v0.1 Large Language Model (LLM) is a instruct fine-tuned version of the Mistral-7B-v0.1 generative text model using a variety of publicly available conversation datasets.

**Developer Portal :** <https://api.market/store/bridgeml/mistralai7b>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/mistralai-Mistral-7B-Instruct-v0.1.png" alt=""><figcaption><p>Mistral-7B-Instruct-v0.1</p></figcaption></figure>

Model name to use in API calls:

```
mistralai/Mistral-7B-Instruct-v0.1
```

The Mistral-7B-Instruct-v0.1 Large Language Model (LLM) is a instruct fine-tuned version of the Mistral-7B-v0.1 generative text model using a variety of publicly available conversation datasets. This model supports function calling and JSON mode.

**Model Developers:** Mistral

**Input Models:** input text only.

**Output Models:** generate text only.

**Model Architecture:** `Mistral-7B-v0.1`, a transformer model, serves as the base for this instruction model, and it has the following architecture choices:

* Grouped-Query Attention
* Sliding-Window Attention
* Byte-fallback BPE tokenizer

**Context Length:** 16384

**License:** Apache 2.0

### Request and Response

**Request**

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/mistralai7b/bridgeml/mistralai7b' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Use voice of customer from an Amazon review to write an ad for a webcam."
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

**Response**

{% code overflow="wrap" %}

```bash
{
  "id": "mistralai/Mistral-7B-Instruct-v0.1-825ff876-d2eb-40ac-9012-5a3f1011db4e",
  "object": "text_completion",
  "created": 1718783411,
  "model": "mistralai/Mistral-7B-Instruct-v0.1",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "\n\r\nAre you looking for a reliable webcam that offers clear and crisp audio? Look no further! One of our satisfied customers had this to say:\n\n\"The only thing I've ever had problems with is lighting, but the USB-C port on the webcam allowed me to quickly connect to my computer and resolve this issue in seconds. Plus, the audio quality is top-notch. I highly recommend this webcam to anyone who wants a reliable and high-quality audio and video experience.\"\n\nDon't let low-quality audio and video hold you back! Get your hands on this Amazon-reviewed webcam today!",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 74,
    "completion_tokens": 136,
    "total_tokens": 210
  }
}
```

{% endcode %}

You can try out this cheap and easy to use LLM API here at <https://api.market/store/bridgeml/mistralai7b>


# Mixtral-8x22B-Instruct-v0.1

The Mixtral-8x22B-Instruct-v0.1 Large Language Model (LLM) is an instruct fine-tuned version of the Mixtral-8x22B-v0.1.

**Developer Portal :** <https://api.market/store/bridgeml/mistralai8x22>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/Mixtral-8x22B-Instruct-v0.1.png" alt=""><figcaption><p>Mixtral-8x22B-Instruct-v0.1</p></figcaption></figure>

Model name to use in API calls:

```
mistralai/Mixtral-8x22B-Instruct-v0.1
```

The Mixtral-8x22B Large Language Model (LLM) is a pretrained generative Sparse Mixture of Experts. This model natively supports function calling, which allows you to call functions directly from the model's output.

The Mixtral-8x22B-Instruct-v0.1 is an advanced machine learning model designed for specific instructional tasks, offering a nuanced understanding of text inputs to generate precise and contextually relevant outputs. Its architecture incorporates multiple layers of transformers, optimizing it for parsing complex instructions and delivering high-quality, actionable responses.&#x20;

Additionally, Mixtral-8x22B-Instruct-v0.1 features enhanced adaptability, allowing it to fine-tune responses based on user feedback, which improves performance over time without the need for extensive retraining.

**Model Developers:** Mistral

**Input Models:** input text only.

**Output Models:** generate text only.

**Context Length:** 65536

**License:** Apache 2.0

### Request and Response

**Request**

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/mistralai8x22/bridgeml/mistralai8x22' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Use voice of customer from a G2 review to write an ad for GitLab."
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

**Response**

{% code overflow="wrap" %}

```bash
{
  "id": "mistralai/Mixtral-8x22B-Instruct-v0.1-98b993cd-91c5-4660-825a-cd0dabd0eb79",
  "object": "text_completion",
  "created": 1718783618,
  "model": "mistralai/Mixtral-8x22B-Instruct-v0.1",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "🌟 Discover GitLab, Your Ultimate DevOps Solution! 🌟\n\nCan't stand slow and disorganized development cycles? You're not alone! Thousands of businesses like yours are turning to GitLab for a faster, smoother, and more unified DevOps experience!\n\n\"GitLab simplifies and streamlines our software development process, helps us to keep an eye on code quality and security, and fuels our continuous integration efforts. The tools it provides make it an essential part of our engineering pipeline.\" —G2 review by an IT manager.\n\n🧱 Why settle for just a source code management tool when you can have an all-in-one platform that covers the entire software development lifecycle?\n\n🏃‍♂️ Explore these fantastic features that have helped our users accelerate innovation:\n\n✅ Reliable version control\n✅ Scalable CI/CD\n✅ Built-in code quality and security\n✅ On-premises or SaaS offerings for flexibility\n✅ Robust collaboration features for teams\n\n🔒 Still unsure? Here's our promise to you:\n\n",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "length",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 71,
    "completion_tokens": 256,
    "total_tokens": 327
  }
}
```

{% endcode %}

You can try out this cheap and easy to use LLM API here at <https://api.market/store/bridgeml/mistralai8x22>


# Meta-Llama-2-7b

Meta-llama7b: A cutting-edge AI-driven virtual assistant designed to streamline tasks, enhance productivity, and adapt seamlessly to user needs.

## **Llama 2**

**Developer Portal :** <https://api.market/store/bridgeml/meta-llama7b>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/nuneybits_vector_art_of_a_llama_programming_8c825672-172b-4e69-a6f1-b7c9e8bf5294.webp" alt=""><figcaption></figcaption></figure>

Llama 2 is a pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. This is the repository for the 7B pretrained model, converted for the Hugging Face Transformers format. Links to other models can be found in the index at the bottom.

### Model Details

*Note: Use of this model is governed by the Meta license. In order to download the model weights and tokenizer, please visit the* [*website*](https://ai.meta.com/resources/models-and-libraries/llama-downloads/) *and accept our License before requesting access here.*

Meta developed and publicly released the Llama 2 family of large language models (LLMs), a collection of pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. Our fine-tuned LLMs, called Llama-2-Chat, are optimized for dialogue use cases. Llama-2-Chat models outperform open-source chat models on most benchmarks we tested, and in our human evaluations for helpfulness and safety, are on par with some popular closed-source models like ChatGPT and PaLM.

**Model Developers** Meta

**Variations** Llama 2 comes in a range of parameter sizes — 7B, 13B, and 70B — as well as pretrained and fine-tuned variations.

**Input** Models input text only.

**Output** Models generate text only.

**Model Architecture** Llama 2 is an auto-regressive language model that uses an optimized transformer architecture. The tuned versions use supervised fine-tuning (SFT) and reinforcement learning with human feedback (RLHF) to align to human preferences for helpfulness and safety.

|         | Training Data                                 | Params | Content Length | GQA | Tokens | LR         |
| ------- | --------------------------------------------- | ------ | -------------- | --- | ------ | ---------- |
| Llama 2 | *A new mix of publicly available online data* | 7B     | 4k             | ✗   | 2.0T   | 3.0 x 10-4 |
| Llama 2 | *A new mix of publicly available online data* | 13B    | 4k             | ✗   | 2.0T   | 3.0 x 10-4 |
| Llama 2 | *A new mix of publicly available online data* | 70B    | 4k             | ✔   | 2.0T   | 1.5 x 10-4 |

*Llama 2 family of models.* Token counts refer to pretraining data only. All models are trained with a global batch-size of 4M tokens. Bigger models - 70B -- use Grouped-Query Attention (GQA) for improved inference scalability.

**Model Dates** Llama 2 was trained between January 2023 and July 2023.

**Status** This is a static model trained on an offline dataset. Future versions of the tuned models will be released as we improve model safety with community feedback.

**License** A custom commercial license is available at: <https://ai.meta.com/resources/models-and-libraries/llama-downloads/>

**Research Paper** "Llama-2: Open Foundation and Fine-tuned Chat Models"

### Intended Use

**Intended Use Cases** Llama 2 is intended for commercial and research use in English. Tuned models are intended for assistant-like chat, whereas pretrained models can be adapted for a variety of natural language generation tasks.

To get the expected features and performance for the chat versions, a specific formatting needs to be followed, including the `INST` and `<<SYS>>` tags, `BOS` and `EOS` tokens, and the whitespaces and breaklines in between (we recommend calling `strip()` on inputs to avoid double-spaces). See our reference code in github for details: [`chat_completion`](https://github.com/facebookresearch/llama/blob/main/llama/generation.py#L212).

**Out-of-scope Uses** Use in any manner that violates applicable laws or regulations (including trade compliance laws).Use in languages other than English. Use in any other way that is prohibited by the Acceptable Use Policy and Licensing Agreement for Llama 2.

### Hardware and Software

**Training Factors** We used custom training libraries, Meta's Research Super Cluster, and production clusters for pretraining. Fine-tuning, annotation, and evaluation were also performed on third-party cloud compute.

**Carbon Footprint** Pretraining utilized a cumulative 3.3M GPU hours of computation on hardware of type A100-80GB (TDP of 350-400W). Estimated total emissions were 539 tCO2eq, 100% of which were offset by Meta’s sustainability program.

|             | Time (GPU hours) | Power Consumption (W) | Carbon Emitted(tCO2eq) |
| ----------- | ---------------- | --------------------- | ---------------------- |
| Llama 2 7B  | 184320           | 400                   | 31.22                  |
| Llama 2 13B | 368640           | 400                   | 62.44                  |
| Llama 2 70B | 1720320          | 400                   | 291.42                 |
| Total       | 3311616          |                       | 539.00                 |

**CO2 emissions during pretraining.** Time: total GPU time required for training each model. Power Consumption: peak power capacity per GPU device for the GPUs used adjusted for power usage efficiency. 100% of the emissions are directly offset by Meta's sustainability program, and because we are openly releasing these models, the pretraining costs do not need to be incurred by others.

### Training Data

**Overview** Llama 2 was pretrained on 2 trillion tokens of data from publicly available sources. The fine-tuning data includes publicly available instruction datasets, as well as over one million new human-annotated examples. Neither the pretraining nor the fine-tuning datasets include Meta user data.

**Data Freshness** The pretraining data has a cutoff of September 2022, but some tuning data is more recent, up to July 2023.

### Evaluation Results

In this section, we report the results for the Llama 1 and Llama 2 models on standard academic benchmarks.For all the evaluations, we use our internal evaluations library.

| Model   | Size | Code     | Commonsense Reasoning | World Knowledge | Reading Comprehension | Math     | MMLU     | BBH      | AGI Eval |
| ------- | ---- | -------- | --------------------- | --------------- | --------------------- | -------- | -------- | -------- | -------- |
| Llama 1 | 7B   | 14.1     | 60.8                  | 46.2            | 58.5                  | 6.95     | 35.1     | 30.3     | 23.9     |
| Llama 1 | 13B  | 18.9     | 66.1                  | 52.6            | 62.3                  | 10.9     | 46.9     | 37.0     | 33.9     |
| Llama 1 | 33B  | 26.0     | 70.0                  | 58.4            | 67.6                  | 21.4     | 57.8     | 39.8     | 41.7     |
| Llama 1 | 65B  | 30.7     | 70.7                  | 60.5            | 68.6                  | 30.8     | 63.4     | 43.5     | 47.6     |
| Llama 2 | 7B   | 16.8     | 63.9                  | 48.9            | 61.3                  | 14.6     | 45.3     | 32.6     | 29.3     |
| Llama 2 | 13B  | 24.5     | 66.9                  | 55.4            | 65.8                  | 28.7     | 54.8     | 39.4     | 39.1     |
| Llama 2 | 70B  | **37.5** | **71.9**              | **63.6**        | **69.4**              | **35.2** | **68.9** | **51.2** | **54.2** |

**Overall performance on grouped academic benchmarks.** *Code:* We report the average pass\@1 scores of our models on HumanEval and MBPP. *Commonsense Reasoning:* We report the average of PIQA, SIQA, HellaSwag, WinoGrande, ARC easy and challenge, OpenBookQA, and CommonsenseQA. We report 7-shot results for CommonSenseQA and 0-shot results for all other benchmarks. *World Knowledge:* We evaluate the 5-shot performance on NaturalQuestions and TriviaQA and report the average. *Reading Comprehension:* For reading comprehension, we report the 0-shot average on SQuAD, QuAC, and BoolQ. *MATH:* We report the average of the GSM8K (8 shot) and MATH (4 shot) benchmarks at top 1.

|         |     | TruthfulQA | Toxigen   |
| ------- | --- | ---------- | --------- |
| Llama 1 | 7B  | 27.42      | 23.00     |
| Llama 1 | 13B | 41.74      | 23.08     |
| Llama 1 | 33B | 44.19      | 22.57     |
| Llama 1 | 65B | 48.71      | 21.77     |
| Llama 2 | 7B  | 33.29      | **21.25** |
| Llama 2 | 13B | 41.86      | 26.10     |
| Llama 2 | 70B | **50.18**  | 24.60     |

**Evaluation of pretrained LLMs on automatic safety benchmarks.** For TruthfulQA, we present the percentage of generations that are both truthful and informative (the higher the better). For ToxiGen, we present the percentage of toxic generations (the smaller the better).

|              |     | TruthfulQA | Toxigen  |
| ------------ | --- | ---------- | -------- |
| Llama-2-Chat | 7B  | 57.04      | **0.00** |
| Llama-2-Chat | 13B | 62.18      | **0.00** |
| Llama-2-Chat | 70B | **64.14**  | 0.01     |

**Evaluation of fine-tuned LLMs on different safety datasets.** Same metric definitions as above.

### Ethical Considerations and Limitations

Llama 2 is a new technology that carries risks with use. Testing conducted to date has been in English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Llama 2’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Llama 2, developers should perform safety testing and tuning tailored to their specific applications of the model.

Please see the Responsible Use Guide available at [https://ai.meta.com/llama/responsible-use-guide/](https://ai.meta.com/llama/responsible-use-guide)

### Reporting Issues

Please report any software “bug,” or other problems with the models through one of the following means:

* Reporting issues with the model: [github.com/facebookresearch/llama](http://github.com/facebookresearch/llama)
* Reporting problematic content generated by the model: [developers.facebook.com/llama\_output\_feedback](http://developers.facebook.com/llama_output_feedback)
* Reporting bugs and security concerns: [facebook.com/whitehat/info](http://facebook.com/whitehat/info)

### Llama Model Index

| Model | Llama2                                                | Llama2-hf                                                | Llama2-chat                                                | Llama2-chat-hf                                                |
| ----- | ----------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------- |
| 7B    | [Link](https://huggingface.co/meta-llama/Llama-2-7b)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-hf)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-chat)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)  |
| 13B   | [Link](https://huggingface.co/meta-llama/Llama-2-13b) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-hf) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-chat) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-chat-hf) |
| 70B   | [Link](https://huggingface.co/meta-llama/Llama-2-70b) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-hf) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-chat) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-chat-hf) |

### Request and Response&#x20;

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/meta-llama7b/bridgeml/meta-llama7b' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Use voice of customer from a G2 review to write an ad for GitLab."
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response

{% code overflow="wrap" %}

```bash
{
  "id": "meta-llama/Llama-2-7b-chat-hf-9a9334d3-59cf-449f-9a40-3a6bde54966a",
  "object": "text_completion",
  "created": 1718902534,
  "model": "meta-llama/Llama-2-7b-chat-hf",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "**Transform Your Workflow with GitLab**\n\nAs a developer, you know the importance of collaboration and efficiency in your workflow. That's why I was thrilled to discover GitLab! With its all-in-one platform, my team can seamlessly manage our projects from start to finish.\n\n**Streamlined Development**\n\nGitLab's intuitive interface allows us to track changes, review code, and merge requests with ease. No more digging through code history or searching for lost comments. The built-in issue tracker helps us prioritize and organize our work, keeping everyone on the same page.\n\n**Powerful CI/CD Pipelines**\n\nAutomate your testing and deployment with GitLab CI/CD. We've set up pipelines that trigger on merge requests, automatically testing and deploying our code. No more manual uploads or monitoring. It's a game-changer for our release cycle.\n\n**Scalable and Secure**\n\nGitLab's cloud hosting offers unparalleled scalability, with auto-scaling and load balancing to ensure our applications are always available. Plus, its built-in security features, such as built-in CI/CD scanning and compliance with industry standards, give us peace of mind.\n\n**Improved Collaboration**\n\nThe GitLab platform allows our team to work together effectively, regardless of location or time zone. Real-time commenting and @",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "length",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 33,
    "completion_tokens": 256,
    "total_tokens": 289
  }
}
```

{% endcode %}

You can use this easy to use and cheap LLM API here at <https://api.market/store/bridgeml/meta-llama7b>


# Meta-Llama-2-13b

Meta-lama13b: Your AI-powered personal assistant, simplifying tasks and boosting productivity with cutting-edge technology.

**Developer Portal :** <https://api.market/store/bridgeml/meta-llama13b>

## **Llama 2**

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/nuneybits_vector_art_of_a_llama_programming_8c825672-172b-4e69-a6f1-b7c9e8bf5294.webp" alt=""><figcaption></figcaption></figure>

Llama 2 is a pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. This is the repository for the 13B pretrained model, converted for the Hugging Face Transformers format. Links to other models can be found in the index at the bottom.

### Model Details

*Note: Use of this model is governed by the Meta license. In order to download the model weights and tokenizer, please visit the* [*website*](https://ai.meta.com/resources/models-and-libraries/llama-downloads/) *and accept our License before requesting access here.*

Meta developed and publicly released the Llama 2 family of large language models (LLMs), a collection of pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. Our fine-tuned LLMs, called Llama-2-Chat, are optimized for dialogue use cases. Llama-2-Chat models outperform open-source chat models on most benchmarks we tested, and in our human evaluations for helpfulness and safety, are on par with some popular closed-source models like ChatGPT and PaLM.

**Model Developers** Meta

**Variations** Llama 2 comes in a range of parameter sizes — 7B, 13B, and 70B — as well as pretrained and fine-tuned variations.

**Input** Models input text only.

**Output** Models generate text only.

**Model Architecture** Llama 2 is an auto-regressive language model that uses an optimized transformer architecture. The tuned versions use supervised fine-tuning (SFT) and reinforcement learning with human feedback (RLHF) to align to human preferences for helpfulness and safety.

|         | Training Data                                 | Params | Content Length | GQA | Tokens | LR         |
| ------- | --------------------------------------------- | ------ | -------------- | --- | ------ | ---------- |
| Llama 2 | *A new mix of publicly available online data* | 7B     | 4k             | ✗   | 2.0T   | 3.0 x 10-4 |
| Llama 2 | *A new mix of publicly available online data* | 13B    | 4k             | ✗   | 2.0T   | 3.0 x 10-4 |
| Llama 2 | *A new mix of publicly available online data* | 70B    | 4k             | ✔   | 2.0T   | 1.5 x 10-4 |

*Llama 2 family of models.* Token counts refer to pretraining data only. All models are trained with a global batch-size of 4M tokens. Bigger models - 70B -- use Grouped-Query Attention (GQA) for improved inference scalability.

**Model Dates** Llama 2 was trained between January 2023 and July 2023.

**Status** This is a static model trained on an offline dataset. Future versions of the tuned models will be released as we improve model safety with community feedback.

**License** A custom commercial license is available at: <https://ai.meta.com/resources/models-and-libraries/llama-downloads/>

**Research Paper** "Llama-2: Open Foundation and Fine-tuned Chat Models"

### Intended Use

**Intended Use Cases** Llama 2 is intended for commercial and research use in English. Tuned models are intended for assistant-like chat, whereas pretrained models can be adapted for a variety of natural language generation tasks.

To get the expected features and performance for the chat versions, a specific formatting needs to be followed, including the `INST` and `<<SYS>>` tags, `BOS` and `EOS` tokens, and the whitespaces and breaklines in between (we recommend calling `strip()` on inputs to avoid double-spaces). See our reference code in github for details: [`chat_completion`](https://github.com/facebookresearch/llama/blob/main/llama/generation.py#L212).

**Out-of-scope Uses** Use in any manner that violates applicable laws or regulations (including trade compliance laws).Use in languages other than English. Use in any other way that is prohibited by the Acceptable Use Policy and Licensing Agreement for Llama 2.

### Hardware and Software

**Training Factors** We used custom training libraries, Meta's Research Super Cluster, and production clusters for pretraining. Fine-tuning, annotation, and evaluation were also performed on third-party cloud compute.

**Carbon Footprint** Pretraining utilized a cumulative 3.3M GPU hours of computation on hardware of type A100-80GB (TDP of 350-400W). Estimated total emissions were 539 tCO2eq, 100% of which were offset by Meta’s sustainability program.

|             | Time (GPU hours) | Power Consumption (W) | Carbon Emitted(tCO2eq) |
| ----------- | ---------------- | --------------------- | ---------------------- |
| Llama 2 7B  | 184320           | 400                   | 31.22                  |
| Llama 2 13B | 368640           | 400                   | 62.44                  |
| Llama 2 70B | 1720320          | 400                   | 291.42                 |
| Total       | 3311616          |                       | 539.00                 |

**CO2 emissions during pretraining.** Time: total GPU time required for training each model. Power Consumption: peak power capacity per GPU device for the GPUs used adjusted for power usage efficiency. 100% of the emissions are directly offset by Meta's sustainability program, and because we are openly releasing these models, the pretraining costs do not need to be incurred by others.

### Training Data

**Overview** Llama 2 was pretrained on 2 trillion tokens of data from publicly available sources. The fine-tuning data includes publicly available instruction datasets, as well as over one million new human-annotated examples. Neither the pretraining nor the fine-tuning datasets include Meta user data.

**Data Freshness** The pretraining data has a cutoff of September 2022, but some tuning data is more recent, up to July 2023.

### Evaluation Results

In this section, we report the results for the Llama 1 and Llama 2 models on standard academic benchmarks.For all the evaluations, we use our internal evaluations library.

| Model   | Size | Code     | Commonsense Reasoning | World Knowledge | Reading Comprehension | Math     | MMLU     | BBH      | AGI Eval |
| ------- | ---- | -------- | --------------------- | --------------- | --------------------- | -------- | -------- | -------- | -------- |
| Llama 1 | 7B   | 14.1     | 60.8                  | 46.2            | 58.5                  | 6.95     | 35.1     | 30.3     | 23.9     |
| Llama 1 | 13B  | 18.9     | 66.1                  | 52.6            | 62.3                  | 10.9     | 46.9     | 37.0     | 33.9     |
| Llama 1 | 33B  | 26.0     | 70.0                  | 58.4            | 67.6                  | 21.4     | 57.8     | 39.8     | 41.7     |
| Llama 1 | 65B  | 30.7     | 70.7                  | 60.5            | 68.6                  | 30.8     | 63.4     | 43.5     | 47.6     |
| Llama 2 | 7B   | 16.8     | 63.9                  | 48.9            | 61.3                  | 14.6     | 45.3     | 32.6     | 29.3     |
| Llama 2 | 13B  | 24.5     | 66.9                  | 55.4            | 65.8                  | 28.7     | 54.8     | 39.4     | 39.1     |
| Llama 2 | 70B  | **37.5** | **71.9**              | **63.6**        | **69.4**              | **35.2** | **68.9** | **51.2** | **54.2** |

**Overall performance on grouped academic benchmarks.** *Code:* We report the average pass\@1 scores of our models on HumanEval and MBPP. *Commonsense Reasoning:* We report the average of PIQA, SIQA, HellaSwag, WinoGrande, ARC easy and challenge, OpenBookQA, and CommonsenseQA. We report 7-shot results for CommonSenseQA and 0-shot results for all other benchmarks. *World Knowledge:* We evaluate the 5-shot performance on NaturalQuestions and TriviaQA and report the average. *Reading Comprehension:* For reading comprehension, we report the 0-shot average on SQuAD, QuAC, and BoolQ. *MATH:* We report the average of the GSM8K (8 shot) and MATH (4 shot) benchmarks at top 1.

|         |     | TruthfulQA | Toxigen   |
| ------- | --- | ---------- | --------- |
| Llama 1 | 7B  | 27.42      | 23.00     |
| Llama 1 | 13B | 41.74      | 23.08     |
| Llama 1 | 33B | 44.19      | 22.57     |
| Llama 1 | 65B | 48.71      | 21.77     |
| Llama 2 | 7B  | 33.29      | **21.25** |
| Llama 2 | 13B | 41.86      | 26.10     |
| Llama 2 | 70B | **50.18**  | 24.60     |

**Evaluation of pretrained LLMs on automatic safety benchmarks.** For TruthfulQA, we present the percentage of generations that are both truthful and informative (the higher the better). For ToxiGen, we present the percentage of toxic generations (the smaller the better).

|              |     | TruthfulQA | Toxigen  |
| ------------ | --- | ---------- | -------- |
| Llama-2-Chat | 7B  | 57.04      | **0.00** |
| Llama-2-Chat | 13B | 62.18      | **0.00** |
| Llama-2-Chat | 70B | **64.14**  | 0.01     |

**Evaluation of fine-tuned LLMs on different safety datasets.** Same metric definitions as above.

### Ethical Considerations and Limitations

Llama 2 is a new technology that carries risks with use. Testing conducted to date has been in English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Llama 2’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Llama 2, developers should perform safety testing and tuning tailored to their specific applications of the model.

Please see the Responsible Use Guide available at [https://ai.meta.com/llama/responsible-use-guide/](https://ai.meta.com/llama/responsible-use-guide)

### Reporting Issues

Please report any software “bug,” or other problems with the models through one of the following means:

* Reporting issues with the model: [github.com/facebookresearch/llama](http://github.com/facebookresearch/llama)
* Reporting problematic content generated by the model: [developers.facebook.com/llama\_output\_feedback](http://developers.facebook.com/llama_output_feedback)
* Reporting bugs and security concerns: [facebook.com/whitehat/info](http://facebook.com/whitehat/info)

### Llama Model Index

| Model | Llama2                                                | Llama2-hf                                                | Llama2-chat                                                | Llama2-chat-hf                                                |
| ----- | ----------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------- |
| 7B    | [Link](https://huggingface.co/meta-llama/Llama-2-7b)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-hf)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-chat)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)  |
| 13B   | [Link](https://huggingface.co/meta-llama/Llama-2-13b) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-hf) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-chat) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-chat-hf) |
| 70B   | [Link](https://huggingface.co/meta-llama/Llama-2-70b) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-hf) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-chat) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-chat-hf) |

### Request and Response&#x20;

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/meta-llama13b/bridgeml/meta-llama13b' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Hello how are you doing?"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response&#x20;

{% code overflow="wrap" %}

```json
{
  "id": "meta-llama/Llama-2-13b-chat-hf-da9d7520-0143-459e-bdc6-299e3d6cf27d",
  "object": "text_completion",
  "created": 1718903151,
  "model": "meta-llama/Llama-2-13b-chat-hf",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "I'm just an AI, so I don't have emotions or feelings like humans do, but I'm always happy to chat with you! Is there something specific you'd like to talk about or ask? I'm here to help with any questions or topics you'd like to discuss.",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 22,
    "completion_tokens": 58,
    "total_tokens": 80
  }
}
```

{% endcode %}

You can try out this easy to use and cheap LLM API here at <https://api.market/store/bridgeml/meta-llama13b>


# Meta-Llama-2-70b

Meta-llama70b: Your versatile AI companion, revolutionizing productivity and simplifying daily tasks with intuitive assistance.

**Developer Portal :** <https://api.market/store/bridgeml/meta-llama70b>

## **Llama 2**

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/nuneybits_vector_art_of_a_llama_programming_8c825672-172b-4e69-a6f1-b7c9e8bf5294.webp" alt=""><figcaption></figcaption></figure>

Llama 2 is a pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. This is the repository for the 70B pretrained model, converted for the Hugging Face Transformers format. Links to other models can be found in the index at the bottom.

### Model Details

*Note: Use of this model is governed by the Meta license. In order to download the model weights and tokenizer, please visit the* [*website*](https://ai.meta.com/resources/models-and-libraries/llama-downloads/) *and accept our License before requesting access here.*

Meta developed and publicly released the Llama 2 family of large language models (LLMs), a collection of pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. Our fine-tuned LLMs, called Llama-2-Chat, are optimized for dialogue use cases. Llama-2-Chat models outperform open-source chat models on most benchmarks we tested, and in our human evaluations for helpfulness and safety, are on par with some popular closed-source models like ChatGPT and PaLM.

**Model Developers** Meta

**Variations** Llama 2 comes in a range of parameter sizes — 7B, 13B, and 70B — as well as pretrained and fine-tuned variations.

**Input** Models input text only.

**Output** Models generate text only.

**Model Architecture** Llama 2 is an auto-regressive language model that uses an optimized transformer architecture. The tuned versions use supervised fine-tuning (SFT) and reinforcement learning with human feedback (RLHF) to align to human preferences for helpfulness and safety.

|         | Training Data                                 | Params | Content Length | GQA | Tokens | LR         |
| ------- | --------------------------------------------- | ------ | -------------- | --- | ------ | ---------- |
| Llama 2 | *A new mix of publicly available online data* | 7B     | 4k             | ✗   | 2.0T   | 3.0 x 10-4 |
| Llama 2 | *A new mix of publicly available online data* | 13B    | 4k             | ✗   | 2.0T   | 3.0 x 10-4 |
| Llama 2 | *A new mix of publicly available online data* | 70B    | 4k             | ✔   | 2.0T   | 1.5 x 10-4 |

*Llama 2 family of models.* Token counts refer to pretraining data only. All models are trained with a global batch-size of 4M tokens. Bigger models - 70B -- use Grouped-Query Attention (GQA) for improved inference scalability.

**Model Dates** Llama 2 was trained between January 2023 and July 2023.

**Status** This is a static model trained on an offline dataset. Future versions of the tuned models will be released as we improve model safety with community feedback.

**License** A custom commercial license is available at: <https://ai.meta.com/resources/models-and-libraries/llama-downloads/>

**Research Paper** "Llama-2: Open Foundation and Fine-tuned Chat Models"

### Intended Use

**Intended Use Cases** Llama 2 is intended for commercial and research use in English. Tuned models are intended for assistant-like chat, whereas pretrained models can be adapted for a variety of natural language generation tasks.

To get the expected features and performance for the chat versions, a specific formatting needs to be followed, including the `INST` and `<<SYS>>` tags, `BOS` and `EOS` tokens, and the whitespaces and breaklines in between (we recommend calling `strip()` on inputs to avoid double-spaces). See our reference code in github for details: [`chat_completion`](https://github.com/facebookresearch/llama/blob/main/llama/generation.py#L212).

**Out-of-scope Uses** Use in any manner that violates applicable laws or regulations (including trade compliance laws).Use in languages other than English. Use in any other way that is prohibited by the Acceptable Use Policy and Licensing Agreement for Llama 2.

### Hardware and Software

**Training Factors** We used custom training libraries, Meta's Research Super Cluster, and production clusters for pretraining. Fine-tuning, annotation, and evaluation were also performed on third-party cloud compute.

**Carbon Footprint** Pretraining utilized a cumulative 3.3M GPU hours of computation on hardware of type A100-80GB (TDP of 350-400W). Estimated total emissions were 539 tCO2eq, 100% of which were offset by Meta’s sustainability program.

|             | Time (GPU hours) | Power Consumption (W) | Carbon Emitted(tCO2eq) |
| ----------- | ---------------- | --------------------- | ---------------------- |
| Llama 2 7B  | 184320           | 400                   | 31.22                  |
| Llama 2 13B | 368640           | 400                   | 62.44                  |
| Llama 2 70B | 1720320          | 400                   | 291.42                 |
| Total       | 3311616          |                       | 539.00                 |

**CO2 emissions during pretraining.** Time: total GPU time required for training each model. Power Consumption: peak power capacity per GPU device for the GPUs used adjusted for power usage efficiency. 100% of the emissions are directly offset by Meta's sustainability program, and because we are openly releasing these models, the pretraining costs do not need to be incurred by others.

### Training Data

**Overview** Llama 2 was pretrained on 2 trillion tokens of data from publicly available sources. The fine-tuning data includes publicly available instruction datasets, as well as over one million new human-annotated examples. Neither the pretraining nor the fine-tuning datasets include Meta user data.

**Data Freshness** The pretraining data has a cutoff of September 2022, but some tuning data is more recent, up to July 2023.

### Evaluation Results

In this section, we report the results for the Llama 1 and Llama 2 models on standard academic benchmarks.For all the evaluations, we use our internal evaluations library.

| Model   | Size | Code     | Commonsense Reasoning | World Knowledge | Reading Comprehension | Math     | MMLU     | BBH      | AGI Eval |
| ------- | ---- | -------- | --------------------- | --------------- | --------------------- | -------- | -------- | -------- | -------- |
| Llama 1 | 7B   | 14.1     | 60.8                  | 46.2            | 58.5                  | 6.95     | 35.1     | 30.3     | 23.9     |
| Llama 1 | 13B  | 18.9     | 66.1                  | 52.6            | 62.3                  | 10.9     | 46.9     | 37.0     | 33.9     |
| Llama 1 | 33B  | 26.0     | 70.0                  | 58.4            | 67.6                  | 21.4     | 57.8     | 39.8     | 41.7     |
| Llama 1 | 65B  | 30.7     | 70.7                  | 60.5            | 68.6                  | 30.8     | 63.4     | 43.5     | 47.6     |
| Llama 2 | 7B   | 16.8     | 63.9                  | 48.9            | 61.3                  | 14.6     | 45.3     | 32.6     | 29.3     |
| Llama 2 | 13B  | 24.5     | 66.9                  | 55.4            | 65.8                  | 28.7     | 54.8     | 39.4     | 39.1     |
| Llama 2 | 70B  | **37.5** | **71.9**              | **63.6**        | **69.4**              | **35.2** | **68.9** | **51.2** | **54.2** |

**Overall performance on grouped academic benchmarks.** *Code:* We report the average pass\@1 scores of our models on HumanEval and MBPP. *Commonsense Reasoning:* We report the average of PIQA, SIQA, HellaSwag, WinoGrande, ARC easy and challenge, OpenBookQA, and CommonsenseQA. We report 7-shot results for CommonSenseQA and 0-shot results for all other benchmarks. *World Knowledge:* We evaluate the 5-shot performance on NaturalQuestions and TriviaQA and report the average. *Reading Comprehension:* For reading comprehension, we report the 0-shot average on SQuAD, QuAC, and BoolQ. *MATH:* We report the average of the GSM8K (8 shot) and MATH (4 shot) benchmarks at top 1.

|         |     | TruthfulQA | Toxigen   |
| ------- | --- | ---------- | --------- |
| Llama 1 | 7B  | 27.42      | 23.00     |
| Llama 1 | 13B | 41.74      | 23.08     |
| Llama 1 | 33B | 44.19      | 22.57     |
| Llama 1 | 65B | 48.71      | 21.77     |
| Llama 2 | 7B  | 33.29      | **21.25** |
| Llama 2 | 13B | 41.86      | 26.10     |
| Llama 2 | 70B | **50.18**  | 24.60     |

**Evaluation of pretrained LLMs on automatic safety benchmarks.** For TruthfulQA, we present the percentage of generations that are both truthful and informative (the higher the better). For ToxiGen, we present the percentage of toxic generations (the smaller the better).

|              |     | TruthfulQA | Toxigen  |
| ------------ | --- | ---------- | -------- |
| Llama-2-Chat | 7B  | 57.04      | **0.00** |
| Llama-2-Chat | 13B | 62.18      | **0.00** |
| Llama-2-Chat | 70B | **64.14**  | 0.01     |

**Evaluation of fine-tuned LLMs on different safety datasets.** Same metric definitions as above.

### Ethical Considerations and Limitations

Llama 2 is a new technology that carries risks with use. Testing conducted to date has been in English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Llama 2’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate, biased or other objectionable responses to user prompts. Therefore, before deploying any applications of Llama 2, developers should perform safety testing and tuning tailored to their specific applications of the model.

Please see the Responsible Use Guide available at [https://ai.meta.com/llama/responsible-use-guide/](https://ai.meta.com/llama/responsible-use-guide)

### Reporting Issues

Please report any software “bug,” or other problems with the models through one of the following means:

* Reporting issues with the model: [github.com/facebookresearch/llama](http://github.com/facebookresearch/llama)
* Reporting problematic content generated by the model: [developers.facebook.com/llama\_output\_feedback](http://developers.facebook.com/llama_output_feedback)
* Reporting bugs and security concerns: [facebook.com/whitehat/info](http://facebook.com/whitehat/info)

### Llama Model Index

| Model | Llama2                                                | Llama2-hf                                                | Llama2-chat                                                | Llama2-chat-hf                                                |
| ----- | ----------------------------------------------------- | -------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------- |
| 7B    | [Link](https://huggingface.co/meta-llama/Llama-2-7b)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-hf)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-chat)  | [Link](https://huggingface.co/meta-llama/Llama-2-7b-chat-hf)  |
| 13B   | [Link](https://huggingface.co/meta-llama/Llama-2-13b) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-hf) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-chat) | [Link](https://huggingface.co/meta-llama/Llama-2-13b-chat-hf) |
| 70B   | [Link](https://huggingface.co/meta-llama/Llama-2-70b) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-hf) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-chat) | [Link](https://huggingface.co/meta-llama/Llama-2-70b-chat-hf) |

### Request and Response

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/meta-llama70b/bridgeml/meta-llama70b' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Hello how are you?"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response

{% code overflow="wrap" %}

```json
{
  "id": "meta-llama/Llama-2-70b-chat-hf-994585ab-e568-4433-b8fb-bf5e6f930334",
  "object": "text_completion",
  "created": 1718903627,
  "model": "meta-llama/Llama-2-70b-chat-hf",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "It seems like I repeated your greeting! I'm here to help with any questions, topics, or even just to chat. What's on your mind today?",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 21,
    "completion_tokens": 33,
    "total_tokens": 54
  }
}
```

{% endcode %}

You can try out this cheap and easy to use LLM API here at <https://api.market/store/bridgeml/meta-llama70b>


# Gemma-7b-it

Gemma-7B-IT: Your all-in-one AI solution for streamlined workflows and data-driven decisions.

**Developer Portal :** <https://api.market/store/bridgeml/google>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/gemma-google.webp" alt=""><figcaption></figcaption></figure>

## Gemma Model Card

**Model Page**: [Gemma](https://ai.google.dev/gemma/docs)

This model card corresponds to the 7B instruct version of the Gemma model. You can also visit the model card of the [2B base model](https://huggingface.co/google/gemma-2b), [7B base model](https://huggingface.co/google/gemma-7b), and [2B instruct model](https://huggingface.co/google/gemma-2b-it).

**Resources and Technical Documentation**:

* [Responsible Generative AI Toolkit](https://ai.google.dev/responsible)
* [Gemma on Kaggle](https://www.kaggle.com/models/google/gemma)
* [Gemma on Vertex Model Garden](https://console.cloud.google.com/vertex-ai/publishers/google/model-garden/335?version=gemma-7b-it-gg-hf)

**Terms of Use**: [Terms](https://www.kaggle.com/models/google/gemma/license/consent)

**Authors**: Google

### Model Information

Summary description and brief definition of inputs and outputs.

#### Description

Gemma is a family of lightweight, state-of-the-art open models from Google, built from the same research and technology used to create the Gemini models. They are text-to-text, decoder-only large language models, available in English, with open weights, pre-trained variants, and instruction-tuned variants. Gemma models are well-suited for a variety of text generation tasks, including question answering, summarization, and reasoning. Their relatively small size makes it possible to deploy them in environments with limited resources such as a laptop, desktop or your own cloud infrastructure, democratizing access to state of the art AI models and helping foster innovation for everyone.

**Fine-tuning the model**

You can find fine-tuning scripts and notebook under the [`examples/` directory](https://huggingface.co/google/gemma-7b/tree/main/examples) of [`google/gemma-7b`](https://huggingface.co/google/gemma-7b) repository. To adapt it to this model, simply change the model-id to `google/gemma-7b-it`. In that repository, we provide:

* A script to perform Supervised Fine-Tuning (SFT) on UltraChat dataset using QLoRA
* A script to perform SFT using FSDP on TPU devices
* A notebook that you can run on a free-tier Google Colab instance to perform SFT on English quotes dataset

#### Inputs and outputs

* **Input:** Text string, such as a question, a prompt, or a document to be summarized.
* **Output:** Generated English-language text in response to the input, such as an answer to a question, or a summary of a document.

### Model Data

Data used for model training and how the data was processed.

#### Training Dataset

These models were trained on a dataset of text data that includes a wide variety of sources, totaling 6 trillion tokens. Here are the key components:

* Web Documents: A diverse collection of web text ensures the model is exposed to a broad range of linguistic styles, topics, and vocabulary. Primarily English-language content.
* Code: Exposing the model to code helps it to learn the syntax and patterns of programming languages, which improves its ability to generate code or understand code-related questions.
* Mathematics: Training on mathematical text helps the model learn logical reasoning, symbolic representation, and to address mathematical queries.

The combination of these diverse data sources is crucial for training a powerful language model that can handle a wide variety of different tasks and text formats.

#### Data Preprocessing

Here are the key data cleaning and filtering methods applied to the training data:

* CSAM Filtering: Rigorous CSAM (Child Sexual Abuse Material) filtering was applied at multiple stages in the data preparation process to ensure the exclusion of harmful and illegal content
* Sensitive Data Filtering: As part of making Gemma pre-trained models safe and reliable, automated techniques were used to filter out certain personal information and other sensitive data from training sets.
* Additional methods: Filtering based on content quality and safely in line with [our policies](https://storage.googleapis.com/gweb-uniblog-publish-prod/documents/2023_Google_AI_Principles_Progress_Update.pdf#page=11).

### Implementation Information

Details about the model internals.

#### Hardware

Gemma was trained using the latest generation of [Tensor Processing Unit (TPU)](https://cloud.google.com/tpu/docs/intro-to-tpu) hardware (TPUv5e).

Training large language models requires significant computational power. TPUs, designed specifically for matrix operations common in machine learning, offer several advantages in this domain:

* Performance: TPUs are specifically designed to handle the massive computations involved in training LLMs. They can speed up training considerably compared to CPUs.
* Memory: TPUs often come with large amounts of high-bandwidth memory, allowing for the handling of large models and batch sizes during training. This can lead to better model quality.
* Scalability: TPU Pods (large clusters of TPUs) provide a scalable solution for handling the growing complexity of large foundation models. You can distribute training across multiple TPU devices for faster and more efficient processing.
* Cost-effectiveness: In many scenarios, TPUs can provide a more cost-effective solution for training large models compared to CPU-based infrastructure, especially when considering the time and resources saved due to faster training.
* These advantages are aligned with [Google's commitments to operate sustainably](https://sustainability.google/operating-sustainably/).

### Evaluation

Model evaluation metrics and results.

#### Benchmark Results

These models were evaluated against a large collection of different datasets and metrics to cover different aspects of text generation:

| Benchmark                                                                          | Metric        | 2B Params   | 7B Params |
| ---------------------------------------------------------------------------------- | ------------- | ----------- | --------- |
| [MMLU](https://arxiv.org/abs/2009.03300)                                           | 5-shot, top-1 | 42.3        | 64.3      |
| [HellaSwag](https://arxiv.org/abs/1905.07830)                                      | 0-shot        | 71.4        | 81.2      |
| [PIQA](https://arxiv.org/abs/1911.11641)                                           | 0-shot        | 77.3        | 81.2      |
| [SocialIQA](https://arxiv.org/abs/1904.09728)                                      | 0-shot        | 49.7        | 51.8      |
| [BooIQ](https://arxiv.org/abs/1905.10044)                                          | 0-shot        | 69.4        | 83.2      |
| [WinoGrande](https://arxiv.org/abs/1907.10641)                                     | partial score | 65.4        | 72.3      |
| [CommonsenseQA](https://arxiv.org/abs/1811.00937)                                  | 7-shot        | 65.3        | 71.3      |
| [OpenBookQA](https://arxiv.org/abs/1809.02789)                                     |               | 47.8        | 52.8      |
| [ARC-e](https://arxiv.org/abs/1911.01547)                                          |               | 73.2        | 81.5      |
| [ARC-c](https://arxiv.org/abs/1911.01547)                                          |               | 42.1        | 53.2      |
| [TriviaQA](https://arxiv.org/abs/1705.03551)                                       | 5-shot        | 53.2        | 63.4      |
| [Natural Questions](https://github.com/google-research-datasets/natural-questions) | 5-shot        | 12.5        | 23        |
| [HumanEval](https://arxiv.org/abs/2107.03374)                                      | pass\@1       | 22.0        | 32.3      |
| [MBPP](https://arxiv.org/abs/2108.07732)                                           | 3-shot        | 29.2        | 44.4      |
| [GSM8K](https://arxiv.org/abs/2110.14168)                                          | maj\@1        | 17.7        | 46.4      |
| [MATH](https://arxiv.org/abs/2108.07732)                                           | 4-shot        | 11.8        | 24.3      |
| [AGIEval](https://arxiv.org/abs/2304.06364)                                        |               | 24.2        | 41.7      |
| [BIG-Bench](https://arxiv.org/abs/2206.04615)                                      |               | 35.2        | 55.1      |
| ------------------------------                                                     | ------------- | ----------- | --------- |
| **Average**                                                                        |               | **45.0**    | **56.9**  |

### Ethics and Safety

Ethics and safety evaluation approach and results.

#### Evaluation Approach

Our evaluation methods include structured evaluations and internal red-teaming testing of relevant content policies. Red-teaming was conducted by a number of different teams, each with different goals and human evaluation metrics. These models were evaluated against a number of different categories relevant to ethics and safety, including:

* Text-to-Text Content Safety: Human evaluation on prompts covering safety policies including child sexual abuse and exploitation, harassment, violence and gore, and hate speech.
* Text-to-Text Representational Harms: Benchmark against relevant academic datasets such as [WinoBias](https://arxiv.org/abs/1804.06876) and [BBQ Dataset](https://arxiv.org/abs/2110.08193v2).
* Memorization: Automated evaluation of memorization of training data, including the risk of personally identifiable information exposure.
* Large-scale harm: Tests for "dangerous capabilities," such as chemical, biological, radiological, and nuclear (CBRN) risks.

#### Evaluation Results

The results of ethics and safety evaluations are within acceptable thresholds for meeting [internal policies](https://storage.googleapis.com/gweb-uniblog-publish-prod/documents/2023_Google_AI_Principles_Progress_Update.pdf#page=11) for categories such as child safety, content safety, representational harms, memorization, large-scale harms. On top of robust internal evaluations, the results of well known safety benchmarks like BBQ, BOLD, Winogender, Winobias, RealToxicity, and TruthfulQA are shown here.

| Benchmark                                                    | Metric        | 2B Params   | 7B Params |
| ------------------------------------------------------------ | ------------- | ----------- | --------- |
| [RealToxicity](https://arxiv.org/abs/2009.11462)             | average       | 6.86        | 7.90      |
| [BOLD](https://arxiv.org/abs/2101.11718)                     |               | 45.57       | 49.08     |
| [CrowS-Pairs](https://aclanthology.org/2020.emnlp-main.154/) | top-1         | 45.82       | 51.33     |
| [BBQ Ambig](https://arxiv.org/abs/2110.08193v2)              | 1-shot, top-1 | 62.58       | 92.54     |
| [BBQ Disambig](https://arxiv.org/abs/2110.08193v2)           | top-1         | 54.62       | 71.99     |
| [Winogender](https://arxiv.org/abs/1804.09301)               | top-1         | 51.25       | 54.17     |
| [TruthfulQA](https://arxiv.org/abs/2109.07958)               |               | 44.84       | 31.81     |
| [Winobias 1\_2](https://arxiv.org/abs/1804.06876)            |               | 56.12       | 59.09     |
| [Winobias 2\_2](https://arxiv.org/abs/1804.06876)            |               | 91.10       | 92.23     |
| [Toxigen](https://arxiv.org/abs/2203.09509)                  |               | 29.77       | 39.59     |
| ------------------------------                               | ------------- | ----------- | --------- |

#### Intended Usage

Open Large Language Models (LLMs) have a wide range of applications across various industries and domains. The following list of potential uses is not comprehensive. The purpose of this list is to provide contextual information about the possible use-cases that the model creators considered as part of model training and development.

* Content Creation and Communication
  * Text Generation: These models can be used to generate creative text formats such as poems, scripts, code, marketing copy, and email drafts.
  * Chatbots and Conversational AI: Power conversational interfaces for customer service, virtual assistants, or interactive applications.
  * Text Summarization: Generate concise summaries of a text corpus, research papers, or reports.
* Research and Education
  * Natural Language Processing (NLP) Research: These models can serve as a foundation for researchers to experiment with NLP techniques, develop algorithms, and contribute to the advancement of the field.
  * Language Learning Tools: Support interactive language learning experiences, aiding in grammar correction or providing writing practice.
  * Knowledge Exploration: Assist researchers in exploring large bodies of text by generating summaries or answering questions about specific topics.

#### Benefits

At the time of release, this family of models provides high-performance open large language model implementations designed from the ground up for Responsible AI development compared to similarly sized models.

Using the benchmark evaluation metrics described in this document, these models have shown to provide superior performance to other, comparably-sized open model alternatives.

### Request and Response

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/google/bridgeml/google' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "hello! how are you doing?"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response

{% code overflow="wrap" %}

```json
{
  "id": "google/gemma-7b-it-725eb606-415a-4687-91dc-2c33a6e49e84",
  "object": "text_completion",
  "created": 1718904207,
  "model": "google/gemma-7b-it",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "I'm doing well, thank you. And you? How have you been?",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 22,
    "completion_tokens": 18,
    "total_tokens": 40
  }
}
```

{% endcode %}

you can try this cheap and easy to use LLM Api here at <https://api.market/store/bridgeml/google>


# NeuralHermes-2.5-Mistral-7B

NeuralHermes-2.5-Mistral-7B: Unleash unparalleled AI capabilities with Mistral's 7B parameters for advanced natural language processing.

**Developer Portal :**  <https://api.market/store/bridgeml/mlabonne>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/qIhaFNM-1.png" alt=""><figcaption></figcaption></figure>

## NeuralHermes 2.5 - Mistral 7B

NeuralHermes is based on the [teknium/OpenHermes-2.5-Mistral-7B](https://huggingface.co/teknium/OpenHermes-2.5-Mistral-7B) model that has been further fine-tuned with Direct Preference Optimization (DPO) using the [mlabonne/chatml\_dpo\_pairs](https://huggingface.co/datasets/mlabonne/chatml_dpo_pairs) dataset. It surpasses the original model on most benchmarks (see results).

It is directly inspired by the RLHF process described by [Intel/neural-chat-7b-v3-1](https://huggingface.co/Intel/neural-chat-7b-v3-1)'s authors to improve performance. I used the same dataset and reformatted it to apply the ChatML template.

The code to train this model is available on [Google Colab](https://colab.research.google.com/drive/15iFBr1xWgztXvhrj5I9fBv20c7CFOPBE?usp=sharing) and [GitHub](https://github.com/mlabonne/llm-course/tree/main). It required an A100 GPU for about an hour.

### Quantized models

* **GGUF**: <https://huggingface.co/TheBloke/NeuralHermes-2.5-Mistral-7B-GGUF>
* **AWQ**: <https://huggingface.co/TheBloke/NeuralHermes-2.5-Mistral-7B-AWQ>
* **GPTQ**: <https://huggingface.co/TheBloke/NeuralHermes-2.5-Mistral-7B-GPTQ>
* **EXL2**:
  * 3.0bpw: <https://huggingface.co/LoneStriker/NeuralHermes-2.5-Mistral-7B-3.0bpw-h6-exl2>
  * 4.0bpw: <https://huggingface.co/LoneStriker/NeuralHermes-2.5-Mistral-7B-4.0bpw-h6-exl2>
  * 5.0bpw: <https://huggingface.co/LoneStriker/NeuralHermes-2.5-Mistral-7B-5.0bpw-h6-exl2>
  * 6.0bpw: <https://huggingface.co/LoneStriker/NeuralHermes-2.5-Mistral-7B-6.0bpw-h6-exl2>
  * 8.0bpw: <https://huggingface.co/LoneStriker/NeuralHermes-2.5-Mistral-7B-8.0bpw-h8-exl2>

### Results

**Update:** NeuralHermes-2.5 became the best Hermes-based model on the Open LLM leaderboard and one of the very best 7b models. 🎉

[![image/png](https://cdn-uploads.huggingface.co/production/uploads/61b8e2ba285851687028d395/yWe6VBFxkHiuOlDVBXtGo.png)](https://cdn-uploads.huggingface.co/production/uploads/61b8e2ba285851687028d395/yWe6VBFxkHiuOlDVBXtGo.png)

Teknium (author of OpenHermes-2.5-Mistral-7B) benchmarked the model ([see his tweet](https://twitter.com/Teknium1/status/1729955709377503660)).

Results are improved on every benchmark: **AGIEval** (from 43.07% to 43.62%), **GPT4All** (from 73.12% to 73.25%), and **TruthfulQA**.

#### AGIEval

[![](https://i.imgur.com/7an3B1f.png)](https://i.imgur.com/7an3B1f.png)

#### GPT4All

[![](https://i.imgur.com/TLxZFi9.png)](https://i.imgur.com/TLxZFi9.png)

#### TruthfulQA

[![](https://i.imgur.com/V380MqD.png)](https://i.imgur.com/V380MqD.png)

You can check the Weights & Biases project [here](https://wandb.ai/mlabonne/DPO/runs/axe71gr0?nw=nwusermlabonne).

### Training hyperparameters

**LoRA**:

* r=16
* lora\_alpha=16
* lora\_dropout=0.05
* bias="none"
* task\_type="CAUSAL\_LM"
* target\_modules=\['k\_proj', 'gate\_proj', 'v\_proj', 'up\_proj', 'q\_proj', 'o\_proj', 'down\_proj']

**Training arguments**:

* per\_device\_train\_batch\_size=4
* gradient\_accumulation\_steps=4
* gradient\_checkpointing=True
* learning\_rate=5e-5
* lr\_scheduler\_type="cosine"
* max\_steps=200
* optim="paged\_adamw\_32bit"
* warmup\_steps=100

**DPOTrainer**:

* beta=0.1
* max\_prompt\_length=1024
* max\_length=1536

[Source](https://github.com/mlabonne)

### Request and Response

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/mlabonne/bridgeml/mlabonne' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Hello, how can you help me?"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response

{% code overflow="wrap" %}

```json
{
  "id": "mlabonne/NeuralHermes-2.5-Mistral-7B-eab3ca77-e1d0-41cb-b43e-e8195af77dc7",
  "object": "text_completion",
  "created": 1718905083,
  "model": "mlabonne/NeuralHermes-2.5-Mistral-7B",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "It seems like you have a question or need assistance with something. Please feel free to provide more information or context so I can do my best to help you.",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 76,
    "completion_tokens": 33,
    "total_tokens": 109
  }
}
```

{% endcode %}

You can use this easy to use and cheap LLM Api here at <https://api.market/store/bridgeml/mlabonne>


# BAAI/bge-large-en-v1.5

BAAI/bge-large-en-v1.5 is a highly advanced language model designed by BAAI, equipped with powerful natural language processing capabilities for diverse application

**Developer Portal :** <https://api.market/store/bridgeml/baai>

## BAAI/bge-large-en-v1.5

BGE Large English v1.5 is a large pretrained generative text model developed by BAAI. This model is designed for a variety of natural language processing tasks, leveraging its extensive training on diverse text data.

### Model Details

*BGE Large English v1.5* is a state-of-the-art language model based on the transformer architecture. With its vast parameter size and extensive training, it demonstrates proficiency in various natural language understanding and generation tasks.

**Model Developers:** BAAI

**Input:** The model accepts text inputs in a wide range of formats, including raw text, tokenized sequences, and more.

**Output:** Similarly, it generates text outputs, providing responses, translations, summaries, or completions based on the input it receives.

**Model Architecture:** Built on the foundation of the transformer architecture, BGE Large English v1.5 utilizes self-attention mechanisms to capture contextual relationships in text data effectively.

**Training Data:** The model has been pretrained on an extensive corpus of text data, encompassing diverse sources such as books, articles, websites, and more. This rich training data enables the model to capture the nuances of natural language usage across various domains and styles.

### Intended Use

**Intended Use Cases:** BGE Large English v1.5 is a versatile tool suitable for a wide array of natural language processing tasks. It can be deployed in applications such as chatbots, virtual assistants, language translation systems, text summarization tools, and more. Researchers and developers can also fine-tune the model for specific downstream tasks to achieve optimal performance.

**Out-of-scope Uses:** While the model is designed to be highly flexible, users should refrain from employing it in ways that contravene ethical guidelines or legal regulations. Any usage intended to harm, deceive, or infringe upon the rights of individuals or groups is strictly prohibited.

### Hardware and Software

**Training Factors:** The development and training of BGE Large English v1.5 involved the utilization of advanced hardware resources and custom training frameworks optimized for large-scale language modeling tasks. The training process likely required substantial computational resources and expertise in machine learning infrastructure.

### Training Data

**Overview:** BGE Large English v1.5 has been pretrained on a vast and diverse corpus of text data, meticulously curated to encompass a broad spectrum of linguistic phenomena and domain-specific knowledge. This extensive training data enables the model to exhibit robust performance across a wide range of natural language understanding and generation tasks.

**Data Freshness:** While specific details regarding the freshness of the training data are not provided, it can be inferred that the data corpus includes recent as well as historical text sources, ensuring relevance and comprehensiveness in capturing the evolving dynamics of natural language usage.

### Evaluation Results

No specific evaluation results are provided for this model in the available documentation. However, users are encouraged to conduct their own evaluations and performance assessments based on their specific use cases and requirements.

### Ethical Considerations and Limitations

As with any language model, BGE Large English v1.5 may produce outputs that are inaccurate, biased, or otherwise objectionable in certain contexts. It is imperative for users to exercise caution and critical judgment when utilizing the model, especially in applications involving sensitive or high-stakes scenarios. Additionally, developers should prioritize ethical considerations and strive to mitigate potential risks associated with unintended consequences of model deployment.

### Reporting Issues

Users encountering issues or anomalies with the model are encouraged to report them to the developers through the designated channels provided by BAAI. Timely reporting of issues facilitates ongoing model refinement and improvement efforts, ultimately contributing to the enhancement of model performance and reliability.

[Website](https://www.baai.ac.cn/english.html) | [Source](https://huggingface.co/BAAI)

### Request and Response

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/baai/bridgeml/baai' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "As a senior copywriter, write a long-form blog on why they should integrate LLM APIs from api.market into their existing offerings and how LLAMA LLM API can handle customer support, documentation and help reduce overall costs"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response

```
```


# CodeLlama-70b-Instruct-hf

CodeLlama-70b-Instruct-hf: A cutting-edge instructional tool leveraging high-fidelity simulations to enhance coding proficiency and comprehension.

**Developer Portal :** [**https://api.market/store/bridgeml/codellama**](https://api.market/store/bridgeml/codellama)

## CodeLlama-70b-Instruct-hf

<figure><img src="https://blog.api.market/wp-content/uploads/2024/06/nuneybits_vector_art_of_a_llama_programming_8c825672-172b-4e69-a6f1-b7c9e8bf5294.webp" alt=""><figcaption></figcaption></figure>

Code Llama is a collection of pretrained and fine-tuned generative text models ranging in scale from 7 billion to 70 billion parameters. This is the repository for the 70B instruct-tuned version in the Hugging Face Transformers format. This model is designed for general code synthesis and understanding. Links to other models can be found in the index at the bottom.

> This is a non-official Code Llama repo. You can find the official Meta repository in the [Meta Llama organization](https://huggingface.co/meta-llama/CodeLlama-70b-Instruct-hf).

Model capabilities:

* [x] Code completion.
* [ ] Infilling.
* [x] Instructions / chat.
* [ ] Python specialist.

As a final detail, please note that if the dialog does not start with a `system` turn, the [original code will insert one with an empty content string](https://github.com/facebookresearch/codellama/blob/1af62e1f43db1fa5140fa43cb828465a603a48f3/llama/generation.py#L418).

### Model Details

\*Note: Use of this model is governed by the Meta license. Meta developed and publicly released the Code Llama family of large language models (LLMs).

**Model Developers** Meta

**Variations** Code Llama comes in four model sizes, and three variants:

* Code Llama: base models designed for general code synthesis and understanding
* Code Llama - Python: designed specifically for Python
* Code Llama - Instruct: for instruction following and safer deployment

All variants are available in sizes of 7B, 13B, 34B, and 70B parameters.

**This repository contains the Instruct version of the 70B parameters model.**

**Input** Models input text only.

**Output** Models generate text only.

**Model Architecture** Code Llama is an auto-regressive language model that uses an optimized transformer architecture. It was fine-tuned with up to 16k tokens. This variant **does not** support long context of up to 100k tokens.

**Model Dates** Code Llama and its variants have been trained between January 2023 and January 2024.

**Status** This is a static model trained on an offline dataset. Future versions of Code Llama - Instruct will be released as we improve model safety with community feedback.

**License** A custom commercial license is available at: <https://ai.meta.com/resources/models-and-libraries/llama-downloads/>

**Research Paper** More information can be found in the paper "[Code Llama: Open Foundation Models for Code](https://ai.meta.com/research/publications/code-llama-open-foundation-models-for-code/)" or its [arXiv page](https://arxiv.org/abs/2308.12950).

### Intended Use

**Intended Use Cases** Code Llama and its variants are intended for commercial and research use in English and relevant programming languages. The base model Code Llama can be adapted for a variety of code synthesis and understanding tasks, Code Llama - Python is designed specifically to handle the Python programming language, and Code Llama - Instruct is intended to be safer to use for code assistant and generation applications.

**Out-of-Scope Uses** Use in any manner that violates applicable laws or regulations (including trade compliance laws). Use in languages other than English. Use in any other way that is prohibited by the Acceptable Use Policy and Licensing Agreement for Code Llama and its variants.

### Evaluation Results

See evaluations for the main models and detailed ablations in Section 3 and safety evaluations in Section 4 of the research paper.

### Ethical Considerations and Limitations

Code Llama and its variants are a new technology that carries risks with use. Testing conducted to date has been in English, and has not covered, nor could it cover all scenarios. For these reasons, as with all LLMs, Code Llama’s potential outputs cannot be predicted in advance, and the model may in some instances produce inaccurate or objectionable responses to user prompts. Therefore, before deploying any applications of Code Llama, developers should perform safety testing and tuning tailored to their specific applications of the model.

Please see the Responsible Use Guide available available at <https://ai.meta.com/llama/responsible-use-guide>.

[Source](https://codellama.dev/about)

### Request and Response

#### Request

{% code overflow="wrap" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/codellama/bridgeml/codellama' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "messages": [
    {
      "role": "user",
      "content": "hello"
    },
    {
      "role": "assistant",
      "content": "Hello, how are you doing?"
    }
  ],
  "temperature": 1,
  "max_tokens": 256,
  "top_p": 1,
  "frequency_penalty": 0,
  "stream": false
}'
```

{% endcode %}

#### Response

{% code overflow="wrap" %}

```json
{
  "id": "codellama/CodeLlama-70b-Instruct-hf-57e4e369-cc50-4bf9-a00c-49da33527837",
  "object": "text_completion",
  "created": 1718907076,
  "model": "codellama/CodeLlama-70b-Instruct-hf",
  "choices": [
    {
      "message": {
        "role": "assistant",
        "content": "Is there something I can help you with or would you like to chat?",
        "tool_calls": null,
        "tool_call_id": null
      },
      "index": 0,
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "usage": {
    "prompt_tokens": 23,
    "completion_tokens": 16,
    "total_tokens": 39
  }
}
```

{% endcode %}

You can use this easy and cheap LLM API here at <https://api.market/store/bridgeml/codellama>


# 🤖🧗Text-to-Image API

Fast text-to-image generation model capable of producing high-quality images

**Developer Portal :** <https://api.market/store/bridgeml/text-to-image>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/07/out-0.png" alt=""><figcaption></figcaption></figure>

Introducing the MagicAPI [Text-to-Image API](https://api.market/store/bridgeml/text-to-image), the ultimate solution for generating high-quality images from text prompts using advanced AI technology. This cutting-edge API is designed to deliver stunning visuals at lightning speed, making it the most affordable text-to-image API on the market today. Whether you're a developer, designer, or content creator, our API provides the perfect blend of performance and cost-efficiency.

#### Key Features

* **AI-Powered Generation:** Leverage state-of-the-art AI to create ultra-high-definition images from text prompts.
* **Unmatched Speed:** Generate images in seconds, ensuring your projects stay on track.
* **High-Quality Output:** Create images that are perfect for production use, thanks to our specialized AI model.
* **Cost-Effective:** Get the best value for your money with our competitively priced service.
* **Easy Integration:** Simple API requests allow for seamless integration into your applications and workflows.
* **Customizable Settings:** Tailor image generation to your needs with adjustable parameters.

#### Integration and Support

Getting started with the MagicAPI Text-to-Image API is easy. Our comprehensive documentation provides all the details you need to integrate quickly. Additionally, our support team is always available to help with any questions or issues you may encounter.

**API Endpoints**

* `POST /text-to-image` : A fast text-to-image model that makes high-quality images in 4 steps

**Input Schema**

When using the API, the following fields are expected in the request body:

* `prompt` (string, required, default: "an epic forest with mountain on the back and a great palatial big house"): The input text prompt for the image generation.
* `width` (integer, required, default: 512): The width of the output image. Recommended values are 1024 or 1280.
* `height` (integer, required, default: 512): The height of the output image. Recommended values are 1024 or 1280.
* `scheduler` (string, optional, default: "K\_EULER"): The scheduler type for the model. Available options include DDIM, DPMSolverMultistep, HeunDiscrete, KarrasDPM, K\_EULER\_ANCESTRAL, K\_EULER, PNDM, and DPM++2MSDE.
* `num_outputs` (integer, optional, default: 1): The number of images to output. Values range from 1 to 4.
* `guidance_scale` (number, optional, default: 0): The scale for classifier-free guidance. Recommended values are between 7 and 8.
* `negative_prompt` (string, optional, default: "worst quality, low quality"): A negative prompt to guide the image generation away from certain concepts.
* `num_inference_steps` (integer, optional, default: 4): The number of denoising steps. The value 4 provides the best results.

#### Example Usage

Generating images with the MagicAPI Text-to-Image API is straightforward. Here’s a step-by-step example of how to use our API:

**Step 1: Generate an Image**

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/text-to-image/text-to-image' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "prompt": "Futuristic space battle, hyper realistic, 4k",
  "height": 512,
  "width": 512,
  "scheduler": "K_EULER",
  "num_outputs": 1,
  "guidance_scale": 0,
  "negative_prompt": "worst quality, low quality",
  "num_inference_steps": 4
}'
```

**Response:**

```json
{
  "status": "succeeded",
  "result": [
    "https://replicate.delivery/yhqm/ni159BXILdbmNFko8GfuMGCiIKAFfo1ERPOa6u95Bljm1fVmA/out-0.png"
  ]
}
```

Sample images

<figure><img src="https://blog.api.market/wp-content/uploads/2024/07/out-1.png" alt=""><figcaption><p>a majestic super advanced planet with a powerful space civilization</p></figcaption></figure>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/07/out-2.png" alt=""><figcaption><p>nice majestic house in front of a grand lush green mountain</p></figcaption></figure>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/07/out-3.png" alt=""><figcaption><p>aurora in a stary night with the hyper realistic planets</p></figcaption></figure>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/07/out-5.png" alt=""><figcaption><p>A pickup truck going up a mountain switchback</p></figcaption></figure>

**Developer Portal :** <https://api.market/store/bridgeml/text-to-image>


# 📝🎧 Text to Audio API

Text to Audio API is a powerful transformer-based model that turns text into audio.

**Developer Portal :** <https://api.market/store/bridgeml/text-to-audio>

<figure><img src="https://blog.api.market/wp-content/uploads/2024/07/Screenshot-2024-07-29-at-11.56.40.png" alt=""><figcaption></figcaption></figure>

Text to Audio API is a powerful transformer-based model that turns text into audio. It can produce realistic, multilingual speech, background noise, and simple sound effects. This API also handles nonverbal cues like laughing, sighing, and crying, making it versatile for various audio applications.

**Usage Example:**

To generate audio, provide a text prompt along with other parameter like speaker which you want to use . We have over 130+ types of speaker voice that you can call and generate the audio. The model outputs a URL to the generated audio.

**API Details:**

* **Text**: The main text input for generating audio.
* **speaker**: Select the speaker voice.
* **language**: The resulted audio language
* **cleanup\_voice**: Whether to clean up the voice output

### Examples

#### Request and Response

`"speaker": "announcer"`

**Request**

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/text-to-audio/text-to-audio' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'text=Greetings, everyone! Today, I want to talk about the importance of resilience. In our fast-paced world, change is constant, and challenges are inevitable. Resilience is the ability to bounce back, adapt, and grow stronger in the face of adversity. It'\''s not just about enduring hardships but thriving through them. We see resilience in nature, where plants thrive after storms, and in people who overcome personal and professional obstacles. It'\''s a skill that can be cultivated through mindfulness, perseverance, and a positive mindset. By embracing challenges as opportunities for growth, we can transform setbacks into stepping stones. Remember, every difficulty faced is a chance to develop resilience. As we move forward, let'\''s support each other in building this invaluable trait, for it'\''s resilience that enables us to navigate life'\''s uncertainties and achieve our fullest potential. Together, we can create a community that not only survives but thrives. Thank you!' \
  -F 'speaker=announcer' \
  -F 'language=en' \
  -F 'cleanup_voice=false'
```

**Output**&#x20;

{% embed url="<https://blog.api.market/wp-content/uploads/2024/07/output.wav>" %}

`"speaker": "de_speaker_9"`

**Request**

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/text-to-audio/text-to-audio' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'text=Greetings, everyone! Today, I want to talk about the importance of resilience. In our fast-paced world, change is constant, and challenges are inevitable. Resilience is the ability to bounce back, adapt, and grow stronger in the face of adversity. It'\''s not just about enduring hardships but thriving through them. We see resilience in nature, where plants thrive after storms, and in people who overcome personal and professional obstacles. It'\''s a skill that can be cultivated through mindfulness, perseverance, and a positive mindset. By embracing challenges as opportunities for growth, we can transform setbacks into stepping stones. Remember, every difficulty faced is a chance to develop resilience. As we move forward, let'\''s support each other in building this invaluable trait, for it'\''s resilience that enables us to navigate life'\''s uncertainties and achieve our fullest potential. Together, we can create a community that not only survives but thrives. Thank you!' \
  -F 'speaker=de_speaker_9' \
  -F 'language=en' \
  -F 'cleanup_voice=false'
```

**Output**&#x20;

{% embed url="<https://blog.api.market/wp-content/uploads/2024/07/output_.de_speaker_9wav-1.wav>" %}

`"speaker": "es_speaker_9"`

**Request**

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/text-to-audio/text-to-audio' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'text=Greetings, everyone! Today, I want to talk about the importance of resilience. In our fast-paced world, change is constant, and challenges are inevitable. Resilience is the ability to bounce back, adapt, and grow stronger in the face of adversity. It'\''s not just about enduring hardships but thriving through them. We see resilience in nature, where plants thrive after storms, and in people who overcome personal and professional obstacles. It'\''s a skill that can be cultivated through mindfulness, perseverance, and a positive mindset. By embracing challenges as opportunities for growth, we can transform setbacks into stepping stones. Remember, every difficulty faced is a chance to develop resilience. As we move forward, let'\''s support each other in building this invaluable trait, for it'\''s resilience that enables us to navigate life'\''s uncertainties and achieve our fullest potential. Together, we can create a community that not only survives but thrives. Thank you!' \
  -F 'speaker=es_speaker_9' \
  -F 'language=en' \
  -F 'cleanup_voice=false'
```

**Output**&#x20;

{% embed url="<https://blog.api.market/wp-content/uploads/2024/07/output_es_speaker_9.wav>" %}

`"speaker": "it_speaker_5"`

**Request**

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/bridgeml/text-to-audio/text-to-audio' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'text=Greetings, everyone! Today, I want to talk about the importance of resilience. In our fast-paced world, change is constant, and challenges are inevitable. Resilience is the ability to bounce back, adapt, and grow stronger in the face of adversity. It'\''s not just about enduring hardships but thriving through them. We see resilience in nature, where plants thrive after storms, and in people who overcome personal and professional obstacles. It'\''s a skill that can be cultivated through mindfulness, perseverance, and a positive mindset. By embracing challenges as opportunities for growth, we can transform setbacks into stepping stones. Remember, every difficulty faced is a chance to develop resilience. As we move forward, let'\''s support each other in building this invaluable trait, for it'\''s resilience that enables us to navigate life'\''s uncertainties and achieve our fullest potential. Together, we can create a community that not only survives but thrives. Thank you!' \
  -F 'speaker=it_speaker_5' \
  -F 'language=en' \
  -F 'cleanup_voice=false'
```

**Output**

{% embed url="<https://blog.api.market/wp-content/uploads/2024/07/output_it_speaker_5.wav>" %}

## Audio Samples

<table><thead><tr><th width="186">Speaker</th><th>Gender</th><th>URL</th></tr></thead><tbody><tr><td>announcer</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/announcer.wav">announcer</a></td></tr><tr><td>de_speaker_0</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_0.wav">de_speaker_0</a></td></tr><tr><td>de_speaker_1</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_1.wav">de_speaker_1</a></td></tr><tr><td>de_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_2.wav">de_speaker_2</a></td></tr><tr><td>de_speaker_3</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_3.wav">de_speaker_3</a></td></tr><tr><td>de_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_4.wav">de_speaker_4</a></td></tr><tr><td>de_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_5.wav">de_speaker_5</a></td></tr><tr><td>de_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_6.wav">de_speaker_6</a></td></tr><tr><td>de_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_7.wav">de_speaker_7</a></td></tr><tr><td>de_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_8.wav">de_speaker_8</a></td></tr><tr><td>de_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/de_speaker_9.wav">de_speaker_9</a></td></tr><tr><td>en_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_0.wav">en_speaker_0</a></td></tr><tr><td>en_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_1.wav">en_speaker_1</a></td></tr><tr><td>en_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_2.wav">en_speaker_2</a></td></tr><tr><td>en_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_3.wav">en_speaker_3</a></td></tr><tr><td>en_speaker_4</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_4.wav">en_speaker_4</a></td></tr><tr><td>en_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_5.wav">en_speaker_5</a></td></tr><tr><td>en_speaker_6</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_6.wav">en_speaker_6</a></td></tr><tr><td>en_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_7.wav">en_speaker_7</a></td></tr><tr><td>en_speaker_8</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_8.wav">en_speaker_8</a></td></tr><tr><td>en_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/en_speaker_9.wav">en_speaker_9</a></td></tr><tr><td>es_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_0.wav">es_speaker_0</a></td></tr><tr><td>es_speaker_1</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_1.wav">es_speaker_1</a></td></tr><tr><td>es_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_2.wav">es_speaker_2</a></td></tr><tr><td>es_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_3.wav">es_speaker_3</a></td></tr><tr><td>es_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_4.wav">es_speaker_4</a></td></tr><tr><td>es_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_5.wav">es_speaker_5</a></td></tr><tr><td>es_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_6.wav">es_speaker_6</a></td></tr><tr><td>es_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_7.wav">es_speaker_7</a></td></tr><tr><td>es_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_8.wav">es_speaker_8</a></td></tr><tr><td>es_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/es_speaker_9.wav">es_speaker_9</a></td></tr><tr><td>fr_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_0.wav">fr_speaker_0</a></td></tr><tr><td>fr_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_1.wav">fr_speaker_1</a></td></tr><tr><td>fr_speaker_2</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_2.wav">fr_speaker_2</a></td></tr><tr><td>fr_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_3.wav">fr_speaker_3</a></td></tr><tr><td>fr_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_4.wav">fr_speaker_4</a></td></tr><tr><td>fr_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_5.wav">fr_speaker_5</a></td></tr><tr><td>fr_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_6.wav">fr_speaker_6</a></td></tr><tr><td>fr_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_7.wav">fr_speaker_7</a></td></tr><tr><td>fr_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_8.wav">fr_speaker_8</a></td></tr><tr><td>fr_speaker_9</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/fr_speaker_9.wav">fr_speaker_9</a></td></tr><tr><td>hi_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_0.wav">hi_speaker_0</a></td></tr><tr><td>hi_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_1.wav">hi_speaker_1</a></td></tr><tr><td>hi_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_2.wav">hi_speaker_2</a></td></tr><tr><td>hi_speaker_3</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_3.wav">hi_speaker_3</a></td></tr><tr><td>hi_speaker_4</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_4.wav">hi_speaker_4</a></td></tr><tr><td>hi_speaker_5</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_5.wav">hi_speaker_5</a></td></tr><tr><td>hi_speaker_6</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_6.wav">hi_speaker_6</a></td></tr><tr><td>hi_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_7.wav">hi_speaker_7</a></td></tr><tr><td>hi_speaker_8</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_8.wav">hi_speaker_8</a></td></tr><tr><td>hi_speaker_9</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/hi_speaker_9.wav">hi_speaker_9</a></td></tr><tr><td>it_speaker_0</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_0.wav">it_speaker_0</a></td></tr><tr><td>it_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_1.wav">it_speaker_1</a></td></tr><tr><td>it_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_2.wav">it_speaker_2</a></td></tr><tr><td>it_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_3.wav">it_speaker_3</a></td></tr><tr><td>it_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_4.wav">it_speaker_4</a></td></tr><tr><td>it_speaker_5</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_5.wav">it_speaker_5</a></td></tr><tr><td>it_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_6.wav">it_speaker_6</a></td></tr><tr><td>it_speaker_7</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_7.wav">it_speaker_7</a></td></tr><tr><td>it_speaker_8</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_8.wav">it_speaker_8</a></td></tr><tr><td>it_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/it_speaker_9.wav">it_speaker_9</a></td></tr><tr><td>ja_speaker_0</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_0.wav">ja_speaker_0</a></td></tr><tr><td>ja_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_1.wav">ja_speaker_1</a></td></tr><tr><td>ja_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_2.wav">ja_speaker_2</a></td></tr><tr><td>ja_speaker_3</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_3.wav">ja_speaker_3</a></td></tr><tr><td>ja_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_4.wav">ja_speaker_4</a></td></tr><tr><td>ja_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_5.wav">ja_speaker_5</a></td></tr><tr><td>ja_speaker_6</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_6.wav">ja_speaker_6</a></td></tr><tr><td>ja_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_7.wav">ja_speaker_7</a></td></tr><tr><td>ja_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_8.wav">ja_speaker_8</a></td></tr><tr><td>ja_speaker_9</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ja_speaker_9.wav">ja_speaker_9</a></td></tr><tr><td>ko_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_0.wav">ko_speaker_0</a></td></tr><tr><td>ko_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_1.wav">ko_speaker_1</a></td></tr><tr><td>ko_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_2.wav">ko_speaker_2</a></td></tr><tr><td>ko_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_3.wav">ko_speaker_3</a></td></tr><tr><td>ko_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_4.wav">ko_speaker_4</a></td></tr><tr><td>ko_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_5.wav">ko_speaker_5</a></td></tr><tr><td>ko_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_6.wav">ko_speaker_6</a></td></tr><tr><td>ko_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_7.wav">ko_speaker_7</a></td></tr><tr><td>ko_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_8.wav">ko_speaker_8</a></td></tr><tr><td>ko_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ko_speaker_9.wav">ko_speaker_9</a></td></tr><tr><td>pl_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_0.wav">pl_speaker_0</a></td></tr><tr><td>pl_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_1.wav">pl_speaker_1</a></td></tr><tr><td>pl_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_2.wav">pl_speaker_2</a></td></tr><tr><td>pl_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_3.wav">pl_speaker_3</a></td></tr><tr><td>pl_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_4.wav">pl_speaker_4</a></td></tr><tr><td>pl_speaker_5</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_5.wav">pl_speaker_5</a></td></tr><tr><td>pl_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_6.wav">pl_speaker_6</a></td></tr><tr><td>pl_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_7.wav">pl_speaker_7</a></td></tr><tr><td>pl_speaker_8</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_8.wav">pl_speaker_8</a></td></tr><tr><td>pl_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pl_speaker_9.wav">pl_speaker_9</a></td></tr><tr><td>pt_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_0.wav">pt_speaker_0</a></td></tr><tr><td>pt_speaker_1</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_1.wav">pt_speaker_1</a></td></tr><tr><td>pt_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_2.wav">pt_speaker_2</a></td></tr><tr><td>pt_speaker_3</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_3.wav">pt_speaker_3</a></td></tr><tr><td>pt_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_4.wav">pt_speaker_4</a></td></tr><tr><td>pt_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_5.wav">pt_speaker_5</a></td></tr><tr><td>pt_speaker_6</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_6.wav">pt_speaker_6</a></td></tr><tr><td>pt_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_7.wav">pt_speaker_7</a></td></tr><tr><td>pt_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_8.wav">pt_speaker_8</a></td></tr><tr><td>pt_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/pt_speaker_9.wav">pt_speaker_9</a></td></tr><tr><td>ru_speaker_0</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_0.wav">ru_speaker_0</a></td></tr><tr><td>ru_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_1.wav">ru_speaker_1</a></td></tr><tr><td>ru_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_2.wav">ru_speaker_2</a></td></tr><tr><td>ru_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_3.wav">ru_speaker_3</a></td></tr><tr><td>ru_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_4.wav">ru_speaker_4</a></td></tr><tr><td>ru_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_5.wav">ru_speaker_5</a></td></tr><tr><td>ru_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_6.wav">ru_speaker_6</a></td></tr><tr><td>ru_speaker_7</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_7.wav">ru_speaker_7</a></td></tr><tr><td>ru_speaker_8</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_8.wav">ru_speaker_8</a></td></tr><tr><td>ru_speaker_9</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/ru_speaker_9.wav">ru_speaker_9</a></td></tr><tr><td>tr_speaker_0</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_0.wav">tr_speaker_0</a></td></tr><tr><td>tr_speaker_1</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_1.wav">tr_speaker_1</a></td></tr><tr><td>tr_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_2.wav">tr_speaker_2</a></td></tr><tr><td>tr_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_3.wav">tr_speaker_3</a></td></tr><tr><td>tr_speaker_4</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_4.wav">tr_speaker_4</a></td></tr><tr><td>tr_speaker_5</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_5.wav">tr_speaker_5</a></td></tr><tr><td>tr_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_6.wav">tr_speaker_6</a></td></tr><tr><td>tr_speaker_7</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_7.wav">tr_speaker_7</a></td></tr><tr><td>tr_speaker_8</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_8.wav">tr_speaker_8</a></td></tr><tr><td>tr_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/tr_speaker_9.wav">tr_speaker_9</a></td></tr><tr><td>zh_speaker_0</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_0.wav">zh_speaker_0</a></td></tr><tr><td>zh_speaker_1</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_1.wav">zh_speaker_1</a></td></tr><tr><td>zh_speaker_2</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_2.wav">zh_speaker_2</a></td></tr><tr><td>zh_speaker_3</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_3.wav">zh_speaker_3</a></td></tr><tr><td>zh_speaker_4</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_4.wav">zh_speaker_4</a></td></tr><tr><td>zh_speaker_5</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_5.wav">zh_speaker_5</a></td></tr><tr><td>zh_speaker_6</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_6.wav">zh_speaker_6</a></td></tr><tr><td>zh_speaker_7</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_7.wav">zh_speaker_7</a></td></tr><tr><td>zh_speaker_8</td><td>Female</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_8.wav">zh_speaker_8</a></td></tr><tr><td>zh_speaker_9</td><td>Male</td><td><a href="https://blog.api.market/wp-content/uploads/2024/07/zh_speaker_9.wav">zh_speaker_9</a></td></tr></tbody></table>

**Developer Portal :** <https://api.market/store/bridgeml/text-to-audio>


# Capix AI

<https://api.market/store/capix>


# FaceSwap Image and Video Face Swap API

Experience seamless digital transformations with our Image and Video Face Swap API.

### ⚠️ Please use this API instead! <a href="#please-use-this-api-instead" id="please-use-this-api-instead"></a>

Capix has decided to shut down this on 21st May 2025. To help our customers, we have released a compatible FaceSwap API built by engineers at API.market. Please reach out to support for any questions or help.\
\
[**Please instead use the API at: MagicAPI FaceSwap-Capix API (https://api.market/store/magicapi/faceswap-capix)**](https://api.market/store/magicapi/faceswap-capix)

#### [Try FaceSwap Image & Video API on API.market](/api-product-docs/magicapi/faceswap-api-instantaneous-replaces-face-with-one-another)

The FaceSwap Image & Video API offers a straightforward solution for replacing faces in images and videos. With over 500% cost savings compared to other services, it is the most affordable and reliable option available. This face swap AI API enables seamless face swapping using simple HTTP POST requests, making it ideal for developers looking to integrate face-swapping functionality into their applications.

![image](https://blog.api.market/wp-content/uploads/2024/07/Faceswap_api_example.png)

### Key Features

* **High-quality face swapping technology:** Our API utilizes state-of-the-art algorithms to ensure seamless and realistic face swaps in both images and videos.
* **Easy integration:** Comprehensive documentation and straightforward implementation make integrating our API into your project quick and hassle-free.
* **Customization options:** Tailor the faceswap experience to suit your needs with customizable parameters for face detection, alignment, and blending.
* **Scalability and reliability:** Built to handle high volumes of requests with minimal latency, ensuring a smooth and reliable user experience.

### Benefits

* Create hilarious memes, captivating social media content, and personalized experiences for your users.
* Add fun filters to your mobile app, create entertaining videos for your social media platforms, or enhance your marketing campaigns with interactive experiences.

#### Description

The FaceSwap Image & Video API provides developers with the ability to perform face swaps in both images and videos with minimal effort. By leveraging the power of HTTP POST requests, this top face-swap API allows you to specify target and swap URLs to perform the face-swapping operation. The service is designed to be highly reliable and affordable, ensuring that developers can integrate face-swapping features without worrying about excessive costs.

**Key Features:**

* **Image Face Swap**: Replace faces in images using a simple POST request with the best face swap API.
* **Video Face Swap**: Perform face swaps in videos seamlessly with our video face swap API.
* **Cost-Effective**: Over 500% cheaper than other face-swapping APIs.
* **Easy Integration**: Simple HTTP POST requests for quick and easy integration.
* **Reliable Service**: Consistent and dependable performance.

![image](https://blog.api.market/wp-content/uploads/2024/07/Faceswap_example_api.market.png)

#### How to Use

**Image Face Swap:**

1. **Endpoint**: `https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image`
2. **Method**: POST
3. **Headers**:
   * `accept: application/json`
   * `x-api-market-key: YOUR_API_KEY`
   * `Content-Type: application/x-www-form-urlencoded`
4. **Data**:
   * `target_url`: URL of the image in which the face needs to be swapped.
   * `swap_url`: URL of the image containing the face to be swapped in.

**Example Request:**

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'target_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg&swap_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
```

**Video Face Swap:**

1. **Endpoint**: `https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video`
2. **Method**: POST
3. **Headers**:
   * `accept: application/json`
   * `x-api-market-key: YOUR_API_KEY`
   * `Content-Type: application/x-www-form-urlencoded`
4. **Data**:
   * `target_url`: URL of the video in which the face needs to be swapped.
   * `swap_url`: URL of the image containing the face to be swapped in.

**Example Request:**

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'target_url=https://storage.ws.pho.to/s2/7e2131eaef5e5cbb0d2c9eef7e2f19343b5a1292.mp4&swap_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
```

**Retrieve Face Swap Result:**

1. **Endpoint**: `https://prod.api.market/api/v1/capix/faceswap/result/`
2. **Method**: POST
3. **Headers**:
   * `accept: application/json`
   * `x-api-market-key: YOUR_API_KEY`
   * `Content-Type: application/x-www-form-urlencoded`
4. **Data**:
   * `request_id`: The unique request ID received after initiating the face swap.

**Example Request:**

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/faceswap/result/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: YOUR_API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'request_id=16bbe697-1323-4ead-9104-30a65ba52149'
```

![image](https://telegra.ph/file/8df15175c95a5b6793840.jpg)

**Note:** The Video Faceswap API is limited to a maximum duration of 4 seconds, even on premium or other plans. Additionally, this API cannot be used for any NSFW content or images, as that violates our policy.

By following these steps, developers can easily integrate face-swapping functionality into their applications using the FaceSwap API. Whether you need an image face swap API, video face swap API, or even a free face swap API for trial purposes, this service provides the most reliable and cost-effective solution on the market.

![image](https://telegra.ph/file/8df15175c95a5b6793840.jpg)

### Image Process

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'target_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg&swap_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'target_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'swap_url': 'https://storage.ws.pho.to/s2/818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg',
}

response = requests.post('https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'target_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg&swap_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image',
  new URLSearchParams({
    'target_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'swap_url': 'https://storage.ws.pho.to/s2/818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/image', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'target_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'swap_url': 'https://storage.ws.pho.to/s2/818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
  })
});
```

{% endtab %}
{% endtabs %}

### Video Process

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'target_url=https://storage.ws.pho.to/s2/7e2131eaef5e5cbb0d2c9eef7e2f19343b5a1292.mp4&swap_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'target_url': 'https://storage.ws.pho.to/s2/7e2131eaef5e5cbb0d2c9eef7e2f19343b5a1292.mp4',
    'swap_url': 'https://storage.ws.pho.to/s2/818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg',
}

response = requests.post('https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'target_url=https://storage.ws.pho.to/s2/7e2131eaef5e5cbb0d2c9eef7e2f19343b5a1292.mp4&swap_url=https%3A%2F%2Fstorage.ws.pho.to%2Fs2%2F818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video',
  new URLSearchParams({
    'target_url': 'https://storage.ws.pho.to/s2/7e2131eaef5e5cbb0d2c9eef7e2f19343b5a1292.mp4',
    'swap_url': 'https://storage.ws.pho.to/s2/818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/faceswap/faceswap/v1/video', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'target_url': 'https://storage.ws.pho.to/s2/7e2131eaef5e5cbb0d2c9eef7e2f19343b5a1292.mp4',
    'swap_url': 'https://storage.ws.pho.to/s2/818f3e408ee37c090cf23a3d12e15a08ada80ad9_m.jpeg'
  })
});
```

{% endtab %}
{% endtabs %}

### Get Result

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/faceswap/result/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'request_id=16bbe697-1323-4ead-9104-30a65ba52149'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'request_id': 'REQUEST_ID',
}

response = requests.post('https://prod.api.market/api/v1/capix/faceswap/result/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/faceswap/result/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'request_id=REQUEST_ID');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/faceswap/result/',
  new URLSearchParams({
    'request_id': 'REQUEST_ID'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javscript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/faceswap/result/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'request_id': 'REQUEST_ID'
  })
});
```

{% endtab %}
{% endtabs %}

### ⚠️ Please use this API instead! <a href="#please-use-this-api-instead" id="please-use-this-api-instead"></a>

Capix has decided to shut down this on 21st May 2025. To help our customers, we have released a compatible FaceSwap API built by engineers at API.market. Please reach out to support for any questions or help.\
\
[**Please instead use the API at: MagicAPI FaceSwap-Capix API (https://api.market/store/magicapi/faceswap-capix)**](https://api.market/store/magicapi/faceswap-capix)


# MakeUp

This API is perfect for enhancing portraits, making them look beautiful and natural with just a few clicks.

#### [Try Demo](https://api.market/store/capix/makeup)

### Endpoints

#### 1. Makeup

* **Endpoint**: `/makeup/v1/addtask`
* **Method**: POST
* **Summary**: Perform makeup operations on an image.
* **Request Body**:
  * `image_url`: URL of the image to be processed
  * `use_skin_healing`: Enable skin healing feature (default: true)
  * `use_eyes_enhancement`: Enable eye enhancement feature (default: true)
  * `use_teeth_whitening`: Enable teeth whitening feature (default: true)
  * `use_portrait_filters`: Enable portrait filters feature (default: true)
  * `use_flash_healing`: Enable flash healing feature (default: true)
  * `use_wrinkles_healing`: Enable wrinkle healing feature (default: true)
  * `use_skin_color_corrector`: Enable skin color correction feature (default: true)

#### 2. Effect

* **Endpoint**: `/makeup/v1/effect/addtask`
* **Method**: POST
* **Summary**: Apply various effects to an image.
* **Request Body**:
  * `image_url`: URL of the image to apply effects to
  * `effect`: Specify the effect to apply. Choose from a list of effects.

#### 3. Result

* **Endpoint**: `/makeup/v1/result`
* **Method**: POST
* **Summary**: Get the result of makeup or effect processing.
* **Request Body**:
  * `request_id`: ID of the request to retrieve the result

Here's a description of the effects:

Color effects: `None`, `Dreamy Retro`, `Sunny Retro`, `Poster Look`, `Fantasy Blue`, `Caramel Haze`, `Retro Sepia`, `Bronze Sepia`, `Dramatic Look`, `Hot Sunset`, `Dramatic Retro`, `Hdr`.

Stylized effects: `None`, `Vintage Card`, `Soft Lilac`, `Vignetting`, `Rain Drops`, `Old Style BW`, `Old Photo`, `Sweet Caramel`, `Retro Film`, `Dramatic Bronze`, `Rainbow Sketch`, `Triptych Effect`, `Rain Effect`, `Snow Effect`.

Backgrounds: `None`, `Dreams of Love`, `Dreams of Paris`, `Lilac Dreams`, `Light Bokeh`, `Flower Dream`, `Sunny Field`, `Frozen Window`, `Dreamlike Scenery`, `Tropical Butterflies`, `Maple Leaves`, `Old Cityscape`, `Old Street Frame`, `Christmas Bokeh`, `In the Wave`, `Magic Snowflakes`, `Industrial`, `Stylish Snakeskin`, `Winter Scenery`.

Lighting effects: `None`, `Rainbow Rays`, `Romantic Landscape`, `Mysterious Rays`, `Dawn Light`, `Floodlights`, `Evening Light`, `Moon Night`.

### Results <a href="#results" id="results"></a>

<figure><img src="https://i.imgur.com/WLEW4M1.png" alt=""><figcaption></figcaption></figure>

Color Enhancement

<figure><img src="https://i.imgur.com/J0L2FQc.jpeg" alt=""><figcaption></figcaption></figure>

Skin Makeup

<figure><img src="https://i.imgur.com/SIpYAf8.png" alt=""><figcaption></figcaption></figure>

Shine Remove

<figure><img src="https://i.imgur.com/WxSARXw.png" alt=""><figcaption></figcaption></figure>

Wrinkle Smooth

<figure><img src="https://i.imgur.com/31ROSRR.png" alt=""><figcaption></figcaption></figure>

Red Eye Remove

<figure><img src="https://i.imgur.com/yN0kXVl.png" alt=""><figcaption></figcaption></figure>

Teeth Whitining&#x20;

<figure><img src="https://i.imgur.com/lB79SK9.png" alt=""><figcaption></figcaption></figure>

Glamour Effect

### Code Snippets <a href="#code-snippets" id="code-snippets"></a>

**MakeUp**

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/makeup/makeup/v1/addtask' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fd0cf3f2b22461f5fcb2a1.png&use_skin_healing=true&use_eyes_enhancement=true&use_teeth_whitening=true&use_portrait_filters=true&use_flash_healing=true&use_wrinkles_healing=true&use_skin_color_corrector=true'
```

**Effect**

```sh
curl -X 'POST' \
  'https://prod.api.market /api/v1/capix/makeup/makeup/v1/effect/addtask' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fd0cf3f2b22461f5fcb2a1.png&effect=Dreamy%20Retro'
```

**Result**

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/makeup/makeup/v1/result' \
  -H 'accept: application/json' \
  -H 'x-api.market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'request_id=REQUEST_ID'
```


# Photolab.me

[Try Demo](https://api.market/store/capix/photolab)

### About API <a href="#about-api" id="about-api"></a>

Photolab.me API is a powerful tool that allows developers to easily integrate a suite of advanced image processing features into their applications. With this API, users can transform their photos into stunning works of art, apply various filters, enhance colors, adjust brightness and contrast, and perform many other image manipulations with just a few lines of code.

***

{% hint style="warning" %}
Note: It is unofficial api of Photolab.me but we guarantene it works well and fast without any blocks and problems.
{% endhint %}

***

### Result <a href="#result" id="result"></a>

<figure><img src="https://telegra.ph/file/95b5632f3aa2aafec3628.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://telegra.ph/file/c8e5629fe73b197296e01.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://telegra.ph/file/a4a818a7008c9b51a4ba7.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://telegra.ph/file/e5e2397d0c2c543aa0515.png" alt=""><figcaption></figcaption></figure>

### Details <a href="#details" id="details"></a>

**1. Apply PhotoLab Effect - Version 1**

This endpoint is used to apply a specific PhotoLab effect to an image using a combo ID.

* **Endpoint**: `https://prod.api.market/api/v1/capix/photolab/photolab/v1/`
* **Method**: `POST`
* **Request Headers**:
  * `Content-Type: application/json`
  * `x-api-market-key: API_TOKEN`
* **Request Body**:

  ```
  {
    "image_url": "URL_OF_IMAGE",
    "combo_id": "COMBO_ID"
  }
  ```

**Parameters:**

* `image_url`: URL of the image to which the effect will be applied.
* `combo_id`: ID of the specific PhotoLab effect to apply.

**2. Apply PhotoLab Effect - Version 2**

Similar to Version 1, this endpoint allows users to apply a specific PhotoLab effect to an image using a combo ID.

* **Endpoint**: `https://prod.api.market/api/v1/capix/photolab/photolab/v2/`
* **Method**: `POST`
* **Request Headers**:
  * `Content-Type: application/json`
  * `x-api-market-key: API_TOKEN`
* **Request Body**:

  ```
  {
    "image_url": "URL_OF_IMAGE",
    "combo_id": "COMBO_ID"
  }
  ```

**Parameters:**

* `image_url`: URL of the image to which the effect will be applied.
* `combo_id`: ID of the specific PhotoLab effect to apply.

**3. Get PhotoLab Result**

This endpoint retrieves the result of a PhotoLab editing request based on the provided request ID.

* **Endpoint**: `https://prod.api.market/api/v1/capix/photolab/result/`
* **Method**: `POST`
* **Request Headers**:
  * `Content-Type: application/json`
  * `x-api-market-key: API_TOKEN`
* **Request Body**:

  ```
  {
    "request_id": "REQUEST_ID"
  }
  ```

**Parameters:**

* `request_id`: ID of the PhotoLab editing request for which the result is requested.

### Code snippets <a href="#code-snippets" id="code-snippets"></a>

**V1 with watermark**

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  -H 'Content-Type: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -d '{
    "image_url": "https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg",
    "combo_id": "23131838"
}' \
  'https://prod.api.market/api/v1/capix/photolab/photolab/v1/'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'Content-Type': 'application/json',
    'x-api-market-key': 'API_KEY',
}

json_data = {
    'image_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'combo_id': '23131838',
}

response = requests.post('https://prod.api.market/api/v1/capix/photolab/photolab/v1/', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/photolab/photolab/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'x-api-market-key: API_KEY',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n    \"image_url\": \"https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg\",\n    \"combo_id\": \"23131838\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/photolab/photolab/v1/',
  {
    'image_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'combo_id': '23131838'
  },
  {
    headers: {
      'Content-Type': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```java
fetch('https://prod.api.market/api/v1/capix/photolab/photolab/v1/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: JSON.stringify({
    'image_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'combo_id': '23131838'
  })
});
```

{% endtab %}
{% endtabs %}

**V2 without watermark**

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  -H 'Content-Type: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -d '{
    "image_url": "https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg",
    "combo_id": "23131838"
}' \
  'https://prod.api.market/api/v1/capix/photolab/photolab/v2/'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'Content-Type': 'application/json',
    'x-api-market-key': 'API_KEY',
}

json_data = {
    'image_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'combo_id': '23131838',
}

response = requests.post('https://prod.api.market/api/v1/capix/photolab/photolab/v2/', headers=headers, json=json_data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/photolab/photolab/v2/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'x-api-market-key: API_KEY',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n    \"image_url\": \"https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg\",\n    \"combo_id\": \"23131838\"\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/photolab/photolab/v2/',
  {
    'image_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'combo_id': '23131838'
  },
  {
    headers: {
      'Content-Type': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/photolab/photolab/v2/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: JSON.stringify({
    'image_url': 'https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg',
    'combo_id': '23131838'
  })
});
```

{% endtab %}
{% endtabs %}

**Result**

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  -H 'Content-Type: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -d '{
    "request_id": REQUEST_ID
}' \
  'https://prod.api.market/api/v1/capix/photolab/result/'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'Content-Type': 'application/json',
    'x-api-market-key': 'API_KEY',
}

data = '{\n    "request_id": REQUEST_ID\n}'

response = requests.post('https://prod.api.market/api/v1/capix/photolab/result/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/photolab/result/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'x-api-market-key: API_KEY',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "{\n    \"request_id\": REQUEST_ID\n}");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/photolab/result/',
  '{\n    "request_id": REQUEST_ID\n}',
  {
    headers: {
      'Content-Type': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/photolab/result/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: '{\n    "request_id": REQUEST_ID\n}'
});
```

{% endtab %}
{% endtabs %}

### Trending Combos <a href="#combo-ids" id="combo-ids"></a>

* <https://photolab.me/d/37890916>
* <https://photolab.me/d/38097826>
* <https://photolab.me/d/38105326>
* <https://photolab.me/d/38062877>
* <https://photolab.me/d/37978636>
* <https://photolab.me/d/37983184>

| Original                                                            | Result                                                              | Combo id |
| ------------------------------------------------------------------- | ------------------------------------------------------------------- | -------- |
| <img src="/files/zxPCFMGJwTGlGyojxSh9" alt="" data-size="original"> | <img src="/files/9wZa73a2eQx7fkdN7WHk" alt="" data-size="original"> | 37890916 |
| <img src="/files/1MahIMxRER5C0RQi6ei8" alt="" data-size="original"> | <img src="/files/VF1WiXRaPP4s6YhOCpc5" alt="" data-size="original"> | 38097826 |
| <img src="/files/gbjqWLkKBFSxBikz4FYw" alt="" data-size="original"> | <img src="/files/zqzi7V1TybWjTLUfOtw8" alt="" data-size="original"> | 38105326 |
| <img src="/files/6h18Qz3g5aRXWCKsjj5s" alt="" data-size="original"> | <img src="/files/lfZ0niR58QVW7CvkmwXs" alt="" data-size="original"> | 37978636 |
| <img src="/files/V0eQbpOyR5Jnd0F98fqW" alt="" data-size="original"> | <img src="/files/f6wazUgmi5JlsSmgKdQx" alt="" data-size="original"> | 37983184 |

### Combo IDs <a href="#combo-ids" id="combo-ids"></a>

When interacting with the PhotoLab API, one of the fundamental steps is identifying and choosing a suitable combo ID. These combo IDs serve as unique identifiers for specific image editing combinations. To locate these IDs, you'll need to navigate to the PhotoLab website at <https://photolab.me/>.

Upon reaching the PhotoLab website, you'll encounter a plethora of image filters and editing options available for exploration. Each filter or editing combination is associated with a distinct combo ID. To illustrate, let's consider the example of visiting the page <https://photolab.me/d/31153495>.

As you land on this page, you'll notice various filters, effects, and editing tools showcased, each contributing to a unique visual outcome. Among these elements, the combo ID is prominently displayed as 31153495. This alphanumeric code serves as the key to accessing and applying the specific editing combination represented on this page.

***

{% hint style="warning" %}
Note: However, all combo ids are not supported directly. Photolab is growing fast and it develops AI based filters which means it is not supported in our API service system yet. You can check combo ids first before making your final decision.
{% endhint %}


# AI Picture Colorizer

Colorizes old grayscale images based on AI

#### [Try Demo](https://api.market/store/capix/colorizer)

### About API <a href="#about-api" id="about-api"></a>

This endpoint colorizes a grayscale image provided by its URL.

**Endpoint**

```sh
POST /capix/colorizer/colorize/v1/
```

**Request Headers**

* Content-Type: application/json
* token: API\_TOKEN (Replace API\_TOKEN with your actual API token)

**Request Body**

```json
{
  "image_url": "https://w0.peakpx.com/wallpaper/300/84/HD-wallpaper-vintage-view-of-old-main-street-trolleys-grayscale-town-tracks-street-vintage.jpg"
}
```

* **image\_url** (string, required): The URL of the grayscale image to be colorized.

**Response**

The response will contain the colorized version of the input image.

***

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/colorizer/colorize/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=IMAGE_URL'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'image_url': 'IMAGE_URL',
}

response = requests.post('https://prod.api.market/api/v1/capix/colorizer/colorize/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/colorizer/colorize/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'image_url=IMAGE_URL');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/colorizer/colorize/v1/',
  new URLSearchParams({
    'image_url': 'IMAGE_URL'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/colorizer/colorize/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'image_url': 'IMAGE_URL'
  })
});
```

{% endtab %}
{% endtabs %}

### Results

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

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

<figure><img src="/files/9e5FoGiBqlppiz8gOJK5" alt=""><figcaption></figcaption></figure>


# AI Picture Upscaler

Upscales and enhances images by AI

#### [Try Demo](https://api.market/store/capix/upscaler)

### Details <a href="#details" id="details"></a>

**Endpoints**

**1. Upscaler v1**

This endpoint is used to upscale images using version 1 of the upscaling algorithm.

* **URL:** `https://prod.api.market/api/v1/capix/upscaler/upscaler/v1/`
* **Method:** `POST`
* **Request Body:**

```json
{
  "scale": 2,
  "image_url": "https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg"
}
```

* **Response:** The response will contain the upscaled image data.

Example cURL request:

**2. Upscaler v2**

This endpoint is used to upscale images using version 2 of the upscaling algorithm.

* **URL:** `https://prod.api.market/api/v1/capix/upscaler/upscaler/v2/`
* **Method:** `POST`
* **Request Body:**

```json
{
  "scale": 2,
  "image_url": "https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg"
}
```

* **Response:** The response will contain the upscaled image data.

### Result <a href="#result" id="result"></a>

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

### Code Examples <a href="#code-examples" id="code-examples"></a>

**Version 1**

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/upscaler/upscaler/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'scale=2&image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fd0cf3f2b22461f5fcb2a1.png'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'scale': '2',
    'image_url': 'https://telegra.ph/file/d0cf3f2b22461f5fcb2a1.png',
}

response = requests.post('https://prod.api.market/api/v1/capix/upscaler/upscaler/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/upscaler/upscaler/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'scale=2&image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fd0cf3f2b22461f5fcb2a1.png');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/upscaler/upscaler/v1/',
  new URLSearchParams({
    'scale': '2',
    'image_url': 'https://telegra.ph/file/d0cf3f2b22461f5fcb2a1.png'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/upscaler/upscaler/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key  },
  body: new URLSearchParams({
    'scale': '2',
    'image_url': 'https://telegra.ph/file/d0cf3f2b22461f5fcb2a1.png'
  })
});
```

{% endtab %}
{% endtabs %}

**Version 2**

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/upscaler/upscaler/v2/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'scale=2&image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fd0cf3f2b22461f5fcb2a1.png'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'scale': '2',
    'image_url': 'https://telegra.ph/file/d0cf3f2b22461f5fcb2a1.png',
}

response = requests.post('https://prod.api.market/api/v1/capix/upscaler/upscaler/v2/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/upscaler/upscaler/v2/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'scale=2&image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fd0cf3f2b22461f5fcb2a1.png');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/upscaler/upscaler/v2/',
  new URLSearchParams({
    'scale': '2',
    'image_url': 'https://telegra.ph/file/d0cf3f2b22461f5fcb2a1.png'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/upscaler/upscaler/v2/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'scale': '2',
    'image_url': 'https://telegra.ph/file/d0cf3f2b22461f5fcb2a1.png'
  })
});
```

{% endtab %}
{% endtabs %}


# AI Background Remover

Background Remover API from Images

[Try Demo](https://api.market/store/capix/rembg)

### Details <a href="#details" id="details"></a>

**Endpoint**

```bash
POST https://prod.api.market/api/v1/capix/rembg/rembg
```

**Request Headers**

* Content-Type: application/json
* x-api-market-key: API\_TOKEN

**Request Body**

```json
{
  "image_url": "https://storage.ws.pho.to/s2/7aa4876bc1f50bc92fc54cb3c326181ac5bbf5ef_m.jpeg"
}
```

* image\_url: URL of the image for which the background needs to be removed.

### Result <a href="#result" id="result"></a>

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

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

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/rembg/rembg' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2F46a973ad6ff03f32b40a0.png'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'image_url': 'https://telegra.ph/file/46a973ad6ff03f32b40a0.png',
}

response = requests.post('https://prod.api.market/api/v1/capix/rembg/rembg', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/rembg/rembg');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2F46a973ad6ff03f32b40a0.png');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/rembg/rembg',
  new URLSearchParams({
    'image_url': 'https://telegra.ph/file/46a973ad6ff03f32b40a0.png'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/rembg/rembg', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'image_url': 'https://telegra.ph/file/46a973ad6ff03f32b40a0.png'
  })
});
```

{% endtab %}
{% endtabs %}


# Object Remover

Inpaints selected parts of the images

[Try Demo](https://api.market/store/capix/inpainting)

### Details <a href="#details" id="details"></a>

**Endpoint**

```bash
POST https://prod.api.market/api/v1/capix/inpainting/inpainting
```

**Request Headers**

* Content-Type: application/json
* x-api-market-key: API\_TOKEN

**Request Body**

```json
{
  "image_url": "https://telegra.ph/file/1dbd57f8abf95e6ae2911.png",
  "mask_url": "https://telegra.ph/file/2402e4a3dd551cc0bca33.png"
}
```

* image\_url: URL of the image for which inpainting will be performed.
* mask\_url: URL of the mask image indicating areas to be inpainted.

### Result <a href="#result" id="result"></a>

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

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/inpainting/inpainting' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2F1dbd57f8abf95e6ae2911.png&mask_url=https%3A%2F%2Ftelegra.ph%2Ffile%2F2402e4a3dd551cc0bca33.png'
```

{% endtab %}

{% tab title="Python" %}

```python
fetch('https://prod.api.market/api/v1/capix/inpainting/inpainting', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'image_url': 'https://telegra.ph/file/1dbd57f8abf95e6ae2911.png',
    'mask_url': 'https://telegra.ph/file/2402e4a3dd551cc0bca33.png'
  })
});
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/inpainting/inpainting');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2F1dbd57f8abf95e6ae2911.png&mask_url=https%3A%2F%2Ftelegra.ph%2Ffile%2F2402e4a3dd551cc0bca33.png');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/inpainting/inpainting',
  new URLSearchParams({
    'image_url': 'https://telegra.ph/file/1dbd57f8abf95e6ae2911.png',
    'mask_url': 'https://telegra.ph/file/2402e4a3dd551cc0bca33.png'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/inpainting/inpainting', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'image_url': 'https://telegra.ph/file/1dbd57f8abf95e6ae2911.png',
    'mask_url': 'https://telegra.ph/file/2402e4a3dd551cc0bca33.png'
  })
});
```

{% endtab %}
{% endtabs %}


# TTS Universal

Text To Speech API, more than 700+ AI voices

[Try Demo](https://api.market/store/capix/tts)

### Details <a href="#details" id="details"></a>

This API allows users to convert text into speech using various voices and services.

* **Base URL**: `https://prod.api.market/api/v1/capix/tts/tts/v1/`

**Request**

* **Method**: POST
* **Content Type**: application/json
* **Headers**:
  * Content-Type: application/json
  * x-api-market-key: API\_KEY

**Request Body**

```json
{
  "text": "Hello, what is your name ?",
  "voice_indentifier": "en-US_Matthew",
  "tts_service": "polly"
}
```

* **text** (string, required): The text to be converted into speech.
* **voice\_indentifier** (string, required): The identifier for the voice to be used. Format: `<language code>_<voice name>`. Example: `en-US_Matthew`.
* **tts\_service** (string, required): The TTS service to be used. Currently supported service is "polly".

### Result <a href="#result" id="result"></a>

{% file src="/files/hm2SnP11ysBwTzMkMACy" %}

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="Curl" %}

```sh
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/tts/tts/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'text=Hello%2C%20what%20is%20your%20name%20%3F&voice_indentifier=en-US_Matthew&tts_service=polly'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'text': 'Hello, what is your name ?',
    'voice_indentifier': 'en-US_Matthew',
    'tts_service': 'polly',
}

response = requests.post('https://prod.api.market/api/v1/capix/tts/tts/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/tts/tts/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'text=Hello%2C%20what%20is%20your%20name%20%3F&voice_indentifier=en-US_Matthew&tts_service=polly');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/tts/tts/v1/',
  new URLSearchParams({
    'text': 'Hello, what is your name ?',
    'voice_indentifier': 'en-US_Matthew',
    'tts_service': 'polly'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/tts/tts/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'text': 'Hello, what is your name ?',
    'voice_indentifier': 'en-US_Matthew',
    'tts_service': 'polly'
  })
});
```

{% endtab %}
{% endtabs %}

### Languages <a href="#languages" id="languages"></a>

| Name                 | Voice Type | Gender | Language                      | Voice Identifier        | TTS Service |
| -------------------- | ---------- | ------ | ----------------------------- | ----------------------- | ----------- |
| Matthew (Standard)   | Standard   | Male   | English (US)                  | en-US\_Matthew          | polly       |
| Joey (Standard)      | Standard   | Male   | English (US)                  | en-US\_Joey             | polly       |
| Jenny                | Premium    | Female | English (US)                  | en-US-JennyNeural       | azure       |
| Amber                | Premium    | Female | English (US)                  | en-US-AmberNeural       | azure       |
| Aria                 | Premium    | Female | English (US)                  | en-US-AriaNeural        | azure       |
| Brandon              | Premium    | Male   | English (US)                  | en-US-BrandonNeural     | azure       |
| Cora                 | Premium    | Female | English (US)                  | en-US-CoraNeural        | azure       |
| Eric                 | Premium    | Male   | English (US)                  | en-US-EricNeural        | azure       |
| Michelle             | Premium    | Female | English (US)                  | en-US-MichelleNeural    | azure       |
| Sara                 | Premium    | Female | English (US)                  | en-US-SaraNeural        | azure       |
| en-US-Wavenet-B      | Standard   | MALE   | English (US)                  | en-US-Wavenet-B         | wavenet     |
| en-US-Wavenet-D      | Standard   | MALE   | English (US)                  | en-US-Wavenet-D         | wavenet     |
| en-US-Wavenet-F      | Standard   | FEMALE | English (US)                  | en-US-Wavenet-F         | wavenet     |
| en-US-Wavenet-H      | Standard   | FEMALE | English (US)                  | en-US-Wavenet-H         | wavenet     |
| en-US-Wavenet-J      | Standard   | MALE   | English (US)                  | en-US-Wavenet-J         | wavenet     |
| Jane                 | Premium    | Female | English (US)                  | en-US-JaneNeural        | azure       |
| Nancy                | Premium    | Female | English (US)                  | en-US-NancyNeural       | azure       |
| en-US-Standard-A     | Standard   | MALE   | English (US)                  | en-US-Standard-A        | wavenet     |
| en-US-Standard-C     | Standard   | FEMALE | English (US)                  | en-US-Standard-C        | wavenet     |
| en-US-Standard-E     | Standard   | FEMALE | English (US)                  | en-US-Standard-E        | wavenet     |
| en-US-Standard-G     | Standard   | FEMALE | English (US)                  | en-US-Standard-G        | wavenet     |
| en-US-Standard-I     | Standard   | MALE   | English (US)                  | en-US-Standard-I        | wavenet     |
| Amy (Standard)       | Standard   | Female | English (UK)                  | en-GB\_Amy              | polly       |
| Emma (Standard)      | Standard   | Female | English (UK)                  | en-GB\_Emma             | polly       |
| Abbi                 | Premium    | Female | English (UK)                  | en-GB-AbbiNeural        | azure       |
| Bella                | Premium    | Female | English (UK)                  | en-GB-BellaNeural       | azure       |
| Ethan                | Premium    | Male   | English (UK)                  | en-GB-EthanNeural       | azure       |
| Maisie               | Premium    | Female | English (UK)                  | en-GB-MaisieNeural      | azure       |
| Olivia               | Premium    | Female | English (UK)                  | en-GB-OliviaNeural      | azure       |
| Sonia                | Premium    | Female | English (UK)                  | en-GB-SoniaNeural       | azure       |
| Mia                  | Premium    | Female | English (UK)                  | en-GB-MiaNeural         | azure       |
| Joanna (Standard)    | Standard   | Female | English (US)                  | en-US\_Joanna           | polly       |
| Salli (Standard)     | Standard   | Female | English (US)                  | en-US\_Salli            | polly       |
| Linda                | Premium    | Female | English (US)                  | en-US-Neural2-A         | wavenet     |
| Guy                  | Premium    | Male   | English (US)                  | en-US-GuyNeural         | azure       |
| Ana                  | Premium    | Female | English (US)                  | en-US-AnaNeural         | azure       |
| Ashley               | Premium    | Female | English (US)                  | en-US-AshleyNeural      | azure       |
| Christopher          | Premium    | Male   | English (US)                  | en-US-ChristopherNeural | azure       |
| Elizabeth            | Premium    | Female | English (US)                  | en-US-ElizabethNeural   | azure       |
| Jacob                | Premium    | Male   | English (US)                  | en-US-JacobNeural       | azure       |
| Monica               | Premium    | Female | English (US)                  | en-US-MonicaNeural      | azure       |
| en-US-Wavenet-A      | Standard   | MALE   | English (US)                  | en-US-Wavenet-A         | wavenet     |
| en-US-Wavenet-C      | Standard   | FEMALE | English (US)                  | en-US-Wavenet-C         | wavenet     |
| en-US-Wavenet-E      | Standard   | FEMALE | English (US)                  | en-US-Wavenet-E         | wavenet     |
| en-US-Wavenet-G      | Standard   | FEMALE | English (US)                  | en-US-Wavenet-G         | wavenet     |
| en-US-Wavenet-I      | Standard   | MALE   | English (US)                  | en-US-Wavenet-I         | wavenet     |
| Davis                | Premium    | Male   | English (US)                  | en-US-DavisNeural       | azure       |
| Jason                | Premium    | Male   | English (US)                  | en-US-JasonNeural       | azure       |
| Tony                 | Premium    | Male   | English (US)                  | en-US-TonyNeural        | azure       |
| en-US-Standard-B     | Standard   | MALE   | English (US)                  | en-US-Standard-B        | wavenet     |
| en-US-Standard-D     | Standard   | MALE   | English (US)                  | en-US-Standard-D        | wavenet     |
| en-US-Standard-F     | Standard   | FEMALE | English (US)                  | en-US-Standard-F        | wavenet     |
| en-US-Standard-H     | Standard   | FEMALE | English (US)                  | en-US-Standard-H        | wavenet     |
| en-US-Standard-J     | Standard   | MALE   | English (US)                  | en-US-Standard-J        | wavenet     |
| Brian (Standard)     | Standard   | Male   | English (UK)                  | en-GB\_Brian            | polly       |
| Isabella             | Premium    | Female | English (UK)                  | en-GB-Neural2-A         | azure       |
| Libby                | Premium    | Female | English (UK)                  | en-GB-LibbyNeural       | azure       |
| Alfie                | Premium    | Male   | English (UK)                  | en-GB-AlfieNeural       | azure       |
| Elliot               | Premium    | Male   | English (UK)                  | en-GB-ElliotNeural      | azure       |
| Hollie               | Premium    | Female | English (UK)                  | en-GB-HollieNeural      | azure       |
| Noah                 | Premium    | Male   | English (UK)                  | en-GB-NoahNeural        | azure       |
| Ryan                 | Premium    | Male   | English (UK)                  | en-GB-RyanNeural        | azure       |
| Thomas               | Premium    | Male   | English (UK)                  | en-GB-ThomasNeural      | azure       |
| en-GB-Standard-A     | Standard   | FEMALE | English (UK)                  | en-GB-Standard-A        | wavenet     |
| en-GB-Standard-B     | Standard   | MALE   | English (UK)                  | en-GB-Standard-B        | wavenet     |
| en-GB-Standard-D     | Standard   | MALE   | English (UK)                  | en-GB-Standard-D        | wavenet     |
| en-GB-Wavenet-A      | Standard   | FEMALE | English (UK)                  | en-GB-Wavenet-A         | wavenet     |
| en-GB-Wavenet-C      | Standard   | FEMALE | English (UK)                  | en-GB-Wavenet-C         | wavenet     |
| en-GB-Wavenet-F      | Standard   | FEMALE | English (UK)                  | en-GB-Wavenet-F         | wavenet     |
| Geraint (Standard)   | Standard   | Male   | English(Welsh)                | en-GB-WLS\_Geraint      | polly       |
| Aled                 | Premium    | Male   | Welsh (United Kingdom)        | cy-GB-AledNeural        | azure       |
| Mads (Standard)      | Standard   | Male   | Danish                        | da-DK\_Mads             | polly       |
| Christel             | Premium    | Female | Danish                        | da-DK-ChristelNeural    | azure       |
| da-DK-Standard-A     | Standard   | FEMALE | Danish                        | da-DK-Standard-A        | wavenet     |
| da-DK-Standard-D     | Standard   | FEMALE | Danish                        | da-DK-Standard-D        | wavenet     |
| da-DK-Wavenet-A      | Standard   | FEMALE | Danish                        | da-DK-Wavenet-A         | wavenet     |
| da-DK-Wavenet-D      | Standard   | FEMALE | Danish                        | da-DK-Wavenet-D         | wavenet     |
| Hans (Standard)      | Standard   | Male   | German (Germany)              | de-DE\_Hans             | polly       |
| Vicki (Standard)     | Standard   | Female | German (Germany)              | de-DE\_Vicki            | polly       |
| Amala                | Premium    | Female | German (Germany)              | de-DE-AmalaNeural       | azure       |
| Christoph            | Premium    | Male   | German (Germany)              | de-DE-ChristophNeural   | azure       |
| Elke                 | Premium    | Female | German (Germany)              | de-DE-ElkeNeural        | azure       |
| Kasper               | Premium    | Male   | German (Germany)              | de-DE-KasperNeural      | azure       |
| Klarissa             | Premium    | Female | German (Germany)              | de-DE-KlarissaNeural    | azure       |
| Louisa               | Premium    | Female | German (Germany)              | de-DE-LouisaNeural      | azure       |
| Ralf                 | Premium    | Male   | German (Germany)              | de-DE-RalfNeural        | azure       |
| de-DE-Standard-A     | Standard   | FEMALE | German (Germany)              | de-DE-Standard-A        | wavenet     |
| de-DE-Standard-C     | Standard   | FEMALE | German (Germany)              | de-DE-Standard-C        | wavenet     |
| de-DE-Standard-E     | Standard   | MALE   | German (Germany)              | de-DE-Standard-E        | wavenet     |
| de-DE-Wavenet-A      | Standard   | FEMALE | German (Germany)              | de-DE-Wavenet-A         | wavenet     |
| de-DE-Wavenet-C      | Standard   | FEMALE | German (Germany)              | de-DE-Wavenet-C         | wavenet     |
| de-DE-Wavenet-E      | Standard   | MALE   | German (Germany)              | de-DE-Wavenet-E         | wavenet     |
| Nicole (Standard)    | Standard   | Female | English (Australia)           | en-AU\_Nicole           | polly       |
| Johanna              | Premium    | Female | English (Australia)           | en-AU-Neural2-A         | wavenet     |
| Natasha              | Premium    | Female | English (Australia)           | en-AU-NatashaNeural     | azure       |
| en-AU-Standard-A     | Standard   | FEMALE | English (Australia)           | en-AU-Standard-A        | wavenet     |
| en-AU-Standard-C     | Standard   | FEMALE | English (Australia)           | en-AU-Standard-C        | wavenet     |
| en-AU-Wavenet-A      | Standard   | FEMALE | English (Australia)           | en-AU-Wavenet-A         | wavenet     |
| en-AU-Wavenet-C      | Standard   | FEMALE | English (Australia)           | en-AU-Wavenet-C         | wavenet     |
| Raveena (Standard)   | Standard   | Female | English (India)               | en-IN\_Raveena          | polly       |
| Prabhat              | Premium    | Male   | English (India)               | en-IN-PrabhatNeural     | azure       |
| en-IN-Standard-B     | Standard   | MALE   | English (India)               | en-IN-Standard-B        | wavenet     |
| en-IN-Standard-D     | Standard   | FEMALE | English (India)               | en-IN-Standard-D        | wavenet     |
| en-IN-Wavenet-B      | Standard   | MALE   | English (India)               | en-IN-Wavenet-B         | wavenet     |
| en-IN-Wavenet-D      | Standard   | FEMALE | English (India)               | en-IN-Wavenet-D         | wavenet     |
| Conchita (Standard)  | Standard   | Female | Spanish (Spain)               | es-ES\_Conchita         | polly       |
| Lucia (Standard)     | Standard   | Female | Spanish (Spain)               | es-ES\_Lucia            | polly       |
| Alvaro               | Premium    | Male   | Spanish (Spain)               | es-ES-AlvaroNeural      | azure       |
| es-ES-Standard-A     | Standard   | FEMALE | Spanish (Spain)               | es-ES-Standard-A        | wavenet     |
| es-ES-Standard-C     | Standard   | FEMALE | Spanish (Spain)               | es-ES-Standard-C        | wavenet     |
| es-ES-Wavenet-B      | Standard   | MALE   | Spanish (Spain)               | es-ES-Wavenet-B         | wavenet     |
| es-ES-Wavenet-C      | Standard   | FEMALE | Spanish (Spain)               | es-ES-Wavenet-C         | wavenet     |
| en-GB-Standard-C     | Standard   | FEMALE | English (UK)                  | en-GB-Standard-C        | wavenet     |
| en-GB-Standard-F     | Standard   | FEMALE | English (UK)                  | en-GB-Standard-F        | wavenet     |
| en-GB-Wavenet-B      | Standard   | MALE   | English (UK)                  | en-GB-Wavenet-B         | wavenet     |
| en-GB-Wavenet-D      | Standard   | MALE   | English (UK)                  | en-GB-Wavenet-D         | wavenet     |
| Oliver               | Premium    | Male   | English (UK)                  | en-GB-OliverNeural      | azure       |
| Gwyneth (Standard)   | Standard   | Female | Welsh (United Kingdom)        | cy-GB\_Gwyneth          | polly       |
| Nia                  | Premium    | Female | Welsh (United Kingdom)        | cy-GB-NiaNeural         | azure       |
| Naja (Standard)      | Standard   | Female | Danish                        | da-DK\_Naja             | polly       |
| Jeppe                | Premium    | Male   | Danish                        | da-DK-JeppeNeural       | azure       |
| da-DK-Standard-C     | Standard   | MALE   | Danish                        | da-DK-Standard-C        | wavenet     |
| da-DK-Standard-E     | Standard   | FEMALE | Danish                        | da-DK-Standard-E        | wavenet     |
| da-DK-Wavenet-C      | Standard   | MALE   | Danish                        | da-DK-Wavenet-C         | wavenet     |
| da-DK-Wavenet-E      | Standard   | FEMALE | Danish                        | da-DK-Wavenet-E         | wavenet     |
| Marlene (Standard)   | Standard   | Female | German (Germany)              | de-DE\_Marlene          | polly       |
| Katja                | Premium    | Female | German (Germany)              | de-DE-KatjaNeural       | azure       |
| Bernd                | Premium    | Male   | German (Germany)              | de-DE-BerndNeural       | azure       |
| Conrad               | Premium    | Male   | German (Germany)              | de-DE-ConradNeural      | azure       |
| Gisela               | Premium    | Female | German (Germany)              | de-DE-GiselaNeural      | azure       |
| Killian              | Premium    | Male   | German (Germany)              | de-DE-KillianNeural     | azure       |
| Klaus                | Premium    | Male   | German (Germany)              | de-DE-KlausNeural       | azure       |
| Maja                 | Premium    | Female | German (Germany)              | de-DE-MajaNeural        | azure       |
| Tanja                | Premium    | Female | German (Germany)              | de-DE-TanjaNeural       | azure       |
| de-DE-Standard-B     | Standard   | MALE   | German (Germany)              | de-DE-Standard-B        | wavenet     |
| de-DE-Standard-D     | Standard   | MALE   | German (Germany)              | de-DE-Standard-D        | wavenet     |
| de-DE-Standard-F     | Standard   | FEMALE | German (Germany)              | de-DE-Standard-F        | wavenet     |
| de-DE-Wavenet-B      | Standard   | MALE   | German (Germany)              | de-DE-Wavenet-B         | wavenet     |
| de-DE-Wavenet-D      | Standard   | MALE   | German (Germany)              | de-DE-Wavenet-D         | wavenet     |
| de-DE-Wavenet-F      | Standard   | FEMALE | German (Germany)              | de-DE-Wavenet-F         | wavenet     |
| Russell (Standard)   | Standard   | Male   | English (Australia)           | en-AU\_Russell          | polly       |
| William              | Premium    | Male   | English (Australia)           | en-AU-WilliamNeural     | azure       |
| en-AU-Standard-B     | Standard   | MALE   | English (Australia)           | en-AU-Standard-B        | wavenet     |
| en-AU-Standard-D     | Standard   | MALE   | English (Australia)           | en-AU-Standard-D        | wavenet     |
| en-AU-Wavenet-B      | Standard   | MALE   | English (Australia)           | en-AU-Wavenet-B         | wavenet     |
| en-AU-Wavenet-D      | Standard   | MALE   | English (Australia)           | en-AU-Wavenet-D         | wavenet     |
| Neerja               | Premium    | Female | English (India)               | en-IN-NeerjaNeural      | azure       |
| en-IN-Standard-A     | Standard   | FEMALE | English (India)               | en-IN-Standard-A        | wavenet     |
| en-IN-Standard-C     | Standard   | MALE   | English (India)               | en-IN-Standard-C        | wavenet     |
| en-IN-Wavenet-A      | Standard   | FEMALE | English (India)               | en-IN-Wavenet-A         | wavenet     |
| en-IN-Wavenet-C      | Standard   | MALE   | English (India)               | en-IN-Wavenet-C         | wavenet     |
| Aditi (Standard)     | Standard   | Female | English (India)               | en-IN\_Aditi            | polly       |
| Enrique (Standard)   | Standard   | Male   | Spanish (Spain)               | es-ES\_Enrique          | polly       |
| Elvira               | Premium    | Female | Spanish (Spain)               | es-ES-ElviraNeural      | azure       |
| es-ES-Standard-B     | Standard   | MALE   | Spanish (Spain)               | es-ES-Standard-B        | wavenet     |
| es-ES-Standard-D     | Standard   | FEMALE | Spanish (Spain)               | es-ES-Standard-D        | wavenet     |
| es-ES-Wavenet-D      | Standard   | FEMALE | Spanish (Spain)               | es-ES-Wavenet-D         | wavenet     |
| Chantal (Standard)   | Standard   | Female | French (Canada)               | fr-CA\_Chantal          | polly       |
| Sylvie               | Premium    | Female | French (Canada)               | fr-CA-SylvieNeural      | azure       |
| Jean                 | Premium    | Male   | French (Canada)               | fr-CA-JeanNeural        | azure       |
| fr-CA-Standard-B     | Standard   | MALE   | French (Canada)               | fr-CA-Standard-B        | wavenet     |
| fr-CA-Standard-D     | Standard   | MALE   | French (Canada)               | fr-CA-Standard-D        | wavenet     |
| fr-CA-Wavenet-B      | Standard   | MALE   | French (Canada)               | fr-CA-Wavenet-B         | wavenet     |
| fr-CA-Wavenet-D      | Standard   | MALE   | French (Canada)               | fr-CA-Wavenet-D         | wavenet     |
| Mathieu (Standard)   | Standard   | Male   | French (France)               | fr-FR\_Mathieu          | polly       |
| Henri                | Premium    | Male   | French (France)               | fr-FR-HenriNeural       | azure       |
| fr-FR-Wavenet-B      | Standard   | MALE   | French (France)               | fr-FR-Wavenet-B         | wavenet     |
| fr-FR-Wavenet-D      | Standard   | MALE   | French (France)               | fr-FR-Wavenet-D         | wavenet     |
| Alain                | Premium    | Male   | French (France)               | fr-FR-AlainNeural       | azure       |
| Celeste              | Premium    | Female | French (France)               | fr-FR-CelesteNeural     | azure       |
| Coralie              | Premium    | Female | French (France)               | fr-FR-CoralieNeural     | azure       |
| Jacqueline           | Premium    | Female | French (France)               | fr-FR-JacquelineNeural  | azure       |
| Josephine            | Premium    | Female | French (France)               | fr-FR-JosephineNeural   | azure       |
| Yves                 | Premium    | Male   | French (France)               | fr-FR-YvesNeural        | azure       |
| fr-FR-Standard-A     | Standard   | FEMALE | French (France)               | fr-FR-Standard-A        | wavenet     |
| fr-FR-Standard-C     | Standard   | FEMALE | French (France)               | fr-FR-Standard-C        | wavenet     |
| fr-FR-Standard-E     | Standard   | FEMALE | French (France)               | fr-FR-Standard-E        | wavenet     |
| Karl (Standard)      | Standard   | Male   | Icelandic (Iceland)           | is-IS\_Karl             | polly       |
| Gunnar               | Premium    | Male   | Icelandic (Iceland)           | is-IS-GunnarNeural      | azure       |
| Carla (Standard)     | Standard   | Female | Italian                       | it-IT\_Carla            | polly       |
| Bianca (Standard)    | Standard   | Female | Italian                       | it-IT\_Bianca           | polly       |
| Isabella             | Premium    | Female | Italian                       | it-IT-IsabellaNeural    | azure       |
| Elsa                 | Premium    | Female | Italian                       | it-IT-ElsaNeural        | azure       |
| Calimero             | Premium    | Male   | Italian                       | it-IT-CalimeroNeural    | azure       |
| Fabiola              | Premium    | Female | Italian                       | it-IT-FabiolaNeural     | azure       |
| Gianni               | Premium    | Male   | Italian                       | it-IT-GianniNeural      | azure       |
| Irma                 | Premium    | Female | Italian                       | it-IT-IrmaNeural        | azure       |
| Palmira              | Premium    | Female | Italian                       | it-IT-PalmiraNeural     | azure       |
| Rinaldo              | Premium    | Male   | Italian                       | it-IT-RinaldoNeural     | azure       |
| it-IT-Standard-B     | Standard   | FEMALE | Italian                       | it-IT-Standard-B        | wavenet     |
| it-IT-Standard-D     | Standard   | MALE   | Italian                       | it-IT-Standard-D        | wavenet     |
| it-IT-Wavenet-B      | Standard   | FEMALE | Italian                       | it-IT-Wavenet-B         | wavenet     |
| it-IT-Wavenet-D      | Standard   | MALE   | Italian                       | it-IT-Wavenet-D         | wavenet     |
| Takumi (Standard)    | Standard   | Male   | Japanese                      | ja-JP\_Takumi           | polly       |
| Nanami               | Premium    | Female | Japanese                      | ja-JP-NanamiNeural      | azure       |
| ja-JP-Standard-A     | Standard   | FEMALE | Japanese                      | ja-JP-Standard-A        | wavenet     |
| ja-JP-Standard-C     | Standard   | MALE   | Japanese                      | ja-JP-Standard-C        | wavenet     |
| ja-JP-Wavenet-A      | Standard   | FEMALE | Japanese                      | ja-JP-Wavenet-A         | wavenet     |
| ja-JP-Wavenet-C      | Standard   | MALE   | Japanese                      | ja-JP-Wavenet-C         | wavenet     |
| Liv (Standard)       | Standard   | Female | Norwegian                     | nb-NO\_Liv              | polly       |
| Finn                 | Premium    | Male   | Norwegian                     | nb-NO-FinnNeural        | azure       |
| nb-NO-Standard-A     | Standard   | FEMALE | Norwegian                     | nb-NO-Standard-A        | wavenet     |
| nb-NO-Standard-C     | Standard   | FEMALE | Norwegian                     | nb-NO-Standard-C        | wavenet     |
| nb-NO-Wavenet-A      | Standard   | FEMALE | Norwegian                     | nb-NO-Wavenet-A         | wavenet     |
| nb-NO-Wavenet-C      | Standard   | FEMALE | Norwegian                     | nb-NO-Wavenet-C         | wavenet     |
| nb-no-Standard-E     | Standard   | FEMALE | Norwegian                     | nb-no-Standard-E        | wavenet     |
| Lotte (Standard)     | Standard   | Female | Dutch (Netherlands)           | nl-NL\_Lotte            | polly       |
| Colette              | Premium    | Female | Dutch (Netherlands)           | nl-NL-ColetteNeural     | azure       |
| Antoine              | Premium    | Male   | French (Canada)               | fr-CA-AntoineNeural     | azure       |
| fr-CA-Standard-A     | Standard   | FEMALE | French (Canada)               | fr-CA-Standard-A        | wavenet     |
| fr-CA-Standard-C     | Standard   | FEMALE | French (Canada)               | fr-CA-Standard-C        | wavenet     |
| fr-CA-Wavenet-A      | Standard   | FEMALE | French (Canada)               | fr-CA-Wavenet-A         | wavenet     |
| fr-CA-Wavenet-C      | Standard   | FEMALE | French (Canada)               | fr-CA-Wavenet-C         | wavenet     |
| Celine (Standard)    | Standard   | Female | French (France)               | fr-FR\_Celine           | polly       |
| Denise               | Premium    | Female | French (France)               | fr-FR-DeniseNeural      | azure       |
| fr-FR-Wavenet-A      | Standard   | FEMALE | French (France)               | fr-FR-Wavenet-A         | wavenet     |
| fr-FR-Wavenet-C      | Standard   | FEMALE | French (France)               | fr-FR-Wavenet-C         | wavenet     |
| fr-FR-Wavenet-E      | Standard   | FEMALE | French (France)               | fr-FR-Wavenet-E         | wavenet     |
| Brigitte             | Premium    | Female | French (France)               | fr-FR-BrigitteNeural    | azure       |
| Claude               | Premium    | Male   | French (France)               | fr-FR-ClaudeNeural      | azure       |
| Eloise               | Premium    | Female | French (France)               | fr-FR-EloiseNeural      | azure       |
| Jerome               | Premium    | Male   | French (France)               | fr-FR-JeromeNeural      | azure       |
| Maurice              | Premium    | Male   | French (France)               | fr-FR-MauriceNeural     | azure       |
| Yvette               | Premium    | Female | French (France)               | fr-FR-YvetteNeural      | azure       |
| fr-FR-Standard-B     | Standard   | MALE   | French (France)               | fr-FR-Standard-B        | wavenet     |
| fr-FR-Standard-D     | Standard   | MALE   | French (France)               | fr-FR-Standard-D        | wavenet     |
| Dora (Standard)      | Standard   | Female | Icelandic (Iceland)           | is-IS\_Dora             | polly       |
| Gudrun               | Premium    | Female | Icelandic (Iceland)           | is-IS-GudrunNeural      | azure       |
| is-is-Standard-A     | Standard   | FEMALE | Icelandic (Iceland)           | is-is-Standard-A        | wavenet     |
| Giorgio (Standard)   | Standard   | Male   | Italian                       | it-IT\_Giorgio          | polly       |
| Diego                | Premium    | Male   | Italian                       | it-IT-DiegoNeural       | azure       |
| Benigno              | Premium    | Male   | Italian                       | it-IT-BenignoNeural     | azure       |
| Cataldo              | Premium    | Male   | Italian                       | it-IT-CataldoNeural     | azure       |
| Fiamma               | Premium    | Female | Italian                       | it-IT-FiammaNeural      | azure       |
| Imelda               | Premium    | Female | Italian                       | it-IT-ImeldaNeural      | azure       |
| Lisandro             | Premium    | Male   | Italian                       | it-IT-LisandroNeural    | azure       |
| Pierina              | Premium    | Female | Italian                       | it-IT-PierinaNeural     | azure       |
| it-IT-Standard-A     | Standard   | FEMALE | Italian                       | it-IT-Standard-A        | wavenet     |
| it-IT-Standard-C     | Standard   | MALE   | Italian                       | it-IT-Standard-C        | wavenet     |
| it-IT-Wavenet-A      | Standard   | FEMALE | Italian                       | it-IT-Wavenet-A         | wavenet     |
| it-IT-Wavenet-C      | Standard   | MALE   | Italian                       | it-IT-Wavenet-C         | wavenet     |
| Mizuki (Standard)    | Standard   | Female | Japanese                      | ja-JP\_Mizuki           | polly       |
| Keita                | Premium    | Male   | Japanese                      | ja-JP-KeitaNeural       | azure       |
| ja-JP-Standard-B     | Standard   | FEMALE | Japanese                      | ja-JP-Standard-B        | wavenet     |
| ja-JP-Standard-D     | Standard   | MALE   | Japanese                      | ja-JP-Standard-D        | wavenet     |
| ja-JP-Wavenet-B      | Standard   | FEMALE | Japanese                      | ja-JP-Wavenet-B         | wavenet     |
| ja-JP-Wavenet-D      | Standard   | MALE   | Japanese                      | ja-JP-Wavenet-D         | wavenet     |
| Pernille             | Premium    | Female | Norwegian                     | nb-NO-PernilleNeural    | azure       |
| Iselin               | Premium    | Female | Norwegian                     | nb-NO-IselinNeural      | azure       |
| nb-NO-Standard-B     | Standard   | MALE   | Norwegian                     | nb-NO-Standard-B        | wavenet     |
| nb-NO-Standard-D     | Standard   | MALE   | Norwegian                     | nb-NO-Standard-D        | wavenet     |
| nb-NO-Wavenet-B      | Standard   | MALE   | Norwegian                     | nb-NO-Wavenet-B         | wavenet     |
| nb-NO-Wavenet-D      | Standard   | MALE   | Norwegian                     | nb-NO-Wavenet-D         | wavenet     |
| nb-no-Wavenet-E      | Standard   | FEMALE | Norwegian                     | nb-no-Wavenet-E         | wavenet     |
| Ruben (Standard)     | Standard   | Male   | Dutch (Netherlands)           | nl-NL\_Ruben            | polly       |
| Fenna                | Premium    | Female | Dutch (Netherlands)           | nl-NL-FennaNeural       | azure       |
| Maarten              | Premium    | Male   | Dutch (Netherlands)           | nl-NL-MaartenNeural     | azure       |
| nl-NL-Standard-B     | Standard   | MALE   | Dutch (Netherlands)           | nl-NL-Standard-B        | wavenet     |
| nl-NL-Standard-D     | Standard   | FEMALE | Dutch (Netherlands)           | nl-NL-Standard-D        | wavenet     |
| nl-NL-Wavenet-A      | Standard   | FEMALE | Dutch (Netherlands)           | nl-NL-Wavenet-A         | wavenet     |
| nl-NL-Wavenet-C      | Standard   | MALE   | Dutch (Netherlands)           | nl-NL-Wavenet-C         | wavenet     |
| nl-NL-Wavenet-E      | Standard   | FEMALE | Dutch (Netherlands)           | nl-NL-Wavenet-E         | wavenet     |
| Jacek (Standard)     | Standard   | Male   | Polish                        | pl-PL\_Jacek            | polly       |
| Maja (Standard)      | Standard   | Female | Polish                        | pl-PL\_Maja             | polly       |
| Marek                | Premium    | Male   | Polish                        | pl-PL-MarekNeural       | azure       |
| pl-PL-Standard-A     | Standard   | FEMALE | Polish                        | pl-PL-Standard-A        | wavenet     |
| pl-PL-Standard-C     | Standard   | MALE   | Polish                        | pl-PL-Standard-C        | wavenet     |
| pl-PL-Standard-E     | Standard   | FEMALE | Polish                        | pl-PL-Standard-E        | wavenet     |
| pl-PL-Wavenet-B      | Standard   | MALE   | Polish                        | pl-PL-Wavenet-B         | wavenet     |
| pl-PL-Wavenet-D      | Standard   | FEMALE | Polish                        | pl-PL-Wavenet-D         | wavenet     |
| Ricardo (Standard)   | Standard   | Male   | Portuguese (Brazil)           | pt-BR\_Ricardo          | polly       |
| Camila (Standard)    | Standard   | Female | Portuguese (Brazil)           | pt-BR\_Camila           | polly       |
| Antonio              | Premium    | Male   | Portuguese (Brazil)           | pt-BR-AntonioNeural     | azure       |
| Donato               | Premium    | Male   | Portuguese (Brazil)           | pt-BR-DonatoNeural      | azure       |
| Fabio                | Premium    | Male   | Portuguese (Brazil)           | pt-BR-FabioNeural       | azure       |
| Humberto             | Premium    | Male   | Portuguese (Brazil)           | pt-BR-HumbertoNeural    | azure       |
| Leila                | Premium    | Female | Portuguese (Brazil)           | pt-BR-LeilaNeural       | azure       |
| Manuela              | Premium    | Female | Portuguese (Brazil)           | pt-BR-ManuelaNeural     | azure       |
| Valerio              | Premium    | Male   | Portuguese (Brazil)           | pt-BR-ValerioNeural     | azure       |
| pt-BR-Standard-A     | Standard   | FEMALE | Portuguese (Brazil)           | pt-BR-Standard-A        | wavenet     |
| pt-BR-Wavenet-B      | Standard   | MALE   | Portuguese (Brazil)           | pt-BR-Wavenet-B         | wavenet     |
| Cristiano (Standard) | Standard   | Male   | Portuguese (Portugal)         | pt-PT\_Cristiano        | polly       |
| Duarte               | Premium    | Male   | Portuguese (Portugal)         | pt-PT-DuarteNeural      | azure       |
| Raquel               | Premium    | Female | Portuguese (Portugal)         | pt-PT-RaquelNeural      | azure       |
| pt-PT-Standard-B     | Standard   | MALE   | Portuguese (Portugal)         | pt-PT-Standard-B        | wavenet     |
| pt-PT-Standard-D     | Standard   | FEMALE | Portuguese (Portugal)         | pt-PT-Standard-D        | wavenet     |
| pt-PT-Wavenet-B      | Standard   | MALE   | Portuguese (Portugal)         | pt-PT-Wavenet-B         | wavenet     |
| pt-PT-Wavenet-D      | Standard   | FEMALE | Portuguese (Portugal)         | pt-PT-Wavenet-D         | wavenet     |
| Alina                | Premium    | Female | Romanian                      | ro-RO-AlinaNeural       | azure       |
| ro-RO-Standard-A     | Standard   | FEMALE | Romanian                      | ro-RO-Standard-A        | wavenet     |
| Maxim (Standard)     | Standard   | Male   | Russian                       | ru-RU\_Maxim            | polly       |
| Svetlana             | Premium    | Female | Russian                       | ru-RU-SvetlanaNeural    | azure       |
| Dmitry               | Premium    | Male   | Russian                       | ru-RU-DmitryNeural      | azure       |
| ru-RU-Standard-B     | Standard   | MALE   | Russian                       | ru-RU-Standard-B        | wavenet     |
| ru-RU-Standard-D     | Standard   | MALE   | Russian                       | ru-RU-Standard-D        | wavenet     |
| ru-RU-Wavenet-A      | Standard   | FEMALE | Russian                       | ru-RU-Wavenet-A         | wavenet     |
| ru-RU-Wavenet-C      | Standard   | FEMALE | Russian                       | ru-RU-Wavenet-C         | wavenet     |
| ru-RU-Wavenet-E      | Standard   | FEMALE | Russian                       | ru-RU-Wavenet-E         | wavenet     |
| Sofie                | Premium    | Female | Swedish                       | sv-SE-SofieNeural       | azure       |
| Mattias              | Premium    | Male   | Swedish                       | sv-SE-MattiasNeural     | azure       |
| sv-SE-Standard-B     | Standard   | FEMALE | Swedish                       | sv-SE-Standard-B        | wavenet     |
| sv-SE-Standard-D     | Standard   | MALE   | Swedish                       | sv-SE-Standard-D        | wavenet     |
| sv-SE-Wavenet-A      | Standard   | FEMALE | Swedish                       | sv-SE-Wavenet-A         | wavenet     |
| sv-SE-Wavenet-C      | Standard   | MALE   | Swedish                       | sv-SE-Wavenet-C         | wavenet     |
| sv-SE-Wavenet-E      | Standard   | MALE   | Swedish                       | sv-SE-Wavenet-E         | wavenet     |
| Ahmet                | Premium    | Male   | Turkish                       | tr-TR-AhmetNeural       | azure       |
| nl-NL-Standard-A     | Standard   | FEMALE | Dutch (Netherlands)           | nl-NL-Standard-A        | wavenet     |
| nl-NL-Standard-C     | Standard   | MALE   | Dutch (Netherlands)           | nl-NL-Standard-C        | wavenet     |
| nl-NL-Standard-E     | Standard   | FEMALE | Dutch (Netherlands)           | nl-NL-Standard-E        | wavenet     |
| nl-NL-Wavenet-B      | Standard   | MALE   | Dutch (Netherlands)           | nl-NL-Wavenet-B         | wavenet     |
| nl-NL-Wavenet-D      | Standard   | FEMALE | Dutch (Netherlands)           | nl-NL-Wavenet-D         | wavenet     |
| Ewa (Standard)       | Standard   | Female | Polish                        | pl-PL\_Ewa              | polly       |
| Jan (Standard)       | Standard   | Male   | Polish                        | pl-PL\_Jan              | polly       |
| Agnieszka            | Premium    | Female | Polish                        | pl-PL-AgnieszkaNeural   | azure       |
| Zofia                | Premium    | Female | Polish                        | pl-PL-ZofiaNeural       | azure       |
| pl-PL-Standard-B     | Standard   | MALE   | Polish                        | pl-PL-Standard-B        | wavenet     |
| pl-PL-Standard-D     | Standard   | FEMALE | Polish                        | pl-PL-Standard-D        | wavenet     |
| pl-PL-Wavenet-A      | Standard   | FEMALE | Polish                        | pl-PL-Wavenet-A         | wavenet     |
| pl-PL-Wavenet-C      | Standard   | MALE   | Polish                        | pl-PL-Wavenet-C         | wavenet     |
| pl-PL-Wavenet-E      | Standard   | FEMALE | Polish                        | pl-PL-Wavenet-E         | wavenet     |
| Vitoria (Standard)   | Standard   | Female | Portuguese (Brazil)           | pt-BR\_Vitoria          | polly       |
| Francisca            | Premium    | Female | Portuguese (Brazil)           | pt-BR-FranciscaNeural   | azure       |
| Brenda               | Premium    | Female | Portuguese (Brazil)           | pt-BR-BrendaNeural      | azure       |
| Elza                 | Premium    | Female | Portuguese (Brazil)           | pt-BR-ElzaNeural        | azure       |
| Giovanna             | Premium    | Female | Portuguese (Brazil)           | pt-BR-GiovannaNeural    | azure       |
| Julio                | Premium    | Male   | Portuguese (Brazil)           | pt-BR-JulioNeural       | azure       |
| Leticia              | Premium    | Female | Portuguese (Brazil)           | pt-BR-LeticiaNeural     | azure       |
| Nicolau              | Premium    | Male   | Portuguese (Brazil)           | pt-BR-NicolauNeural     | azure       |
| Yara                 | Premium    | Female | Portuguese (Brazil)           | pt-BR-YaraNeural        | azure       |
| pt-BR-Standard-B     | Standard   | MALE   | Portuguese (Brazil)           | pt-BR-Standard-B        | wavenet     |
| pt-BR-Wavenet-A      | Standard   | FEMALE | Portuguese (Brazil)           | pt-BR-Wavenet-A         | wavenet     |
| Ines (Standard)      | Standard   | Female | Portuguese (Portugal)         | pt-PT\_Ines             | polly       |
| Fernanda             | Premium    | Female | Portuguese (Portugal)         | pt-PT-FernandaNeural    | azure       |
| pt-PT-Standard-A     | Standard   | FEMALE | Portuguese (Portugal)         | pt-PT-Standard-A        | wavenet     |
| pt-PT-Standard-C     | Standard   | MALE   | Portuguese (Portugal)         | pt-PT-Standard-C        | wavenet     |
| pt-PT-Wavenet-A      | Standard   | FEMALE | Portuguese (Portugal)         | pt-PT-Wavenet-A         | wavenet     |
| pt-PT-Wavenet-C      | Standard   | MALE   | Portuguese (Portugal)         | pt-PT-Wavenet-C         | wavenet     |
| Carmen (Standard)    | Standard   | Female | Romanian                      | ro-RO\_Carmen           | polly       |
| Emil                 | Premium    | Male   | Romanian                      | ro-RO-EmilNeural        | azure       |
| ro-RO-Wavenet-A      | Standard   | FEMALE | Romanian                      | ro-RO-Wavenet-A         | wavenet     |
| Tatyana (Standard)   | Standard   | Female | Russian                       | ru-RU\_Tatyana          | polly       |
| Dariya               | Premium    | Female | Russian                       | ru-RU-DariyaNeural      | azure       |
| ru-RU-Standard-A     | Standard   | FEMALE | Russian                       | ru-RU-Standard-A        | wavenet     |
| ru-RU-Standard-C     | Standard   | FEMALE | Russian                       | ru-RU-Standard-C        | wavenet     |
| ru-RU-Standard-E     | Standard   | FEMALE | Russian                       | ru-RU-Standard-E        | wavenet     |
| ru-RU-Wavenet-B      | Standard   | MALE   | Russian                       | ru-RU-Wavenet-B         | wavenet     |
| ru-RU-Wavenet-D      | Standard   | MALE   | Russian                       | ru-RU-Wavenet-D         | wavenet     |
| Astrid (Standard)    | Standard   | Female | Swedish                       | sv-SE\_Astrid           | polly       |
| Hillevi              | Premium    | Female | Swedish                       | sv-SE-HilleviNeural     | azure       |
| sv-SE-Standard-A     | Standard   | FEMALE | Swedish                       | sv-SE-Standard-A        | wavenet     |
| sv-SE-Standard-C     | Standard   | FEMALE | Swedish                       | sv-SE-Standard-C        | wavenet     |
| sv-SE-Standard-E     | Standard   | MALE   | Swedish                       | sv-SE-Standard-E        | wavenet     |
| sv-SE-Wavenet-B      | Standard   | FEMALE | Swedish                       | sv-SE-Wavenet-B         | wavenet     |
| sv-SE-Wavenet-D      | Standard   | FEMALE | Swedish                       | sv-SE-Wavenet-D         | wavenet     |
| Filiz (Standard)     | Standard   | Female | Turkish                       | tr-TR\_Filiz            | polly       |
| Emel                 | Premium    | Female | Turkish                       | tr-TR-EmelNeural        | azure       |
| tr-TR-Standard-A     | Standard   | FEMALE | Turkish                       | tr-TR-Standard-A        | wavenet     |
| tr-TR-Standard-C     | Standard   | FEMALE | Turkish                       | tr-TR-Standard-C        | wavenet     |
| tr-TR-Standard-E     | Standard   | MALE   | Turkish                       | tr-TR-Standard-E        | wavenet     |
| tr-TR-Wavenet-B      | Standard   | MALE   | Turkish                       | tr-TR-Wavenet-B         | wavenet     |
| tr-TR-Wavenet-D      | Standard   | FEMALE | Turkish                       | tr-TR-Wavenet-D         | wavenet     |
| Lupe (Standard)      | Standard   | Female | Spanish (US)                  | es-US\_Lupe             | polly       |
| Penelope (Standard)  | Standard   | Female | Spanish (US)                  | es-US\_Penelope         | polly       |
| Paloma               | Premium    | Female | Spanish (US)                  | es-US-PalomaNeural      | azure       |
| es-US-Standard-B     | Standard   | MALE   | Spanish (US)                  | es-US-Standard-B        | wavenet     |
| es-US-Wavenet-A      | Standard   | FEMALE | Spanish (US)                  | es-US-Wavenet-A         | wavenet     |
| es-US-Wavenet-C      | Standard   | MALE   | Spanish (US)                  | es-US-Wavenet-C         | wavenet     |
| Madhur               | Premium    | Male   | Hindi                         | hi-IN-MadhurNeural      | azure       |
| hi-IN-Standard-A     | Standard   | FEMALE | Hindi                         | hi-IN-Standard-A        | wavenet     |
| hi-IN-Standard-C     | Standard   | MALE   | Hindi                         | hi-IN-Standard-C        | wavenet     |
| hi-IN-Wavenet-A      | Standard   | FEMALE | Hindi                         | hi-IN-Wavenet-A         | wavenet     |
| hi-IN-Wavenet-C      | Standard   | MALE   | Hindi                         | hi-IN-Wavenet-C         | wavenet     |
| Seoyeon (Standard)   | Standard   | Female | Korean                        | ko-KR\_Seoyeon          | polly       |
| ko-KR-Standard-A     | Standard   | FEMALE | Korean                        | ko-KR-Standard-A        | wavenet     |
| ko-KR-Standard-C     | Standard   | MALE   | Korean                        | ko-KR-Standard-C        | wavenet     |
| ko-KR-Wavenet-A      | Standard   | FEMALE | Korean                        | ko-KR-Wavenet-A         | wavenet     |
| ko-KR-Wavenet-C      | Standard   | MALE   | Korean                        | ko-KR-Wavenet-C         | wavenet     |
| Mia (Standard)       | Standard   | Female | Spanish (Mexico)              | es-MX\_Mia              | polly       |
| Jorge                | Premium    | Male   | Spanish (Mexico)              | es-MX-JorgeNeural       | azure       |
| Candela              | Premium    | Female | Spanish (Mexico)              | es-MX-CandelaNeural     | azure       |
| Cecilio              | Premium    | Male   | Spanish (Mexico)              | es-MX-CecilioNeural     | azure       |
| Larissa              | Premium    | Female | Spanish (Mexico)              | es-MX-LarissaNeural     | azure       |
| Luciano              | Premium    | Male   | Spanish (Mexico)              | es-MX-LucianoNeural     | azure       |
| Nuria                | Premium    | Female | Spanish (Mexico)              | es-MX-NuriaNeural       | azure       |
| Renata               | Premium    | Female | Spanish (Mexico)              | es-MX-RenataNeural      | azure       |
| Molly                | Premium    | Female | English (New Zealand)         | en-NZ-MollyNeural       | azure       |
| Leah                 | Premium    | Female | English (South Africa)        | en-ZA-LeahNeural        | azure       |
| Alba                 | Premium    | Female | Catalan                       | ca-ES-AlbaNeural        | azure       |
| ca-es-Standard-A     | Standard   | FEMALE | Catalan                       | ca-es-Standard-A        | wavenet     |
| Ingrid               | Premium    | Female | German (Austria)              | de-AT-IngridNeural      | azure       |
| Adri                 | Premium    | Female | Afrikaans                     | af-ZA-AdriNeural        | azure       |
| af-ZA-Standard-A     | Standard   | FEMALE | Afrikaans                     | af-ZA-Standard-A        | wavenet     |
| Mekdes               | Premium    | Female | Amharic                       | am-ET-MekdesNeural      | azure       |
| Hamdan               | Premium    | Male   | Arabic (United Arab Emirates) | ar-AE-HamdanNeural      | azure       |
| Laila                | Premium    | Female | Arabic (Bahrain)              | ar-BH-LailaNeural       | azure       |
| Ismael               | Premium    | Male   | Arabic (Algeria)              | ar-DZ-IsmaelNeural      | azure       |
| Shakir               | Premium    | Male   | Arabic (Egypt)                | ar-EG-ShakirNeural      | azure       |
| Rana                 | Premium    | Female | Arabic (Iraq)                 | ar-IQ-RanaNeural        | azure       |
| Sana                 | Premium    | Female | Arabic (Jordan)               | ar-JO-SanaNeural        | azure       |
| Noura                | Premium    | Female | Arabic (Kuwait)               | ar-KW-NouraNeural       | azure       |
| Omar                 | Premium    | Male   | Arabic (Libya)                | ar-LY-OmarNeural        | azure       |
| tr-TR-Standard-B     | Standard   | MALE   | Turkish                       | tr-TR-Standard-B        | wavenet     |
| tr-TR-Standard-D     | Standard   | FEMALE | Turkish                       | tr-TR-Standard-D        | wavenet     |
| tr-TR-Wavenet-A      | Standard   | FEMALE | Turkish                       | tr-TR-Wavenet-A         | wavenet     |
| tr-TR-Wavenet-C      | Standard   | FEMALE | Turkish                       | tr-TR-Wavenet-C         | wavenet     |
| tr-TR-Wavenet-E      | Standard   | MALE   | Turkish                       | tr-TR-Wavenet-E         | wavenet     |
| Miguel (Standard)    | Standard   | Male   | Spanish (US)                  | es-US\_Miguel           | polly       |
| Camila               | Premium    | Female | Spanish (US)                  | es-US-Neural2-A         | azure       |
| Alonso               | Premium    | Male   | Spanish (US)                  | es-US-AlonsoNeural      | azure       |
| es-US-Standard-A     | Standard   | FEMALE | Spanish (US)                  | es-US-Standard-A        | wavenet     |
| es-US-Standard-C     | Standard   | MALE   | Spanish (US)                  | es-US-Standard-C        | wavenet     |
| es-US-Wavenet-B      | Standard   | MALE   | Spanish (US)                  | es-US-Wavenet-B         | wavenet     |
| Aditi (Standard)     | Standard   | Female | Hindi                         | hi-IN\_Aditi            | polly       |
| Swara                | Premium    | Female | Hindi                         | hi-IN-SwaraNeural       | azure       |
| hi-IN-Standard-B     | Standard   | MALE   | Hindi                         | hi-IN-Standard-B        | wavenet     |
| hi-IN-Standard-D     | Standard   | FEMALE | Hindi                         | hi-IN-Standard-D        | wavenet     |
| hi-IN-Wavenet-B      | Standard   | MALE   | Hindi                         | hi-IN-Wavenet-B         | wavenet     |
| hi-IN-Wavenet-D      | Standard   | FEMALE | Hindi                         | hi-IN-Wavenet-D         | wavenet     |
| InJoon               | Premium    | Male   | Korean                        | ko-KR-InJoonNeural      | azure       |
| ko-KR-Standard-B     | Standard   | FEMALE | Korean                        | ko-KR-Standard-B        | wavenet     |
| ko-KR-Standard-D     | Standard   | MALE   | Korean                        | ko-KR-Standard-D        | wavenet     |
| ko-KR-Wavenet-B      | Standard   | FEMALE | Korean                        | ko-KR-Wavenet-B         | wavenet     |
| ko-KR-Wavenet-D      | Standard   | MALE   | Korean                        | ko-KR-Wavenet-D         | wavenet     |
| Dalia                | Premium    | Female | Spanish (Mexico)              | es-MX-DaliaNeural       | azure       |
| Beatriz              | Premium    | Female | Spanish (Mexico)              | es-MX-BeatrizNeural     | azure       |
| Carlota              | Premium    | Female | Spanish (Mexico)              | es-MX-CarlotaNeural     | azure       |
| Gerardo              | Premium    | Male   | Spanish (Mexico)              | es-MX-GerardoNeural     | azure       |
| Liberto              | Premium    | Male   | Spanish (Mexico)              | es-MX-LibertoNeural     | azure       |
| Marina               | Premium    | Female | Spanish (Mexico)              | es-MX-MarinaNeural      | azure       |
| Pelayo               | Premium    | Male   | Spanish (Mexico)              | es-MX-PelayoNeural      | azure       |
| Yago                 | Premium    | Male   | Spanish (Mexico)              | es-MX-YagoNeural        | azure       |
| Mitchell             | Premium    | Male   | English (New Zealand)         | en-NZ-MitchellNeural    | azure       |
| Luke                 | Premium    | Male   | English (South Africa)        | en-ZA-LukeNeural        | azure       |
| Latifa               | Premium    | Female | Pashto                        | ps-AF-LatifaNeural      | azure       |
| Joana                | Premium    | Female | Catalan                       | ca-ES-JoanaNeural       | azure       |
| Enric                | Premium    | Male   | Catalan                       | ca-ES-EnricNeural       | azure       |
| Jonas                | Premium    | Male   | German (Austria)              | de-AT-JonasNeural       | azure       |
| Willem               | Premium    | Male   | Afrikaans                     | af-ZA-WillemNeural      | azure       |
| Ameha                | Premium    | Male   | Amharic                       | am-ET-AmehaNeural       | azure       |
| Fatima               | Premium    | Female | Arabic (United Arab Emirates) | ar-AE-FatimaNeural      | azure       |
| Ali                  | Premium    | Male   | Arabic (Bahrain)              | ar-BH-AliNeural         | azure       |
| Amina                | Premium    | Female | Arabic (Algeria)              | ar-DZ-AminaNeural       | azure       |
| Salma                | Premium    | Female | Arabic (Egypt)                | ar-EG-SalmaNeural       | azure       |
| Bassel               | Premium    | Male   | Arabic (Iraq)                 | ar-IQ-BasselNeural      | azure       |
| Taim                 | Premium    | Male   | Arabic (Jordan)               | ar-JO-TaimNeural        | azure       |
| Fahed                | Premium    | Male   | Arabic (Kuwait)               | ar-KW-FahedNeural       | azure       |
| Iman                 | Premium    | Female | Arabic (Libya)                | ar-LY-ImanNeural        | azure       |
| Jamal                | Premium    | Male   | Arabic (Morocco)              | ar-MA-JamalNeural       | azure       |
| Mouna                | Premium    | Female | Arabic (Morocco)              | ar-MA-MounaNeural       | azure       |
| Aysha                | Premium    | Female | Arabic                        | ar-OM-AyshaNeural       | azure       |
| Moaz                 | Premium    | Male   | Arabic (Qatar)                | ar-QA-MoazNeural        | azure       |
| Zariyah              | Premium    | Female | Arabic (Saudi Arabia)         | ar-SA-ZariyahNeural     | azure       |
| Laith                | Premium    | Male   | Arabic (Syria)                | ar-SY-LaithNeural       | azure       |
| Reem                 | Premium    | Female | Arabic (Tunisia)              | ar-TN-ReemNeural        | azure       |
| Saleh                | Premium    | Male   | Arabic (Yemen)                | ar-YE-SalehNeural       | azure       |
| Kalina               | Premium    | Female | Bulgarian                     | bg-BG-KalinaNeural      | azure       |
| Nabanita             | Premium    | Female | Bangla (Bangladesh)           | bn-BD-NabanitaNeural    | azure       |
| Bashkar              | Premium    | Male   | Bengali (India)               | bn-IN-BashkarNeural     | azure       |
| bn-IN-Standard-A     | Standard   | FEMALE | Bengali (India)               | bn-IN-Standard-A        | wavenet     |
| bn-IN-Wavenet-A      | Standard   | FEMALE | Bengali (India)               | bn-IN-Wavenet-A         | wavenet     |
| Goran                | Premium    | Male   | Bosnian                       | bs-BA-GoranNeural       | azure       |
| Antonin              | Premium    | Male   | Czech                         | cs-CZ-AntoninNeural     | azure       |
| cs-CZ-Standard-A     | Standard   | FEMALE | Czech                         | cs-CZ-Standard-A        | wavenet     |
| Jan                  | Premium    | Male   | German (Switzerland)          | de-CH-JanNeural         | azure       |
| Athina               | Premium    | Female | Greek                         | el-GR-AthinaNeural      | azure       |
| el-GR-Wavenet-A      | Standard   | FEMALE | Greek                         | el-GR-Wavenet-A         | wavenet     |
| Clara                | Premium    | Female | English (Canada)              | en-CA-ClaraNeural       | azure       |
| Sam                  | Premium    | Male   | English (Hongkong)            | en-HK-SamNeural         | azure       |
| Connor               | Premium    | Male   | English (Ireland)             | en-IE-ConnorNeural      | azure       |
| Asilia               | Premium    | Female | English (Kenya)               | en-KE-AsiliaNeural      | azure       |
| Abeo                 | Premium    | Male   | English (Nigeria)             | en-NG-AbeoNeural        | azure       |
| James                | Premium    | Male   | English (Philippines)         | en-PH-JamesNeural       | azure       |
| Luna                 | Premium    | Female | English (Singapore)           | en-SG-LunaNeural        | azure       |
| Elimu                | Premium    | Male   | English (Tanzania)            | en-TZ-ElimuNeural       | azure       |
| Elena                | Premium    | Female | Spanish (Argentina)           | es-AR-ElenaNeural       | azure       |
| Marcelo              | Premium    | Male   | Spanish (Bolivia)             | es-BO-MarceloNeural     | azure       |
| Catalina             | Premium    | Female | Spanish (Chile)               | es-CL-CatalinaNeural    | azure       |
| Gonzalo              | Premium    | Male   | Spanish (Colombia)            | es-CO-GonzaloNeural     | azure       |
| Juan                 | Premium    | Male   | Spanish (Costa Rica)          | es-CR-JuanNeural        | azure       |
| Belkys               | Premium    | Female | Spanish (Cuba)                | es-CU-BelkysNeural      | azure       |
| Emilio               | Premium    | Male   | Spanish (Dominican Republic)  | es-DO-EmilioNeural      | azure       |
| Andrea               | Premium    | Female | Spanish (Ecuador)             | es-EC-AndreaNeural      | azure       |
| Javier               | Premium    | Male   | Spanish (Equatorial Guinea)   | es-GQ-JavierNeural      | azure       |
| Andres               | Premium    | Male   | Spanish (Guatemala)           | es-GT-AndresNeural      | azure       |
| Carlos               | Premium    | Male   | Spanish (Honduras)            | es-HN-CarlosNeural      | azure       |
| Federico             | Premium    | Male   | Spanish (Nicaragua)           | es-NI-FedericoNeural    | azure       |
| Margarita            | Premium    | Female | Spanish (Panama)              | es-PA-MargaritaNeural   | azure       |
| Alex                 | Premium    | Male   | Spanish (Peru)                | es-PE-AlexNeural        | azure       |
| Karina               | Premium    | Female | Spanish (Puerto Rico)         | es-PR-KarinaNeural      | azure       |
| Mario                | Premium    | Male   | Spanish (Paraguay)            | es-PY-MarioNeural       | azure       |
| Lorena               | Premium    | Female | Spanish (El Salvador)         | es-SV-LorenaNeural      | azure       |
| Mateo                | Premium    | Male   | Spanish (Uruguay)             | es-UY-MateoNeural       | azure       |
| Paola                | Premium    | Female | Spanish (Venezuela)           | es-VE-PaolaNeural       | azure       |
| Anu                  | Premium    | Female | Estonian                      | et-EE-AnuNeural         | azure       |
| Dilara               | Premium    | Female | Persian                       | fa-IR-DilaraNeural      | azure       |
| Selma                | Premium    | Female | Finnish                       | fi-FI-SelmaNeural       | azure       |
| Noora                | Premium    | Female | Finnish                       | fi-FI-NooraNeural       | azure       |
| fi-FI-Wavenet-A      | Standard   | FEMALE | Finnish                       | fi-FI-Wavenet-A         | wavenet     |
| Abdullah             | Premium    | Male   | Arabic                        | ar-OM-AbdullahNeural    | azure       |
| Amal                 | Premium    | Female | Arabic (Qatar)                | ar-QA-AmalNeural        | azure       |
| Hamed                | Premium    | Male   | Arabic (Saudi Arabia)         | ar-SA-HamedNeural       | azure       |
| Amany                | Premium    | Female | Arabic (Syria)                | ar-SY-AmanyNeural       | azure       |
| Hedi                 | Premium    | Male   | Arabic (Tunisia)              | ar-TN-HediNeural        | azure       |
| Maryam               | Premium    | Female | Arabic (Yemen)                | ar-YE-MaryamNeural      | azure       |
| Borislav             | Premium    | Male   | Bulgarian                     | bg-BG-BorislavNeural    | azure       |
| bg-bg-Standard-A     | Standard   | FEMALE | Bulgarian                     | bg-bg-Standard-A        | wavenet     |
| Pradeep              | Premium    | Male   | Bangla (Bangladesh)           | bn-BD-PradeepNeural     | azure       |
| Tanishaa             | Premium    | Female | Bengali (India)               | bn-IN-TanishaaNeural    | azure       |
| bn-IN-Standard-B     | Standard   | MALE   | Bengali (India)               | bn-IN-Standard-B        | wavenet     |
| bn-IN-Wavenet-B      | Standard   | MALE   | Bengali (India)               | bn-IN-Wavenet-B         | wavenet     |
| Vesna                | Premium    | Female | Bosnian                       | bs-BA-VesnaNeural       | azure       |
| Vlasta               | Premium    | Female | Czech                         | cs-CZ-VlastaNeural      | azure       |
| cs-CZ-Wavenet-A      | Standard   | FEMALE | Czech                         | cs-CZ-Wavenet-A         | wavenet     |
| Leni                 | Premium    | Female | German (Switzerland)          | de-CH-LeniNeural        | azure       |
| Nestoras             | Premium    | Male   | Greek                         | el-GR-NestorasNeural    | azure       |
| el-GR-Standard-A     | Standard   | FEMALE | Greek                         | el-GR-Standard-A        | wavenet     |
| Liam                 | Premium    | Male   | English (Canada)              | en-CA-LiamNeural        | azure       |
| Yan                  | Premium    | Female | English (Hongkong)            | en-HK-YanNeural         | azure       |
| Emily                | Premium    | Female | English (Ireland)             | en-IE-EmilyNeural       | azure       |
| Chilemba             | Premium    | Male   | English (Kenya)               | en-KE-ChilembaNeural    | azure       |
| Ezinne               | Premium    | Female | English (Nigeria)             | en-NG-EzinneNeural      | azure       |
| Rosa                 | Premium    | Female | English (Philippines)         | en-PH-RosaNeural        | azure       |
| Wayne                | Premium    | Male   | English (Singapore)           | en-SG-WayneNeural       | azure       |
| Imani                | Premium    | Female | English (Tanzania)            | en-TZ-ImaniNeural       | azure       |
| Tomas                | Premium    | Male   | Spanish (Argentina)           | es-AR-TomasNeural       | azure       |
| Sofia                | Premium    | Female | Spanish (Bolivia)             | es-BO-SofiaNeural       | azure       |
| Lorenzo              | Premium    | Male   | Spanish (Chile)               | es-CL-LorenzoNeural     | azure       |
| Salome               | Premium    | Female | Spanish (Colombia)            | es-CO-SalomeNeural      | azure       |
| Maria                | Premium    | Female | Spanish (Costa Rica)          | es-CR-MariaNeural       | azure       |
| Manuel               | Premium    | Male   | Spanish (Cuba)                | es-CU-ManuelNeural      | azure       |
| Ramona               | Premium    | Female | Spanish (Dominican Republic)  | es-DO-RamonaNeural      | azure       |
| Luis                 | Premium    | Male   | Spanish (Ecuador)             | es-EC-LuisNeural        | azure       |
| Teresa               | Premium    | Female | Spanish (Equatorial Guinea)   | es-GQ-TeresaNeural      | azure       |
| Marta                | Premium    | Female | Spanish (Guatemala)           | es-GT-MartaNeural       | azure       |
| Karla                | Premium    | Female | Spanish (Honduras)            | es-HN-KarlaNeural       | azure       |
| Yolanda              | Premium    | Female | Spanish (Nicaragua)           | es-NI-YolandaNeural     | azure       |
| Roberto              | Premium    | Male   | Spanish (Panama)              | es-PA-RobertoNeural     | azure       |
| Camila               | Premium    | Female | Spanish (Peru)                | es-PE-CamilaNeural      | azure       |
| Victor               | Premium    | Male   | Spanish (Puerto Rico)         | es-PR-VictorNeural      | azure       |
| Tania                | Premium    | Female | Spanish (Paraguay)            | es-PY-TaniaNeural       | azure       |
| Rodrigo              | Premium    | Male   | Spanish (El Salvador)         | es-SV-RodrigoNeural     | azure       |
| Valentina            | Premium    | Female | Spanish (Uruguay)             | es-UY-ValentinaNeural   | azure       |
| Sebastian            | Premium    | Male   | Spanish (Venezuela)           | es-VE-SebastianNeural   | azure       |
| Kert                 | Premium    | Male   | Estonian                      | et-EE-KertNeural        | azure       |
| Farid                | Premium    | Male   | Persian                       | fa-IR-FaridNeural       | azure       |
| Harri                | Premium    | Male   | Finnish                       | fi-FI-HarriNeural       | azure       |
| fi-FI-Standard-A     | Standard   | FEMALE | Finnish                       | fi-FI-Standard-A        | wavenet     |
| Angelo               | Premium    | Male   | Filipino                      | fil-PH-AngeloNeural     | azure       |
| Blessica             | Premium    | Female | Filipino                      | fil-PH-BlessicaNeural   | azure       |
| fil-PH-Standard-B    | Standard   | FEMALE | Filipino                      | fil-PH-Standard-B       | wavenet     |
| fil-PH-Standard-D    | Standard   | MALE   | Filipino                      | fil-PH-Standard-D       | wavenet     |
| fil-PH-Wavenet-B     | Standard   | FEMALE | Filipino                      | fil-PH-Wavenet-B        | wavenet     |
| fil-PH-Wavenet-D     | Standard   | MALE   | Filipino                      | fil-PH-Wavenet-D        | wavenet     |
| Gerard               | Premium    | Male   | French (Belgium)              | fr-BE-GerardNeural      | azure       |
| Fabrice              | Premium    | Male   | French (Switzerland)          | fr-CH-FabriceNeural     | azure       |
| Orla                 | Premium    | Female | Irish                         | ga-IE-OrlaNeural        | azure       |
| Sabela               | Premium    | Female | Galician                      | gl-ES-SabelaNeural      | azure       |
| Niranjan             | Premium    | Male   | Gujarati                      | gu-IN-NiranjanNeural    | azure       |
| gu-IN-Standard-B     | Standard   | MALE   | Gujarati                      | gu-IN-Standard-B        | wavenet     |
| gu-IN-Wavenet-B      | Standard   | MALE   | Gujarati                      | gu-IN-Wavenet-B         | wavenet     |
| Hila                 | Premium    | Female | Hebrew                        | he-IL-HilaNeural        | azure       |
| Srecko               | Premium    | Male   | Croatian                      | hr-HR-SreckoNeural      | azure       |
| Tamas                | Premium    | Male   | Hungarian                     | hu-HU-TamasNeural       | azure       |
| hu-HU-Wavenet-A      | Standard   | FEMALE | Hungarian                     | hu-HU-Wavenet-A         | wavenet     |
| Gadis                | Premium    | Female | Indonesian                    | id-ID-GadisNeural       | azure       |
| id-ID-Standard-B     | Standard   | MALE   | Indonesian                    | id-ID-Standard-B        | wavenet     |
| id-ID-Standard-D     | Standard   | FEMALE | Indonesian                    | id-ID-Standard-D        | wavenet     |
| id-ID-Wavenet-B      | Standard   | MALE   | Indonesian                    | id-ID-Wavenet-B         | wavenet     |
| id-ID-Wavenet-D      | Standard   | FEMALE | Indonesian                    | id-ID-Wavenet-D         | wavenet     |
| Siti                 | Premium    | Female | Javanese                      | jv-ID-SitiNeural        | azure       |
| Giorgi               | Premium    | Male   | Georgian                      | ka-GE-GiorgiNeural      | azure       |
| Daulet               | Premium    | Male   | Kazakh                        | kk-KZ-DauletNeural      | azure       |
| Sreymom              | Premium    | Female | Khmer                         | km-KH-SreymomNeural     | azure       |
| Sapna                | Premium    | Female | Kannada                       | kn-IN-SapnaNeural       | azure       |
| kn-IN-Standard-B     | Standard   | MALE   | Kannada                       | kn-IN-Standard-B        | wavenet     |
| kn-IN-Wavenet-B      | Standard   | MALE   | Kannada                       | kn-IN-Wavenet-B         | wavenet     |
| Keomany              | Premium    | Female | Lao                           | lo-LA-KeomanyNeural     | azure       |
| Ona                  | Premium    | Female | Lithuanian                    | lt-LT-OnaNeural         | azure       |
| Nils                 | Premium    | Male   | Latvian                       | lv-LV-NilsNeural        | azure       |
| Aleksandar           | Premium    | Male   | Macedonian                    | mk-MK-AleksandarNeural  | azure       |
| Midhun               | Premium    | Male   | Malayalam                     | ml-IN-MidhunNeural      | azure       |
| ml-IN-Standard-A     | Standard   | FEMALE | Malayalam                     | ml-IN-Standard-A        | wavenet     |
| ml-IN-Wavenet-A      | Standard   | FEMALE | Malayalam                     | ml-IN-Wavenet-A         | wavenet     |
| Bataa                | Premium    | Male   | Mongolian (Mongolia)          | mn-MN-BataaNeural       | azure       |
| Aarohi               | Premium    | Female | Marathi                       | mr-IN-AarohiNeural      | azure       |
| Osman                | Premium    | Male   | Malay (Malaysia)              | ms-MY-OsmanNeural       | azure       |
| ms-MY-Wavenet-A      | Standard   | FEMALE | Malay (Malaysia)              | ms-MY-Wavenet-A         | wavenet     |
| ms-MY-Wavenet-C      | Standard   | FEMALE | Malay (Malaysia)              | ms-MY-Wavenet-C         | wavenet     |
| ms-MY-Standard-A     | Standard   | FEMALE | Malay (Malaysia)              | ms-MY-Standard-A        | wavenet     |
| ms-MY-Standard-C     | Standard   | FEMALE | Malay (Malaysia)              | ms-MY-Standard-C        | wavenet     |
| Grace                | Premium    | Female | Maltese                       | mt-MT-GraceNeural       | azure       |
| Nilar                | Premium    | Female | Burmese                       | my-MM-NilarNeural       | azure       |
| Hemkala              | Premium    | Female | Nepali                        | ne-NP-HemkalaNeural     | azure       |
| Arnaud               | Premium    | Male   | Dutch (Belgium)               | nl-BE-ArnaudNeural      | azure       |
| nl-BE-Standard-A     | Standard   | FEMALE | Dutch (Belgium)               | nl-BE-Standard-A        | wavenet     |
| nl-BE-Wavenet-A      | Standard   | FEMALE | Dutch (Belgium)               | nl-BE-Wavenet-A         | wavenet     |
| Sameera              | Premium    | Male   | Sinhala                       | si-LK-SameeraNeural     | azure       |
| Lukas                | Premium    | Male   | Slovak                        | sk-SK-LukasNeural       | azure       |
| fil-PH-Standard-A    | Standard   | FEMALE | Filipino                      | fil-PH-Standard-A       | wavenet     |
| fil-PH-Standard-C    | Standard   | MALE   | Filipino                      | fil-PH-Standard-C       | wavenet     |
| fil-PH-Wavenet-A     | Standard   | FEMALE | Filipino                      | fil-PH-Wavenet-A        | wavenet     |
| fil-PH-Wavenet-C     | Standard   | MALE   | Filipino                      | fil-PH-Wavenet-C        | wavenet     |
| Charline             | Premium    | Female | French (Belgium)              | fr-BE-CharlineNeural    | azure       |
| Ariane               | Premium    | Female | French (Switzerland)          | fr-CH-ArianeNeural      | azure       |
| Colm                 | Premium    | Male   | Irish                         | ga-IE-ColmNeural        | azure       |
| Roi                  | Premium    | Male   | Galician                      | gl-ES-RoiNeural         | azure       |
| Dhwani               | Premium    | Female | Gujarati                      | gu-IN-DhwaniNeural      | azure       |
| gu-IN-Standard-A     | Standard   | FEMALE | Gujarati                      | gu-IN-Standard-A        | wavenet     |
| gu-IN-Wavenet-A      | Standard   | FEMALE | Gujarati                      | gu-IN-Wavenet-A         | wavenet     |
| Avri                 | Premium    | Male   | Hebrew                        | he-IL-AvriNeural        | azure       |
| Gabrijela            | Premium    | Female | Croatian                      | hr-HR-GabrijelaNeural   | azure       |
| Noemi                | Premium    | Female | Hungarian                     | hu-HU-NoemiNeural       | azure       |
| hu-HU-Standard-A     | Standard   | FEMALE | Hungarian                     | hu-HU-Standard-A        | wavenet     |
| Ardi                 | Premium    | Male   | Indonesian                    | id-ID-ArdiNeural        | azure       |
| id-ID-Standard-A     | Standard   | FEMALE | Indonesian                    | id-ID-Standard-A        | wavenet     |
| id-ID-Standard-C     | Standard   | MALE   | Indonesian                    | id-ID-Standard-C        | wavenet     |
| id-ID-Wavenet-A      | Standard   | FEMALE | Indonesian                    | id-ID-Wavenet-A         | wavenet     |
| id-ID-Wavenet-C      | Standard   | MALE   | Indonesian                    | id-ID-Wavenet-C         | wavenet     |
| Dimas                | Premium    | Male   | Javanese                      | jv-ID-DimasNeural       | azure       |
| Eka                  | Premium    | Female | Georgian                      | ka-GE-EkaNeural         | azure       |
| Aigul                | Premium    | Female | Kazakh                        | kk-KZ-AigulNeural       | azure       |
| Piseth               | Premium    | Male   | Khmer                         | km-KH-PisethNeural      | azure       |
| Gagan                | Premium    | Male   | Kannada                       | kn-IN-GaganNeural       | azure       |
| kn-IN-Standard-A     | Standard   | FEMALE | Kannada                       | kn-IN-Standard-A        | wavenet     |
| kn-IN-Wavenet-A      | Standard   | FEMALE | Kannada                       | kn-IN-Wavenet-A         | wavenet     |
| Chanthavong          | Premium    | Male   | Lao                           | lo-LA-ChanthavongNeural | azure       |
| Leonas               | Premium    | Male   | Lithuanian                    | lt-LT-LeonasNeural      | azure       |
| Everita              | Premium    | Female | Latvian                       | lv-LV-EveritaNeural     | azure       |
| lv-lv-Standard-A     | Standard   | MALE   | Latvian                       | lv-lv-Standard-A        | wavenet     |
| Marija               | Premium    | Female | Macedonian                    | mk-MK-MarijaNeural      | azure       |
| Sobhana              | Premium    | Female | Malayalam                     | ml-IN-SobhanaNeural     | azure       |
| ml-IN-Standard-B     | Standard   | MALE   | Malayalam                     | ml-IN-Standard-B        | wavenet     |
| ml-IN-Wavenet-B      | Standard   | MALE   | Malayalam                     | ml-IN-Wavenet-B         | wavenet     |
| Yesui                | Premium    | Female | Mongolian (Mongolia)          | mn-MN-YesuiNeural       | azure       |
| Manohar              | Premium    | Male   | Marathi                       | mr-IN-ManoharNeural     | azure       |
| Yasmin               | Premium    | Female | Malay (Malaysia)              | ms-MY-YasminNeural      | azure       |
| ms-MY-Wavenet-B      | Standard   | MALE   | Malay (Malaysia)              | ms-MY-Wavenet-B         | wavenet     |
| ms-MY-Wavenet-D      | Standard   | MALE   | Malay (Malaysia)              | ms-MY-Wavenet-D         | wavenet     |
| ms-MY-Standard-B     | Standard   | MALE   | Malay (Malaysia)              | ms-MY-Standard-B        | wavenet     |
| ms-MY-Standard-D     | Standard   | MALE   | Malay (Malaysia)              | ms-MY-Standard-D        | wavenet     |
| Joseph               | Premium    | Male   | Maltese                       | mt-MT-JosephNeural      | azure       |
| Thiha                | Premium    | Male   | Burmese                       | my-MM-ThihaNeural       | azure       |
| Sagar                | Premium    | Male   | Nepali                        | ne-NP-SagarNeural       | azure       |
| Dena                 | Premium    | Female | Dutch (Belgium)               | nl-BE-DenaNeural        | azure       |
| nl-BE-Standard-B     | Standard   | MALE   | Dutch (Belgium)               | nl-BE-Standard-B        | wavenet     |
| nl-BE-Wavenet-B      | Standard   | MALE   | Dutch (Belgium)               | nl-BE-Wavenet-B         | wavenet     |
| Thilini              | Premium    | Female | Sinhala                       | si-LK-ThiliniNeural     | azure       |
| Viktoria             | Premium    | Female | Slovak                        | sk-SK-ViktoriaNeural    | azure       |


# Home GPT

Regenerates old rooms and houses to modern one

#### [Demo](https://api.market/store/capix/homegpt)

### About API <a href="#about-api" id="about-api"></a>

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

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

***

#### Endpoints <a href="#endpoints" id="endpoints"></a>

**1. Home Configuration**

This endpoint is used to configure the home with an image URL and theme.

**Parameters**

* `image_url` (string): URL of the image to be used for home configuration.
* `theme` (string): Theme for the home (e.g., "Modern").

**Headers**

* x-api-market-key (string): Your API key.
* `Content-Type` (string): Must be `application/json`.

**2. Room Configuration**

This endpoint is used to configure a room with an image URL, theme, and room type.

**Parameters**

* `image_url` (string): URL of the image to be used for room configuration.
* `theme` (string): Theme for the room (e.g., "Modern").
* `room` (string): Type of the room (e.g., "Living room").

**Headers**

* x-api-market-key (string): Your API key.
* `Content-Type` (string): Must be `application/json`.

**3. Fetch Room Result**

This endpoint is used to fetch the result of a room configuration based on a request ID.

**Parameters**

* `request_id` (string): Unique identifier for the room configuration request.

**Headers**

* x-api-market-key (string): Your API key.
* `Content-Type` (string): Must be `application/json`.

**Example Workflow**

1. **Configure Home**
   * Send a POST request to the `/home/` endpoint with the image URL and theme to configure the home.
2. **Configure Room**
   * Send a POST request to the `/room/` endpoint with the image URL, theme, and room type to configure a specific room.
3. **Fetch Room Result**
   * Send a POST request to the `/room/result/` endpoint with the request ID to fetch the result of the room configuration.

**Notes**

* Replace `API_KEY` with your actual API key in all requests.
* Ensure that all JSON data in the request body is properly formatted.

By following this documentation, you should be able to interact with the Capix API v2 efficiently for configuring homes and rooms, as well as retrieving the results of those configurations.

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/homegpt/home/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fc6c8be08bfb1e27e558a1.png&theme=Modern'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'image_url': 'https://telegra.ph/file/c6c8be08bfb1e27e558a1.png',
    'theme': 'Modern',
}

response = requests.post('https://prod.api.market/api/v1/capix/homegpt/home/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/homegpt/home/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fc6c8be08bfb1e27e558a1.png&theme=Modern');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/homegpt/home/v1/',
  new URLSearchParams({
    'image_url': 'https://telegra.ph/file/c6c8be08bfb1e27e558a1.png',
    'theme': 'Modern'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/homegpt/home/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'image_url': 'https://telegra.ph/file/c6c8be08bfb1e27e558a1.png',
    'theme': 'Modern'
  })
});
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/homegpt/room/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fc6c8be08bfb1e27e558a1.png&room=Living%20room&theme=Modern'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'image_url': 'https://telegra.ph/file/c6c8be08bfb1e27e558a1.png',
    'room': 'Living room',
    'theme': 'Modern',
}

response = requests.post('https://prod.api.market/api/v1/capix/homegpt/room/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/homegpt/room/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'image_url=https%3A%2F%2Ftelegra.ph%2Ffile%2Fc6c8be08bfb1e27e558a1.png&room=Living%20room&theme=Modern');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/homegpt/room/v1/',
  new URLSearchParams({
    'image_url': 'https://telegra.ph/file/c6c8be08bfb1e27e558a1.png',
    'room': 'Living room',
    'theme': 'Modern'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/homegpt/room/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'image_url': 'https://telegra.ph/file/c6c8be08bfb1e27e558a1.png',
    'room': 'Living room',
    'theme': 'Modern'
  })
});
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/homegpt/result/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'request_id=REQUEST_ID'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'request_id': 'REQUEST_ID',
}

response = requests.post('https://prod.api.market/api/v1/capix/homegpt/result/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/homegpt/result/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'request_id=REQUEST_ID');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/homegpt/result/',
  new URLSearchParams({
    'request_id': 'REQUEST_ID'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/homegpt/result/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'request_id': 'REQUEST_ID'
  })
});
```

{% endtab %}
{% endtabs %}

### Theme <a href="#theme" id="theme"></a>

While you are generating your room images, you can use different themes. You can find themes [here ](https://www.homegpt.app/roomgpt).

<figure><img src="https://docs.capix.uz/~gitbook/image?url=https%3A%2F%2F2897687215-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FSeO3NtyiVp4pZWbnaKgi%252Fuploads%252FPApT9f6wK5rZejxYPbxn%252Fimage.png%3Falt%3Dmedia%26token%3Dfdaf134b-5fee-4de7-9c94-83df7b570584&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=42bed893fd5ae20efe3016cf1f0254245ff12b4ed29ce3dab3657b5c059f5fca" alt=""><figcaption></figcaption></figure>

**Room names could be one of these**: `Living Room`, `Dining Room`, `Gaming Room`, `Bedroom`, `Bathroom`, `Office`, `Kitchen`, `Guest Room`, `Laundry Room`, `Home Theater`, `Playroom`, `Music Room`, `Exercise Room`, `Library`, `Sunroom`, `Mudroom`, `Attic`, `Basement`, `Pantry`, `Wine Cellar`, `Garage`, `Outdoor Living Space`, `Pool Room`, `Study Room`, `Home Office`, `House Exterior`, `Outdoor Pool Area`, `Outdoor Patio`, `Outdoor Garden`, `Meeting Room`, `Workshop`, `Fitness Gym`, `Coffee Shop`, `Clothing Store`, `Walk-in Closet`, `Toilet`, `Restaurant`, `Coworking Space`, `Hotel Lobby`, `Hotel Room`, `Hotel Bathroom`, `Exhibition Space`, `Onsen`, `Drop Zone`

**Themes could be one of these**: `Modern`, `Neutral`, `Monochromatic`, `Complementary`, `Cyberpunk`, `Analogous`, `Warm`, `Cool`, `Pastel`, `Black and white`, `Earthy`, `Vintage`, `Minimalist`, `Scandinavian`, `Bohemian`, `High-Contrast`, `Bright`, `Ocean-inspired`, `Rustic`, `Tropical`, `Bold`, `Jewel-toned`, `Art Deco`, `Mediterranean`, `Traditional`, `Beachy`, `Moody`, `Urban`, `Contemporary`, `Retro`, `Whimsical`, `Zen`, `Industrial`, `Biophilic`, `Farmhouse`, `Japanese Design`, `Coastal`, `Cottagecore`, `French Country`, `Maximalist`, `Art Nouveau`, `Baroque`, `Vaporwave`, `Ski Chalet`, `Sketch`, `Christmas`, `Tribal`, `Medieval`, `Chinese New Year`, `Halloween`, `Kelly Wearstler`, `Nate Berkus`, `Joanna Gaines`, `Martyn Lawrence Bullard`, `Philippe Starck`, `Emily Henderson`, `Miles Redd`, `Victoria Hagan`, `Tom Dixon`, `Timothy Corrigan`, `Axel Vervoordt`, `Kelly Hoppen`, `Ilse Crawford`, `India Mahdavi`, `David Collins`, `Thomas O'Brien`, `Jacques Garcia`, `Bunny Williams`, `Kelly Behun`, `Robert Couturier`


# AI & Plagiarism Checker

An AI API service to detect AI content

[Try Demo](https://api.market/store/capix/free)

### Endpoints <a href="#endpoints" id="endpoints"></a>

**URL**

`https://prod.api.market/api/v1/capix/free/detector/v1/`

**Method**

`POST`

**Description**

This endpoint detects anomalies in the provided content. It analyzes the text and returns insights or flags any peculiarities based on predefined criteria.

**Request Headers**

* `Content-Type: application/json`: Indicates that the request body format is JSON.
* x-api-market-key`: API_KEY`: Your unique API key for authentication. Replace `API_KEY` with your actual API key.

### **Request Body**

The request body must be in JSON format and contain the following parameter:

* `content` (string): The text content to be analyzed.

Example:

```json
{
  "content": "In the bustling metropolis of Neo City, where technology reigned supreme, a peculiar phenomenon began to unfold. Citizens reported receiving mysterious messages simply saying \"hello\" on their electronic devices, be it their holographic screens or their neural implants. The message seemed to emanate from an unknown source, sparking curiosity and a sense of unease among the populace."
}
```

**Response**

The response will be in JSON format and may include the following fields:

* `ai_percentage` (number): The percentage likelihood that the content was generated by AI.
* `average_score` (number): The average score of all analyzed sentences.
* `content_label` (string): A label indicating the likelihood of AI-generated content (e.g., "May Have AI").
* `gptzero_me_label` (string): Another label indicating AI detection results (e.g., "ai").
* `sentence_scores` (array): An array of sentences and their respective scores.

Example Response:

```json
{
  "ai_percentage": 66.66666666666666,
  "average_score": 42.94423105622707,
  "content_label": "May Have AI",
  "gptzero_me_label": "ai",
  "sentence_scores": [
    [
      "In the bustling metropolis of Neo City, where technology reigned supreme, a peculiar phenomenon began to unfold.",
      35.899437137314855
    ],
    [
      "Citizens reported receiving mysterious messages simply saying \"hello\" on their electronic devices, be it their holographic screens or their neural implants.",
      74.62703649255953
    ],
    [
      "The message seemed to emanate from an unknown source, sparking curiosity and a sense of unease among the populace.",
      18.306219538806836
    ]
  ]
}
```

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/free/detector/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'content=ContentDetector.AI%20is%20an%20accurate%20and%20free%20AI%20Detector%20and%20AI%20Content%20Detector%20that%20can%20be%20used%20to%20detect%20any%20AI-generated%20content.%20It%20provides%20a%20probability%20score%20based%20on%20the%20likelihood%20that%20the%20text%20content%20was%20generated%20by%20AI%20tools%20or%20chatbots.'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'content': 'ContentDetector.AI is an accurate and free AI Detector and AI Content Detector that can be used to detect any AI-generated content. It provides a probability score based on the likelihood that the text content was generated by AI tools or chatbots.',
}

response = requests.post('https://prod.api.market/api/v1/capix/free/detector/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/free/detector/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'content=ContentDetector.AI%20is%20an%20accurate%20and%20free%20AI%20Detector%20and%20AI%20Content%20Detector%20that%20can%20be%20used%20to%20detect%20any%20AI-generated%20content.%20It%20provides%20a%20probability%20score%20based%20on%20the%20likelihood%20that%20the%20text%20content%20was%20generated%20by%20AI%20tools%20or%20chatbots.');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/free/detector/v1/',
  new URLSearchParams({
    'content': 'ContentDetector.AI is an accurate and free AI Detector and AI Content Detector that can be used to detect any AI-generated content. It provides a probability score based on the likelihood that the text content was generated by AI tools or chatbots.'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/free/detector/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'content': 'ContentDetector.AI is an accurate and free AI Detector and AI Content Detector that can be used to detect any AI-generated content. It provides a probability score based on the likelihood that the text content was generated by AI tools or chatbots.'
  })
});
```

{% endtab %}
{% endtabs %}

This code returns response like this:

```json
{
    "ai_percentage":66.66666666666666,
    "average_score":42.94423105622707,
    "content_label":"May Have AI",
    "gptzero_me_label":"ai",
    "sentence_scores":[
        [
            "In the bustling metropolis of Neo City, where technology reigned supreme, a peculiar phenomenon began to unfold.",
            35.899437137314855
        ],
        [
            "Citizens reported receiving mysterious messages simply saying \"hello\" on their electronic devices, be it their holographic screens or their neural implants.",
            74.62703649255953
        ],
        [
            "The message seemed to emanate from an unknown source, sparking curiosity and a sense of unease among the populace.",
            18.306219538806836
        ]
    ]
}
```


# AI Story Generator

Generate story based on mode, topic and genre

[Try Demo](https://api.market/store/capix/story)

### Endpoints <a href="#endpoints" id="endpoints"></a>

1. **Endpoint**: `POST` request to `"https://prod.api.market/api/v1/capix/story/generate/story/v1/"`.
2. **Headers**:
   * `Content-Type`: Specifies the format of the request body, which is `application/json`.
   * x-api-market-key: The API key for authentication. Replace `"API_KEY"` with your actual API key.
3. **Request Body**:
   * **Format**: JSON
   * **Parameters**:
     * `mode`: Specifies the mode of story generation. In this case, it's set to `"Creative"`.
     * `text`: The text providing details about the story to be generated. This includes the story topic, setting, main characters, plot details, resolution, and themes.
     * `word_count`: Specifies the desired word count for the generated story, set to `1200` in this example.
     * `story_genre`: Specifies the genre of the story. In this case, it's set to `"Mystery"`.
4. **Authentication**: The API requires an API key (`token`) for authentication.

Here's the documentation based on the provided cURL command:

***

**Story Generation API Documentation**

**Endpoint:**

```
POST https://prod.api.market/api/v1/capix/story/generate/story/v1/
```

**Request Body (JSON):**

```json
{
  "mode": "Creative",
  "text": "Story Topic: A Time-Travel Adventure Setting: The story is set in both the present day and the Victorian era. The present-day setting is a bustling modern city known for its technological advancements. The Victorian setting is characterized by cobblestone streets, gas-lit lamps, and the early stages of industrialization. Main Characters: Alex: A curious and adventurous software engineer from the present day who inadvertently discovers a time-travel device. Eliza: A resourceful and intelligent Victorian-era inventor who dreams of changing the future. Plot Details: Discovery of the Time Machine: Alex discovers an old, mysterious device in their attic, left behind by a forgotten ancestor. Experimenting with it, they accidentally activate it and are transported to the Victorian era. Meeting Eliza: Alex meets Eliza, who is fascinated by the time machine and Alex's futuristic knowledge. Together, they explore the possibilities of time travel. A Threat Emerges: A sinister figure from the Victorian era learns about the time machine and wants to use it for nefarious purposes, threatening both the past and the future. Race Against Time: Alex and Eliza must work together to safeguard the time machine and prevent the alteration of history. They face challenges in both eras, blending elements of Victorian society with futuristic technology. Resolution: The story concludes with a thrilling confrontation, and a decision that affects both characters' destinies. Themes: The story explores themes of adventure, the ethics of time travel, the impact of technology on society, and the timeless nature of human curiosity and ambition.",
  "word_count": 1200,
  "story_genre": "Mystery"
}
```

**Request Parameters:**

* `mode`: Specifies the mode of story generation.
* `text`: Details about the story, including topic, setting, characters, plot, resolution, and themes.
* `word_count`: Desired word count for the generated story.
* `story_genre`: Genre of the story.

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/story/generate/story/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'text=Story%20Topic%3A%20A%20Time-Travel%20Adventure%0A%0A%0ASetting%3A%20The%20story%20is%20set%20in%20both%20the%20present%20day%20and%20the%20Victorian%20era.%20The%20present-day%20setting%20is%20a%20bustling%20modern%20city%20known%20for%20its%20technological%20advancements.%20The%20Victorian%20setting%20is%20characterized%20by%20cobblestone%20streets%2C%20gas-lit%20lamps%2C%20and%20the%20early%20stages%20of%20industrialization.%0A%0A%0AMain%20Characters%3A%0A%0A%0AAlex%3A%20A%20curious%20and%20adventurous%20software%20engineer%20from%20the%20present%20day%20who%20inadvertently%20discovers%20a%20time-travel%20device.%0AEliza%3A%20A%20resourceful%20and%20intelligent%20Victorian-era%20inventor%20who%20dreams%20of%20changing%20the%20future.%0APlot%20Details%3A%0A%0A%0ADiscovery%20of%20the%20Time%20Machine%3A%20Alex%20discovers%20an%20old%2C%20mysterious%20device%20in%20their%20attic%2C%20left%20behind%20by%20a%20forgotten%20ancestor.%20Experimenting%20with%20it%2C%20they%20accidentally%20activate%20it%20and%20are%20transported%20to%20the%20Victorian%20era.%0AMeeting%20Eliza%3A%20Alex%20meets%20Eliza%2C%20who%20is%20fascinated%20by%20the%20time%20machine%20and%20Alex'\''s%20futuristic%20knowledge.%20Together%2C%20they%20explore%20the%20possibilities%20of%20time%20travel.%0AA%20Threat%20Emerges%3A%20A%20sinister%20figure%20from%20the%20Victorian%20era%20learns%20about%20the%20time%20machine%20and%20wants%20to%20use%20it%20for%20nefarious%20purposes%2C%20threatening%20both%20the%20past%20and%20the%20future.%0ARace%20Against%20Time%3A%20Alex%20and%20Eliza%20must%20work%20together%20to%20safeguard%20the%20time%20machine%20and%20prevent%20the%20alteration%20of%20history.%20They%20face%20challenges%20in%20both%20eras%2C%20blending%20elements%20of%20Victorian%20society%20with%20futuristic%20technology.%0AResolution%3A%20The%20story%20concludes%20with%20a%20thrilling%20confrontation%2C%20and%20a%20decision%20that%20affects%20both%20characters'\''%20destinies.%0AThemes%3A%20The%20story%20explores%20themes%20of%20adventure%2C%20the%20ethics%20of%20time%20travel%2C%20the%20impact%20of%20technology%20on%20society%2C%20and%20the%20timeless%20nature%20of%20human%20curiosity%20and%20ambition.&word_count=1200&mode=Creative&story_genre=Mystery'

```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = "text=Story%20Topic%3A%20A%20Time-Travel%20Adventure%0A%0A%0ASetting%3A%20The%20story%20is%20set%20in%20both%20the%20present%20day%20and%20the%20Victorian%20era.%20The%20present-day%20setting%20is%20a%20bustling%20modern%20city%20known%20for%20its%20technological%20advancements.%20The%20Victorian%20setting%20is%20characterized%20by%20cobblestone%20streets%2C%20gas-lit%20lamps%2C%20and%20the%20early%20stages%20of%20industrialization.%0A%0A%0AMain%20Characters%3A%0A%0A%0AAlex%3A%20A%20curious%20and%20adventurous%20software%20engineer%20from%20the%20present%20day%20who%20inadvertently%20discovers%20a%20time-travel%20device.%0AEliza%3A%20A%20resourceful%20and%20intelligent%20Victorian-era%20inventor%20who%20dreams%20of%20changing%20the%20future.%0APlot%20Details%3A%0A%0A%0ADiscovery%20of%20the%20Time%20Machine%3A%20Alex%20discovers%20an%20old%2C%20mysterious%20device%20in%20their%20attic%2C%20left%20behind%20by%20a%20forgotten%20ancestor.%20Experimenting%20with%20it%2C%20they%20accidentally%20activate%20it%20and%20are%20transported%20to%20the%20Victorian%20era.%0AMeeting%20Eliza%3A%20Alex%20meets%20Eliza%2C%20who%20is%20fascinated%20by%20the%20time%20machine%20and%20Alex's%20futuristic%20knowledge.%20Together%2C%20they%20explore%20the%20possibilities%20of%20time%20travel.%0AA%20Threat%20Emerges%3A%20A%20sinister%20figure%20from%20the%20Victorian%20era%20learns%20about%20the%20time%20machine%20and%20wants%20to%20use%20it%20for%20nefarious%20purposes%2C%20threatening%20both%20the%20past%20and%20the%20future.%0ARace%20Against%20Time%3A%20Alex%20and%20Eliza%20must%20work%20together%20to%20safeguard%20the%20time%20machine%20and%20prevent%20the%20alteration%20of%20history.%20They%20face%20challenges%20in%20both%20eras%2C%20blending%20elements%20of%20Victorian%20society%20with%20futuristic%20technology.%0AResolution%3A%20The%20story%20concludes%20with%20a%20thrilling%20confrontation%2C%20and%20a%20decision%20that%20affects%20both%20characters'%20destinies.%0AThemes%3A%20The%20story%20explores%20themes%20of%20adventure%2C%20the%20ethics%20of%20time%20travel%2C%20the%20impact%20of%20technology%20on%20society%2C%20and%20the%20timeless%20nature%20of%20human%20curiosity%20and%20ambition.&word_count=1200&mode=Creative&story_genre=Mystery"

response = requests.post('https://prod.api.market/api/v1/capix/story/generate/story/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/story/generate/story/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, "text=Story%20Topic%3A%20A%20Time-Travel%20Adventure%0A%0A%0ASetting%3A%20The%20story%20is%20set%20in%20both%20the%20present%20day%20and%20the%20Victorian%20era.%20The%20present-day%20setting%20is%20a%20bustling%20modern%20city%20known%20for%20its%20technological%20advancements.%20The%20Victorian%20setting%20is%20characterized%20by%20cobblestone%20streets%2C%20gas-lit%20lamps%2C%20and%20the%20early%20stages%20of%20industrialization.%0A%0A%0AMain%20Characters%3A%0A%0A%0AAlex%3A%20A%20curious%20and%20adventurous%20software%20engineer%20from%20the%20present%20day%20who%20inadvertently%20discovers%20a%20time-travel%20device.%0AEliza%3A%20A%20resourceful%20and%20intelligent%20Victorian-era%20inventor%20who%20dreams%20of%20changing%20the%20future.%0APlot%20Details%3A%0A%0A%0ADiscovery%20of%20the%20Time%20Machine%3A%20Alex%20discovers%20an%20old%2C%20mysterious%20device%20in%20their%20attic%2C%20left%20behind%20by%20a%20forgotten%20ancestor.%20Experimenting%20with%20it%2C%20they%20accidentally%20activate%20it%20and%20are%20transported%20to%20the%20Victorian%20era.%0AMeeting%20Eliza%3A%20Alex%20meets%20Eliza%2C%20who%20is%20fascinated%20by%20the%20time%20machine%20and%20Alex's%20futuristic%20knowledge.%20Together%2C%20they%20explore%20the%20possibilities%20of%20time%20travel.%0AA%20Threat%20Emerges%3A%20A%20sinister%20figure%20from%20the%20Victorian%20era%20learns%20about%20the%20time%20machine%20and%20wants%20to%20use%20it%20for%20nefarious%20purposes%2C%20threatening%20both%20the%20past%20and%20the%20future.%0ARace%20Against%20Time%3A%20Alex%20and%20Eliza%20must%20work%20together%20to%20safeguard%20the%20time%20machine%20and%20prevent%20the%20alteration%20of%20history.%20They%20face%20challenges%20in%20both%20eras%2C%20blending%20elements%20of%20Victorian%20society%20with%20futuristic%20technology.%0AResolution%3A%20The%20story%20concludes%20with%20a%20thrilling%20confrontation%2C%20and%20a%20decision%20that%20affects%20both%20characters'%20destinies.%0AThemes%3A%20The%20story%20explores%20themes%20of%20adventure%2C%20the%20ethics%20of%20time%20travel%2C%20the%20impact%20of%20technology%20on%20society%2C%20and%20the%20timeless%20nature%20of%20human%20curiosity%20and%20ambition.&word_count=1200&mode=Creative&story_genre=Mystery");

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/story/generate/story/v1/',
  "text=Story%20Topic%3A%20A%20Time-Travel%20Adventure%0A%0A%0ASetting%3A%20The%20story%20is%20set%20in%20both%20the%20present%20day%20and%20the%20Victorian%20era.%20The%20present-day%20setting%20is%20a%20bustling%20modern%20city%20known%20for%20its%20technological%20advancements.%20The%20Victorian%20setting%20is%20characterized%20by%20cobblestone%20streets%2C%20gas-lit%20lamps%2C%20and%20the%20early%20stages%20of%20industrialization.%0A%0A%0AMain%20Characters%3A%0A%0A%0AAlex%3A%20A%20curious%20and%20adventurous%20software%20engineer%20from%20the%20present%20day%20who%20inadvertently%20discovers%20a%20time-travel%20device.%0AEliza%3A%20A%20resourceful%20and%20intelligent%20Victorian-era%20inventor%20who%20dreams%20of%20changing%20the%20future.%0APlot%20Details%3A%0A%0A%0ADiscovery%20of%20the%20Time%20Machine%3A%20Alex%20discovers%20an%20old%2C%20mysterious%20device%20in%20their%20attic%2C%20left%20behind%20by%20a%20forgotten%20ancestor.%20Experimenting%20with%20it%2C%20they%20accidentally%20activate%20it%20and%20are%20transported%20to%20the%20Victorian%20era.%0AMeeting%20Eliza%3A%20Alex%20meets%20Eliza%2C%20who%20is%20fascinated%20by%20the%20time%20machine%20and%20Alex's%20futuristic%20knowledge.%20Together%2C%20they%20explore%20the%20possibilities%20of%20time%20travel.%0AA%20Threat%20Emerges%3A%20A%20sinister%20figure%20from%20the%20Victorian%20era%20learns%20about%20the%20time%20machine%20and%20wants%20to%20use%20it%20for%20nefarious%20purposes%2C%20threatening%20both%20the%20past%20and%20the%20future.%0ARace%20Against%20Time%3A%20Alex%20and%20Eliza%20must%20work%20together%20to%20safeguard%20the%20time%20machine%20and%20prevent%20the%20alteration%20of%20history.%20They%20face%20challenges%20in%20both%20eras%2C%20blending%20elements%20of%20Victorian%20society%20with%20futuristic%20technology.%0AResolution%3A%20The%20story%20concludes%20with%20a%20thrilling%20confrontation%2C%20and%20a%20decision%20that%20affects%20both%20characters'%20destinies.%0AThemes%3A%20The%20story%20explores%20themes%20of%20adventure%2C%20the%20ethics%20of%20time%20travel%2C%20the%20impact%20of%20technology%20on%20society%2C%20and%20the%20timeless%20nature%20of%20human%20curiosity%20and%20ambition.&word_count=1200&mode=Creative&story_genre=Mystery",
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY',
      'Content-Type': 'application/x-www-form-urlencoded'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/story/generate/story/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: "text=Story%20Topic%3A%20A%20Time-Travel%20Adventure%0A%0A%0ASetting%3A%20The%20story%20is%20set%20in%20both%20the%20present%20day%20and%20the%20Victorian%20era.%20The%20present-day%20setting%20is%20a%20bustling%20modern%20city%20known%20for%20its%20technological%20advancements.%20The%20Victorian%20setting%20is%20characterized%20by%20cobblestone%20streets%2C%20gas-lit%20lamps%2C%20and%20the%20early%20stages%20of%20industrialization.%0A%0A%0AMain%20Characters%3A%0A%0A%0AAlex%3A%20A%20curious%20and%20adventurous%20software%20engineer%20from%20the%20present%20day%20who%20inadvertently%20discovers%20a%20time-travel%20device.%0AEliza%3A%20A%20resourceful%20and%20intelligent%20Victorian-era%20inventor%20who%20dreams%20of%20changing%20the%20future.%0APlot%20Details%3A%0A%0A%0ADiscovery%20of%20the%20Time%20Machine%3A%20Alex%20discovers%20an%20old%2C%20mysterious%20device%20in%20their%20attic%2C%20left%20behind%20by%20a%20forgotten%20ancestor.%20Experimenting%20with%20it%2C%20they%20accidentally%20activate%20it%20and%20are%20transported%20to%20the%20Victorian%20era.%0AMeeting%20Eliza%3A%20Alex%20meets%20Eliza%2C%20who%20is%20fascinated%20by%20the%20time%20machine%20and%20Alex's%20futuristic%20knowledge.%20Together%2C%20they%20explore%20the%20possibilities%20of%20time%20travel.%0AA%20Threat%20Emerges%3A%20A%20sinister%20figure%20from%20the%20Victorian%20era%20learns%20about%20the%20time%20machine%20and%20wants%20to%20use%20it%20for%20nefarious%20purposes%2C%20threatening%20both%20the%20past%20and%20the%20future.%0ARace%20Against%20Time%3A%20Alex%20and%20Eliza%20must%20work%20together%20to%20safeguard%20the%20time%20machine%20and%20prevent%20the%20alteration%20of%20history.%20They%20face%20challenges%20in%20both%20eras%2C%20blending%20elements%20of%20Victorian%20society%20with%20futuristic%20technology.%0AResolution%3A%20The%20story%20concludes%20with%20a%20thrilling%20confrontation%2C%20and%20a%20decision%20that%20affects%20both%20characters'%20destinies.%0AThemes%3A%20The%20story%20explores%20themes%20of%20adventure%2C%20the%20ethics%20of%20time%20travel%2C%20the%20impact%20of%20technology%20on%20society%2C%20and%20the%20timeless%20nature%20of%20human%20curiosity%20and%20ambition.&word_count=1200&mode=Creative&story_genre=Mystery"
});
```

{% endtab %}
{% endtabs %}

**It returns response like this**

```json
{
  "story": "In the heart of a bustling modern city, Alex, a curious and adventurous software engineer, stumbled upon a hidden secret tucked away in the dusty corners of their attic. An old, mysterious device, left behind by a forgotten ancestor, beckoned to Alex with its enigmatic aura. Intrigued, Alex couldn't resist the temptation to tinker with it, resulting in a dazzling display of lights and whirring mechanisms. In a heartbeat, they found themselves transported back in time to the Victorian era.\n\nAs Alex stood bewildered amidst cobblestone streets bathed in the soft glow of gas-lit lamps, a figure approached – Eliza, a resourceful and intelligent Victorian-era inventor with a gleam of curiosity in her eyes. She was drawn to the strange contraption that had whisked Alex away and marveled at the futuristic knowledge Alex possessed.\n\nTogether, Alex and Eliza embarked on a thrilling journey through time, exploring the intricacies of the time machine and the vast possibilities it presented. Their collaboration bridged two eras, blending Victorian society's traditions with Alex's technological insights from the future.\n\nHowever, their newfound adventure took a sinister turn when a shadowy figure from the Victorian era unearthed the existence of the time machine. Driven by malevolent intentions, the mysterious antagonist sought to harness the power of time travel for their own nefarious purposes, posing a grave threat to both the past and the future.\n\nFaced with impending danger, Alex and Eliza realized that they held the fate of history in their hands. With time running out, they raced against the clock, navigating through the complexities of each era and confronting unforeseen challenges that tested their resolve.\n\nAs the tension mounted, a final showdown unfolded, blending elements of mystery and suspense. Alex and Eliza found themselves in a thrilling confrontation with the malevolent figure, the stakes higher than ever before. In a climactic turn of events, they made a decision that would not only safeguard the integrity of the timeline but also shape their destinies in ways they never imagined.\n\nAmidst the whirlwind of adventure and intrigue, the timeless themes of human curiosity and ambition resonated deeply. The ethics of time travel, the impact of technology on society, and the unyielding spirit of exploration painted a tapestry of wonder and reflection, transcending the boundaries of time itself.\n\nAs Alex and Eliza bid farewell to the Victorian era, their hearts enriched by the bond forged through their extraordinary journey, they carried with them a newfound understanding of the interconnectedness of past, present, and future. And as the time machine hummed to life once more, propelling them back to the present day, they knew that their adventures had only just begun – for time, like the mysteries it held, was infinite and ever beckoning to those who dared to explore its depths."
}
```

#### Data values <a href="#data-values" id="data-values"></a>

* You can explain the story on the `topic` parametr
* Word Count is the max word count of the story. Max 2000 is received.
* Writing Mode could be either: Standard, Complex, Creative, Simple
* Story Genre could be eighter: science fiction, mystery, fantasy, descriptive


# AI Essay Generator

Generate esay based on mode, topic and word limit

[Try Demo](https://api.market/store/capix/essay)

### Endpoints <a href="#endpoints" id="endpoints"></a>

`POST https://prod.api.market/api/v1/capix/essay/generate/essay/v1/`

**Overview**

This endpoint allows you to generate an essay based on a provided description, mode, and word count. The request must include a valid API token in the headers.

**Request Headers**

* **Content-Type**: `application/json`
* **x-magicapi-key**: `API_KEY` (Replace `API_KEY` with your actual API key)

**Request Body**

The body of the request should be in JSON format and include the following parameters:

* **description**: A detailed description of the essay topic and key points to be covered. This is a string that provides guidance on what the essay should encompass.
* **mode**: The mode of the essay generation. For example, it could be "Standard", "Detailed", etc.
* **word\_count**: The desired word count for the generated essay. This should be an integer.

**Example Request Body**

```json
{
  "description": "Essay Topic: The Impact of Social Media on Human Communication Key Details and Questions: Introduction: Introduce the topic by highlighting the ubiquity of social media in modern life. Pose the central question: Has social media enhanced or hindered human communication? Historical Perspective: How did people communicate before the advent of social media? What were the key stages in the evolution of social media platforms? Positive Impacts of Social Media: How has social media facilitated global connectivity and understanding? Discuss the role of social media in democratizing content creation and information sharing. Negative Impacts of Social Media: Analyze the potential for misinformation and echo chambers. Explore the effects of social media on mental health and interpersonal relationships. Social Media and Business: How has social media transformed business marketing and customer engagement? Discuss the rise of influencer culture and its implications. The Future of Social Media: Speculate on the future trends in social media. What role might emerging technologies like AI and VR play in the evolution of social media? Conclusion: Summarize the main points. Reflect on the balance between the benefits and drawbacks of social media. Provide a personal perspective or a call to action on how to use social media responsibly. Themes to Explore: The role of technology in shaping human interaction. The balance between virtual and real-life communication. Ethical considerations in the age of digital media.",
  "mode": "Standard",
  "word_count": 1200
}
```

**Error Handling**

The API will return appropriate error messages if the request is invalid or if there is an issue with generating the essay. Common error codes include:

* **400 Bad Request**: The request was invalid. This can happen if the JSON is malformed or required parameters are missing.
* **401 Unauthorized**: The API key provided in the `token` header is invalid.
* **500 Internal Server Error**: An error occurred on the server while processing the request.

**Example Error Response**

```json
{
  "error": "Invalid API key"
}
```

**Notes**

* Ensure that the API key is kept secure and not exposed in public repositories or client-side code.
* Adjust the `description`, `mode`, and `word_count` according to your specific requirements for the essay generation.

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="CURL" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/essay/generate/essay/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'description=Essay%20Topic%3A%20The%20Impact%20of%20Social%20Media%20on%20Human%20Communication%0A%0A%0AKey%20Details%20and%20Questions%3A%0A%0A%0AIntroduction%3A%20Introduce%20the%20topic%20by%20highlighting%20the%20ubiquity%20of%20social%20media%20in%20modern%20life.%20Pose%20the%20central%20question%3A%20Has%20social%20media%20enhanced%20or%20hindered%20human%20communication%3F%0A%0A%0AHistorical%20Perspective%3A%0A%0A%0AHow%20did%20people%20communicate%20before%20the%20advent%20of%20social%20media%3F%0AWhat%20were%20the%20key%20stages%20in%20the%20evolution%20of%20social%20media%20platforms%3F%0APositive%20Impacts%20of%20Social%20Media%3A%0A%0A%0AHow%20has%20social%20media%20facilitated%20global%20connectivity%20and%20understanding%3F%0ADiscuss%20the%20role%20of%20social%20media%20in%20democratizing%20content%20creation%20and%20information%20sharing.%0ANegative%20Impacts%20of%20Social%20Media%3A%0A%0A%0AAnalyze%20the%20potential%20for%20misinformation%20and%20echo%20chambers.%0AExplore%20the%20effects%20of%20social%20media%20on%20mental%20health%20and%20interpersonal%20relationships.%0ASocial%20Media%20and%20Business%3A%0A%0A%0AHow%20has%20social%20media%20transformed%20business%20marketing%20and%20customer%20engagement%3F%0ADiscuss%20the%20rise%20of%20influencer%20culture%20and%20its%20implications.%0AThe%20Future%20of%20Social%20Media%3A%0A%0A%0ASpeculate%20on%20the%20future%20trends%20in%20social%20media.%0AWhat%20role%20might%20emerging%20technologies%20like%20AI%20and%20VR%20play%20in%20the%20evolution%20of%20social%20media%3F%0AConclusion%3A%0A%0A%0ASummarize%20the%20main%20points.%0AReflect%20on%20the%20balance%20between%20the%20benefits%20and%20drawbacks%20of%20social%20media.%0AProvide%20a%20personal%20perspective%20or%20a%20call%20to%20action%20on%20how%20to%20use%20social%20media%20responsibly.%0AThemes%20to%20Explore%3A%0A%0A%0AThe%20role%20of%20technology%20in%20shaping%20human%20interaction.%0AThe%20balance%20between%20virtual%20and%20real-life%20communication.%0AEthical%20considerations%20in%20the%20age%20of%20digital%20media.&word_count=1200&mode=Standard'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'description': 'Essay Topic: The Impact of Social Media on Human Communication\n\n\nKey Details and Questions:\n\n\nIntroduction: Introduce the topic by highlighting the ubiquity of social media in modern life. Pose the central question: Has social media enhanced or hindered human communication?\n\n\nHistorical Perspective:\n\n\nHow did people communicate before the advent of social media?\nWhat were the key stages in the evolution of social media platforms?\nPositive Impacts of Social Media:\n\n\nHow has social media facilitated global connectivity and understanding?\nDiscuss the role of social media in democratizing content creation and information sharing.\nNegative Impacts of Social Media:\n\n\nAnalyze the potential for misinformation and echo chambers.\nExplore the effects of social media on mental health and interpersonal relationships.\nSocial Media and Business:\n\n\nHow has social media transformed business marketing and customer engagement?\nDiscuss the rise of influencer culture and its implications.\nThe Future of Social Media:\n\n\nSpeculate on the future trends in social media.\nWhat role might emerging technologies like AI and VR play in the evolution of social media?\nConclusion:\n\n\nSummarize the main points.\nReflect on the balance between the benefits and drawbacks of social media.\nProvide a personal perspective or a call to action on how to use social media responsibly.\nThemes to Explore:\n\n\nThe role of technology in shaping human interaction.\nThe balance between virtual and real-life communication.\nEthical considerations in the age of digital media.',
    'word_count': '1200',
    'mode': 'Standard',
}

response = requests.post('https://prod.api.market/api/v1/capix/essay/generate/essay/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/essay/generate/essay/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'description=Essay%20Topic%3A%20The%20Impact%20of%20Social%20Media%20on%20Human%20Communication%0A%0A%0AKey%20Details%20and%20Questions%3A%0A%0A%0AIntroduction%3A%20Introduce%20the%20topic%20by%20highlighting%20the%20ubiquity%20of%20social%20media%20in%20modern%20life.%20Pose%20the%20central%20question%3A%20Has%20social%20media%20enhanced%20or%20hindered%20human%20communication%3F%0A%0A%0AHistorical%20Perspective%3A%0A%0A%0AHow%20did%20people%20communicate%20before%20the%20advent%20of%20social%20media%3F%0AWhat%20were%20the%20key%20stages%20in%20the%20evolution%20of%20social%20media%20platforms%3F%0APositive%20Impacts%20of%20Social%20Media%3A%0A%0A%0AHow%20has%20social%20media%20facilitated%20global%20connectivity%20and%20understanding%3F%0ADiscuss%20the%20role%20of%20social%20media%20in%20democratizing%20content%20creation%20and%20information%20sharing.%0ANegative%20Impacts%20of%20Social%20Media%3A%0A%0A%0AAnalyze%20the%20potential%20for%20misinformation%20and%20echo%20chambers.%0AExplore%20the%20effects%20of%20social%20media%20on%20mental%20health%20and%20interpersonal%20relationships.%0ASocial%20Media%20and%20Business%3A%0A%0A%0AHow%20has%20social%20media%20transformed%20business%20marketing%20and%20customer%20engagement%3F%0ADiscuss%20the%20rise%20of%20influencer%20culture%20and%20its%20implications.%0AThe%20Future%20of%20Social%20Media%3A%0A%0A%0ASpeculate%20on%20the%20future%20trends%20in%20social%20media.%0AWhat%20role%20might%20emerging%20technologies%20like%20AI%20and%20VR%20play%20in%20the%20evolution%20of%20social%20media%3F%0AConclusion%3A%0A%0A%0ASummarize%20the%20main%20points.%0AReflect%20on%20the%20balance%20between%20the%20benefits%20and%20drawbacks%20of%20social%20media.%0AProvide%20a%20personal%20perspective%20or%20a%20call%20to%20action%20on%20how%20to%20use%20social%20media%20responsibly.%0AThemes%20to%20Explore%3A%0A%0A%0AThe%20role%20of%20technology%20in%20shaping%20human%20interaction.%0AThe%20balance%20between%20virtual%20and%20real-life%20communication.%0AEthical%20considerations%20in%20the%20age%20of%20digital%20media.&word_count=1200&mode=Standard');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/essay/generate/essay/v1/',
  new URLSearchParams({
    'description': 'Essay Topic: The Impact of Social Media on Human Communication\n\n\nKey Details and Questions:\n\n\nIntroduction: Introduce the topic by highlighting the ubiquity of social media in modern life. Pose the central question: Has social media enhanced or hindered human communication?\n\n\nHistorical Perspective:\n\n\nHow did people communicate before the advent of social media?\nWhat were the key stages in the evolution of social media platforms?\nPositive Impacts of Social Media:\n\n\nHow has social media facilitated global connectivity and understanding?\nDiscuss the role of social media in democratizing content creation and information sharing.\nNegative Impacts of Social Media:\n\n\nAnalyze the potential for misinformation and echo chambers.\nExplore the effects of social media on mental health and interpersonal relationships.\nSocial Media and Business:\n\n\nHow has social media transformed business marketing and customer engagement?\nDiscuss the rise of influencer culture and its implications.\nThe Future of Social Media:\n\n\nSpeculate on the future trends in social media.\nWhat role might emerging technologies like AI and VR play in the evolution of social media?\nConclusion:\n\n\nSummarize the main points.\nReflect on the balance between the benefits and drawbacks of social media.\nProvide a personal perspective or a call to action on how to use social media responsibly.\nThemes to Explore:\n\n\nThe role of technology in shaping human interaction.\nThe balance between virtual and real-life communication.\nEthical considerations in the age of digital media.',
    'word_count': '1200',
    'mode': 'Standard'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/essay/generate/essay/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'description': 'Essay Topic: The Impact of Social Media on Human Communication\n\n\nKey Details and Questions:\n\n\nIntroduction: Introduce the topic by highlighting the ubiquity of social media in modern life. Pose the central question: Has social media enhanced or hindered human communication?\n\n\nHistorical Perspective:\n\n\nHow did people communicate before the advent of social media?\nWhat were the key stages in the evolution of social media platforms?\nPositive Impacts of Social Media:\n\n\nHow has social media facilitated global connectivity and understanding?\nDiscuss the role of social media in democratizing content creation and information sharing.\nNegative Impacts of Social Media:\n\n\nAnalyze the potential for misinformation and echo chambers.\nExplore the effects of social media on mental health and interpersonal relationships.\nSocial Media and Business:\n\n\nHow has social media transformed business marketing and customer engagement?\nDiscuss the rise of influencer culture and its implications.\nThe Future of Social Media:\n\n\nSpeculate on the future trends in social media.\nWhat role might emerging technologies like AI and VR play in the evolution of social media?\nConclusion:\n\n\nSummarize the main points.\nReflect on the balance between the benefits and drawbacks of social media.\nProvide a personal perspective or a call to action on how to use social media responsibly.\nThemes to Explore:\n\n\nThe role of technology in shaping human interaction.\nThe balance between virtual and real-life communication.\nEthical considerations in the age of digital media.',
    'word_count': '1200',
    'mode': 'Standard'
  })
});
```

{% endtab %}
{% endtabs %}

**It returns response like this**

```json
{
    "essay":"**The Impact of Social Media on Human Communication**\n\nIn today's digital age, social media has become an integral part of our daily lives, revolutionizing the way we communicate and interact with others. The pervasive nature of social media platforms raises the essential question: Has social media enhanced or hindered human communication? To delve into this complex query, we must first journey through the historical perspective of communication, explore the positive and negative impacts of social media, delve into its implications on businesses, speculate on its future, and reflect on the ethical considerations that arise in the digital realm.\n\n**Historical Perspective**\n\nBefore the era of social media, communication was primarily conducted through face-to-face interactions, letters, telephones, and later emails. The advent of social media marked a significant shift in how people connect and share information. From the humble beginnings of platforms like Six Degrees and Friendster to the ubiquitous giants of today such as Facebook, Twitter, and Instagram, the evolution of social media platforms has been rapid and transformative. Each stage introduced new features, functionalities, and opportunities for users to engage and communicate in innovative ways.\n\n**Positive Impacts of Social Media**\n\nSocial media has fostered global connectivity and understanding by breaking down geographical barriers, enabling individuals from diverse backgrounds to interact and exchange ideas effortlessly. Platforms like Twitter and Instagram have become powerful tools for activists, allowing them to amplify their voices and mobilize support for social causes. Moreover, social media has democratized content creation, empowering individuals to share their stories, opinions, and creative works with a global audience instantly. This democratization of information has paved the way for greater inclusivity and diversity in the digital sphere.\n\n**Negative Impacts of Social Media**\n\nDespite its numerous benefits, social media has also brought about challenges such as the rampant spread of misinformation and the creation of echo chambers where individuals are exposed only to information that aligns with their existing beliefs. This phenomenon can fuel polarization and hinder constructive dialogue. Additionally, the constant use of social media has been linked to negative effects on mental health, including increased feelings of isolation, anxiety, and depression. Furthermore, the reliance on digital communication has altered interpersonal relationships, leading to a decrease in face-to-face interactions and meaningful connections.\n\n**Social Media and Business**\n\nThe integration of social media into the business world has revolutionized marketing strategies and customer engagement practices. Companies now leverage platforms like Facebook and Instagram to reach a wider audience, tailor their messaging, and solicit feedback in real-time. The rise of influencer culture has disrupted traditional advertising methods, with influencers wielding significant influence over consumer behavior and brand perception. Businesses must navigate this new landscape carefully, balancing authenticity and commercial interests to build meaningful relationships with their target demographics.\n\n**The Future of Social Media**\n\nAs we look towards the future, trends in social media are likely to be shaped by emerging technologies such as artificial intelligence (AI) and virtual reality (VR). AI-powered algorithms will continue to personalize user experiences, curate content, and enhance security measures. VR technologies may revolutionize how we interact in virtual spaces, blurring the lines between physical and digital communication. The evolution of social media will undoubtedly present new opportunities and challenges, requiring us to adapt and innovate continually.\n\n**Conclusion**\n\nIn conclusion, the impact of social media on human communication is multifaceted, with both positive and negative implications. While social media has facilitated global connectivity, information sharing, and business growth, it has also contributed to the spread of misinformation, mental health issues, and changes in interpersonal dynamics. To navigate this digital landscape responsibly, users must be mindful of the content they consume and share, foster meaningful connections offline, and engage critically with the platforms they use. As we continue to embrace the possibilities of social media, it is crucial to strike a balance between virtual interactions and real-life connections and uphold ethical standards in our digital engagements.\n\nIn this era of rapid technological advancement, the interplay between social media and human communication underscores the need for thoughtful reflection and proactive engagement. By navigating the complexities of social media with intentionality and care, we can harness its transformative potential while mitigating its pitfalls. As we journey forward into an increasingly interconnected world, let us strive to use social media as a tool for positive change, empathy, and authentic connection.\n\n**Themes to Explore**\n\nThe role of technology in shaping human interaction highlights the dynamic interplay between digital tools and social behaviors. Understanding how technology influences our communication patterns can inform more conscious and intentional use of social media platforms.\n\nThe balance between virtual and real-life communication signifies the importance of maintaining meaningful connections both online and offline. While social media offers opportunities for global engagement, nurturing authentic relationships in the physical world remains essential for overall well-being.\n\nEthical considerations in the age of digital media underscore the need for accountability, transparency, and critical thinking in our online interactions. By upholding ethical standards and promoting responsible digital citizenship, we can create a safer and more inclusive online environment for all users.\n\nIn essence, the impact of social media on human communication extends far beyond the digital realm, shaping the way we connect, collaborate, and understand one another in the modern age. By exploring the complexities of this phenomenon, we can cultivate a deeper awareness of the power dynamics at play in our digital interactions and strive to use social media as a force for positive change and authentic expression."
}
```

### Data values <a href="#data-values" id="data-values"></a>

* You can explain the essay on the `description` parametr
* Word Count is the max word count of the story. Max 2000 is received. Result: You can seperate the titles with comma
* Writing Mode could be either: Standard, Academic, Professional, Journalistic
* Writing Purpose could be eighter: Narrative, Argumentative, Expository, Descriptive


# Book Title Generator

Generates book titles using prompts

[Try Demo](https://api.market/store/capix/title)

### Endpoints <a href="#endpoints" id="endpoints"></a>

`POST https://prod.api.market/v1/capix/title/generate/booktitle/v1/`

**Description**

This endpoint generates a title based on the provided description and mode. It is part of the Capix API version 2.

**Headers**

* x-api-market-key: (string) A required header for authentication. Replace `API_KEY` with your actual API key.
* `Content-Type`: (string) This should be set to `application/json` to indicate that the request body contains JSON data.

**Request Body**

The request body should be a JSON object with the following fields:

* `mode`: (string) The mode in which the title should be generated. Example values include `Formal`, `Casual`, etc.
* `description`: (string) A brief description that will be used to generate the title.

**Example Request Body**

```json
{
  "mode": "Formal",
  "description": "let us dive"
}
```

**Error Handling**

If the request is invalid or the token is missing/incorrect, the server will respond with an appropriate HTTP status code and a message indicating the error.

**Example Error Responses**

* `401 Unauthorized`

  ```json
  {
    "error": "Invalid token."
  }
  ```
* `400 Bad Request`

  ```json
  {
    "error": "Invalid request body."
  }
  ```

**Notes**

* Ensure that the `token` header contains a valid API key.
* The `mode` field should be one of the accepted values. Check the API documentation or contact support if you are unsure about the valid modes.
* The `description` field should be a concise and meaningful string to get the best results from the title generation.

### Code Examples <a href="#code-examples" id="code-examples"></a>

{% tabs %}
{% tab title="CURL" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/capix/title/generate/booktitle/v1/' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'description=let%20us%20dive&mode=Formal'
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

headers = {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY',
    'Content-Type': 'application/x-www-form-urlencoded',
}

data = {
    'description': 'let us dive',
    'mode': 'Formal',
}

response = requests.post('https://prod.api.market/api/v1/capix/title/generate/booktitle/v1/', headers=headers, data=data)
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://prod.api.market/api/v1/capix/title/generate/booktitle/v1/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json',
    'x-api-market-key: API_KEY',
    'Content-Type: application/x-www-form-urlencoded',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'description=let%20us%20dive&mode=Formal');

$response = curl_exec($ch);

curl_close($ch);
```

{% endtab %}

{% tab title="NodeJs" %}

```javascript
import axios from 'axios';

const response = await axios.post(
  'https://prod.api.market/api/v1/capix/title/generate/booktitle/v1/',
  new URLSearchParams({
    'description': 'let us dive',
    'mode': 'Formal'
  }),
  {
    headers: {
      'accept': 'application/json',
      'x-api-market-key': 'API_KEY'
    }
  }
);
```

{% endtab %}

{% tab title="Javascript" %}

```javascript
fetch('https://prod.api.market/api/v1/capix/title/generate/booktitle/v1/', {
  method: 'POST',
  headers: {
    'accept': 'application/json',
    'x-api-market-key': 'API_KEY'
  },
  body: new URLSearchParams({
    'description': 'let us dive',
    'mode': 'Formal'
  })
});
```

{% endtab %}
{% endtabs %}

**It returns response like this**

```json
{
    "titles":[
        "Journey of Echoes",
        " Whispered Reflections",
        " Depths Unveiled"
    ]
}
```


# Trueway

<https://api.market/store/trueway/>


# ⛕ 🗺️ Trueway Routing API

Finding the optimal route between two or more locations.

### Trueway Routing API: Your Affordable Navigation Solution

Welcome to Trueway Routing API, the cost-effective alternative to the Google Maps API. Designed to deliver the most efficient routes, our API ensures you get from point A to point B quickly, while avoiding obstacles like traffic, tolls, and highways. Whether you're a developer creating the next big app or a business optimizing logistics, Trueway Routing API is your go-to solution for seamless navigation.

**Developer Portal :** <https://api.market/store/trueway/routing>

#### Why Choose Trueway Routing API?

* **Global Coverage:** Access a vast network of roads across the globe, ensuring reliable routing anywhere in the world.
* **Optimal Routing:** Determine the best route for multiple stops, solving complex logistics challenges like the traveling salesman problem.
* **Traffic-Aware Navigation:** Utilize both historical and live traffic data to find the fastest route for any time of day.
* **Customizable Routes:** Easily avoid toll roads, highways, or ferries with simple parameters.
* **Detailed Route Information:** Receive comprehensive details, including distance, duration, route geometry, and turn-by-turn directions.
* **Affordable Pricing:** Enjoy all these features at a fraction of the cost of the Google Maps API.

#### Powerful Features to Enhance Your Application

**FindDrivingRoute:**

* Calculate the best route for multiple locations with up to 25 stops.
* Optimize the order of stops for efficiency.
* Avoid specific road types with customizable parameters.
* Use historical and live traffic data for accurate travel times.

**FindDrivingPath:**

* Ideal for routes between two points with optional intermediate stops.
* Avoid highways, tolls, and ferries.
* Traffic-aware routing for precise travel estimates.

#### API Parameters

**Required:**

* **stops:** Specify two or more semicolon-delimited locations (Lat/Lng).
* **origin & destination:** Define the starting and ending points for your route.

**Optional:**

* **avoid\_highways, avoid\_tolls, avoid\_ferries:** Customize your route preferences.
* **geometry\_format:** Choose your preferred route geometry format: latlng, lnglat, or geojson.
* **optimize:** Optimize the order of stops for efficiency.
* **waypoints:** Add intermediate locations for detailed routing.
* **start\_time:** Account for traffic conditions based on travel start time.

#### Comprehensive Response Data

Receive a detailed route response with the following fields:

* **Distance:** Total length of the route.
* **Duration:** Estimated travel time.
* **Geometry:** Precise route geometry in your chosen format.
* **Bounds:** Geographic bounds of the route.
* **Legs & Steps:** Breakdown of the route into manageable segments with specific instructions and maneuvers.

#### Real-World Examples

**FindDrivingRoute Request:**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/trueway/routing/DirectionsService/FindDrivingRoute?stops=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=false&avoid_highways=false&avoid_ferries=false&optimize=false' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="NodeJs" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/trueway/routing/DirectionsService/FindDrivingRoute?stops=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=SOME_BOOLEAN_VALUE&avoid_highways=SOME_BOOLEAN_VALUE&avoid_ferries=SOME_BOOLEAN_VALUE&optimize=SOME_BOOLEAN_VALUE';

let options = {method: 'GET', headers: {'x-api-market-key': 'SOME_STRING_VALUE'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

headers = { 'x-api-market-key': "SOME_STRING_VALUE" }

conn.request("GET", "/api/v1/trueway/routing/DirectionsService/FindDrivingRoute?stops=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=SOME_BOOLEAN_VALUE&avoid_highways=SOME_BOOLEAN_VALUE&avoid_ferries=SOME_BOOLEAN_VALUE&optimize=SOME_BOOLEAN_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/trueway/routing/DirectionsService/FindDrivingRoute?stops=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=SOME_BOOLEAN_VALUE&avoid_highways=SOME_BOOLEAN_VALUE&avoid_ferries=SOME_BOOLEAN_VALUE&optimize=SOME_BOOLEAN_VALUE")
  .get()
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

**FindDrivingRoute Response:**

```json
{
  "route": {
    "distance": 10178,
    "duration": 2579,
    "bounds": {
      "south": 40.618996,
      "west": -74.025801,
      "north": 40.645342,
      "east": -73.98077
    },
    "geometry": {
      "coordinates": [
        [
          40.629103,
          -74.025801
        ],
        [
          40.629409,
          -74.025679
        ],
        [
          40.629389,
          -74.025588
        ],
        [
          40.629379,
          -74.025558
        ],
        [
          40.629369,
          -74.025548
        ],
        [
          40.629369,
          -74.025537
        ],
        [
          40.628994,
          -74.024899
        ],
        [
          40.628247,
          -74.023633
        ],
        [
          40.628177,
          -74.023523
        ],
        [
          40.628137,
          -74.023452
        ],
        [
          40.628097,
          -74.023402
        ],
        [
          40.628057,
          -74.023341
        ],
        [
          40.628007,
          -74.023241
        ],
        [
          40.627916,
          -74.0231
        ],
        [
          40.627443,
          -74.02231
        ],
        [
          40.626753,
          -74.0212
        ],
        [
          40.626662,
          -74.021042
        ],
        [
          40.62656,
          -74.020904
        ],
        [
          40.627301,
          -74.020599
        ],
        [
          40.627513,
          -74.02052
        ],
        [
          40.628057,
          -74.020303
        ],
        [
          40.627946,
          -74.020106
        ],
        [
          40.627876,
          -74.020007
        ],
        [
          40.627765,
          -74.01981
        ],
        [
          40.627624,
          -74.019582
        ],
        [
          40.627493,
          -74.019385
        ],
        [
          40.627443,
          -74.019286
        ],
        [
          40.627382,
          -74.019196
        ],
        [
          40.627271,
          -74.019018
        ],
        [
          40.627068,
          -74.01868
        ],
        [
          40.626977,
          -74.01852
        ],
        [
          40.626967,
          -74.0185
        ],
        [
          40.626946,
          -74.01848
        ],
        [
          40.626896,
          -74.01838
        ],
        [
          40.626865,
          -74.01834
        ],
        [
          40.626845,
          -74.0183
        ],
        [
          40.626804,
          -74.01823
        ],
        [
          40.626774,
          -74.01819
        ],
        [
          40.626733,
          -74.01812
        ],
        [
          40.626682,
          -74.01803
        ],
        [
          40.626631,
          -74.01795
        ],
        [
          40.626611,
          -74.01793
        ],
        [
          40.626601,
          -74.01791
        ],
        [
          40.62657,
          -74.01788
        ],
        [
          40.626499,
          -74.017769
        ],
        [
          40.626316,
          -74.017467
        ],
        [
          40.626204,
          -74.017286
        ],
        [
          40.626143,
          -74.017185
        ],
        [
          40.626102,
          -74.017114
        ],
        [
          40.626041,
          -74.017003
        ],
        [
          40.62601,
          -74.016953
        ],
        [
          40.62598,
          -74.016912
        ],
        [
          40.625868,
          -74.01671
        ],
        [
          40.625766,
          -74.016537
        ],
        [
          40.625643,
          -74.016345
        ],
        [
          40.625593,
          -74.016254
        ],
        [
          40.62546,
          -74.01603
        ],
        [
          40.625369,
          -74.015858
        ],
        [
          40.625359,
          -74.015828
        ],
        [
          40.625348,
          -74.015787
        ],
        [
          40.625287,
          -74.015675
        ],
        [
          40.625206,
          -74.015554
        ],
        [
          40.62476,
          -74.014815
        ],
        [
          40.624285,
          -74.01404
        ],
        [
          40.623593,
          -74.012893
        ],
        [
          40.623483,
          -74.012695
        ],
        [
          40.623444,
          -74.012645
        ],
        [
          40.622947,
          -74.011815
        ],
        [
          40.622621,
          -74.011273
        ],
        [
          40.621961,
          -74.010176
        ],
        [
          40.621647,
          -74.00965
        ],
        [
          40.621372,
          -74.0092
        ],
        [
          40.621304,
          -74.00908
        ],
        [
          40.620823,
          -74.008276
        ],
        [
          40.620636,
          -74.007973
        ],
        [
          40.62032,
          -74.007446
        ],
        [
          40.620004,
          -74.006899
        ],
        [
          40.619547,
          -74.006128
        ],
        [
          40.619337,
          -74.005765
        ],
        [
          40.619277,
          -74.005664
        ],
        [
          40.618996,
          -74.005211
        ],
        [
          40.619606,
          -74.00458
        ],
        [
          40.620162,
          -74.004002
        ],
        [
          40.62035,
          -74.003804
        ],
        [
          40.620714,
          -74.003427
        ],
        [
          40.62099,
          -74.003131
        ],
        [
          40.621265,
          -74.002855
        ],
        [
          40.621539,
          -74.002559
        ],
        [
          40.621814,
          -74.002283
        ],
        [
          40.622364,
          -74.001701
        ],
        [
          40.622818,
          -74.001216
        ],
        [
          40.622917,
          -74.001117
        ],
        [
          40.623175,
          -74.000839
        ],
        [
          40.623463,
          -74.00054
        ],
        [
          40.623533,
          -74.00048
        ],
        [
          40.623773,
          -74.00024
        ],
        [
          40.623963,
          -74.00006
        ],
        [
          40.624034,
          -73.99998
        ],
        [
          40.624557,
          -73.999437
        ],
        [
          40.624638,
          -73.999346
        ],
        [
          40.624912,
          -73.999064
        ],
        [
          40.625247,
          -73.99872
        ],
        [
          40.625531,
          -73.998416
        ],
        [
          40.625817,
          -73.998112
        ],
        [
          40.625868,
          -73.998061
        ],
        [
          40.626387,
          -73.997523
        ],
        [
          40.626489,
          -73.997422
        ],
        [
          40.626591,
          -73.997311
        ],
        [
          40.626733,
          -73.997159
        ],
        [
          40.626855,
          -73.997027
        ],
        [
          40.626906,
          -73.996977
        ],
        [
          40.626946,
          -73.996926
        ],
        [
          40.627078,
          -73.996795
        ],
        [
          40.627169,
          -73.996694
        ],
        [
          40.62718,
          -73.996684
        ],
        [
          40.627261,
          -73.996603
        ],
        [
          40.627352,
          -73.996512
        ],
        [
          40.627533,
          -73.996331
        ],
        [
          40.627634,
          -73.996221
        ],
        [
          40.627675,
          -73.996181
        ],
        [
          40.627946,
          -73.9959
        ],
        [
          40.628127,
          -73.99571
        ],
        [
          40.628447,
          -73.99538
        ],
        [
          40.628586,
          -73.995221
        ],
        [
          40.628676,
          -73.995131
        ],
        [
          40.628736,
          -73.995072
        ],
        [
          40.629132,
          -73.994675
        ],
        [
          40.629162,
          -73.994645
        ],
        [
          40.629241,
          -73.994566
        ],
        [
          40.629793,
          -73.993993
        ],
        [
          40.630157,
          -73.993608
        ],
        [
          40.630343,
          -73.993411
        ],
        [
          40.630539,
          -73.993746
        ],
        [
          40.630981,
          -73.994467
        ],
        [
          40.631119,
          -73.994685
        ],
        [
          40.631207,
          -73.994843
        ],
        [
          40.631355,
          -73.995101
        ],
        [
          40.631473,
          -73.99529
        ],
        [
          40.631542,
          -73.99542
        ],
        [
          40.63165,
          -73.9956
        ],
        [
          40.631967,
          -73.99611
        ],
        [
          40.632304,
          -73.996694
        ],
        [
          40.632973,
          -73.997817
        ],
        [
          40.633205,
          -73.998193
        ],
        [
          40.63381,
          -73.999195
        ],
        [
          40.634023,
          -73.999548
        ],
        [
          40.634104,
          -73.999669
        ],
        [
          40.634328,
          -74.00004
        ],
        [
          40.635234,
          -74.001523
        ],
        [
          40.635489,
          -74.001918
        ],
        [
          40.63555,
          -74.002007
        ],
        [
          40.637017,
          -74.0044
        ],
        [
          40.637477,
          -74.00515
        ],
        [
          40.637895,
          -74.005866
        ],
        [
          40.638004,
          -74.006047
        ],
        [
          40.6383,
          -74.006544
        ],
        [
          40.63834,
          -74.006615
        ],
        [
          40.638448,
          -74.006797
        ],
        [
          40.638655,
          -74.007152
        ],
        [
          40.638999,
          -74.00774
        ],
        [
          40.639206,
          -74.008084
        ],
        [
          40.639647,
          -74.00884
        ],
        [
          40.64003,
          -74.00948
        ],
        [
          40.640246,
          -74.009849
        ],
        [
          40.640739,
          -74.010671
        ],
        [
          40.640927,
          -74.010977
        ],
        [
          40.640957,
          -74.011037
        ],
        [
          40.641284,
          -74.011569
        ],
        [
          40.641723,
          -74.012299
        ],
        [
          40.641943,
          -74.012665
        ],
        [
          40.641953,
          -74.012665
        ],
        [
          40.642285,
          -74.013221
        ],
        [
          40.642477,
          -74.01354
        ],
        [
          40.642628,
          -74.01378
        ],
        [
          40.643308,
          -74.014896
        ],
        [
          40.643633,
          -74.015422
        ],
        [
          40.644194,
          -74.014835
        ],
        [
          40.64458,
          -74.014432
        ],
        [
          40.644774,
          -74.014241
        ],
        [
          40.645027,
          -74.01398
        ],
        [
          40.645342,
          -74.01366
        ],
        [
          40.64522,
          -74.01347
        ],
        [
          40.645109,
          -74.01329
        ],
        [
          40.644997,
          -74.013101
        ],
        [
          40.644885,
          -74.012923
        ],
        [
          40.644316,
          -74.012003
        ],
        [
          40.644082,
          -74.011638
        ],
        [
          40.64399,
          -74.01148
        ],
        [
          40.643878,
          -74.011303
        ],
        [
          40.643806,
          -74.011185
        ],
        [
          40.643654,
          -74.010938
        ],
        [
          40.643297,
          -74.010375
        ],
        [
          40.642973,
          -74.009839
        ],
        [
          40.642871,
          -74.00968
        ],
        [
          40.642679,
          -74.00936
        ],
        [
          40.642648,
          -74.0093
        ],
        [
          40.642305,
          -74.008749
        ],
        [
          40.642034,
          -74.008296
        ],
        [
          40.641743,
          -74.007811
        ],
        [
          40.641633,
          -74.007629
        ],
        [
          40.641404,
          -74.007243
        ],
        [
          40.641334,
          -74.007132
        ],
        [
          40.641304,
          -74.007081
        ],
        [
          40.640977,
          -74.006513
        ],
        [
          40.64064,
          -74.005946
        ],
        [
          40.640591,
          -74.005866
        ],
        [
          40.640305,
          -74.005382
        ],
        [
          40.640217,
          -74.005221
        ],
        [
          40.639991,
          -74.00485
        ],
        [
          40.639951,
          -74.00478
        ],
        [
          40.639461,
          -74.003962
        ],
        [
          40.639431,
          -74.003923
        ],
        [
          40.639019,
          -74.00322
        ],
        [
          40.638695,
          -74.002668
        ],
        [
          40.638271,
          -74.001977
        ],
        [
          40.637716,
          -74.001067
        ],
        [
          40.637377,
          -74.00049
        ],
        [
          40.637137,
          -74.00011
        ],
        [
          40.637017,
          -73.99992
        ],
        [
          40.636986,
          -73.99987
        ],
        [
          40.636936,
          -73.999769
        ],
        [
          40.636906,
          -73.999709
        ],
        [
          40.636402,
          -73.998892
        ],
        [
          40.636038,
          -73.998274
        ],
        [
          40.63557,
          -73.997503
        ],
        [
          40.635,
          -73.996563
        ],
        [
          40.634674,
          -73.99604
        ],
        [
          40.634125,
          -73.995161
        ],
        [
          40.634064,
          -73.995052
        ],
        [
          40.633325,
          -73.993855
        ],
        [
          40.632215,
          -73.992038
        ],
        [
          40.631996,
          -73.99167
        ],
        [
          40.631947,
          -73.99159
        ],
        [
          40.631789,
          -73.99134
        ],
        [
          40.631779,
          -73.99131
        ],
        [
          40.631591,
          -73.991
        ],
        [
          40.630686,
          -73.989466
        ],
        [
          40.629921,
          -73.988159
        ],
        [
          40.629389,
          -73.987241
        ],
        [
          40.628825,
          -73.98631
        ],
        [
          40.628626,
          -73.985982
        ],
        [
          40.627906,
          -73.984796
        ],
        [
          40.628467,
          -73.984224
        ],
        [
          40.629023,
          -73.983652
        ],
        [
          40.628527,
          -73.982829
        ],
        [
          40.628097,
          -73.98213
        ],
        [
          40.627775,
          -73.981588
        ],
        [
          40.627554,
          -73.981225
        ],
        [
          40.627321,
          -73.980831
        ],
        [
          40.627281,
          -73.98077
        ]
      ]
    },
    "legs": [
      {
        "distance": 3938,
        "duration": 832,
        "start_point_index": 0,
        "start_point": {
          "lat": 40.629103,
          "lng": -74.025801
        },
        "end_point_index": 130,
        "end_point": {
          "lat": 40.630157,
          "lng": -73.993608
        },
        "bounds": {
          "south": 40.618996,
          "west": -74.025801,
          "north": 40.630157,
          "east": -73.993608
        },
        "steps": [
          {
            "distance": 37,
            "duration": 9,
            "start_point_index": 0,
            "start_point": {
              "lat": 40.629103,
              "lng": -74.025801
            },
            "end_point_index": 1,
            "end_point": {
              "lat": 40.629409,
              "lng": -74.025679
            },
            "bounds": {
              "south": 40.629103,
              "west": -74.025801,
              "north": 40.629409,
              "east": -74.025679
            }
          },
          {
            "distance": 513,
            "duration": 79,
            "start_point_index": 1,
            "start_point": {
              "lat": 40.629409,
              "lng": -74.025679
            },
            "end_point_index": 17,
            "end_point": {
              "lat": 40.62656,
              "lng": -74.020904
            },
            "bounds": {
              "south": 40.62656,
              "west": -74.025679,
              "north": 40.629409,
              "east": -74.020904
            },
            "maneuver": "turn right"
          },
          {
            "distance": 174,
            "duration": 45,
            "start_point_index": 17,
            "start_point": {
              "lat": 40.62656,
              "lng": -74.020904
            },
            "end_point_index": 20,
            "end_point": {
              "lat": 40.628057,
              "lng": -74.020303
            },
            "bounds": {
              "south": 40.62656,
              "west": -74.020904,
              "north": 40.628057,
              "east": -74.020303
            },
            "maneuver": "turn left"
          },
          {
            "distance": 1627,
            "duration": 303,
            "start_point_index": 20,
            "start_point": {
              "lat": 40.628057,
              "lng": -74.020303
            },
            "end_point_index": 80,
            "end_point": {
              "lat": 40.618996,
              "lng": -74.005211
            },
            "bounds": {
              "south": 40.618996,
              "west": -74.020303,
              "north": 40.628057,
              "east": -74.005211
            },
            "maneuver": "turn right"
          },
          {
            "distance": 1587,
            "duration": 396,
            "start_point_index": 80,
            "start_point": {
              "lat": 40.618996,
              "lng": -74.005211
            },
            "end_point_index": 130,
            "end_point": {
              "lat": 40.630157,
              "lng": -73.993608
            },
            "bounds": {
              "south": 40.618996,
              "west": -74.005211,
              "north": 40.630157,
              "east": -73.993608
            },
            "maneuver": "turn left"
          }
        ]
      },
      {
        "distance": 2603,
        "duration": 726,
        "start_point_index": 130,
        "start_point": {
          "lat": 40.630157,
          "lng": -73.993608
        },
        "end_point_index": 179,
        "end_point": {
          "lat": 40.645027,
          "lng": -74.01398
        },
        "bounds": {
          "south": 40.630157,
          "west": -74.015422,
          "north": 40.645027,
          "east": -73.993411
        },
        "steps": [
          {
            "distance": 28,
            "duration": 7,
            "start_point_index": 130,
            "start_point": {
              "lat": 40.630157,
              "lng": -73.993608
            },
            "end_point_index": 131,
            "end_point": {
              "lat": 40.630343,
              "lng": -73.993411
            },
            "bounds": {
              "south": 40.630157,
              "west": -73.993608,
              "north": 40.630343,
              "east": -73.993411
            }
          },
          {
            "distance": 2380,
            "duration": 647,
            "start_point_index": 131,
            "start_point": {
              "lat": 40.630343,
              "lng": -73.993411
            },
            "end_point_index": 175,
            "end_point": {
              "lat": 40.643633,
              "lng": -74.015422
            },
            "bounds": {
              "south": 40.630343,
              "west": -74.015422,
              "north": 40.643633,
              "east": -73.993411
            },
            "maneuver": "turn left"
          },
          {
            "distance": 195,
            "duration": 72,
            "start_point_index": 175,
            "start_point": {
              "lat": 40.643633,
              "lng": -74.015422
            },
            "end_point_index": 179,
            "end_point": {
              "lat": 40.645027,
              "lng": -74.01398
            },
            "bounds": {
              "south": 40.643633,
              "west": -74.015422,
              "north": 40.645027,
              "east": -74.01398
            },
            "maneuver": "turn right"
          }
        ]
      },
      {
        "distance": 3637,
        "duration": 1021,
        "start_point_index": 179,
        "start_point": {
          "lat": 40.645027,
          "lng": -74.01398
        },
        "end_point_index": 249,
        "end_point": {
          "lat": 40.627281,
          "lng": -73.98077
        },
        "bounds": {
          "south": 40.627281,
          "west": -74.01398,
          "north": 40.645342,
          "east": -73.98077
        },
        "steps": [
          {
            "distance": 45,
            "duration": 11,
            "start_point_index": 179,
            "start_point": {
              "lat": 40.645027,
              "lng": -74.01398
            },
            "end_point_index": 180,
            "end_point": {
              "lat": 40.645342,
              "lng": -74.01366
            },
            "bounds": {
              "south": 40.645027,
              "west": -74.01398,
              "north": 40.645342,
              "east": -74.01366
            }
          },
          {
            "distance": 3121,
            "duration": 865,
            "start_point_index": 180,
            "start_point": {
              "lat": 40.645342,
              "lng": -74.01366
            },
            "end_point_index": 241,
            "end_point": {
              "lat": 40.627906,
              "lng": -73.984796
            },
            "bounds": {
              "south": 40.627906,
              "west": -74.01366,
              "north": 40.645342,
              "east": -73.984796
            },
            "maneuver": "turn right"
          },
          {
            "distance": 160,
            "duration": 56,
            "start_point_index": 241,
            "start_point": {
              "lat": 40.627906,
              "lng": -73.984796
            },
            "end_point_index": 243,
            "end_point": {
              "lat": 40.629023,
              "lng": -73.983652
            },
            "bounds": {
              "south": 40.627906,
              "west": -73.984796,
              "north": 40.629023,
              "east": -73.983652
            },
            "maneuver": "turn left"
          },
          {
            "distance": 311,
            "duration": 89,
            "start_point_index": 243,
            "start_point": {
              "lat": 40.629023,
              "lng": -73.983652
            },
            "end_point_index": 249,
            "end_point": {
              "lat": 40.627281,
              "lng": -73.98077
            },
            "bounds": {
              "south": 40.627281,
              "west": -73.983652,
              "north": 40.629023,
              "east": -73.98077
            },
            "maneuver": "turn right"
          }
        ]
      }
    ]
  }
}
```

**FindDrivingPath Request:**

```json
curl -X 'GET' \
  'https://prod.api.market/api/v1/trueway/routing/DirectionsService/FindDrivingPath?origin=40.629041%2C-74.025606&destination=40.627177%2C-73.980853&avoid_tolls=false&avoid_highways=false&avoid_ferries=false' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

**FindDrivingPath Response:**

```json
{
  "route": {
    "distance": 5425,
    "duration": 1103,
    "bounds": {
      "south": 40.614813,
      "west": -74.025801,
      "north": 40.629409,
      "east": -73.98077
    },
    "geometry": {
      "coordinates": [
        [
          40.629103,
          -74.025801
        ],
        [
          40.629409,
          -74.025679
        ],
        [
          40.629389,
          -74.025588
        ],
        [
          40.629379,
          -74.025558
        ],
        [
          40.629369,
          -74.025548
        ],
        [
          40.629369,
          -74.025537
        ],
        [
          40.628994,
          -74.024899
        ],
        [
          40.628247,
          -74.023633
        ],
        [
          40.628177,
          -74.023523
        ],
        [
          40.628137,
          -74.023452
        ],
        [
          40.628097,
          -74.023402
        ],
        [
          40.628057,
          -74.023341
        ],
        [
          40.628007,
          -74.023241
        ],
        [
          40.627916,
          -74.0231
        ],
        [
          40.627443,
          -74.02231
        ],
        [
          40.626753,
          -74.0212
        ],
        [
          40.626662,
          -74.021042
        ],
        [
          40.62656,
          -74.020904
        ],
        [
          40.627301,
          -74.020599
        ],
        [
          40.627513,
          -74.02052
        ],
        [
          40.628057,
          -74.020303
        ],
        [
          40.627946,
          -74.020106
        ],
        [
          40.627876,
          -74.020007
        ],
        [
          40.627765,
          -74.01981
        ],
        [
          40.627624,
          -74.019582
        ],
        [
          40.627493,
          -74.019385
        ],
        [
          40.627443,
          -74.019286
        ],
        [
          40.627382,
          -74.019196
        ],
        [
          40.627271,
          -74.019018
        ],
        [
          40.627068,
          -74.01868
        ],
        [
          40.626977,
          -74.01852
        ],
        [
          40.626967,
          -74.0185
        ],
        [
          40.626946,
          -74.01848
        ],
        [
          40.626896,
          -74.01838
        ],
        [
          40.626865,
          -74.01834
        ],
        [
          40.626845,
          -74.0183
        ],
        [
          40.626804,
          -74.01823
        ],
        [
          40.626774,
          -74.01819
        ],
        [
          40.626733,
          -74.01812
        ],
        [
          40.626682,
          -74.01803
        ],
        [
          40.626631,
          -74.01795
        ],
        [
          40.626611,
          -74.01793
        ],
        [
          40.626601,
          -74.01791
        ],
        [
          40.62657,
          -74.01788
        ],
        [
          40.626499,
          -74.017769
        ],
        [
          40.626316,
          -74.017467
        ],
        [
          40.626204,
          -74.017286
        ],
        [
          40.626143,
          -74.017185
        ],
        [
          40.626102,
          -74.017114
        ],
        [
          40.626041,
          -74.017003
        ],
        [
          40.62601,
          -74.016953
        ],
        [
          40.62598,
          -74.016912
        ],
        [
          40.625868,
          -74.01671
        ],
        [
          40.625766,
          -74.016537
        ],
        [
          40.625643,
          -74.016345
        ],
        [
          40.625593,
          -74.016254
        ],
        [
          40.62546,
          -74.01603
        ],
        [
          40.625369,
          -74.015858
        ],
        [
          40.625359,
          -74.015828
        ],
        [
          40.625348,
          -74.015787
        ],
        [
          40.625287,
          -74.015675
        ],
        [
          40.625206,
          -74.015554
        ],
        [
          40.62476,
          -74.014815
        ],
        [
          40.624285,
          -74.01404
        ],
        [
          40.623593,
          -74.012893
        ],
        [
          40.623483,
          -74.012695
        ],
        [
          40.623444,
          -74.012645
        ],
        [
          40.622947,
          -74.011815
        ],
        [
          40.622621,
          -74.011273
        ],
        [
          40.621961,
          -74.010176
        ],
        [
          40.621647,
          -74.00965
        ],
        [
          40.621372,
          -74.0092
        ],
        [
          40.621304,
          -74.00908
        ],
        [
          40.620823,
          -74.008276
        ],
        [
          40.620636,
          -74.007973
        ],
        [
          40.62032,
          -74.007446
        ],
        [
          40.620004,
          -74.006899
        ],
        [
          40.619547,
          -74.006128
        ],
        [
          40.619337,
          -74.005765
        ],
        [
          40.619277,
          -74.005664
        ],
        [
          40.618996,
          -74.005211
        ],
        [
          40.61822,
          -74.003933
        ],
        [
          40.617662,
          -74.003023
        ],
        [
          40.617214,
          -74.002313
        ],
        [
          40.616308,
          -74.000849
        ],
        [
          40.616165,
          -74.00061
        ],
        [
          40.615851,
          -74.00008
        ],
        [
          40.61579,
          -73.99997
        ],
        [
          40.615669,
          -73.999779
        ],
        [
          40.615648,
          -73.999739
        ],
        [
          40.614813,
          -73.998375
        ],
        [
          40.615416,
          -73.997746
        ],
        [
          40.615993,
          -73.997149
        ],
        [
          40.616552,
          -73.996573
        ],
        [
          40.617122,
          -73.99598
        ],
        [
          40.617245,
          -73.99585
        ],
        [
          40.617397,
          -73.9957
        ],
        [
          40.617692,
          -73.9954
        ],
        [
          40.618261,
          -73.994814
        ],
        [
          40.618311,
          -73.994774
        ],
        [
          40.618352,
          -73.994724
        ],
        [
          40.618826,
          -73.99424
        ],
        [
          40.618856,
          -73.99421
        ],
        [
          40.618886,
          -73.994181
        ],
        [
          40.619187,
          -73.993875
        ],
        [
          40.619944,
          -73.993096
        ],
        [
          40.620537,
          -73.992474
        ],
        [
          40.621137,
          -73.991859
        ],
        [
          40.621265,
          -73.99171
        ],
        [
          40.621402,
          -73.99156
        ],
        [
          40.621422,
          -73.99155
        ],
        [
          40.62148,
          -73.99149
        ],
        [
          40.621677,
          -73.99128
        ],
        [
          40.622227,
          -73.990689
        ],
        [
          40.622601,
          -73.990286
        ],
        [
          40.622779,
          -73.990114
        ],
        [
          40.623354,
          -73.989497
        ],
        [
          40.623933,
          -73.988888
        ],
        [
          40.624497,
          -73.98829
        ],
        [
          40.624588,
          -73.988199
        ],
        [
          40.624628,
          -73.988159
        ],
        [
          40.624729,
          -73.988058
        ],
        [
          40.62477,
          -73.988007
        ],
        [
          40.625064,
          -73.987704
        ],
        [
          40.625623,
          -73.98713
        ],
        [
          40.625562,
          -73.98703
        ],
        [
          40.625399,
          -73.98676
        ],
        [
          40.625287,
          -73.98657
        ],
        [
          40.624851,
          -73.985853
        ],
        [
          40.624366,
          -73.985062
        ],
        [
          40.624305,
          -73.984973
        ],
        [
          40.624436,
          -73.984835
        ],
        [
          40.624881,
          -73.984401
        ],
        [
          40.62546,
          -73.983839
        ],
        [
          40.626051,
          -73.983276
        ],
        [
          40.626143,
          -73.983176
        ],
        [
          40.626234,
          -73.983087
        ],
        [
          40.626295,
          -73.983028
        ],
        [
          40.626346,
          -73.982978
        ],
        [
          40.626621,
          -73.982719
        ],
        [
          40.626977,
          -73.98237
        ],
        [
          40.6272,
          -73.98215
        ],
        [
          40.627533,
          -73.98183
        ],
        [
          40.627775,
          -73.981588
        ],
        [
          40.627554,
          -73.981225
        ],
        [
          40.627321,
          -73.980831
        ],
        [
          40.627281,
          -73.98077
        ]
      ]
    },
    "steps": [
      {
        "distance": 37,
        "duration": 9,
        "start_point_index": 0,
        "start_point": {
          "lat": 40.629103,
          "lng": -74.025801
        },
        "end_point_index": 1,
        "end_point": {
          "lat": 40.629409,
          "lng": -74.025679
        },
        "bounds": {
          "south": 40.629103,
          "west": -74.025801,
          "north": 40.629409,
          "east": -74.025679
        }
      },
      {
        "distance": 513,
        "duration": 79,
        "start_point_index": 1,
        "start_point": {
          "lat": 40.629409,
          "lng": -74.025679
        },
        "end_point_index": 17,
        "end_point": {
          "lat": 40.62656,
          "lng": -74.020904
        },
        "bounds": {
          "south": 40.62656,
          "west": -74.025679,
          "north": 40.629409,
          "east": -74.020904
        },
        "maneuver": "turn right"
      },
      {
        "distance": 174,
        "duration": 45,
        "start_point_index": 17,
        "start_point": {
          "lat": 40.62656,
          "lng": -74.020904
        },
        "end_point_index": 20,
        "end_point": {
          "lat": 40.628057,
          "lng": -74.020303
        },
        "bounds": {
          "south": 40.62656,
          "west": -74.020904,
          "north": 40.628057,
          "east": -74.020303
        },
        "maneuver": "turn left"
      },
      {
        "distance": 2367,
        "duration": 442,
        "start_point_index": 20,
        "start_point": {
          "lat": 40.628057,
          "lng": -74.020303
        },
        "end_point_index": 90,
        "end_point": {
          "lat": 40.614813,
          "lng": -73.998375
        },
        "bounds": {
          "south": 40.614813,
          "west": -74.020303,
          "north": 40.628057,
          "east": -73.998375
        },
        "maneuver": "turn right"
      },
      {
        "distance": 1533,
        "duration": 349,
        "start_point_index": 90,
        "start_point": {
          "lat": 40.614813,
          "lng": -73.998375
        },
        "end_point_index": 124,
        "end_point": {
          "lat": 40.625623,
          "lng": -73.98713
        },
        "bounds": {
          "south": 40.614813,
          "west": -73.998375,
          "north": 40.625623,
          "east": -73.98713
        },
        "maneuver": "turn left"
      },
      {
        "distance": 234,
        "duration": 25,
        "start_point_index": 124,
        "start_point": {
          "lat": 40.625623,
          "lng": -73.98713
        },
        "end_point_index": 130,
        "end_point": {
          "lat": 40.624305,
          "lng": -73.984973
        },
        "bounds": {
          "south": 40.624305,
          "west": -73.98713,
          "north": 40.625623,
          "east": -73.984973
        },
        "maneuver": "turn right"
      },
      {
        "distance": 478,
        "duration": 128,
        "start_point_index": 130,
        "start_point": {
          "lat": 40.624305,
          "lng": -73.984973
        },
        "end_point_index": 143,
        "end_point": {
          "lat": 40.627775,
          "lng": -73.981588
        },
        "bounds": {
          "south": 40.624305,
          "west": -73.984973,
          "north": 40.627775,
          "east": -73.981588
        },
        "maneuver": "turn left"
      },
      {
        "distance": 89,
        "duration": 26,
        "start_point_index": 143,
        "start_point": {
          "lat": 40.627775,
          "lng": -73.981588
        },
        "end_point_index": 146,
        "end_point": {
          "lat": 40.627281,
          "lng": -73.98077
        },
        "bounds": {
          "south": 40.627281,
          "west": -73.981588,
          "north": 40.627775,
          "east": -73.98077
        },
        "maneuver": "turn right"
      }
    ]
  }
}
```

#### Get Started with Trueway Routing API

Transform the way you navigate with Trueway Routing API, the affordable alternative to the Google Maps API. Whether it's for a single trip or complex multi-stop itineraries, our API provides the precision, flexibility, and reliability you need.\
\
Developer Portal : <https://api.market/store/trueway/routing>


# 🌐📍Trueway Geocoding API: Forward and Reverse Geocoding

Affordable API to Convert coordinates into addresses and addresses into coordinates.

### Developer Portal : <https://api.market/store/trueway/geocoding>

### Unlock the Power of Location with Trueway Geocoding API

#### Transform Addresses into Coordinates and Coordinates into Addresses

**Trueway Geocoding API** offers a robust and reliable alternative to Google Maps, providing comprehensive geocoding services that meet your business needs at a much more affordable price. Whether you need to convert an address into geographic coordinates (forward geocoding) or transform coordinates into a human-readable address (reverse geocoding), Trueway has you covered with global coverage and multi-language support.

#### Why Choose Trueway Geocoding API?

* **Global Coverage**: Access accurate geocoding services anywhere in the world.
* **Forward Geocoding**: Seamlessly convert street addresses into precise latitude and longitude coordinates.
* **Reverse Geocoding**: Easily translate geographic coordinates into human-readable addresses.
* **Multi-Language Support**: Receive geocoding results in the language you prefer with support for ISO 639-1 language codes.
* **Cost-Effective**: Trueway Geocoding API is more affordable compared to Google Geocoding API, providing you with the same high-quality service at a lower price.

#### Powerful Features and Capabilities

**Forward Geocoding**

Forward geocoding allows you to transform any address into geographic coordinates. Simply provide the street address, and let Trueway handle the rest.

**Required Parameter:**

* **address**: The street address you wish to geocode.

**Optional Parameters:**

* **language**: Specify the two-letter language code (ISO 639-1) for results.
* **bounds**: Prefer results within a specified rectangular area (format: south, west, north, east).
* **country**: Bias results towards a specific country using the two-letter country code (ccTLD or ISO 3166-1).

**Reverse Geocoding**

Reverse geocoding is perfect for when you need to convert geographic coordinates into a detailed, human-readable address.

**Required Parameter:**

* **location**: The geographic coordinates (latitude/longitude) you wish to reverse geocode.

**Optional Parameter:**

* **language**: Specify the two-letter language code (ISO 639-1) for results.

#### Detailed Geocoding Responses

Every geocoding response from Trueway includes a wealth of information:

* **Address Components**: Detailed elements such as street, house number, neighborhood, and locality.
* **Postal Code and Country**: Accurate postal codes and country information.
* **Region and Area**: Comprehensive regional and area details.
* **Location Type**: Identify whether the result is exact, approximate, or a centroid.
* **Address Types**: Differentiated types like street address, route, road intersection, administrative area, and more.

**Trueway Geocoding API – Your Trusted Partner for Location Data**

Whether you are developing a **maps API**, enhancing delivery services, or simply need accurate **geo location API** data, Trueway provides the tools and support you need to succeed. Start your geocoding journey today and unlock the power of location with Trueway Geocoding API. Find out **about my location** with precise **map coordinates** and convert **latitude and longitude to address** effortlessly with our advanced geocoding solutions.

#### Request and Response

**Request**

{% tabs %}
{% tab title="curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/trueway/geocoding/GeocodingService/Geocode?address=505%20Howard%20St%2C%20San%20Francisco&country=US&language=en&bounds=-90.0%2C-180.0%2C90.0%2C180.0' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="Nodejs" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/trueway/geocoding/GeocodingService/Geocode?address=505%20Howard%20St%2C%20San%20Francisco&postal_code=SOME_STRING_VALUE&country=US&area=SOME_STRING_VALUE&locality=SOME_STRING_VALUE&street=SOME_STRING_VALUE&language=en&region=SOME_STRING_VALUE&bounds=-90.0%2C-180.0%2C90.0%2C180.0';

let options = {method: 'GET', headers: {'x-api-market-key': 'SOME_STRING_VALUE'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```python
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

headers = { 'x-api-market-key': "SOME_STRING_VALUE" }

conn.request("GET", "/api/v1/trueway/geocoding/GeocodingService/Geocode?address=505%20Howard%20St%2C%20San%20Francisco&postal_code=SOME_STRING_VALUE&country=US&area=SOME_STRING_VALUE&locality=SOME_STRING_VALUE&street=SOME_STRING_VALUE&language=en&region=SOME_STRING_VALUE&bounds=-90.0%2C-180.0%2C90.0%2C180.0", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```java
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/trueway/geocoding/GeocodingService/Geocode?address=505%20Howard%20St%2C%20San%20Francisco&postal_code=SOME_STRING_VALUE&country=US&area=SOME_STRING_VALUE&locality=SOME_STRING_VALUE&street=SOME_STRING_VALUE&language=en&region=SOME_STRING_VALUE&bounds=-90.0%2C-180.0%2C90.0%2C180.0")
  .get()
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

**Response**

```json
{
  "results": [
    {
      "address": "505 Howard St, San Francisco, CA 94105, USA",
      "postal_code": "94105",
      "country": "United States",
      "region": "California",
      "area": "San Francisco County",
      "locality": "San Francisco",
      "neighborhood": "SoMa",
      "street": "Howard Street",
      "house": "505",
      "location": {
        "lat": 37.787926,
        "lng": -122.396187
      },
      "location_type": "exact",
      "type": "street_address"
    }
  ]
}
```

#### Request and Response of ReverseGeocode

#### Request

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/trueway/geocoding/GeocodingService/ReverseGeocode?location=37.7879493%2C-122.3961974&language=en' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

#### Response

```json
{
  "results": [
    {
      "address": "505 Howard St, San Francisco, CA 94105, USA",
      "postal_code": "94105",
      "country": "United States",
      "region": "California",
      "area": "San Francisco County",
      "locality": "San Francisco",
      "neighborhood": "SoMa",
      "street": "Howard Street",
      "house": "505",
      "location": {
        "lat": 37.787926,
        "lng": -122.396187
      },
      "location_type": "exact",
      "type": "poi"
    },
    {
      "address": "18 Tehama St, San Francisco, CA 94105, USA",
      "postal_code": "94105",
      "country": "United States",
      "region": "California",
      "area": "San Francisco County",
      "locality": "San Francisco",
      "neighborhood": "SoMa",
      "street": "Tehama Street",
      "house": "18",
      "location": {
        "lat": 37.78795,
        "lng": -122.396136
      },
      "location_type": "exact",
      "type": "street_address"
    },
    {
      "address": "505 Howard St, San Francisco, CA 94105, USA",
      "postal_code": "94105",
      "country": "United States",
      "region": "California",
      "area": "San Francisco County",
      "locality": "San Francisco",
      "neighborhood": "SoMa",
      "street": "Howard Street",
      "house": "505",
      "location": {
        "lat": 37.787926,
        "lng": -122.396187
      },
      "location_type": "exact",
      "type": "street_address"
    },
    {
      "address": "22 Tehama St, San Francisco, CA 94105, USA",
      "postal_code": "94105",
      "country": "United States",
      "region": "California",
      "area": "San Francisco County",
      "locality": "San Francisco",
      "neighborhood": "SoMa",
      "street": "Tehama Street",
      "house": "22",
      "location": {
        "lat": 37.787717,
        "lng": -122.395972
      },
      "location_type": "approximate",
      "type": "street_address"
    },
    {
      "address": "QJQ3+5G SoMa, San Francisco, CA, USA",
      "country": "United States",
      "region": "California",
      "area": "San Francisco County",
      "locality": "San Francisco",
      "neighborhood": "SoMa",
      "location": {
        "lat": 37.787926,
        "lng": -122.396187
      },
      "location_type": "centroid",
      "type": "poi"
    }
  ]
}
```

### Developer Portal : <https://api.market/store/trueway/geocoding>


# 🛤️ ⏱️Trueway Matrix API: Travel Distance and Time

Calculate distances and durations between a set of origins and destinations.

### TrueWay Matrix API: Your Affordable Solution for Distance and Duration Calculation

Developer Portal : <https://api.market/store/trueway/matrix>

#### Transform Your Logistics with TrueWay Matrix API

Unlock precise and efficient route calculations with the TrueWay Matrix API, the ultimate alternative to Google Distance Matrix API. Whether you’re solving complex logistical problems, optimizing delivery routes, or enhancing search results with actual travel times, TrueWay Matrix API offers an affordable and reliable solution.

#### Key Features:

* **Comprehensive Global Coverage**: Access an extensive global road network to calculate distances and durations between multiple origins and destinations.
* **Accurate Predictions**: Utilize predictive or live traffic information to get precise travel times based on specified start times.
* **Flexible Route Options**: Customize your routes by avoiding highways, tolls, or ferries to meet your specific needs.
* **Dynamic Traffic Data**: Calculate traffic-based distance and duration matrices over specified time periods for optimal planning.
* **Scalable Requests**: Support up to 25 origins and destinations per request, providing flexibility for various applications.

#### Ideal for Multiple Applications:

* **Traveling Salesman Problem (TSP)**: Efficiently solve TSP by calculating the shortest possible route visiting multiple points.
* **Vehicle Routing Problem (VRP)**: Optimize vehicle routes to minimize travel time and distance.
* **Search Result Optimization**: Sort search results by actual travel distance or time for enhanced user experiences.
* **Arrival Time Calculation**: Determine precise arrival times based on real-time travel conditions.
* **Commute Time Comparison**: Compare travel times between different locations for better decision-making.
* **Data Clustering**: Cluster data points based on travel times and distances for advanced analytics.

#### How It Works:

The TrueWay Matrix API calculates distances and durations between specified origins and destinations. Using the CalculateDrivingDistanceMatrix request, input a list of origins and destinations to receive a matrix of optimal route distances and durations.

**Example Request:**

{% tabs %}
{% tab title="Curl" %}

```bash
{
curl -X 'GET' \
  'https://prod.api.market/api/v1/trueway/matrix/MatrixService/CalculateDrivingMatrix?origins=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&destinations=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=false&avoid_highways=false&avoid_ferries=false' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
}
```

{% endtab %}

{% tab title="Nodejs" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/trueway/matrix/MatrixService/CalculateDrivingMatrix?origins=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&destinations=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=SOME_BOOLEAN_VALUE&avoid_highways=SOME_BOOLEAN_VALUE&avoid_ferries=SOME_BOOLEAN_VALUE&start_time=SOME_STRING_VALUE';

let options = {method: 'GET', headers: {'x-api-market-key': 'SOME_STRING_VALUE'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

headers = { 'x-api-market-key': "SOME_STRING_VALUE" }

conn.request("GET", "/api/v1/trueway/matrix/MatrixService/CalculateDrivingMatrix?origins=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&destinations=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=SOME_BOOLEAN_VALUE&avoid_highways=SOME_BOOLEAN_VALUE&avoid_ferries=SOME_BOOLEAN_VALUE&start_time=SOME_STRING_VALUE", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/trueway/matrix/MatrixService/CalculateDrivingMatrix?origins=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&destinations=40.629041%2C-74.025606%3B40.630099%2C-73.993521%3B40.644895%2C-74.013818%3B40.627177%2C-73.980853&avoid_tolls=SOME_BOOLEAN_VALUE&avoid_highways=SOME_BOOLEAN_VALUE&avoid_ferries=SOME_BOOLEAN_VALUE&start_time=SOME_STRING_VALUE")
  .get()
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

**Example Response:**

```json
{
  "distances": [
    [
      0,
      3935,
      2072,
      5420
    ],
    [
      3991,
      0,
      2602,
      1476
    ],
    [
      2660,
      2661,
      0,
      3635
    ],
    [
      5744,
      2071,
      4036,
      0
    ]
  ],
  "durations": [
    [
      0,
      830,
      500,
      1099
    ],
    [
      890,
      0,
      725,
      401
    ],
    [
      553,
      758,
      0,
      1029
    ],
    [
      1231,
      538,
      1198,
      0
    ]
  ]
}
```

In this example, the distance from the 2nd origin point to the 3rd destination point is 3646 meters, and the travel time is 1030 seconds.

#### Seamless Integration:

Integrate TrueWay Matrix API into your applications effortlessly to enhance route planning, logistics optimization, and travel-time analysis. With our affordable pricing, you can perform multiple API calls without breaking the bank, making TrueWay a cost-effective choice compared to Google Distance Matrix API.

#### Get Started Now!

Optimize your routes, improve efficiency, and make data-driven decisions with TrueWay Matrix API, the most affordable distance matrix API on the market.

Enhance your API mapping solutions and see why TrueWay Routing API is the smart choice for your business needs.\
\
Developer Portal : <https://api.market/store/trueway/matrix>


# 🏛️ Trueway Places API

Get Detailed information for over 180+ million places and points of interest (POI's): categories, names, addresses, phone numbers, geo-coordinates, etc.

### Discover the Power of Trueway Places API

Developer Portal : <https://api.market/store/trueway/places>

#### The Ultimate Google Maps Alternative for Seamless Place Search

Are you looking for a robust, reliable, and affordable API for searching places? Look no further than Trueway Places API. Our cutting-edge solution offers unparalleled features and capabilities designed to meet all your place-search needs at a fraction of the cost of Google Place Search API.

#### Why Choose Trueway Places API?

Trueway Places API is your ultimate tool for discovering locations around the world. Whether you need to search by text or proximity, our API provides accurate, detailed, and comprehensive results that make location-based services more efficient and effective.

#### Key Features

**Global Coverage**

Access a vast database of places worldwide, ensuring that you can find the locations you need no matter where you are.

**Versatile Search Options**

* **Text Search**: Enter a name or address to find the exact place you're looking for with our FindPlaceByText feature.
* **Nearby Search**: Discover places around a specific location within a defined radius with our FindPlacesNearby feature.

**Multi-Language Support**

Get results in your preferred language with support for multiple languages (ISO 639-1 codes).

#### How It Works

**FindPlaceByText**

A simple and efficient way to search for places using text input.

* **Required**: `text` - The name or address of the place you’re searching for.
* **Optional**: `language`, `bounds` - Specify the language for results and the preferred rectangular area for search results.

**FindPlacesNearby**

Locate places within a specified radius around a given latitude and longitude.

* **Required**: `location` - The central point for the search.
* **Optional**: `radius`, `type`, `language` - Define the search radius, place type, and result language.

#### Comprehensive Response Data

Each search query returns a list of places with detailed information, including:

* ID
* Name
* Address
* Location (latitude/longitude)
* Phone number
* Website
* Types
* Distance (for nearby search)

#### Extensive Place Types

Search for a wide variety of place types, including:

* Airports
* Restaurants
* Hospitals
* Schools
* Museums
* And many more...

#### Free and Public API Access

Trueway Places API offers a free API tier and public API access, making it an excellent choice for developers looking for an affordable and reliable maps API solution. Compared to the Google Place Search API, Trueway Places API provides similar functionalities at a much lower cost, ensuring that you get the best value for your money.

#### Get Started with Trueway Places API Today

Unlock the full potential of location-based services with Trueway Places API. Experience the accuracy, versatility, and global coverage that sets us apart as the leading alternative to Google Maps.

#### Request and Response

**Request**

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'GET' \
  'https://prod.api.marketv/api/v1/trueway/places/PlacesService/FindPlaceByText?text=Children%27s%20Creativity%20Museum&language=en&bounds=-90.0%2C-180.0%2C90.0%2C180.0' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

{% endtab %}

{% tab title="NodeJs" %}

```bash
const fetch = require('node-fetch');

let url = 'https://prod.api.market/api/v1/trueway/places/PlacesService/FindPlaceByText?text=Children's%20Creativity%20Museum&language=en&bounds=-90.0%2C-180.0%2C90.0%2C180.0';

let options = {method: 'GET', headers: {'x-api-market-key': 'SOME_STRING_VALUE'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="python" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

headers = { 'x-api-market-key': "SOME_STRING_VALUE" }

conn.request("GET", "/api/v1/trueway/places/PlacesService/FindPlaceByText?text=Children's%20Creativity%20Museum&language=en&bounds=-90.0%2C-180.0%2C90.0%2C180.0", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endtab %}

{% tab title="Java" %}

```bash
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/trueway/places/PlacesService/FindPlaceByText?text=Children's%20Creativity%20Museum&language=en&bounds=-90.0%2C-180.0%2C90.0%2C180.0")
  .get()
  .addHeader("prod.api.market", "SOME_STRING_VALUE")
  .build();

Response response = client.newCall(request).execute();
```

{% endtab %}
{% endtabs %}

**Response**

```json
{
  "results": [
    {
      "id": "578A19E791A33F37C5189F95D428ED1E",
      "name": "Children's Creativity Museum",
      "address": "221 4th St, San Francisco, CA 94103, United States",
      "phone_number": "+14158203320",
      "website": "http://www.creativity.org/",
      "location": {
        "lat": 37.783383,
        "lng": -122.402305
      },
      "types": [
        "museum",
        "tourist_attraction"
      ]
    }
  ]
}

```

#### About Trueway Places API

Trueway Places API is designed to provide developers with a seamless and efficient way to search for places globally. Whether you need text-based search or proximity-based search, our location API offers a robust solution to meet your needs.\
\
Developer Portal : <https://api.market/store/trueway/places>


# AILabTools

<https://api.market/store/ailabtools/>


# Cartoon-Yourself

Convert photos into various cartoon styles with our Cartoon Yourself API, featuring advanced 3D game effects and high-quality sketch transformations.

#### Transform Your Photos with the Cartoon Yourself API

**Developer Portal :** <https://api.market/store/ailabtools/cartoon-yourself>

**Cartoon Yourself API** is the ultimate tool for transforming your personal photos into captivating cartoon images, enhanced with advanced artistic effects. By leveraging cutting-edge GAN technology, this API can convert faces and entire images into stunning 3D game styles, adding depth and spatial realism perfect for game expos, cosplay events, and large-scale gaming tournaments.

**Key Features**

* **Cartoon Transformation**: Automatically convert photos into cartoon-style images, preserving unique user-specific features for a personalized result.
* **Headshot Sketch**: Detects the head region in an image and generates a high-quality 512x512 pixel sketch, ideal for avatars and artistic portraits.
* **3D Game Effects**: Creates detailed 3D cartoon effects that provide a three-dimensional feel, suitable for promotional activities.
* **EffectGAN Technology**: Utilizes sophisticated generative adversarial networks to deliver unique artistic transformations, including Ukiyo-e, Pop Art, Pixar, American comic, angel, and demon styles.

Whether you're looking to create personalized avatars, enhance interactive marketing campaigns, or add artistic flair to digital content, the Cartoon Yourself API offers seamless integration, high performance, and exceptional scalability. Empower your applications with advanced image transformation capabilities, delivering visually appealing and unique cartoon effects tailored to modern digital experiences.

**Application Scenarios**

* **Protect Privacy**: Transforming people into cartoons can help protect their privacy by preventing the identification of individuals in the original images.
* **Social Entertainment**: Turn your photos into cartoon characters to create a cute atmosphere and share them with friends.
* **Personalized Avatars**: Generate secondary cartoon images with unique personality characteristics for use in avatars across various internet applications.
* **Interactive Marketing**: Enhance activity scenarios such as festivals, exhibitions, and marketing promotions, attracting users to interact, participate, and share.

**Features and Advantages**

* **Reproduce Character Expressions**: Based on deep learning algorithms, it recognizes character gender, expressions, and other features, restoring them in cartoon avatars.
* **Full Body Cartoon**: Avoid embarrassing scenes with full-body cartoon transformations compared to face-only cartoons.
* **Multi-Person Mode**: Capable of handling couple photos, family photos, and group photos.
* **Excellent Algorithm**: Based on massive data training and polished through actual business scenarios, ensuring superior results.
* **Realistic Image**: Multi-dimensional preservation of user characteristics, defining delicate beauty and extreme beauty in portrait caricature images.
* **Business-Driven**: Continually iterates to meet business needs, optimizing the effect continuously.

Unlock the potential of your photos with the Cartoon Yourself API, also known as **Toonify API** and **Cartoonify API**, and experience the power of cutting-edge image transformation technology. Enhance your digital content, protect privacy, and engage users like never before. For those looking for an even more accessible solution, explore the **Free Toonify API** option to start creating stunning cartoon effects at no cost.

If you're also interested in routing solutions, check out the **Trueway Routing API**, known for being a much more affordable alternative to other mapping APIs.

#### Categories and Types of Cartoonization

The Cartoon Yourself API offers a variety of cartoonization types, each suited to different artistic needs:

**Full-Body Cartoonization**

* **Japanese Manga (I)**: `jpcartoon`
* **Japanese Manga (II)**: `anime`
* **Chinese Fine Brushwork Painting**: `claborate`
* **Hong Kong-Style Comic**: `hongkong`
* **Comic**: `comic`
* **3D Animation**: `animation3d`
* **Hand-Painted**: `handdrawn`
* **Pencil Drawing (I)**: `sketch`
* **Pencil Drawing (II)**: `full`
* **Artistic Effects**: `artstyle`
* **Retro Cartoon**: `classic_cartoon`
* **Moe Manga**: `tccartoon`
* **China Comics**: `hkcartoon`

**Facial Cartoonization**

* **3D Cartoon**: `3d_cartoon`
* **Pixar**: `pixar`
* **Pixar Pro**: `pixar_plus`
* **Angel**: `angel`
* **Angel Pro**: `angel_plus`
* **Demon**: `demon`
* **Ukiyo-e**: `ukiyoe_cartoon`
* **American Manga**: `amcartoon`
* **World Famous Paintings**: `famous`
* **3D Effects**: `3d`
* **3D Game Effects**: `3d_game`

**Avatar Cartoonization**

* **Popper**: `bopu_cartoon`
* **Western**: `western`
* **Avatar**: `avatar`
* **Japanese Manga (Portrait)**: `jpcartoon_head`
* **Pencil Drawing (Head)**: `head`

### Request and Response&#x20;

#### Request

{% tabs %}
{% tab title="Curl" %}

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/ailabtools/cartoon-yourself/portrait/effects/portrait-animation' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: multipart/form-data' \
  -F 'image=@Shahrukh_khan.png;type=image/png' \
  -F 'type=pixar'
```

{% endtab %}

{% tab title="Nodejs" %}

```bash
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();

formData.append('image', 'null');
formData.append('type', 'pixar');

let url = 'https://prod.api.market/api/v1/ailabtools/cartoon-yourself/portrait/effects/portrait-animation';

let options = {
  method: 'POST',
  headers: {
    'x-api-market-key': 'SOME_STRING_VALUE',
    'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
  }
};

options.body = formData;

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

{% endtab %}

{% tab title="Python" %}
{% code overflow="wrap" %}

```bash
import http.client

conn = http.client.HTTPSConnection("api.magicapi.dev")

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\nnull\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npixar\r\n-----011000010111000001101001--\r\n\r\n"

headers = {
    'x-api-market-key': "SOME_STRING_VALUE",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001"
    }

conn.request("POST", "/api/v1/ailabtools/cartoon-yourself/portrait/effects/portrait-animation", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

{% endcode %}
{% endtab %}

{% tab title="Java" %}
{% code overflow="wrap" %}

```java
OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\nnull\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\npixar\r\n-----011000010111000001101001--\r\n\r\n");
Request request = new Request.Builder()
  .url("https://prod.api.market/api/v1/ailabtools/cartoon-yourself/portrait/effects/portrait-animation")
  .post(body)
  .addHeader("x-api-market-key", "SOME_STRING_VALUE")
  .addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
  .build();

Response response = client.newCall(request).execute();
```

{% endcode %}
{% endtab %}
{% endtabs %}

#### Response

```bash
{
  "data": {
    "image_url": "https://ai-result-001.ailabtools.com/faceBody/generateHumanAnimeStyle/2024-07-12/054013-a2f86213-f590-2a3f-0de2-6e9735ee8bd9-1720762813.png"
  },
  "error_code": 0,
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "log_id": "20240712134009D4D355A1362F35C5D461",
  "request_id": "20240712134009D4D355A1362F35C5D461"
}
```

### Rendered images

### Full-Body Cartoonization

**Original Image**

![Original Image](https://ai-resource.ailabtools.com/cartoon-yourself/doc/OriginalImage-2.webp)

**Result Images**

| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-jpcartoon-1.webp" alt="Japanese Manga (I)"><br>Japanese Manga (I)</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-anime-1.webp" alt="Japanese Manga (II)"><br>Japanese Manga (II)</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-claborate-1.webp" alt="Chinese fine brushwork painting"><br>Chinese fine brushwork painting</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-hongkong-1.webp" alt="Hong Kong-style comic style"><br>Hong Kong-style comic style</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-comic-1.webp" alt="Comic"><br>Comic</p>                          |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-animation3d-1.webp" alt="3D Animation"><br>3D Animation</p>           | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-handdrawn-1.webp" alt="hand-painted"><br>hand-painted</p>           | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-sketch-1.webp" alt="Pencil drawing (I)"><br>Pencil drawing (I)</p>                              | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-full-1.webp" alt="Pencil drawing (II)"><br>Pencil drawing (II)</p>                     | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-artstyle-1.webp" alt="Artistic effects"><br>Artistic effects</p> |
| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-classic_cartoon-1.webp" alt="Retro Cartoon"><br>Retro Cartoon</p>     | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-tccartoon-1.webp" alt="Moe Manga"><br>Moe Manga</p>                 | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-hkcartoon-1.webp" alt="China Comics"><br>China Comics</p>                                       |                                                                                                                                                                           |                                                                                                                                                     |

### Facial Cartoonization

**Original Image**

![Original Image](https://ai-resource.ailabtools.com/cartoon-yourself/doc/OriginalImage-2.webp)

**Result Images**

| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-3d_cartoon-1.webp" alt="3D cartoon"><br>3D cartoon</p>                     | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-pixar-1.webp" alt="Pixar"><br>Pixar</p>        | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-pixar_plus-1.webp" alt="Pixar Pro"><br>Pixar Pro</p>          | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-angel-1.webp" alt="Angel"><br>Angel</p>                       |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-angel_plus-1.webp" alt="Angel Pro"><br>Angel Pro</p>                       | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-demon-1.webp" alt="Demon"><br>Demon</p>        | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-ukiyoe_cartoon-1.webp" alt="Ukiyo-e"><br>Ukiyo-e</p>          | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-amcartoon-1.webp" alt="American Manga"><br>American Manga</p> |
| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-famous-1.webp" alt="World famous paintings"><br>World famous paintings</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-3d-1.webp" alt="3D Effects"><br>3D Effects</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-3d_game-1.webp" alt="3D game effects"><br>3D game effects</p> |                                                                                                                                                  |

#### Avatar Cartoonization

**Original Image**

![Original Image](https://ai-resource.ailabtools.com/cartoon-yourself/doc/OriginalImage-2.webp)

**Result Images**

| <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-bopu_cartoon-1.webp" alt="Popper"><br>Popper</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-western-1.webp" alt="Western"><br>Western</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-avatar-1.webp" alt="Avatar"><br>Avatar</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-jpcartoon_head-1.webp" alt="Japanese Manga (portrait)"><br>Japanese Manga (portrait)</p> | <p><img src="https://ai-resource.ailabtools.com/cartoon-yourself/doc/ResultImage-2-head-1.webp" alt="Pencil drawing (head)"><br>Pencil drawing (head)</p> |
| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |

**Developer Portal :** <https://api.market/store/ailabtools/cartoon-yourself>


# SharpAPI

<https://api.market/store/sharpapi.com/>


# 📄 AI-Powered Resume/CV Parsing API

Advanced AI-powered Resume/CV parsing using AI

Developer Portal : <https://api.market/store/sharpapi.com/resume><br>

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

Transform your recruitment process with the AI Resume Parsing API by SharpAPI.com. Effortlessly scrape CVs and extract comprehensive candidate data with our advanced AI resume scraper. Simply upload a document, and our Parse PDF Resume API will return detailed candidate information to streamline your hiring workflow.

#### Description:

SharpAPI.com's AI-powered Resume/CV Parsing API offers a robust solution for modern recruitment needs. This API leverages cutting-edge AI technology to accurately parse and extract extensive data points from resumes and CVs, significantly enhancing your candidate evaluation process.

**Key Features:**

* **Comprehensive Data Extraction:** Automatically retrieve detailed candidate information such as name, contact details, skills, job history, education, honors, and certifications.
* **Form-Data File Upload:** Upload resumes and CVs as form-data parameters. The file should be uploaded with the parameter name `file`.
* **Language Support:** Optionally specify the language of the resume/CV for better parsing accuracy. The default is set to English.
* **Free Resume Parsing API:** Get started with a free tier to parse resumes and CVs.

**API Endpoints:**

1. **Parse PDF Resume:**

   ```sh
   curl -X 'POST' \
     'https://prod.api.market/api/v1/sharpapi.com/resume/api/v1/hr/parse_resume' \
     -H 'accept: application/json' \
     -H 'x-api-market-key: YOUR_API_KEY' \
     -H 'Content-Type: multipart/form-data' \
     -F 'file=@Your_Resume.pdf;type=application/pdf' \
     -F 'language=English'
   ```

   **Response:**

   ```json
   {
     "status_url": "https://prod.api.market/v1/hr/parse_resume/job/status/8bd71aa1-d733-4ce2-a6be-c38ffe0c39e6",
     "job_id": "8bd71aa1-d733-4ce2-a6be-c38ffe0c39e6"
   }
   ```
2. **Check Parsing Status:**

   ```sh
   curl -X 'GET' \
     'https://prod.api.market/api/v1/sharpapi.com/resume/api/v1/hr/parse_resume/job/status/8bd71aa1-d733-4ce2-a6be-c38ffe0c39e6' \
     -H 'accept: application/json' \
     -H 'x-api-market-key: YOUR_API_KEY'
   ```

   **Response:**

```json
{
  "data": {
    "type": "api_job_result",
    "id": "87eda824-6b9e-4557-b5e0-fa23b2207d58",
    "attributes": {
      "status": "success",
      "type": "hr_parse_resume",
      "result": {
        "candidate_name": "Linda Harris",
        "candidate_email": "linda.h@dayjob.co.uk",
        "candidate_phone": "02476 000 0000, 0887 222 9999",
        "candidate_address": "34 Made Up Road, Coventry, CV66 7RF",
        "candidate_language": "English",
        "candidate_spoken_languages": [
          "German"
        ],
        "candidate_honors_and_awards": [],
        "candidate_courses_and_certifications": [
          "ISEB certification"
        ],
        "positions": [
          {
            "position_name": "Test Engineer",
            "company_name": "IT & Telecoms Company",
            "country": "United Kingdom",
            "start_date": "2008-06-01",
            "end_date": null,
            "skills": [
              "Acceptance testing",
              "Technical investigation",
              "Exploratory testing",
              "Agile",
              "Test environments",
              "Test management tools",
              "UAT knowledge",
              "Writing test reports",
              "Organising test activities",
              "Performance testing",
              "Integration testing",
              "Equipment failure response",
              "Audits and reviews",
              "Monitoring repair trends",
              "Documentation updates",
              "Executing test cases",
              "Testing and fault finding",
              "Reporting issues",
              "Software installation",
              "Problem solving",
              "Testing Web software",
              "Testing PC software",
              "Testing mobile software",
              "Manual testing methods",
              "Test Systems hardware and software"
            ],
            "job_details": "Responsible for the whole test process from planning, through test plan development, execution & result reporting. Also involved in the development and improvement of the test functions, putting forward suggestions and implementing plans accordingly. Duties included organising, conducting and supporting test activities, performance testing, integration testing, responding to equipment failures, participating in audits and reviews, monitoring repair trends, updating documentation, executing test cases, testing and fault finding finished systems, reporting issues to the Test Manager, and assisting in software installation."
          }
        ],
        "education_qualifications": [
          {
            "school_name": "Nuneaton University",
            "school_type": "University or equivalent",
            "degree_type": "Bachelor’s Degree or equivalent",
            "faculty_department": "",
            "specialization_subjects": "Information Technology (Software Engineering)",
            "country": "United Kingdom",
            "start_date": "2005-01-01",
            "end_date": "2008-01-01",
            "learning_mode": "In-person learning",
            "education_details": ""
          },
          {
            "school_name": "Coventry North School",
            "school_type": "High School/Secondary School or equivalent",
            "degree_type": "High School/Secondary School Diploma or equivalent",
            "faculty_department": "",
            "specialization_subjects": "",
            "country": "United Kingdom",
            "start_date": "2000-01-01",
            "end_date": "2005-01-01",
            "learning_mode": "In-person learning",
            "education_details": "A levels: Maths (A), English (B), Technology (B), Science (C)"
          }
        ]
      }
    }
  }
}
```

**Note:** Replace `"YOUR_API_KEY"` with your actual API key.

Empower your HR team with SharpAPI.com's AI Resume Parsing API to make data-driven hiring decisions with ease and efficiency. Use our Free Resume Parsing API to get started today.

**Keywords:** AI Resume parsing, scrape CV, AI resume scraper, AI resume parser, Parse PDF resume API, Free Resume Parsing API, Parse PDF resume API

Developer Portal : <https://api.market/store/sharpapi.com/resume>


# 🛩️ Airports Database & Flight Duration API

🛩️ Comprehensive Airport Data and Accurate Flight Duration Calculations for 30,000 airports + flights

Developer Portal : <https://api.market/store/sharpapi.com/airports><br>

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

Discover an extensive, advanced database of nearly 30,000 airports and calculate precise flight durations with the Airports Database & Flight Duration API by SharpAPI.com. Seamlessly access detailed airport information and journey times using flexible filters and comprehensive endpoints.

#### Description:

SharpAPI.com presents the Airports Database & Flight Duration API, designed to provide developers and businesses with a robust and detailed resource for global airport information and flight duration calculations.

**Key Features:**

* **Extensive Airport Database:** Access information on almost 30,000 airports worldwide, including ICAO, IATA, LID codes, airport names, city names, subdivisions, countries, timezones, elevations, and geographical coordinates.
* **Advanced Filtering:** Efficiently browse and filter airport data using ICAO codes, IATA codes, LID codes, city names, and airport names to find exactly what you need.
* **Flight Duration Calculations:** Utilize the Flight Length endpoint to calculate the total journey duration between any two airports. Provide parameters such as departure and arrival airport codes, dates, and times to get accurate travel times.
* **Detailed Responses:** Get comprehensive data in JSON format, including detailed airport information and human-readable flight duration summaries.

**Example API Requests:**

* **Retrieve Airport List:**

  ```bash
  curl -X 'GET' \
    'https://prod.api.market/api/v1/sharpapi.com/airports/v1/airports' \
    -H 'accept: application/json' \
    -H 'x-api-market-key: YOUR_API_KEY'
  ```

  **Response**

```json
{
  "data": [
    {
      "id": "1ef266de-5a6c-67d6-86a1-06bb2780ed98",
      "icao": "00AA",
      "iata": "",
      "lid": "00AA",
      "name": "Aero B Ranch Airport",
      "city": "Leoti",
      "subdivision": "Kansas",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 3435,
      "latitude": 38.7,
      "longitude": -101.47
    },
    {
      "id": "1ef266de-5a8e-6f02-ba5c-06bb2780ed98",
      "icao": "00AK",
      "iata": "",
      "lid": "00AK",
      "name": "Lowell Field",
      "city": "Anchor Point",
      "subdivision": "Alaska",
      "country": "US",
      "timezone": "America/Anchorage",
      "elevation": 252,
      "latitude": 59.95,
      "longitude": -151.69
    },
    {
      "id": "1ef266de-5a93-63ae-b408-06bb2780ed98",
      "icao": "00AL",
      "iata": "",
      "lid": "00AL",
      "name": "Epps Airpark",
      "city": "Harvest",
      "subdivision": "Alabama",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 820,
      "latitude": 34.86,
      "longitude": -86.77
    },
    {
      "id": "1ef266de-5a97-6166-bced-06bb2780ed98",
      "icao": "00AN",
      "iata": "",
      "lid": "00AN",
      "name": "Katmai Lodge Airport",
      "city": "King Salmon",
      "subdivision": "Alaska",
      "country": "US",
      "timezone": "America/Anchorage",
      "elevation": 80,
      "latitude": 59.09,
      "longitude": -156.46
    },
    {
      "id": "1ef266de-5a9a-6578-b79f-06bb2780ed98",
      "icao": "00AR",
      "iata": "",
      "lid": "00AR",
      "name": "Arland Airport",
      "city": "Bennington",
      "subdivision": "Kansas",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 1352,
      "latitude": 38.97,
      "longitude": -97.6
    },
    {
      "id": "1ef266de-5a9d-6a5c-8cd4-06bb2780ed98",
      "icao": "00AS",
      "iata": "",
      "lid": "00AS",
      "name": "Fulton Airport",
      "city": "Alex",
      "subdivision": "Oklahoma",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 1100,
      "latitude": 34.94,
      "longitude": -97.82
    },
    {
      "id": "1ef266de-5aa0-6c5c-91b1-06bb2780ed98",
      "icao": "00CA",
      "iata": "",
      "lid": "00CA",
      "name": "Goldstone /Gts/ Airport",
      "city": "Barstow",
      "subdivision": "California",
      "country": "US",
      "timezone": "America/Los_Angeles",
      "elevation": 3038,
      "latitude": 35.35,
      "longitude": -116.89
    },
    {
      "id": "1ef266de-5aa3-6d80-a6d9-06bb2780ed98",
      "icao": "00CL",
      "iata": "",
      "lid": "00CL",
      "name": "Williams Ag Airport",
      "city": "Biggs",
      "subdivision": "California",
      "country": "US",
      "timezone": "America/Los_Angeles",
      "elevation": 87,
      "latitude": 39.43,
      "longitude": -121.76
    },
    {
      "id": "1ef266de-5aa6-681e-873c-06bb2780ed98",
      "icao": "00FA",
      "iata": "",
      "lid": "00FA",
      "name": "Grass Patch Airport",
      "city": "Bushnell",
      "subdivision": "Florida",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 53,
      "latitude": 28.65,
      "longitude": -82.22
    },
    {
      "id": "1ef266de-5aa9-683e-9f64-06bb2780ed98",
      "icao": "00FL",
      "iata": "",
      "lid": "00FL",
      "name": "River Oak Airport",
      "city": "Okeechobee",
      "subdivision": "Florida",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 35,
      "latitude": 27.23,
      "longitude": -80.97
    },
    {
      "id": "1ef266de-5aac-6624-ad2a-06bb2780ed98",
      "icao": "00GA",
      "iata": "",
      "lid": "00GA",
      "name": "Lt World Airport",
      "city": "Lithonia",
      "subdivision": "Georgia",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 700,
      "latitude": 33.77,
      "longitude": -84.07
    },
    {
      "id": "1ef266de-5aaf-6414-b9b6-06bb2780ed98",
      "icao": "00ID",
      "iata": "",
      "lid": "00ID",
      "name": "Delta Shores Airport",
      "city": "Clark Fork",
      "subdivision": "Idaho",
      "country": "US",
      "timezone": "America/Los_Angeles",
      "elevation": 2064,
      "latitude": 48.15,
      "longitude": -116.21
    },
    {
      "id": "1ef266de-5ab2-63da-9d73-06bb2780ed98",
      "icao": "00IG",
      "iata": "",
      "lid": "00IG",
      "name": "Goltl Airport",
      "city": "Mcdonald",
      "subdivision": "Kansas",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 3359,
      "latitude": 39.72,
      "longitude": -101.4
    },
    {
      "id": "1ef266de-5ab5-603a-8621-06bb2780ed98",
      "icao": "00IL",
      "iata": "",
      "lid": "00IL",
      "name": "Hammer Airport",
      "city": "Polo",
      "subdivision": "Illinois",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 840,
      "latitude": 41.98,
      "longitude": -89.56
    },
    {
      "id": "1ef266de-5ab7-6ed4-b9b7-06bb2780ed98",
      "icao": "00IS",
      "iata": "",
      "lid": "00IS",
      "name": "Hayenga's Cant Find Farms Airport",
      "city": "Kings",
      "subdivision": "Illinois",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 820,
      "latitude": 40.03,
      "longitude": -89.12
    },
    {
      "id": "1ef266de-5aba-6a1c-ae17-06bb2780ed98",
      "icao": "00KS",
      "iata": "",
      "lid": "00KS",
      "name": "Hayden Farm Airport",
      "city": "Gardner",
      "subdivision": "Kansas",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 1100,
      "latitude": 38.73,
      "longitude": -94.93
    },
    {
      "id": "1ef266de-5abd-6abe-80fb-06bb2780ed98",
      "icao": "00KY",
      "iata": "",
      "lid": "00KY",
      "name": "Robbins Roost Airport",
      "city": "Stanford",
      "subdivision": "Kentucky",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 1265,
      "latitude": 37.41,
      "longitude": -84.62
    },
    {
      "id": "1ef266de-5ac0-6782-acb9-06bb2780ed98",
      "icao": "00LS",
      "iata": "",
      "lid": "00LS",
      "name": "Lejeune Airport",
      "city": "Esterwood",
      "subdivision": "Louisiana",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 12,
      "latitude": 30.14,
      "longitude": -92.43
    },
    {
      "id": "1ef266de-5ac3-620c-9932-06bb2780ed98",
      "icao": "00MD",
      "iata": "",
      "lid": "00MD",
      "name": "Slater Field",
      "city": "Federalsburg",
      "subdivision": "Maryland",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 45,
      "latitude": 38.76,
      "longitude": -75.75
    },
    {
      "id": "1ef266de-5ac5-6f70-879b-06bb2780ed98",
      "icao": "00MN",
      "iata": "",
      "lid": "00MN",
      "name": "Battle Lake Municipal Airport",
      "city": "Battle Lake",
      "subdivision": "Minnesota",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 1365,
      "latitude": 46.3,
      "longitude": -95.7
    },
    {
      "id": "1ef266de-5ac8-6ad6-b894-06bb2780ed98",
      "icao": "00NC",
      "iata": "",
      "lid": "00NC",
      "name": "North Raleigh Airport",
      "city": "Louisburg",
      "subdivision": "North Carolina",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 348,
      "latitude": 36.09,
      "longitude": -78.37
    },
    {
      "id": "1ef266de-5acb-67f4-9d80-06bb2780ed98",
      "icao": "00NY",
      "iata": "",
      "lid": "00NY",
      "name": "Weiss Airfield",
      "city": "West Bloomfield",
      "subdivision": "New York",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 1000,
      "latitude": 42.9,
      "longitude": -77.5
    },
    {
      "id": "1ef266de-5ace-6968-8dfe-06bb2780ed98",
      "icao": "00OK",
      "iata": "",
      "lid": "00OK",
      "name": "Gull Bay Landing Airport",
      "city": "Sandsprings",
      "subdivision": "Oklahoma",
      "country": "US",
      "timezone": "America/Chicago",
      "elevation": 960,
      "latitude": 36.2,
      "longitude": -96.22
    },
    {
      "id": "1ef266de-5ad1-6906-8051-06bb2780ed98",
      "icao": "00PN",
      "iata": "",
      "lid": "00PN",
      "name": "Ferrell Field",
      "city": "Mercer",
      "subdivision": "Pennsylvania",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 1301,
      "latitude": 41.3,
      "longitude": -80.21
    },
    {
      "id": "1ef266de-5ad4-6660-bae6-06bb2780ed98",
      "icao": "00SC",
      "iata": "",
      "lid": "00SC",
      "name": "Flying O Airport",
      "city": "Sumter",
      "subdivision": "South Carolina",
      "country": "US",
      "timezone": "America/New_York",
      "elevation": 150,
      "latitude": 34.01,
      "longitude": -80.27
    }
  ],
  "links": {
    "first": "https://sharpapi.com/api/v1/airports?page=1",
    "last": "https://sharpapi.com/api/v1/airports?page=1128",
    "prev": null,
    "next": "https://sharpapi.com/api/v1/airports?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1128,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=5",
        "label": "5",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=7",
        "label": "7",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=8",
        "label": "8",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=9",
        "label": "9",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=10",
        "label": "10",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=1127",
        "label": "1127",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=1128",
        "label": "1128",
        "active": false
      },
      {
        "url": "https://sharpapi.com/api/v1/airports?page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://sharpapi.com/api/v1/airports",
    "per_page": 25,
    "to": 25,
    "total": 28186
  }
}
```

* **Calculate Flight Duration:**

  ```bash
  curl -X 'GET' \
    'https://prod.api.market/api/v1/sharpapi.com/airports/v1/airports/flight_duration/IATA/SIN/2024-06-27/01%3A40/IATA/DXB/2024-06-27/12%3A10' \
    -H 'accept: application/json' \
    -H 'x-api-market-key: YOUR_API_KEY'
  ```

**Response**

```json
{
  "flight_length": {
    "days": 0,
    "hours": 14,
    "minutes": 30,
    "human": "14 hours 30 minutes",
    "human_cn": "14 小时 30 分钟"
  },
  "departure_local": "2024-06-27 01:40:00",
  "arrival_local": "2024-06-27 12:10:00",
  "departure_airport": {
    "id": "1ef266e0-00ca-656e-b481-06bb2780ed98",
    "icao": "WSSS",
    "iata": "SIN",
    "lid": "",
    "name": "Singapore Changi International Airport",
    "city": "Singapore",
    "subdivision": "North East",
    "country": "SG",
    "timezone": "Asia/Singapore",
    "elevation": 22,
    "latitude": 1.35,
    "longitude": 103.99
  },
  "arrival_airport": {
    "id": "1ef266df-80aa-62e4-ac59-06bb2780ed98",
    "icao": "OMDB",
    "iata": "DXB",
    "lid": "",
    "name": "Dubai International Airport",
    "city": "Dubai",
    "subdivision": "Dubai",
    "country": "AE",
    "timezone": "Asia/Dubai",
    "elevation": 34,
    "latitude": 25.25,
    "longitude": 55.36
  }
}
```

* **Retrieve Specific Airport Data by ID:**

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/sharpapi.com/airports/v1/airports/1ef266e0-00ca-656e-b481-06bb2780ed98' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

**Response**

```json
{
  "data": {
    "id": "1ef266e0-00ca-656e-b481-06bb2780ed98",
    "icao": "WSSS",
    "iata": "SIN",
    "lid": "",
    "name": "Singapore Changi International Airport",
    "city": "Singapore",
    "subdivision": "North East",
    "country": "SG",
    "timezone": "Asia/Singapore",
    "elevation": 22,
    "latitude": 1.35,
    "longitude": 103.99
  }
}
```

* **Retrieve Specific Airport Data by IATA Code:**

  ```bash
  curl -X 'GET' \
    'https://prod.api.market/api/v1/sharpapi.com/airports/v1/airports/iata/SIN' \
    -H 'accept: application/json' \
    -H 'x-api-market-key: YOUR_API_KEY'
  ```

**Response**

```json
{
  "data": {
    "id": "1ef266e0-00ca-656e-b481-06bb2780ed98",
    "icao": "WSSS",
    "iata": "SIN",
    "lid": "",
    "name": "Singapore Changi International Airport",
    "city": "Singapore",
    "subdivision": "North East",
    "country": "SG",
    "timezone": "Asia/Singapore",
    "elevation": 22,
    "latitude": 1.35,
    "longitude": 103.99
  }
}

```

With the Airports Database & Flight Duration API by SharpAPI.com, streamline your travel planning, enhance your logistics operations, and provide valuable insights to your users with accurate and up-to-date airport data and flight duration information.

Developer Portal : <https://api.market/store/sharpapi.com/airports>


# Text to Speech


# Turn your text into Magical-sounding Audio

Designed to provide you with the most realistic human-sounding voices at an affordable price

**Developer Portal :** <https://api.market/store/text-to-speech/text-to-speech>

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

The Text-to-Speech (TTS) API offers an easy-to-use solution for converting text into lifelike audio. Whether you need to add a human touch to your app, create engaging content, or build accessibility features, this API provides a seamless way to generate high-quality voice output. With a variety of voice models and languages, you can tailor the audio experience to your specific needs.

This API features straightforward endpoints to list available models and languages and to perform TTS conversions. Simply send a request with the desired text and parameters, and receive a realistic audio file in response. The flexibility and affordability of this API make it an ideal choice for developers looking to enhance their projects with natural-sounding speech.

### Endpoints&#x20;

`GET /models/list`  Retrieve list of available TTS models

`GET /languages/list`  Retrieve list of available languages

`POST /tts/run`  Run Text to Speech conversion

### Request and Response

`GET /models/list`

**Request**

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/text-to-speech/text-to-speech/models/list' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

**Response**

```json
{
  "status": 0,
  "msg": "Success",
  "models": [
    {
      "id": 1,
      "speaker_name": "Joe",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 2,
      "speaker_name": "Jane",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 3,
      "speaker_name": "Philip",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 4,
      "speaker_name": "Anthony",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 5,
      "speaker_name": "Pam",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 6,
      "speaker_name": "John",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 7,
      "speaker_name": "Bryan",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 8,
      "speaker_name": "Adrienne",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 9,
      "speaker_name": "Ariele",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 10,
      "speaker_name": "Brittany",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 11,
      "speaker_name": "Jack",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 12,
      "speaker_name": "Caroline",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 13,
      "speaker_name": "Samantha",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 14,
      "speaker_name": "Sara",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 15,
      "speaker_name": "Quinn",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 16,
      "speaker_name": "Victoria",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 17,
      "speaker_name": "Tracy",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 18,
      "speaker_name": "Georgia",
      "gender": "female",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 19,
      "speaker_name": "Henry",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 20,
      "speaker_name": "Jerry",
      "gender": "male",
      "languages": [
        "en"
      ],
      "multilingual": false
    },
    {
      "id": 21,
      "speaker_name": "Generic-female-1",
      "gender": "female",
      "languages": [
        "en",
        "fr-fr",
        "pt-br"
      ],
      "multilingual": true
    },
    {
      "id": 22,
      "speaker_name": "Generic-female-2",
      "gender": "female",
      "languages": [
        "en",
        "fr-fr",
        "pt-br"
      ],
      "multilingual": true
    },
    {
      "id": 23,
      "speaker_name": "Generic-female-3",
      "gender": "female",
      "languages": [
        "en",
        "fr-fr",
        "pt-br"
      ],
      "multilingual": true
    },
    {
      "id": 24,
      "speaker_name": "Generic-male-1",
      "gender": "male",
      "languages": [
        "en",
        "fr-fr",
        "pt-br"
      ],
      "multilingual": true
    },
    {
      "id": 25,
      "speaker_name": "Generic-male-2",
      "gender": "male",
      "languages": [
        "en",
        "fr-fr",
        "pt-br"
      ],
      "multilingual": true
    },
    {
      "id": 26,
      "speaker_name": "Generic-male-3",
      "gender": "male",
      "languages": [
        "en",
        "fr-fr",
        "pt-br"
      ],
      "multilingual": true
    }
  ]
}
```

`GET /languages/list`

**Request**

```bash
curl -X 'GET' \
  'https://prod.api.market/api/v1/text-to-speech/text-to-speech/languages/list' \
  -H 'accept: application/json' \
  -H 'x-api-market-key: API_KEY'
```

**Response**

<pre class="language-json"><code class="lang-json"><strong>{
</strong>  "status": 0,
  "msg": "Success",
  "languages": [
    "en",
    "fr-fr",
    "pt-br"
  ]
}
</code></pre>

`POST /tts/run`

**Request**

```bash
curl -X 'POST' \
  'https://prod.api.market/api/v1/text-to-speech/text-to-speech/tts/run' \
  -H 'accept: audio/wav' \
  -H 'x-api-market-key: API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "speaker_id": 1,
  "lang": "en",
  "text_data": "Hi, this is the text that I want to transform into speech."
}'
```

Just paste the curl request in the Postman or terminal to receive the response result of the request.&#x20;

**Developer Portal :** <https://api.market/store/text-to-speech/text-to-speech>


