Update hosting configuration

PATCH

namespace

{namespaceId}

hosting

TypeScript

import { Agentset } from "agentset";

const agentset = new Agentset({ apiKey: 'agentset_xxx' });
const ns = agentset.namespace('ns_xxx');

const updatedHosting = await ns.hosting.update({
  title: "My Knowledge Base",
  welcomeMessage: "Welcome to my knowledge base!",
  searchEnabled: true,
});
console.log(updatedHosting);

{
  "success": true,
  "data": {
    "namespaceId": "<string>",
    "title": "<string>",
    "slug": "<string>",
    "logo": "<string>",
    "systemPrompt": "<string>",
    "exampleQuestions": [],
    "exampleSearchQueries": [],
    "welcomeMessage": "<string>",
    "citationMetadataPath": "<string>",
    "searchEnabled": true,
    "rerankConfig": {
      "model": "cohere:rerank-v3.5",
      "limit": 15
    },
    "llmConfig": {
      "model": "openai:gpt-4.1"
    },
    "topK": 50,
    "protected": true,
    "allowedEmails": [],
    "allowedEmailDomains": [],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Default authentication mechanism

Path Parameters

namespaceId

string

required

The id of the namespace (prefixed with ns_) The id of the namespace (prefixed with ns_)

Body

application/json

title

string

Minimum string length: 1

slug

string

Required string length: 2 - 48

logo

protected

boolean

allowedEmails

string<email>[]

allowedEmailDomains

string[]

systemPrompt

string

exampleQuestions

string[]

Maximum array length: 4

exampleSearchQueries

string[]

Maximum array length: 4

welcomeMessage

string

citationMetadataPath

string

searchEnabled

boolean

rerankModel

enum<string>

Available options:

cohere:rerank-v3.5,

cohere:rerank-english-v3.0,

cohere:rerank-multilingual-v3.0,

zeroentropy:zerank-1,

zeroentropy:zerank-1-small

llmModel

enum<string>

Available options:

openai:gpt-4.1,

openai:gpt-5,

openai:gpt-5-mini,

openai:gpt-5-nano

topK

integer

Required range: 1 <= x <= 100

rerankLimit

integer

Required range: 1 <= x <= 100

Response

The updated hosting configuration

success

boolean

required

data

Hosting · object

required

Show child attributes

data.namespaceId

string

required

The ID of the namespace this hosting belongs to.

data.title

string | null

required

The title displayed on the hosted interface.

data.slug

string | null

required

The unique slug for accessing the hosted interface.

data.logo

string | null

required

The URL or base64 encoded image of the logo.

data.systemPrompt

string | null

required

The system prompt used for the chat interface.

data.exampleQuestions

string[]

required

Example questions to display to users in the chat interface.

data.exampleSearchQueries

string[]

required

Example search queries to display to users in the search interface.

data.welcomeMessage

string | null

required

Welcome message displayed to users.

data.citationMetadataPath

string | null

required

Path to metadata field used for citations.

data.searchEnabled

boolean

default:true

required

Whether search functionality is enabled.

data.rerankConfig

object

required

Configuration for the reranking model.

Show child attributes

data.rerankConfig.model

enum<string>

required

Available options:

cohere:rerank-v3.5,

cohere:rerank-english-v3.0,

cohere:rerank-multilingual-v3.0,

zeroentropy:zerank-1,

zeroentropy:zerank-1-small

data.rerankConfig.limit

integer

default:15

required

Number of documents after reranking.

Required range: 1 <= x <= 100

data.llmConfig

object

required

Configuration for the LLM model.

Show child attributes

data.llmConfig.model

enum<string>

required

Available options:

openai:gpt-4.1,

openai:gpt-5,

openai:gpt-5-mini,

openai:gpt-5-nano

data.topK

integer

default:50

required

Number of documents to retrieve from vector store.

Required range: 1 <= x <= 100

data.protected

boolean

default:true

required

Whether the hosted interface is protected by authentication.

data.allowedEmails

string[]

required

List of allowed email addresses (when protected is true).

data.allowedEmailDomains

string[]

required

List of allowed email domains (when protected is true).

data.createdAt

string

required

The date and time the hosting was created.

data.updatedAt

string

required

The date and time the hosting was last updated.

Delete hosting configurationDelete the hosting configuration for a namespace.

⌘I

TypeScript

import { Agentset } from "agentset";

const agentset = new Agentset({ apiKey: 'agentset_xxx' });
const ns = agentset.namespace('ns_xxx');

const updatedHosting = await ns.hosting.update({
  title: "My Knowledge Base",
  welcomeMessage: "Welcome to my knowledge base!",
  searchEnabled: true,
});
console.log(updatedHosting);

{
  "success": true,
  "data": {
    "namespaceId": "<string>",
    "title": "<string>",
    "slug": "<string>",
    "logo": "<string>",
    "systemPrompt": "<string>",
    "exampleQuestions": [],
    "exampleSearchQueries": [],
    "welcomeMessage": "<string>",
    "citationMetadataPath": "<string>",
    "searchEnabled": true,
    "rerankConfig": {
      "model": "cohere:rerank-v3.5",
      "limit": 15
    },
    "llmConfig": {
      "model": "openai:gpt-4.1"
    },
    "topK": 50,
    "protected": true,
    "allowedEmails": [],
    "allowedEmailDomains": [],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Overview

Namespaces

Ingest Jobs

Documents

Hosting

Search

Uploads

Update hosting configuration

Authorizations

Path Parameters

Body

Response