Search the published references of a public collection.

Collections store references, not copied content. They start private. Owner search reads current files in owned bases and published files in other bases. Publication includes only references to currently public bases; private bases and later additions stay out. Every public read checks base publication again. Private or withdrawn collections return 404. Responses use private, no-store. Returns: { query, items[{document,base,snippet}], next }

get/api/public-collections/{collection_id}/search

Request

  • Base URL: https://okfindex.com
  • URL: https://okfindex.com/api/public-collections/{collection_id}/search
  • Auth: none declared

Path parameters

collection_idstring required

The 64-character ID returned by this API.

Query parameters

qstring required

3–160 characters. Uses the existing MySQL FULLTEXT phrase search in document bodies.

afterstring

Document cursor from the next-page URL. Do not construct it.

Response

{ query, items[{document,base,snippet}], next }

querystring required

The requested word or phrase.

nextstring nullable required

Next page URL, or null when the bounded result is complete.

Changes

No recorded changes to this operation across all 1 revision of this API.