segments

Combine Segment Endpoint

Combine this segment with an adjacent segment.

post/segments/{segment_id}/combine

Request

  • Base URL: https://api.framesail.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.framesail.com/segments/{segment_id}/combine
  • Auth: HTTP bearer

Path parameters

segment_idstring required

Request body

dry_runboolean

Preview the operation's consequences (assets kept / staled / recreated / deleted, jobs cancelled, rendered assets lost) without applying it.

with_segment_idstring required

ID of the adjacent segment to merge with.

keep'this' | 'other'

Which segment's creative data survives. 'this' = the segment in the URL, 'other' = with_segment_id.

Response

Successful Response

segmentsobject[] required
warningstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.