Skip to content

API Overview

A high-level overview of the OikosTV public API endpoints.

Base URL

https://dev.api.crewvid.com/api/v1/

Content & Discovery

MethodEndpointDescription
GET/videos/{shortUUID}Fetch detailed information about a specific video
GET/channels/{handle}Retrieve channel details, including subscriber counts and metadata
GET/videos/{shortUUID}/playbackGet playback bundle (manifest + session JWT) for a video

Monetization & Rewards

MethodEndpointDescription
GET/me/rewards/balanceCheck your current PeerCredit balance
POST/rewards/redeemExchange PeerCredits for ad-free viewing hours
GET/studio/monetization/flagsView enabled monetization features for a channel

Authentication

All API requests must include a valid session token in the Authorization header:

http
Authorization: Bearer <session_token>

Rate limiting

To ensure platform stability, all public endpoints are subject to rate limiting. Please implement exponential backoff for retries.

Versioning

We use versioned URLs (e.g., /api/v1/...) to maintain backward compatibility as the API evolves. The current stable version is v1.

Error Responses

The API returns errors in a consistent format:

json
{
  "error": "Description of what went wrong"
}

Common HTTP status codes:

CodeMeaning
400Bad Request — invalid parameters
401Unauthorized — missing or invalid token
403Forbidden — insufficient permissions
404Not Found — resource doesn't exist
429Too Many Requests — rate limit exceeded
500Internal Server Error

SDK available

For easier integration, use the @crewvid/outpost-sdk package instead of calling the API directly.