{"source":"nasjonalbiblioteket","operation":"search_within_item","description":"Full-text search inside the OCR'd pages of one specific digitized item\n(a book, one newspaper issue, a journal issue, etc.), returning which\npages contain the term. Use this to jump straight to relevant pages of\na long item instead of reading it page by page. Signature: search_within_item(item_id: string, required; q: string, required; max_pages: integer, pages, optional, default 30; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"search_within_item(item_id: string, required; q: string, required; max_pages: integer, pages, optional, default 30; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"item_id","type":"string","schema":{"type":"string"},"required":true,"default":null,"description":"The sesamId or URN from search()/get_item(). Only works for digitized items (accessInfo.digital=true from search()/get_item()).","unit":null},{"name":"q","type":"string","schema":{"type":"string"},"required":true,"default":null,"description":"The word or phrase to find.","unit":null},{"name":"max_pages","type":"integer","schema":{"type":"integer"},"required":false,"default":30,"description":"Max distinct pages to return, 1 to 200 (default 30). Unit: pages.","unit":"pages"},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100).","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket/search_within_item?item_id={item_id}&q={q}&max_pages=30&limit=25&offset=0","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"id":{"type":"string"},"query":{"type":"string"},"total_matches":{"type":"integer"},"pages_truncated":{"type":"boolean"},"pages":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"string"},"match_count":{"type":"integer"},"sample_text":{"type":["string","null"]},"thumbnail":{"type":"string","format":"uri"}},"additionalProperties":false,"required":["page_id","match_count"]}}},"additionalProperties":false,"required":["id","query","total_matches","pages_truncated","pages"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["library_item"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"502":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket/search_within_item/schema","operation":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket/search_within_item","source":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["id","query","total_matches","pages_truncated","pages","pages[].page_id","pages[].match_count","pages[].sample_text","pages[].thumbnail"],"output_fields_truncated":false,"canonical_field_aliases":{"identifier":["id"]},"response_example":{"source":"nasjonalbiblioteket","operation":"search_within_item","parameters":{"item_id":"example-id","q":"example value","max_pages":30},"data":{"id":"example-id","query":"example value","total_matches":1,"pages_truncated":true,"pages":[{"page_id":"example-id","match_count":1,"sample_text":"example value","thumbnail":"https://example.invalid/resource"}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"nasjonalbiblioteket","name":"National Library of Norway","description":"Search books, newspapers, journals, photos, maps, audiovisual media and digitized full text.","cache_ttl_seconds":300,"documentation":"https://api.nb.no/"}]},"_provenance":{"data":{"source":"nasjonalbiblioteket","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket"},"entities":{"source":"nasjonalbiblioteket","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket/search_within_item","source":"https://allemannsdata.com/wiki/api/v1/kilder/nasjonalbiblioteket","wiki":"https://allemannsdata.com/wiki/kilder/nasjonalbiblioteket/search_within_item/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}