Star API

Star API developer guide

For outside developers on partner accounts with Star API. Use this guide to connect your platform to Star: receive pitches, track campaign status, review shortlists with fit, pull delivery assets, and listen for webhooks. You only see data scoped to your partner key.

Base/api/star/v1

AuthBearer star_live_… / star_test_…

Start with Star ← Back to Star

Auth

Every request needs a partner API key issued for your company when Star API is on your quote. Live keys start with star_live_. Sandbox keys start with star_test_. Keys are shown once when created in the dashboard. Store them like any other secret.

Authorization: Bearer star_live_…

Your key scopes every response. You only receive briefs, shortlists, and creators attached to your partner account. Star is not a public roster directory.

Briefs and campaign pipeline

Submit a campaign brief from your side, then read pipeline status as Branch B produces the work. Stages move in order: RECEIVED → REVIEWED → PITCHED → GREENLIT → PRE_PROD → LIVE → DELIVERED.

POST /briefs

{
  "title": "Summer launch PV",
  "brief": "Music-led campaign for JP + EN audiences…",
  "brand": "Acme",
  "ownerName": "Maya Chen",
  "budgetNote": "Premium",
  "genres": ["J-pop"],
  "formats": ["Music video"],
  "languages": ["Japanese", "English"]
}

GET /briefs · GET /briefs/:id

List briefs or fetch one by id. Responses include pipeline timestamps, daysInStage, overdue flag, shortlist seats, and delivery assets.

PATCH /briefs/:id

Update fields you own on a brief, such as stage notes your integration needs or owner display name.

{ "stage": "PITCHED", "ownerName": "Maya Chen" }

Creator shortlist with fit

Star does not expose a browseable creator catalog. For each brief you get a shortlist: proposed creators with fit reasons (genre, format, language, verified reach), estimated view bands, and seat state PROPOSED, ACCEPTED, or DECLINED.

POST /briefs/:id/shortlist

Ask Star to propose seats from the roster that match the brief targets and your account filters.

{ "action": "propose", "limit": 5 }

Or attach a creator and set a seat decision yourself:

{
  "creatorId": "clx…",
  "seatStatus": "ACCEPTED",
  "fitNote": "Strong EN anime audience, Live2D ready"
}

GET /briefs/:id/shortlist

Returns fit cards for this brief only: verdict, score, matched tags, reasons, estimated impressions, and creator metrics.

{
  "shortlist": [{
    "status": "PROPOSED",
    "fit": {
      "verdict": "Strong fit",
      "reasons": ["Genre match: J-pop", "Language match: English"],
      "matched": { "genres": ["J-pop"], "formats": [], "languages": ["English"] }
    },
    "estimatedImpressions": { "min": 80000, "max": 150000 },
    "creator": { "id": "…", "name": "…", "reach": 32000 }
  }]
}

Creators and verified metrics

List creators already on your shortlists. Each record includes languages, genres, formats, verified followers, average views, growth, and lastCheckedAt. Search is limited to that partner-scoped set.

GET /creators?q=english
GET /creators/:id

Delivery assets

When cuts and finals are ready, pull them from the brief. Your integration can sync URLs into your DAM or review queue.

PATCH /briefs/:id
{
  "asset": {
    "kind": "FINAL",
    "label": "Master 1080p",
    "url": "https://…",
    "deliveredAt": "2026-08-15T18:00:00.000Z"
  }
}

Webhooks

Register an HTTPS endpoint on your servers. When events fire, Star posts a signed payload. Verify X-Star-Signature (sha256=…) when a webhook secret is issued.

POST /webhooks
{
  "url": "https://your.app/hooks/star",
  "events": ["pitch.sent", "status.changed", "creator.accepted", "asset.ready"]
}

Account and config

Read your partner account and update filters your integration uses (minimum followers, platforms, languages, exclude paused creators).

GET /account
PATCH /account
{
  "config": {
    "minFollowers": 40000,
    "platforms": ["YOUTUBE"],
    "excludePaused": true,
    "languages": ["Japanese", "English"]
  }
}

Export

Download a CSV of your campaigns for spreadsheets or offline sync.

GET /export/briefs

Event catalog

brief.created: new brief submitted
pitch.sent: pipeline pitched or shortlist proposed
status.changed: other pipeline stage changes
creator.accepted / creator.declined: creator seat accepted or declined
asset.ready: delivery link attached