Marginalia Search

opencollection: 1.0.0
info:
  name: Marginalia Search API
  version: 2.0.0
request:
  auth:
    type: apikey
    key: API-Key
    value: '{{API-Key}}'
    placement: header
items:
- info:
    name: Search
    type: folder
  items:
  - info:
      name: Execute a web search
      type: http
    http:
      method: GET
      url: https://api2.marginalia-search.com/search
      params:
      - name: query
        value: ''
        type: query
        description: Search terms.
      - name: count
        value: ''
        type: query
        description: Number of results to return.
      - name: timeout
        value: ''
        type: query
        description: Maximum execution time in milliseconds.
      - name: dc
        value: ''
        type: query
        description: Maximum results per domain.
      - name: page
        value: ''
        type: query
        description: Result page (1-indexed).
      - name: nsfw
        value: ''
        type: query
        description: NSFW content filtering (experimental).
      - name: filter
        value: ''
        type: query
        description: Apply a named filter previously created via /filter.
    docs: Run a search query against the Marginalia index and return ranked results. Optional parameters allow paging, per-domain
      capping, NSFW filtering, and named filter application.
- info:
    name: Filters
    type: folder
  items:
  - info:
      name: List configured filters
      type: http
    http:
      method: GET
      url: https://api2.marginalia-search.com/filter
    docs: List configured filters
  - info:
      name: Retrieve a filter definition
      type: http
    http:
      method: GET
      url: https://api2.marginalia-search.com/filter/:name
      params:
      - name: name
        value: ''
        type: path
        description: Filter name.
    docs: Retrieve a filter definition
  - info:
      name: Create a named filter
      type: http
    http:
      method: POST
      url: https://api2.marginalia-search.com/filter/:name
      params:
      - name: name
        value: ''
        type: path
        description: Filter name.
    docs: Create or update a filter. Filter bodies are XML supporting domain inclusion/exclusion, temporal bias, term filtering,
      and parameter constraints (year, quality, size, rank).
  - info:
      name: Delete a filter
      type: http
    http:
      method: DELETE
      url: https://api2.marginalia-search.com/filter/:name
      params:
      - name: name
        value: ''
        type: path
        description: Filter name.
    docs: Delete a filter
bundled: true