API Playground

Interactive API testing environment

Version 1.0.0 Base URL https://api.loreax.bervant.co.ke

Global Authorization

This token will be automatically added to all requests that require authentication. Login tokens are auto-saved.

POST /v1/access/purchases

Purchase a post

Request URL

Headers

Request Body (JSON)

Expected Responses

                                                        201
                                                        Purchase successful
                                                    

{
    "message": "Purchase completed",
    "data": {
        "id": "01HQ123456789ABCDEFGHJKMNP",
        "postId": 123,
        "buyerUserId": 456,
        "creatorUserId": 789,
        "grossAmount": 10000,
        "platformFee": 1500,
        "creatorNet": 8500,
        "discount": 0,
        "currency": "KES",
        "status": "completed",
        "expiresAt": "2025-01-01T00:00:00Z",
        "purchasedAt": "2026-04-24T08:00:00Z",
        "grantsAccess": true
    },
    "meta": {
        "requestId": "01HQ123456789ABCDEFGHJKMNP",
        "traceId": "0af7651916cd43dd8448eb211c80319c",
        "timestamp": "2026-04-24T08:00:00Z"
    }
}

                                                        422
                                                        Validation error
                                                    

{
    "message": "Invalid input",
    "errors": [],
    "meta": []
}

                                                        430
                                                        Business rule violation (already purchased, no purchase rule, insufficient funds)
                                                    

{
    "errorCode": "POST_ALREADY_PURCHASED",
    "message": "User 456 has already purchased post 123.",
    "meta": {
        "requestId": "string",
        "traceId": "string",
        "timestamp": "2025-01-01T00:00:00Z"
    }
}

POST /v1/collections

Create a creator collection

Request URL

Headers

Request Body (JSON)

DELETE /v1/content/comments/{comment}

Delete own comment

Request URL

Headers

PATCH /v1/content/comments/{comment}

Update own comment

Request URL

Headers

Request Body (JSON)

POST /v1/content/comments/{comment}/pin

Pin a comment as the post creator

Request URL

Headers

Request Body (JSON)

POST /v1/posts/{post}/poll/vote

Vote on a poll post

Request URL

Headers

Request Body (JSON)

GET /v1/posts/{post}/comments

List comments for a post

Request URL

Headers

POST /v1/posts/{post}/comments

Create a comment

Request URL

Headers

Request Body (JSON)

POST /v1/posts

Create a draft post

Request URL

Headers

Request Body (JSON)

GET /v1/posts/{post}

Show a post when visible to the current viewer

Request URL

Headers

DELETE /v1/posts/{post}

Delete an owned post

Request URL

Headers

PATCH /v1/posts/{post}

Edit an owned post

Request URL

Headers

Request Body (JSON)

POST /v1/posts/{post}/publish

Publish an owned post

Request URL

Headers

Request Body (JSON)

POST /v1/posts/{post}/unpublish

Unpublish an owned post

Request URL

Headers

Request Body (JSON)

POST /v1/posts/{post}/media

Attach media to a draft post

Request URL

Headers

Request Body (JSON)

GET /

Get API root information

Request URL

Headers

Expected Responses

                                                        200
                                                        API information
                                                    

{
    "message": "Loreax v1 APIs",
    "data": {
        "version": "v1",
        "docs": {
            "wiki": "https://dev.loreax.bervant.co.ke",
            "openapi": {
                "schema": "https://dev.loreax.bervant.co.ke/api-reference",
                "json": "https://dev.loreax.bervant.co.ke/api-reference/download/openapi",
                "postman": "https://dev.loreax.bervant.co.ke/api-reference/download/postman",
                "bruno": "https://dev.loreax.bervant.co.ke/api-reference/download/bruno"
            },
            "interactive": "https://dev.loreax.bervant.co.ke/api-playground"
        },
        "services": {
            "postgres": {
                "status": "ok",
                "latency_ms": 12
            },
            "redis": {
                "status": "ok",
                "latency_ms": 2
            },
            "mongodb": {
                "status": "ok",
                "latency_ms": 1
            },
            "s3": {
                "status": "error",
                "message": "Unable to check existence"
            },
            "mpesa": {
                "status": "ok",
                "latency_ms": 494,
                "cached": false
            }
        }
    },
    "meta": {
        "requestId": "01HQ123456789ABCDEFGHJKMNP",
        "traceId": "0af7651916cd43dd8448eb211c80319c",
        "timestamp": "2026-04-27T10:00:00Z"
    }
}

