Skip to main content
Fetch Tenants
curl --request GET \
  --url https://{api_endpoint}/api/v1/tenants \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "title": "<string>",
    "description": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "created_by_username": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "tags": [
      "<string>"
    ],
    "settings": {
      "model_settings": {
        "base_llm": {
          "model_name": "<string>",
          "model_id": "<string>",
          "model_params": {},
          "guardrails": {
            "hap": {},
            "social_bias": {},
            "pii": {}
          },
          "system_prompt": "<string>"
        },
        "embeddings": {
          "model_name": "<string>",
          "model_id": "<string>"
        },
        "is_base_llm_enabled": true
      },
      "router_settings": {
        "router_type": "unified",
        "model_name": "<string>",
        "model_id": "<string>",
        "model_params": {},
        "routing_prompt": "<string>",
        "router_config": {
          "continue_journey_on_none": true,
          "confidence_threshold": 123,
          "confidence_method": "perplexity"
        }
      },
      "user_settings": {
        "confirm_routing": true,
        "clear_watsonx_assistant_context": false,
        "clientside_shortlisting": false
      },
      "slot_filling_settings": {
        "slot_filler_type": "unified",
        "model_name": "<string>",
        "model_id": "<string>",
        "model_params": {}
      }
    }
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

select
string
default:*

Response

Successful Response

id
string | null
name
string | null
title
string | null
description
string | null
created_on
string<date-time> | null
created_by
string | null
created_by_username
string | null
updated_at
string<date-time> | null
tags
string[] | null
settings
object | null