Skip to main content
Get Watsonx Assistant Instance
curl --request GET \
  --url https://{api_endpoint}/api/v1/assistants/watsonx/{assistant_id} \
  --header 'Authorization: Bearer <token>'
{
  "type": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "<string>",
  "tenant_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>"
  ],
  "name": "<string>",
  "provider": "<string>",
  "nickname": "<string>",
  "api_key": "<string>",
  "service_instance_url": "<string>",
  "assistant_id": "<string>",
  "environment_id": "<string>",
  "api_version": "2023-06-15",
  "authorization_url": "<string>",
  "crn": "<string>",
  "intent": "<string>",
  "action_title": "<string>",
  "search_stickiness": false,
  "shareable_context": true,
  "hidden": false,
  "message_context": {},
  "connection_id": "<string>",
  "context_access_enabled": true,
  "context_variables": []
}

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
assistant_id
string
required

Response

Successful Response

​
type
string
required
​
id
string<uuid> | null
​
tenant_id
string | null
​
tenant_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
​
name
string | null
​
provider
string | null
​
nickname
string | null
​
api_key
string | null
​
service_instance_url
string | null
​
assistant_id
string | null
​
environment_id
string | null
​
api_version
string | null
default:2023-06-15
​
auth_type
enum<string> | null
Available options:
ICP_IAM,
IBM_CLOUD_IAM,
MCSP,
BEARER_TOKEN,
<hidden>
​
authorization_url
string | null
​
crn
string | null
​
intent
string | null
​
action_title
string | null
​
search_stickiness
boolean
default:false
​
shareable_context
boolean
default:true
​
hidden
boolean
default:false
​
message_context
Message Context · object
​
connection_id
string | null
​
context_access_enabled
boolean
default:true

Enable access to context variables for this agent

​
context_variables
string[]

List of context variable names that this agent can access