GET /v1/discovery/creators

Browse public creators

Request URL

Headers

POST /v1/discovery/interactions

Log discovery interaction batch

Request URL

Headers

Request Body (JSON)

GET /v1/discovery/search

Search posts, creators, collections, and tags

Request URL

Headers

POST /v1/auth/login

Authenticate and receive access token

Request URL

Headers

Request Body (JSON)

POST /v1/auth/logout

Revoke the current access token

Request URL

Headers

Request Body (JSON)

POST /v1/auth/register

Request URL

Headers

Request Body (JSON)

GET /v1/monetization/premium

Show current premium subscription

Request URL

Headers

POST /v1/monetization/premium

Start premium subscription

Request URL

Headers

Request Body (JSON)

POST /v1/monetization/premium/cancel

Cancel premium at period end

Request URL

Headers

Request Body (JSON)

GET /v1/creators/{creator}/tiers

List a creator active tiers

Request URL

Headers

POST /v1/monetization/tiers

Create a creator tier

Request URL

Headers

Request Body (JSON)

PATCH /v1/monetization/tiers/{tier}

Update an owned creator tier

Request URL

Headers

Request Body (JSON)

POST /v1/monetization/tiers/{tier}/archive

Archive an owned creator tier

Request URL

Headers

Request Body (JSON)

GET /v1/monetization/tier-subscriptions

List own tier subscriptions

Request URL

Headers

POST /v1/monetization/tier-subscriptions

Subscribe to a tier

Request URL

Headers

Request Body (JSON)

POST /v1/monetization/tier-subscriptions/{subscription}/cancel

Cancel a tier subscription at period end

Request URL

Headers

Request Body (JSON)

POST /v1/monetization/tier-subscriptions/{subscription}/resume

Resume a tier subscription

Request URL

Headers

Request Body (JSON)

GET /v1/monetization/verification-requests

List own verification requests

Request URL

Headers

POST /v1/monetization/verification-requests

Submit a notable verification request

Request URL

Headers

Request Body (JSON)

GET /v1/payments/withdrawals

List own withdrawals

Request URL

Headers

POST /v1/payments/withdrawals

Request a withdrawal

Request URL

Headers

Request Body (JSON)

GET /v1/payments/withdrawals/{withdrawal}

Show a withdrawal

Request URL

Headers

GET /v1/payments/withdrawal-methods

List own withdrawal methods

Request URL

Headers

POST /v1/payments/withdrawal-methods

Add a withdrawal method

Request URL

Headers

Request Body (JSON)

GET /v1/fanclubs

List fan clubs the authenticated user belongs to

Request URL

Headers

POST /v1/fanclubs

Create the authenticated creator fan club

Request URL

Headers

Request Body (JSON)

GET /v1/fanclubs/{id}

Show fan club details

Request URL

Headers

PATCH /v1/fanclubs/{id}

Update fan club metadata

Request URL

Headers

Request Body (JSON)

POST /v1/fanclubs/{id}/join

Join a fan club when qualified

Request URL

Headers

Request Body (JSON)

GET /v1/fanclubs/{id}/channels

List fan club channels

Request URL

Headers

POST /v1/fanclubs/{id}/channels

Create a fan club channel

Request URL

Headers

Request Body (JSON)

GET /v1/fanclubs/{id}/members

List fan club members

Request URL

Headers

