Skip to main content
Register An External Chat Completions Agent.
curl --request POST \
  --url https://{api_endpoint}/api/v1/agents/external-chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_url": "<string>",
  "title": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "name": "<string>",
  "auth_scheme": "BEARER_TOKEN",
  "auth_config": {},
  "chat_params": {},
  "instructions": "<string>",
  "config": {
    "hidden": false,
    "enable_cot": false
  },
  "nickname": "<string>",
  "connection_id": "<string>",
  "provider": "external_chat",
  "context_access_enabled": true,
  "context_variables": []
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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.

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
​
api_url
string
required
​
title
string | null
​
description
string | null
​
tags
string[] | null
​
name
string | null
​
auth_scheme
enum<string>
default:BEARER_TOKEN
Available options:
BEARER_TOKEN,
API_KEY,
NONE
​
auth_config
Auth Config · object
​
chat_params
Chat Params · object
​
instructions
string | null
​
config
ExternalChatAgentConfig · object
​
nickname
string | null
​
connection_id
string | null
​
provider
string
default:external_chat
​
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

Response

Successful Response