> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akapulu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update clip

> Rename a clip or set its favorite take.

Rename a clip or set its favorite take.

Send `id` plus at least one of:

* `name`
* `favorite_id` — a take on this clip, or `null` to clear

The first take on a clip is marked favorite automatically. Use this endpoint to change that later.


## OpenAPI

````yaml openapi/akapulu.json POST /clips/update
openapi: 3.1.0
info:
  title: Akapulu Labs API
  version: 1.0.0
  description: Public Akapulu Labs API reference.
servers:
  - url: https://akapulu.com/api
security:
  - bearerAuth: []
paths:
  /clips/update:
    post:
      summary: Update clip
      description: Rename a clip or set its favorite take.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClipRequest'
            examples:
              default:
                value:
                  id: 11111111-2222-3333-4444-555555555555
                  favorite_id: 22222222-3333-4444-5555-666666666666
      responses:
        '200':
          description: Clip updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Clip'
              examples:
                success:
                  value:
                    id: 11111111-2222-3333-4444-555555555555
                    name: Product intro
                    favorite_id: 22222222-3333-4444-5555-666666666666
                    take_count: 1
                    created_at: '2026-08-25T20:00:00+00:00'
                    updated_at: '2026-08-25T20:00:12+00:00'
                    takes:
                      - id: 22222222-3333-4444-5555-666666666666
                        clip_id: 11111111-2222-3333-4444-555555555555
                        name: Take 1
                        status: ready_to_render
                        avatar_id: 66666666-7777-8888-9999-000000000000
                        error: null
                        audio_url: >-
                          https://example.s3.amazonaws.com/audio?X-Amz-Expires=3600
                        video_url: null
                        created_at: '2026-08-25T20:00:00+00:00'
                        updated_at: '2026-08-25T20:00:12+00:00'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                default:
                  value:
                    error: name or favorite_id is required
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                default:
                  value:
                    error: Invalid API key
        '404':
          description: Clip not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                default:
                  value:
                    error: Clip not found
components:
  schemas:
    UpdateClipRequest:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          format: uuid
          description: Clip ID.
        name:
          type: string
        favorite_id:
          description: Take ID on this clip, or null to clear.
          oneOf:
            - type: string
              format: uuid
            - type: 'null'
    Clip:
      allOf:
        - $ref: '#/components/schemas/ClipSummary'
        - type: object
          properties:
            takes:
              type: array
              items:
                $ref: '#/components/schemas/TakeSummary'
    ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
    ClipSummary:
      type: object
      required:
        - id
        - name
        - favorite_id
        - take_count
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        favorite_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Favorite take on this clip, or null.
        take_count:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    TakeSummary:
      type: object
      required:
        - id
        - clip_id
        - name
        - status
        - avatar_id
        - error
        - audio_url
        - video_url
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
        clip_id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - starting_tts
            - generating_audio
            - generating_motion_instructions
            - ready_to_render
            - starting_video
            - preparing_video
            - generating_face_video
            - generating_avatar_gestures
            - compositing
            - applying_labels
            - watermarking
            - signing
            - complete
            - failed
          description: >-
            Current landmark. Poll until ready_to_render for audio, complete for
            video.
        avatar_id:
          type: string
          format: uuid
        error:
          type:
            - string
            - 'null'
        audio_url:
          type:
            - string
            - 'null'
          description: Hour-long download URL once audio exists.
        video_url:
          type:
            - string
            - 'null'
          description: Hour-long download URL once video exists.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````