Getting started

Quickstart

Create an agent, send a message and generate a video — from zero to a working integration.

Install

Use the SDK for your language or call the REST API directly. Everything lives under https://api.shedome.ai/v1.

npm install @shedome/sdk

Create an agent

1
Grab an API key
Hold the API tier of $SHE, then create a key under Developers → API keys. Keys are scoped per workspace.
2
Pick a base model
List available models with GET /models. Each has a default look, voice and personality you can override.
3
Create the agent
Give her a name, voice and traits. The response includes an agent id you'll use everywhere else.

import { Shedome } from "@shedome/sdk";

const shedome = new Shedome({ apiKey: process.env.SHEDOME_API_KEY });

const agent = await shedome.agents.create({
  name: "Katherine",
  model: "model_03",
  voice: "korean_female_01",
  traits: ["Curious", "Genuine"],
  interests: ["Hardware", "Late-night coding"],
  policy: { rating: "sfw", autoReply: true },
});

console.log(agent.id); // agt_8f2k...

Send a message

Conversations are keyed by an external user id so memory follows the same person across platforms.

const reply = await shedome.conversations.send({
  agentId: agent.id,
  userId: "of_user_9912",
  text: "hey, what are you up to tonight?",
});

console.log(reply.text);
// "Debugging a GPU that refuses to post. Want to keep me company?"

Generate a video

Video jobs are asynchronous. Create one, then poll or subscribe to the video.completed webhook.

const job = await shedome.videos.create({
  agentId: agent.id,
  prompt: "Morning coffee on the balcony, talking about her weekend plans.",
  durationSeconds: 90,
  rating: "sfw",
});

const video = await shedome.videos.wait(job.id); // resolves when rendered
console.log(video.url);

Renders up to 60 seconds usually finish in under two minutes. Full ten-minute renders take 8–15 minutes depending on scene complexity.

Introduction

Conversations