{"ok":true,"site":"collections-vam","host":"collections.vam.ac.uk","about":"V&A Explore the Collections: a JSON CLI over the Victoria and Albert Museum's public collections API. It can search and filter museum objects, fetch object records, IIIF manifests and image info, get facet counts, autocomplete makers, search archives, export results as CSV and browse organisation pages.","commands":[{"command":"search-objects","summary":"Search V&A collection objects by keyword. Filters: maker, object name, material, place, accession number, category, place/material/technique/person/organisation/collection IDs, has-image and on-displa","params":[{"name":"q","type":"string","description":"Free-text keyword searched across all fields"},{"name":"q_actor","type":"string","description":"Search only the Artist/maker field (person or organisation name)"},{"name":"q_object_name","type":"string","description":"Search only the title / object type field"},{"name":"q_material_technique","type":"string","description":"Search only the materials and techniques field"},{"name":"q_place_name","type":"string","description":"Search only the place name field"},{"name":"q_accession_number","type":"string","description":"Search by museum accession number, e.g. M.934-1983"},{"name":"images_exist","type":"boolean","description":"true = only objects that have images"},{"name":"kw_location_type","type":"string","description":"Location type filter. 'display' = only objects currently on display","oneOf":["display"]},{"name":"id_category","type":"string","description":"Category facet ID, e.g. THES48982 (Ceramics)"},{"name":"id_place","type":"string","description":"Place-of-origin facet ID, e.g. x29523 (Yorkshire), x28980 (London)"},{"name":"id_material","type":"string","description":"Material facet ID, e.g. x29356"},{"name":"id_technique","type":"string","description":"Technique facet ID"},{"name":"id_person","type":"string","description":"Person (maker) ID, e.g. A17686"},{"name":"id_organisation","type":"string","description":"Organisation ID, e.g. A22676 (Apple Inc.)"},{"name":"id_collection","type":"string","description":"Museum collection/department ID"},{"name":"kw_object_type","type":"string","description":"Exact object type keyword, e.g. Teapot"},{"name":"year_made_from","type":"number","description":"Earliest year of production, e.g. 1700"},{"name":"year_made_to","type":"number","description":"Latest year of production, e.g. 1800"},{"name":"order_by","type":"string","description":"Sort field, e.g. 'date' (default is relevance)"},{"name":"order_sort","type":"string","description":"Sort direction","oneOf":["asc","desc"]},{"name":"page","type":"number","description":"Page number (1-based)","default":1},{"name":"page_size","type":"number","description":"Results per page (max 100)","default":15}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/search-objects?q=teapot&q_actor=Wedgwood&id_category=THES48982"},{"command":"export-objects-csv","summary":"Export object search results as CSV text. Takes the same main filters as search-objects.","params":[{"name":"q","type":"string","description":"Free-text keyword"},{"name":"q_actor","type":"string","description":"Artist/maker name"},{"name":"images_exist","type":"boolean","description":"true = only objects with images"},{"name":"kw_location_type","type":"string","description":"'display' = only objects on display","oneOf":["display"]},{"name":"id_category","type":"string","description":"Category facet ID, e.g. THES48982"},{"name":"id_place","type":"string","description":"Place facet ID, e.g. x29523"},{"name":"id_material","type":"string","description":"Material facet ID"},{"name":"id_person","type":"string","description":"Person ID"},{"name":"id_organisation","type":"string","description":"Organisation ID"},{"name":"page","type":"number","description":"Page number","default":1},{"name":"page_size","type":"number","description":"Rows per page (max 100)","default":15}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/export-objects-csv?q=teapot"},{"command":"get-object","summary":"Get the full catalogue record for one museum object by its system number (the digits after 'O', e.g. O151155 -> 151155).","params":[{"name":"object_num","type":"number","required":true,"description":"Numeric part of the object system number (O151155 -> 151155)"}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/get-object"},{"command":"get-object-manifest","summary":"Get the IIIF presentation manifest (all images with their image service URLs) for an object.","params":[{"name":"object_num","type":"number","required":true,"description":"Numeric part of the object system number (O94917 -> 94917)"}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/get-object-manifest"},{"command":"get-image-info","summary":"Get IIIF image info (dimensions, tile sizes, supported formats) for an image asset ID such as _primaryImageId.","params":[{"name":"asset_ref","type":"string","required":true,"description":"Image asset reference, e.g. 2007BP1152 (the _primaryImageId field from search results)"}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/get-image-info"},{"command":"get-facet-counts","summary":"Get facet counts (categories, people, places, materials, techniques, etc.) for an object search.","params":[{"name":"q","type":"string","description":"Free-text keyword"},{"name":"q_actor","type":"string","description":"Artist/maker name"},{"name":"images_exist","type":"boolean","description":"true = only objects with images"},{"name":"kw_location_type","type":"string","description":"'display' = only objects on display","oneOf":["display"]},{"name":"id_category","type":"string","description":"Category facet ID"},{"name":"id_place","type":"string","description":"Place facet ID"},{"name":"cluster_size","type":"number","description":"Number of terms returned per facet"}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/get-facet-counts?q=teapot"},{"command":"list-facet-values","summary":"List the values and counts of one facet type (e.g. place, material, category) for an object search. Use this to find facet IDs for search-objects.","params":[{"name":"cluster_type","type":"string","required":true,"description":"Facet type","oneOf":["category","person","organisation","collection","gallery","style","place","object_type","technique","material"]},{"name":"q","type":"string","description":"Free-text keyword to scope the counts"},{"name":"cluster_size","type":"number","description":"Number of terms to return"}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/list-facet-values?q=teapot"},{"command":"autocomplete-names","summary":"Search-as-you-type suggestions for people and organisations (makers), returning their IDs for use in id_person / id_organisation filters.","params":[{"name":"q","type":"string","required":true,"description":"Partial name to complete"},{"name":"page_size","type":"number","description":"Number of suggestions","default":10},{"name":"page","type":"number","description":"Page number (1-based)","default":1}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/autocomplete-names?q=Wedgwood"},{"command":"search-archives","summary":"Search the V&A archives index (archive collections and records) by keyword.","params":[{"name":"q","type":"string","description":"Keyword (max 128 chars)"},{"name":"q_archive_title","type":"string","description":"Search archive titles only"},{"name":"q_creator","type":"string","description":"Search the creator field only"},{"name":"page","type":"number","description":"Page number","default":1},{"name":"page_size","type":"number","description":"Results per page","default":15}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/search-archives?q=teapot"},{"command":"list-suggested-facets","summary":"List the site's built-in suggested facets (popular places, etc.) with their system-number IDs.","params":[],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/list-suggested-facets"},{"command":"list-organisations","summary":"List organisations in the collection A–Z for a given starting letter, with their organisation IDs and profile URLs.","params":[{"name":"letter","type":"string","required":true,"description":"Lowercase starting letter a-z"}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/list-organisations"},{"command":"get-organisation-objects","summary":"Open an organisation profile page and list its featured collection objects.","params":[{"name":"org_id","type":"string","required":true,"description":"Organisation ID, e.g. A22676 or AUTH407110 (taken from list-organisations URLs)"},{"name":"slug","type":"string","required":true,"description":"URL slug of the organisation name, e.g. apple-inc."}],"exampleUrl":"https://clify-dev.netlify.app/collections-vam/get-organisation-objects"}]}