Content-Aware Storage (CAS) APIs

List of all REST API references for CAS service.

Authorize for REST APIs

For authentication of REST APIs, ensure you have a valid OpenShift® Container Platform bearer token in Authorization header:
  1. Retrieve the token:
    1. Go to OpenShift console.
    2. In the page that displays, click Display Token link.
    3. In the Your API token is page, copy the token value from the Log in with this token section.
  2. In your browser, go to swagger - https://<fusion url>/api/v1/querysearch/docs.

    The Swagger document specifies the list of resources that are available in the REST API and the operations that can be called on those resources. The Swagger document also specifies the list of parameters for an operation, including the name and type of the parameters and information about acceptable values for those parameters.

  3. In the FastAPI page, click Authorize.
  4. In the Available authorizations window, enter a value for HTTPBearer.
  5. Click Authorize.

Try APIs from swagger

For more information about swagger docs, see https://fusionconsoleurl/api/v1/querysearch/docs# or in the user interface go to Domains > View Search APIs.

In the swagger, expand the API and click Try it out.

/tables

Description
It return all the document processor "tables".
Method
GET
Usage
Check swagger.

/semantic_search

Description
Matches the exact words and uses natural language processing (NLP) and machine learning to find results that are semantically relevant.
Method
POST
Parameters
Parameter: Type Description
"query": string The natural language question that is used by the embedding model to return a list of relevant snippets of text from the ingested documents.
"table": string Name of a particular document processor that has ingested documents from a given domain.
"limit": int Maximum number of results returned, default is 5.
"enable_source": boolean If true, any source information about the document is returned.
"enable_content_metadata": boolean If true, any metadata about the relevant document is returned.
Usage
Check swagger.
Sample end-user CLI chatbot
The CLI-powered chatbot enables a secured, authenticated access to Content-Aware Storage through a conversational CLI, powered by LLMs such as IBM watsonx Granite, Open AI, NVIDIA NIM, and Ollama. It uses CAS's semantic APIs to deliver efficient, AI-enabled insights, accelerating RAG workflows with improved performance, security, and efficiency.
For more information, follow the reference example in GitHub.
CAS chatbot CLI view