sequences

Stop a preview that is being written

Ask the preview streaming under preview_id (its first frame) to stop. Cooperative: the preview checks before each model call and while the model writes, and ends there, its stream closing on an error frame with reason stopped. A preview that has already finished is unaffected.

post/sequences/{sequence_id}/agent/preview/{preview_id}/stop/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/sequences/{sequence_id}/agent/preview/{preview_id}/stop/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

sequence_idstring uuid required
preview_idstring uuid required

Response

Successful Response

preview_idstring uuid required

Changes

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