POST /v1/fanclubs/{id}/timeout-user

Timeout a fan club member

Request URL

Headers

Request Body (JSON)

GET /v1/fanclubs/{id}/channels/{slug}/messages

List historical fan club messages

Request URL

Headers

POST /v1/fanclubs/{id}/channels/{slug}/messages

Post a fan club message

Request URL

Headers

Request Body (JSON)

GET /v1/fanclubs/{id}/channels/{slug}/stream

Open fan club message stream

Request URL

Headers

POST /v1/fanclubs/{id}/messages/{msgId}/pin

Pin a fan club message

Request URL

Headers

Request Body (JSON)

POST /v1/fanclubs/{id}/messages/{msgId}/delete

Delete a fan club message

Request URL

Headers

Request Body (JSON)

POST /v1/social/follow/{userId}

Follow a user

Request URL

Headers

Request Body (JSON)

DELETE /v1/social/follow/{userId}

Unfollow a user

Request URL

Headers

GET /v1/users/{id}/followers

List user followers

Request URL

Headers

GET /v1/users/{id}/following

List users followed by a user

Request URL

Headers

GET /v1/social/lists

List own creator lists

Request URL

Headers

POST /v1/social/lists

Create a creator list

Request URL

Headers

Request Body (JSON)

GET /v1/social/lists/{id}

View a public or owned creator list

Request URL

Headers

DELETE /v1/social/lists/{id}

Delete an owned creator list

Request URL

Headers

PATCH /v1/social/lists/{id}

Update an owned creator list

Request URL

Headers

Request Body (JSON)

POST /v1/social/lists/{id}/members/{userId}

Add a member to an owned creator list

Request URL

Headers

Request Body (JSON)

DELETE /v1/social/lists/{id}/members/{userId}

Remove a member from an owned creator list

Request URL

Headers

POST /v1/social/posts/{id}/like

Like a post

Request URL

Headers

Request Body (JSON)

DELETE /v1/social/posts/{id}/like

Unlike a post

Request URL

Headers

POST /v1/social/posts/{id}/share

Track a post share

Request URL

Headers

Request Body (JSON)

POST /v1/social/posts/{id}/save

Save a post

Request URL

Headers

Request Body (JSON)

DELETE /v1/social/posts/{id}/save

Unsave a post

Request URL

Headers

GET /v1/social/saves

List own saved posts

Request URL

Headers

GET /v1/taxonomy/niches

List active niches

Request URL

Headers

Expected Responses

                                                        200
                                                        List of active niches
                                                    

{
    "message": "Success",
    "data": [
        {
            "id": "01HQ123456789ABCDEFGHJKMNP",
            "name": "Technology",
            "slug": "technology",
            "description": "Tech, gadgets, software, and innovation",
            "isActive": true,
            "sortOrder": 1
        }
    ]
}

GET /v1/taxonomy/categories

List active categories

Request URL

Headers

Expected Responses

                                                        200
                                                        List of active categories
                                                    

{
    "message": "Success",
    "data": [
        {
            "id": "01HQ234567890BCDEFGHJKMNPQ",
            "nicheId": "01HQ123456789ABCDEFGHJKMNP",
            "name": "Web Development",
            "slug": "web-development",
            "description": "Frontend, backend, and full-stack development",
            "isActive": true,
            "sortOrder": 1
        }
    ]
}

GET /v1/taxonomy/tags

Search active tags

Request URL

Headers

Expected Responses

                                                        200
                                                        List of matching tags
                                                    

{
    "message": "Success",
    "data": [
        {
            "id": "01HQ345678901CDEFGHJKMNPQR",
            "name": "javascript",
            "slug": "javascript",
            "useCount": 42,
            "isActive": true
        }
    ]
}

GET /v1/timeline/home

Get personalized home timeline

Request URL

Headers

GET /v1/timeline/explore

Get explore timeline

Request URL

Headers

GET /v1/timeline/trending

Get trending timeline