v1

latestOpenAPI 3.1.02026-07-26252382475.4 KB
watsonx Assistant

Get Watsonx Assistant Instance

get/v1/assistants/watsonx/{assistant_id}

Path parameters

assistant_idstring required

Response

Successful Response

idstring uuid nullable
tenant_idstring nullable
tenant_namestring nullable
titlestring nullable
descriptionstring nullable
created_onstring date-time nullable
created_bystring nullable
created_by_usernamestring nullable
updated_atstring date-time nullable
tagsstring[] nullable
namestring nullable
typestring required
providerstring nullable
nicknamestring nullable
api_keystring nullable
service_instance_urlstring nullable
assistant_idstring nullable
environment_idstring nullable
api_versionstring nullable
auth_type'ICP_IAM' | 'IBM_CLOUD_IAM' | 'MCSP' | 'BEARER_TOKEN' | '<hidden>'
authorization_urlstring nullable
crnstring nullable
intentstring nullable
action_titlestring nullable
search_stickinessboolean
shareable_contextboolean
hiddenboolean
message_contextobject nullable
connection_idstring nullable
context_access_enabledboolean

Enable access to context variables for this agent

context_variablesstring[]

List of context variable names that this agent can access