# Coloso — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Discover and browse Coloso's entire course catalog by searching products, filtering by categories, and viewing details on new releases, best sellers, and free classes. Get insights into promotional events, trending keywords, and personalized recommendations to find the perfect creative courses.

**Category:** Education | **Website:** [coloso.global/](https://coloso.global/) | **Docs:** [parse.bot/marketplace/a45d93ee-7d71-4a8b-ae71-c216b9074942/coloso-global-api](https://parse.bot/marketplace/a45d93ee-7d71-4a8b-ae71-c216b9074942/coloso-global-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_best_sellers

Get the best-selling courses with curated sections and a ranked list. Returns multiple sections like Best Class, Trending Topic, and Editor's Pick. Each section contains items with full course details.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_best_sellers \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_category_products

Get all products for a specific category. Returns an array of course objects with details like title, instructor, keywords, card assets, and open date. Use list_categories to discover valid category IDs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category_id` | string | Yes | Category ID from list_categories endpoint (e.g. '78' for Illustration, '88' for Blender). |
| `sort` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_category_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_id":"<string>","sort":"<string>"}'
```

### get_event_details

Get details for a specific promotional event including metadata and featured courses. Returns event title, description, image, and associated course listings with instructor and keyword info.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `event_code` | string | Yes | Event code slug identifying the promotional event (e.g. 'signature'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_event_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_code":"<string>"}'
```

### get_free_classes

Get free courses available on the platform. Returns a flat array of free course objects with details including title, instructor, keywords, image URL, and state.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_free_classes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_homepage

Fetch the Coloso Global homepage banners and today's top 10 courses. Returns navigation cover banners (keyed by type) and a today_top_10 array which may be empty depending on current site configuration.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_homepage \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_new_releases

Get upcoming and newly released courses including earlybird deals. Returns curated sections (each with a title and items array) and a ranked_list array. Section items include course details like title, instructor, state, and open date.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_new_releases \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_product_details

Get detailed information for a single course product. At least one of course_id or slug must be provided. Lookup by course_id is faster. Returns a single course object with full details including extras, assets, and instructor info.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `course_id` | string | No | Numeric course ID as a string (e.g. '264097'). Preferred lookup method. |
| `slug` | string | No | Course URL slug (e.g. 'illustrator-shale-us'). Used when course_id is not available. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_product_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"course_id":"<string>","slug":"<string>"}'
```

### get_recommended_keywords

Get trending search keywords and search metadata from the platform. Returns recommended keywords for the search UI and a placeholder hint string.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/get_recommended_keywords \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_all_products

List all products across multiple top-level categories. Aggregates and deduplicates courses from all major categories. Returns a large array of unique course objects.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/list_all_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_categories

List all available course categories and their IDs. Returns a flat list of 33 categories including subcategories. Each category has a name, numeric ID, and URL.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/list_categories \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_products

Search for courses by keyword. Returns matching courses split into a 'courses' array (catalog matches) and a 'searched' array (search-ranked results with pricing). Also returns total count and popular keywords.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword (e.g. 'blender', 'animation', 'character'). |
| `sort` | string | No | Sort order for results. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-coloso-global-api-a45d93ee/search_products \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>","sort":"<string>"}'
```
