V1

Content search across books

Changed on

Perform a text or vector search across books. Optionally filter by specific book IDs and version IDs. Requires bearer token authentication.

get/v1/content-search

Request

  • Base URL
    https://api.usul.ai
  • URL
    https://api.usul.ai/v1/content-search
  • Auth
    HTTP bearer

Query parameters

qstring required

Search query

type'text' | 'vector' required

Search type: 'text' for keyword search, 'vector' for semantic search

booksstring

Comma-separated list of bookId:versionId pairs to search within (e.g., 'book1:v1,book2:v2')

include_chapters'true' | 'false'

Whether to include chapter metadata in results

include_details'true' | 'false'

Whether to include book details in each result

pageinteger

Page number for pagination

limitinteger

Number of results per page

Response

Content search results retrieved successfully

totalinteger required

Total number of matching results

totalPagesinteger required

Total number of pages

perPageinteger required

Results per page

currentPageinteger required

Current page number

hasNextPageboolean required

Whether there is a next page

hasPreviousPageboolean required

Whether there is a previous page

Changes

  • c97a31c24e55Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      added the non-success response with the status