Namespaces
Ingest Jobs
Hosting
Search
Retrieve hosting configuration
Retrieve the hosting configuration for a namespace.
import { Agentset } from "agentset";
const agentset = new Agentset({ apiKey: 'agentset_xxx' });
const ns = agentset.namespace('ns_xxx');
const hosting = await ns.hosting.get();
console.log(hosting);{
"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
Default authentication mechanism
Path Parameters
The id of the namespace (prefixed with ns_) The id of the namespace (prefixed with ns_)
Response
The hosting configuration
Show child attributes
Show child attributes
The ID of the namespace this hosting belongs to.
The title displayed on the hosted interface.
The unique slug for accessing the hosted interface.
The URL or base64 encoded image of the logo.
The system prompt used for the chat interface.
Example questions to display to users in the chat interface.
Example search queries to display to users in the search interface.
Welcome message displayed to users.
Path to metadata field used for citations.
Whether search functionality is enabled.
Configuration for the reranking model.
Show child attributes
Show child attributes
cohere:rerank-v3.5, cohere:rerank-english-v3.0, cohere:rerank-multilingual-v3.0, zeroentropy:zerank-1, zeroentropy:zerank-1-small Number of documents after reranking.
1 <= x <= 100Number of documents to retrieve from vector store.
1 <= x <= 100Whether the hosted interface is protected by authentication.
List of allowed email addresses (when protected is true).
List of allowed email domains (when protected is true).
The date and time the hosting was created.
The date and time the hosting was last updated.
import { Agentset } from "agentset";
const agentset = new Agentset({ apiKey: 'agentset_xxx' });
const ns = agentset.namespace('ns_xxx');
const hosting = await ns.hosting.get();
console.log(hosting);{
"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>"
}
}