Register Watsonx Assistant Instance
curl --request POST \
--url https://{api_endpoint}/v1/assistants/watsonx \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"config": {
"assistant_id": "<string>",
"environment_id": "<string>",
"service_instance_url": "<string>",
"intent": "<string>",
"action_title": "<string>",
"search_stickiness": false,
"shareable_context": true,
"hidden": false,
"api_key": "<string>",
"api_version": "2023-06-15",
"auth_type": "BEARER_TOKEN",
"auth_config": {},
"authorization_url": "<string>",
"crn": "<string>",
"message_context": {},
"connection_id": "<string>",
"context_access_enabled": true,
"context_variables": []
},
"title": "<string>",
"tags": [
"<string>"
],
"name": "<string>",
"nickname": "<string>"
}
'import requests
url = "https://{api_endpoint}/v1/assistants/watsonx"
payload = {
"description": "<string>",
"config": {
"assistant_id": "<string>",
"environment_id": "<string>",
"service_instance_url": "<string>",
"intent": "<string>",
"action_title": "<string>",
"search_stickiness": False,
"shareable_context": True,
"hidden": False,
"api_key": "<string>",
"api_version": "2023-06-15",
"auth_type": "BEARER_TOKEN",
"auth_config": {},
"authorization_url": "<string>",
"crn": "<string>",
"message_context": {},
"connection_id": "<string>",
"context_access_enabled": True,
"context_variables": []
},
"title": "<string>",
"tags": ["<string>"],
"name": "<string>",
"nickname": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
config: {
assistant_id: '<string>',
environment_id: '<string>',
service_instance_url: '<string>',
intent: '<string>',
action_title: '<string>',
search_stickiness: false,
shareable_context: true,
hidden: false,
api_key: '<string>',
api_version: '2023-06-15',
auth_type: 'BEARER_TOKEN',
auth_config: {},
authorization_url: '<string>',
crn: '<string>',
message_context: {},
connection_id: '<string>',
context_access_enabled: true,
context_variables: []
},
title: '<string>',
tags: ['<string>'],
name: '<string>',
nickname: '<string>'
})
};
fetch('https://{api_endpoint}/v1/assistants/watsonx', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_endpoint}/v1/assistants/watsonx",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'config' => [
'assistant_id' => '<string>',
'environment_id' => '<string>',
'service_instance_url' => '<string>',
'intent' => '<string>',
'action_title' => '<string>',
'search_stickiness' => false,
'shareable_context' => true,
'hidden' => false,
'api_key' => '<string>',
'api_version' => '2023-06-15',
'auth_type' => 'BEARER_TOKEN',
'auth_config' => [
],
'authorization_url' => '<string>',
'crn' => '<string>',
'message_context' => [
],
'connection_id' => '<string>',
'context_access_enabled' => true,
'context_variables' => [
]
],
'title' => '<string>',
'tags' => [
'<string>'
],
'name' => '<string>',
'nickname' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_endpoint}/v1/assistants/watsonx"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"config\": {\n \"assistant_id\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_instance_url\": \"<string>\",\n \"intent\": \"<string>\",\n \"action_title\": \"<string>\",\n \"search_stickiness\": false,\n \"shareable_context\": true,\n \"hidden\": false,\n \"api_key\": \"<string>\",\n \"api_version\": \"2023-06-15\",\n \"auth_type\": \"BEARER_TOKEN\",\n \"auth_config\": {},\n \"authorization_url\": \"<string>\",\n \"crn\": \"<string>\",\n \"message_context\": {},\n \"connection_id\": \"<string>\",\n \"context_access_enabled\": true,\n \"context_variables\": []\n },\n \"title\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"nickname\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_endpoint}/v1/assistants/watsonx")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"config\": {\n \"assistant_id\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_instance_url\": \"<string>\",\n \"intent\": \"<string>\",\n \"action_title\": \"<string>\",\n \"search_stickiness\": false,\n \"shareable_context\": true,\n \"hidden\": false,\n \"api_key\": \"<string>\",\n \"api_version\": \"2023-06-15\",\n \"auth_type\": \"BEARER_TOKEN\",\n \"auth_config\": {},\n \"authorization_url\": \"<string>\",\n \"crn\": \"<string>\",\n \"message_context\": {},\n \"connection_id\": \"<string>\",\n \"context_access_enabled\": true,\n \"context_variables\": []\n },\n \"title\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"nickname\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/assistants/watsonx")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"config\": {\n \"assistant_id\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_instance_url\": \"<string>\",\n \"intent\": \"<string>\",\n \"action_title\": \"<string>\",\n \"search_stickiness\": false,\n \"shareable_context\": true,\n \"hidden\": false,\n \"api_key\": \"<string>\",\n \"api_version\": \"2023-06-15\",\n \"auth_type\": \"BEARER_TOKEN\",\n \"auth_config\": {},\n \"authorization_url\": \"<string>\",\n \"crn\": \"<string>\",\n \"message_context\": {},\n \"connection_id\": \"<string>\",\n \"context_access_enabled\": true,\n \"context_variables\": []\n },\n \"title\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"nickname\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}watsonx Assistant
Register Watsonx Assistant Instance
Register Watsonx Assistant Instance
curl --request POST \
--url https://{api_endpoint}/v1/assistants/watsonx \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"config": {
"assistant_id": "<string>",
"environment_id": "<string>",
"service_instance_url": "<string>",
"intent": "<string>",
"action_title": "<string>",
"search_stickiness": false,
"shareable_context": true,
"hidden": false,
"api_key": "<string>",
"api_version": "2023-06-15",
"auth_type": "BEARER_TOKEN",
"auth_config": {},
"authorization_url": "<string>",
"crn": "<string>",
"message_context": {},
"connection_id": "<string>",
"context_access_enabled": true,
"context_variables": []
},
"title": "<string>",
"tags": [
"<string>"
],
"name": "<string>",
"nickname": "<string>"
}
'import requests
url = "https://{api_endpoint}/v1/assistants/watsonx"
payload = {
"description": "<string>",
"config": {
"assistant_id": "<string>",
"environment_id": "<string>",
"service_instance_url": "<string>",
"intent": "<string>",
"action_title": "<string>",
"search_stickiness": False,
"shareable_context": True,
"hidden": False,
"api_key": "<string>",
"api_version": "2023-06-15",
"auth_type": "BEARER_TOKEN",
"auth_config": {},
"authorization_url": "<string>",
"crn": "<string>",
"message_context": {},
"connection_id": "<string>",
"context_access_enabled": True,
"context_variables": []
},
"title": "<string>",
"tags": ["<string>"],
"name": "<string>",
"nickname": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
config: {
assistant_id: '<string>',
environment_id: '<string>',
service_instance_url: '<string>',
intent: '<string>',
action_title: '<string>',
search_stickiness: false,
shareable_context: true,
hidden: false,
api_key: '<string>',
api_version: '2023-06-15',
auth_type: 'BEARER_TOKEN',
auth_config: {},
authorization_url: '<string>',
crn: '<string>',
message_context: {},
connection_id: '<string>',
context_access_enabled: true,
context_variables: []
},
title: '<string>',
tags: ['<string>'],
name: '<string>',
nickname: '<string>'
})
};
fetch('https://{api_endpoint}/v1/assistants/watsonx', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_endpoint}/v1/assistants/watsonx",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'config' => [
'assistant_id' => '<string>',
'environment_id' => '<string>',
'service_instance_url' => '<string>',
'intent' => '<string>',
'action_title' => '<string>',
'search_stickiness' => false,
'shareable_context' => true,
'hidden' => false,
'api_key' => '<string>',
'api_version' => '2023-06-15',
'auth_type' => 'BEARER_TOKEN',
'auth_config' => [
],
'authorization_url' => '<string>',
'crn' => '<string>',
'message_context' => [
],
'connection_id' => '<string>',
'context_access_enabled' => true,
'context_variables' => [
]
],
'title' => '<string>',
'tags' => [
'<string>'
],
'name' => '<string>',
'nickname' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{api_endpoint}/v1/assistants/watsonx"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"config\": {\n \"assistant_id\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_instance_url\": \"<string>\",\n \"intent\": \"<string>\",\n \"action_title\": \"<string>\",\n \"search_stickiness\": false,\n \"shareable_context\": true,\n \"hidden\": false,\n \"api_key\": \"<string>\",\n \"api_version\": \"2023-06-15\",\n \"auth_type\": \"BEARER_TOKEN\",\n \"auth_config\": {},\n \"authorization_url\": \"<string>\",\n \"crn\": \"<string>\",\n \"message_context\": {},\n \"connection_id\": \"<string>\",\n \"context_access_enabled\": true,\n \"context_variables\": []\n },\n \"title\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"nickname\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{api_endpoint}/v1/assistants/watsonx")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"config\": {\n \"assistant_id\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_instance_url\": \"<string>\",\n \"intent\": \"<string>\",\n \"action_title\": \"<string>\",\n \"search_stickiness\": false,\n \"shareable_context\": true,\n \"hidden\": false,\n \"api_key\": \"<string>\",\n \"api_version\": \"2023-06-15\",\n \"auth_type\": \"BEARER_TOKEN\",\n \"auth_config\": {},\n \"authorization_url\": \"<string>\",\n \"crn\": \"<string>\",\n \"message_context\": {},\n \"connection_id\": \"<string>\",\n \"context_access_enabled\": true,\n \"context_variables\": []\n },\n \"title\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"nickname\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_endpoint}/v1/assistants/watsonx")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"config\": {\n \"assistant_id\": \"<string>\",\n \"environment_id\": \"<string>\",\n \"service_instance_url\": \"<string>\",\n \"intent\": \"<string>\",\n \"action_title\": \"<string>\",\n \"search_stickiness\": false,\n \"shareable_context\": true,\n \"hidden\": false,\n \"api_key\": \"<string>\",\n \"api_version\": \"2023-06-15\",\n \"auth_type\": \"BEARER_TOKEN\",\n \"auth_config\": {},\n \"authorization_url\": \"<string>\",\n \"crn\": \"<string>\",\n \"message_context\": {},\n \"connection_id\": \"<string>\",\n \"context_access_enabled\": true,\n \"context_variables\": []\n },\n \"title\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"nickname\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Successful Response
⌘I

