Skip to content
Ishvana Ishvana Docs

Update bookmark

PUT
/api/browser/bookmarks/{bookmark_id}

Update mutable bookmark fields (title, category, project, tags).

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
bookmark_id
required
Bookmark Id
string

Request Body required

Section titled “Request Body required ”
BookmarkUpdateRequest

Request model for updating bookmark fields.

object
title
Any of:
string
category
Any of:
string
project
Any of:
string
tags
Any of:
Array<string>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

BookmarkResponse

Response model for bookmark creation results - COMPLETE BOOKMARK DATA.

Contains the complete bookmark including all user-provided data, AI-generated tags, summary, and usage suggestions for knowledge organization. This is the SINGLE SOURCE OF TRUTH for bookmark structure - frontend consumes this schema.

Fields:

  • bookmark_id: Unique identifier for the bookmark
  • url: Bookmarked URL
  • title: Page title
  • content: Page content
  • category: Bookmark category (research/reference/documentation/inspiration/other)
  • description: User-provided description or notes
  • project: Project context
  • user_tags: User-defined tags
  • ai_tags: AI-generated tags for categorization
  • ai_summary: AI-generated summary of the content
  • suggestions: AI-generated suggestions for usage
  • created_at: ISO 8601 timestamp of bookmark creation

AI Tags: Generated based on content analysis, typically 3-7 tags capturing:

  • Primary topics
  • Technologies mentioned
  • Content type (tutorial, reference, etc.)
  • Difficulty level

AI Summary: 2-3 sentence summary of bookmark content and utility.

Suggestions: Actionable recommendations like:

  • “Use for React performance optimization reference”
  • “Apply patterns to Ishvana frontend components”
  • “Share with team for TypeScript best practices”

Usage: Returned from POST /api/browser/bookmark endpoint.

JSON Example:

{
  "bookmarkId": "bm_abc123",
  "url": "https://example.com/typescript-guide",
  "title": "TypeScript Best Practices",
  "content": "TypeScript is a typed superset...",
  "category": "documentation",
  "description": "Comprehensive guide to TypeScript best practices",
  "project": "ishvana_docs",
  "userTags": ["typescript", "reference"],
  "aiTags": ["typescript", "best-practices", "type-safety", "tutorial"],
  "aiSummary": "Comprehensive guide to TypeScript best practices focusing on "
    "type safety and modern patterns",
  "suggestions": [
    "Apply type narrowing patterns to Ishvana codebase",
    "Use as reference for strict TypeScript configuration",
    "Share with development team"
  ],
  "createdAt": "2024-12-20T10:30:00Z"
}
object
bookmarkId
required
Bookmarkid

Unique bookmark identifier

string
url
required
Url

Bookmarked URL

string
title
required
Title

Page title

string
content
required
Content

Page content

string
category
required
Category

Bookmark category

string
description
required
Description

User-provided description or notes

string
project
required
Project

Project context

string
userTags
Usertags

User-defined tags

Array<string>
aiTags
Aitags

AI-generated tags

Array<string>
aiSummary
Any of:
string
suggestions
Suggestions

Usage suggestions

Array<string>
createdAt
required
Createdat

ISO 8601 bookmark creation timestamp

string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object