Entwicklerdokumentation

Scope-Referenz

Granulare Scopes mappen auf Backend-Berechtigungen. Fordern Sie nur die Scopes an, die Ihre Integration benötigt.

Wie Scopes funktionieren

Bei Key-Erstellung werden angeforderte Scopes mit den Rollenberechtigungen des Erstellers geschnitten. Routen erzwingen Scopes unabhängig.

  • Studio-lizenziertes Projekt für API-Nutzung erforderlich
  • Schedule- und Budget-KI-Neuläufe erfordern Studio-Scopes
  • Aktivitätslogs zeichnen api_key_used-Events für mutierende Aufrufe auf

Scope-Referenz

Projekte

ScopeBeschreibung
projects:readProjekt-Metadaten auflisten und lesen
projects:createProjekte im Workspace erstellen
projects:updateProjekteinstellungen aktualisieren
projects:archiveProjekte archivieren
projects:deleteProjekte löschen
projects:exportProjektlieferungen exportieren

Drehbuch und Breakdown

ScopeBeschreibung
screenplay:uploadDrehbuchversionen hochladen
screenplay:editDrehbuchinhalt bearbeiten
screenplay:lockProduktionsdrehbücher sperren oder entsperren
screenplay:breakdownBreakdown-Tags und Elemente verwalten
screenplay:share_linksShare-Links erstellen und verwalten
breakdown:rerunKI-Breakdown erneut ausführen

Scheduling

ScopeBeschreibung
scheduling:readSchedules und Stripboards lesen
scheduling:editSchedule-Daten bearbeiten
scheduling:rerunKI-Schedule-Generierung erneut ausführen (Studio)

Budget

ScopeBeschreibung
budgeting:readBudget-Topsheets und Positionen lesen
budgeting:editBudget-Daten bearbeiten
budgeting:rerunKI-Budget-Analyse erneut ausführen (Studio)

Coverage

ScopeBeschreibung
coverage:readCoverage-Berichte lesen
coverage:editCoverage-Inhalt bearbeiten
coverage:rerunKI-Coverage erneut ausführen

Workspace

ScopeBeschreibung
workspace:readWorkspace-Metadaten lesen
workspace:members:readWorkspace-Mitglieder auflisten
workspace:activity:readWorkspace-Aktivitätslogs lesen
API-Scopes-Referenz | RivetAI Developers · RivetAI