42 lines
1.3 KiB
YAML
42 lines
1.3 KiB
YAML
info:
|
|
name: Create Media Highlight
|
|
type: http
|
|
seq: 2
|
|
http:
|
|
method: POST
|
|
url: '{{base_url}}/api/media-items/{{media_item_id}}/highlights'
|
|
auth: inherit
|
|
body:
|
|
type: json
|
|
jsonBody: "{\n \"selection_text\": \"This is the highlighted text from the\
|
|
\ media item.\",\n \"start_position\": \"page:45:offset:120\",\n \"end_position\"\
|
|
: \"page:45:offset:145\",\n \"color\": \"#ffff00\",\n \"note_id\": \"\""
|
|
|
|
docs: |-
|
|
## Create Media Highlight
|
|
|
|
Creates a new highlight for a specific media item.
|
|
|
|
**Method:** POST
|
|
|
|
**Endpoint:** /api/media-items/:id/highlights
|
|
|
|
**Path Parameters:**
|
|
- `id` (string): Media item ID
|
|
|
|
**Request Body:**
|
|
- `selection_text` (string): Highlighted text (required, 1-5000 chars)
|
|
- `start_position` (string): Start position (required, max 100 chars)
|
|
- `end_position` (string): End position (required, max 100 chars)
|
|
- `color` (string): Highlight color in hex format (optional, default #ffff00)
|
|
- `note_id` (string): Optional associated note ID
|
|
|
|
**Response:**
|
|
- Highlight object with all fields including generated ID and timestamps
|
|
|
|
**Status Codes:**
|
|
- 201: Created
|
|
- 400: Invalid request
|
|
- 401: Unauthorized
|
|
- 404: Media item not found
|