README

High-level PHP client for the HeroShots / StudioHero platform, authenticated with a portal JWT or API key. PSR-4 namespace HeroShots\.

Scope: image generation (incl. still-life), short video, long video, still-life video, the full Studio Hero storyboard flow, avatar listing & generation, and account balance. See GUIDE.md for use-case walkthroughs.

Install

composer require heroshots/sdk

Requires PHP 8.1+. Runtime dependency: guzzlehttp/guzzle.

Authenticate

use HeroShots\Client;

// Email/password login: stores the JWT, auto re-logins on expiry.
// Base URL defaults to https://app.heroshots.ai.
$client = Client::fromLogin('dev@partner.com', 'secret');

// Or reuse an existing token.
$client = new Client(token: 'eyJ...');

Agency act-as

Agency API keys can operate as a managed brand by passing the managedUserId returned by the managed-client provisioning API. The SDK adds X-Managed-User-Id to authenticated requests.

use HeroShots\Client;

$client = new Client(token: 'lz_live_YOUR_AGENCY_KEY', managedUserId: 12345);
$job = $client->images->generate('https://example.com/product.jpg');

// Switch target brand later, or pass null to clear it.
$client->withManagedUser(67890);

Usage

// Local file paths are auto-uploaded to hosted URLs.
$briefs = $client->storyboard->briefSuggestions('product.jpg', 'model.jpg', [
    'duration_seconds' => 30, 'language_code' => 'it',
]);

$candidates = $client->storyboard->candidates($briefs[0], 30, 'product.jpg', 'model.jpg');

$job = $client->storyboard->generate($briefs[0], 30, $candidates[0], 'product.jpg', 'model.jpg');
$sb  = $client->storyboard->wait($job['job_id']);          // polls until done/failed

$vjob  = $client->longvideo->start('product.jpg', null, $sb['storyboard']);
$final = $client->longvideo->wait($vjob['job_id']);
echo $final['final_video_url'];

Extra backend fields go in the trailing $payload/$fields array argument and are forwarded verbatim. /api/v1 billing metadata is under $result['_meta'].

Resources

uploads · images · videos · longvideo · stilllife · storyboard · avatars

Plus on the client: login(), me(), balance(), stats().

Errors

use HeroShots\Errors\ValidationException;

try {
    $client->storyboard->candidates('', 30, 'p.jpg');
} catch (ValidationException $e) {
    echo $e->errorCode . ': ' . $e->getMessage();
}

All errors extend HeroShots\Errors\ApiException (->errorCode, ->status, ->details).

Test

composer install
composer test       # PHPUnit, offline (Guzzle MockHandler)

Billing

Generations cost credits. Check remaining credits with $client->balance() (hs_credits + wallet_balance). Use $client->stats() for the full raw /api/auth/stats payload, including recent generations and offered plans. See examples/full_storyboard_flow.php.

heroshots / sdk

Maintainers

Package info

Statistics

Security