Skip to main content
Register Watsonx Assistant Instance
curl --request POST \
  --url https://{api_endpoint}/api/v1/assistants/watsonx \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "nickname": "<string>",
  "config": {
    "assistant_id": "<string>",
    "environment_id": "<string>",
    "intent": "<string>",
    "action_title": "<string>",
    "search_stickiness": false,
    "shareable_context": true,
    "hidden": false,
    "api_key": "<string>",
    "service_instance_url": "<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": []
  }
}'
"<any>"
If only one of the fields name or nickname is provided, the system automatically generates the other based on the value you entered.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
description
string
required
​
config
object
required
​
title
string | null
​
tags
string[] | null
​
name
string | null
​
nickname
string | null

Response

Successful Response

The response is of type any.