Skip to content

ContentStudio API

Generated from products/contentstudio/api-gateway/docs/openapi.yaml. Run npm run docs:generate to refresh.

ContentStudio API Gateway for content workflows.

FieldValue
Version0.3.0

Servers

  • http://localhost:3101

Endpoints (57)

MethodPathSummary
GET /healthHealth check
GET /healthzHealth check (k8s)
GET /readyReadiness
GET /liveLiveness
GET /api/v1/docs/openapi.yamlOpenAPI YAML
GET /api/v1/docs/openapi.jsonOpenAPI JSON
GET /api/v1/auth/sessionAuth session info
POST /api/v1/auth/signinSign in
GET /api/v1/contentList content items
POST /api/v1/contentCreate content
GET /api/v1/content/{id}Get content by ID
PATCH /api/v1/content/{id}Update content
GET /api/v1/content/slug/{slug}Get content by slug
GET /api/v1/social/platformsList social platforms
GET /api/v1/social/accountsList connected accounts
GET /api/v1/campaignsList campaigns
POST /api/v1/campaignsCreate campaign
GET /api/v1/media/foldersList media folders
GET /api/v1/brand/assetsBrand assets
GET /api/v1/brand/voiceBrand voice
GET /api/v1/brand/guidelinesBrand guidelines
GET /api/v1/templates/categoriesTemplate categories
GET /api/v1/templates/popularPopular templates
GET /api/v1/seo/auditsSEO audits
GET /api/v1/seo/schema/templatesSEO schema templates
GET /api/v1/analytics/reportsAnalytics reports
GET /api/v1/analytics/dashboardAnalytics dashboard
GET /api/v1/videosList videos
POST /api/v1/videosCreate video
GET /api/v1/videos/projectsList video projects
POST /api/v1/videos/projectsCreate video project
GET /api/v1/videos/dashboard/summaryVideo dashboard summary
GET /api/v1/videos/{videoId}Get video by id
PUT /api/v1/videos/{videoId}Update video
POST /api/v1/videos/{videoId}/workflow/transitionTransition video workflow stage
GET /api/v1/videos/{videoId}/versionsList video versions
POST /api/v1/videos/{videoId}/versionsCreate video version snapshot
POST /api/v1/videos/{videoId}/publishCreate publication request
GET /api/v1/videos/{videoId}/publicationsList publications for a video
POST /api/v1/videos/{videoId}/publications/{publicationId}/retryRetry a failed publication
GET /api/v1/videos/{videoId}/engagement/eventsList engagement events
POST /api/v1/videos/{videoId}/engagement/eventsIngest engagement event
PATCH /api/v1/videos/{videoId}/engagement/events/{eventId}/reviewMark engagement event reviewed/unreviewed
POST /api/v1/videos/{videoId}/engagement/events/{eventId}/tasksCreate a task from engagement event
GET /api/v1/videos/{videoId}/engagement/summaryEngagement summary rollup
GET /api/v1/videos/{videoId}/engagement/timelineEngagement timeline rollup
GET /api/v1/videos/{videoId}/commerce-linksList commerce links
POST /api/v1/videos/{videoId}/commerce-linksCreate commerce link
PATCH /api/v1/videos/{videoId}/commerce-links/{commerceLinkId}Update commerce link
POST /api/v1/videos/{videoId}/conversions/eventsIngest conversion event
GET /api/v1/videos/{videoId}/impact/kpisVideo impact KPIs
GET /api/v1/videos/{videoId}/impact/overviewVideo impact overview
GET /api/v1/videos/{videoId}/support/mappingsList support mappings
POST /api/v1/videos/{videoId}/support/mappingsCreate support mapping
PATCH /api/v1/videos/{videoId}/support/mappings/{mappingId}Update support mapping
POST /api/v1/videos/{videoId}/support/eventsIngest support event
GET /api/v1/videos/{videoId}/support/impactSupport impact rollup

GET /health

Health check

GET /healthz

Health check (k8s)

GET /ready

Readiness

GET /live

Liveness

GET /api/v1/docs/openapi.yaml

OpenAPI YAML

GET /api/v1/docs/openapi.json

OpenAPI JSON

GET /api/v1/auth/session

Auth session info

POST /api/v1/auth/signin

Sign in

GET /api/v1/content

List content items

POST /api/v1/content

Create content

GET /api/v1/content/{id}

Get content by ID

PATCH /api/v1/content/{id}

Update content

GET /api/v1/content/slug/{slug}

Get content by slug

GET /api/v1/social/platforms

List social platforms

GET /api/v1/social/accounts

List connected accounts

GET /api/v1/campaigns

List campaigns

POST /api/v1/campaigns

Create campaign

GET /api/v1/media/folders

List media folders

GET /api/v1/brand/assets

Brand assets

GET /api/v1/brand/voice

Brand voice

GET /api/v1/brand/guidelines

Brand guidelines

GET /api/v1/templates/categories

Template categories

GET /api/v1/templates/popular

Popular templates

GET /api/v1/seo/audits

SEO audits

GET /api/v1/seo/schema/templates

SEO schema templates

GET /api/v1/analytics/reports

Analytics reports

GET /api/v1/analytics/dashboard

Analytics dashboard

GET /api/v1/videos

List videos

POST /api/v1/videos

Create video

GET /api/v1/videos/projects

List video projects

POST /api/v1/videos/projects

Create video project

GET /api/v1/videos/dashboard/summary

Video dashboard summary

GET /api/v1/videos/{videoId}

Get video by id

PUT /api/v1/videos/{videoId}

Update video

POST /api/v1/videos/{videoId}/workflow/transition

Transition video workflow stage

GET /api/v1/videos/{videoId}/versions

List video versions

POST /api/v1/videos/{videoId}/versions

Create video version snapshot

POST /api/v1/videos/{videoId}/publish

Create publication request

GET /api/v1/videos/{videoId}/publications

List publications for a video

POST /api/v1/videos/{videoId}/publications/{publicationId}/retry

Retry a failed publication

GET /api/v1/videos/{videoId}/engagement/events

List engagement events

POST /api/v1/videos/{videoId}/engagement/events

Ingest engagement event

PATCH /api/v1/videos/{videoId}/engagement/events/{eventId}/review

Mark engagement event reviewed/unreviewed

POST /api/v1/videos/{videoId}/engagement/events/{eventId}/tasks

Create a task from engagement event

GET /api/v1/videos/{videoId}/engagement/summary

Engagement summary rollup

GET /api/v1/videos/{videoId}/engagement/timeline

Engagement timeline rollup

List commerce links

POST /api/v1/videos/{videoId}/commerce-links

Create commerce link

PATCH /api/v1/videos/{videoId}/commerce-links/{commerceLinkId}

Update commerce link

POST /api/v1/videos/{videoId}/conversions/events

Ingest conversion event

GET /api/v1/videos/{videoId}/impact/kpis

Video impact KPIs

GET /api/v1/videos/{videoId}/impact/overview

Video impact overview

GET /api/v1/videos/{videoId}/support/mappings

List support mappings

POST /api/v1/videos/{videoId}/support/mappings

Create support mapping

PATCH /api/v1/videos/{videoId}/support/mappings/{mappingId}

Update support mapping

POST /api/v1/videos/{videoId}/support/events

Ingest support event

GET /api/v1/videos/{videoId}/support/impact

Support impact rollup