API: Create Clip

Create a Clip at a playback point in a transcribed Episode. Clip generation is asynchronous unless reusable completed output is already available.

Endpoint

POSThttps://app.podwise.ai/api/open/v1/episodes/[seq]/clips

Path Parameters

seq: Episode sequence number.

Request Body


type RequestBody = {
  // Non-negative integer playback point in seconds
  point: number,
}

Response

The endpoint returns HTTP 200 with the newly created Clip resource. Poll Get Clip to follow generation and obtain ready media.


type Response = {
  success: true,
  result: {
    id: number,
    episodeId: string,
    episodeSeq: number,
    episodeTitle: string,
    episodeCover: string | null,
    podcastName: string,
    podcastCover: string | null,
    title: string,
    takeaways: string[],
    content: string | null,
    point: number,
    clipStart: number | null,
    clipEnd: number | null,
    status: "waiting" | "processing" | "done" | "failed",
    exportable: boolean,
    // Unix timestamp in seconds
    createdAt: number,
  },
}

Error Responses

Status	Error	Description
400	—	Invalid Episode sequence number or `point`.
402	—	Open API or Clips are not available for the current plan.
404	`not_found`	Episode does not exist.
404	`not_transcribed`	Episode has not been transcribed yet.

Authorization Error Codes