Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Connections
Tools
Large Language Models (LLMs)
Evaluation Framework
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Assistants Runs
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Documents
- Vector Index
- Catalog Management
- Tenant Management
- Provisioning Lite
- Embed settings
- User Profiles
- Completions
- Background Tasks
- Auth
- Orchestrate Assistant
- Notifications
- IBM unique ID mapping
- Prompts
- Artifact Management
- Default Agent Settings
- all journey types
- Connections
- Tools
- Welcome Content
- LLM Analytics
- Internal Calls are listed over here
- Agents
- Agent Releases
- Agent Release Environments
- Agent Chat Starter Settings
- API Reference
- channel integration
- Knowledge-Bases
- Chat with Docs
- Toolkits
- Voice Configurations
- Models
- Model-Policy
- Credentials
- Teams Channel
- Twilio WhatsApp Channel
Legal notices
Tenant Management
Fetch Tenants
GET
/
tenants
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/tenants \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"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": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"social_bias": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"pii": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
}
},
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Response
200
application/json
Successful Response
The response is of type TenantOut · object[]
.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/tenants \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
[
{
"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": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"social_bias": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"pii": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
}
},
"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": {}
}
}
}
]
Assistant
Responses are generated using AI and may contain mistakes.