Getting Started with RunAsh AI

Complete setup guide from installation to your first API call — follow these steps to get streaming and integrating quickly.

Quick Overview

This guide covers: account setup, installing the RunAsh SDK/CLI, configuring credentials, and making your first API request (create stream). Follow the steps in order — you’ll be live or integrating in under 15 minutes.

Step 1 — Create and verify your account
  1. Sign up at the RunAsh seller registration page and verify your email address.
  2. Complete your seller profile (display name, profile photo, business details) so payouts and publishing are enabled.
  3. Request API access from the dashboard if required — some accounts need approval for production API keys.
Step 2 — Install the SDK / CLI

RunAsh provides a JavaScript SDK and a minimal CLI for creating streams and testing. Pick the approach that fits your stack.

Install (npm)
npm install @runash/sdk
Install (yarn)
yarn add @runash/sdk
If you prefer curl for quick testing, you can use our REST endpoints directly (see the example below).
Step 3 — Configure credentials

Obtain your API key from the RunAsh dashboard (Dashboard → API Keys). Treat it like a secret.

Environment variable (recommended)
# .env
RUNASH_API_KEY=sk_live_XXXXXXXXXXXX
Header (example)
Authorization: Bearer sk_live_XXXXXXXXXXXX
Step 4 — Your first API call

Example: create a new stream session. Replace sk_live_... with your API key.

cURL
curl -X POST "https://api.runash.in/v1/streams"   -H "Authorization: Bearer sk_live_XXXXXXXXXXXX"   -H "Content-Type: application/json"   -d '{
    "title": "My First Live Stream",
    "description": "Showing our organic products",
    "category": "Live Streaming",
    "scheduled_time": "2026-02-01T15:00:00Z"
  }'
JavaScript (SDK)
import RunAsh from "@runash/sdk";

const client = new RunAsh({ apiKey: process.env.RUNASH_API_KEY });

const stream = await client.streams.create({
  title: "My First Live Stream",
  description: "Showing our organic products",
  category: "Live Streaming",
  scheduled_time: "2026-02-01T15:00:00Z",
});

console.log(stream.id, stream.push_url);
The response will include stream IDs and push/ingest URLs (RTMP/SDK). Use the push URL in your encoder or mobile app to go live.
Step 5 — Verify & test
  1. Use the returned push URL in your streaming software (OBS, Streamlabs) or the RunAsh mobile app.
  2. Start a private/test stream to confirm audio/video and overlays work as expected.
  3. Check the stream status in the dashboard and inspect analytics for any dropped frames or errors.
Tip
Use a low-latency test with a small audience before public broadcasting.
Troubleshooting common issues
401 / Unauthorized

Check your API key and headers. Make sure you are using the correct environment (test vs production).

Connection / RTMP errors

Verify push URL, credentials, and that your encoder is set to the recommended bitrate for your network.

Missing features or permissions

Some accounts require approval for production API keys — contact support to enable features.

Next steps & resources
  • Read the full for endpoints and webhooks.
  • Configure stream settings and AI features in .
  • Try AI features in a private stream: auto-enhancement, noise reduction, and product recognition.

Need a hand? Our onboarding team can help with API key setup, SDK integration, and a live test — reach out via the support page.

Was this page helpful?

Your feedback helps us improve RunAsh docs.