FUSE is a read-only service -
indexing content from an organization's
sources of knowledge with that collective
knowledge then being put to work in
useful ways. Typically there's no need for
a
third party to access FUSE's data since it
exists already in the sources themselves.
Occasionally, however, there are use cases
and
that's where FUSE's API comes into
play:
- Pull data that was generated by and lives
only in FUSE - for example, transcripts, topic
classifications, OCR
output, or subscriber
details.
- Use FUSE's aggregated knowledge of an
organization to build a custom application
on top of, avoiding the repeat work of
collecting the knowledge again.
- Drawing FUSE content into a custom
application where you need to tightly
control the display and flow of
information.
Endpoint
GET
https://fuse.fusesearch.app/api/1/seriesAuthentication uses Basic
Auth.
- Username:
usernameprovided by FUSE - Password: your
API_KEYprovided by FUSE
Query Parameters
Required
query– The search query. Uses fuSeQL syntax.
Optional
scorefunction– ID of the score function to use. Set by the Fuse team based on your requirements.default_fields– Comma-separated list of fields to search. You can boost specific fields using ^. Example: description^100,summary^5,* This boosts the description field by 100, summary by 5, and searches all fields (*).page– Page number of results. Default: 1.per_page– Number of results per page. Default: 20.facets– Comma-separated list of fields to facet on.fields– Fields to retrieve. Use * to retrieve all fields.highlight– Words to highlight in the results (usually the user query).highlight_fields– Comma-separated list of fields to apply highlighting to.highlight_full_fields– Comma-separated list of fields to show full highlighted content.suggest– Words to base suggestions on (usually the user query).
Example Request
curl -u username:API_KEY
"https://fuse.fusesearch.app/api/1/seriesquery=search+term&default_fields=title^10,summary&fields=title,summary" Response
Returns JSON results. Suggested: run a
query to see structure and contents.
Example use cases include search results
display, faceting, autocomplete
suggestions, and highlighting matched
terms.
Tips
- Use
fields=*during development to explore available fields. - Try different
default_fieldsboosts to improve relevance. - Use
facetsto power filters in UI. highlightandhighlight_fieldsimprove user clarity in UI.- Use
suggestfor search term refinement or autocomplete.
For questions or help setting up
scorefunction, contact FUSE Support via
Email or call
us at (844) 434-FUSE. Thank you for using FUSE!