For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
      • Webhook Signature Validation
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • PromptObjectModel
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
      • Datasphere
        • create
        • delete
        • deleteChunk
        • get
        • getChunk
        • list
        • listChunks
        • search
        • update
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Methods
REST Client

Datasphere

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

create

Next
Built with

Manage documents and perform semantic search via the Datasphere API. Documents are stored with vector embeddings, enabling natural-language search across your knowledge base. The documents sub-resource provides full CRUD plus search and chunk-level operations.

Access via client.datasphere.documents on a RestClient instance.

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4 project: "your-project-id",
5 token: "your-api-token",
6 host: "your-space.signalwire.com"
7});
8
9const results = await client.datasphere.documents.search({ query_string: "billing FAQ" });
10for (const doc of results.data ?? []) {
11 console.log(doc.id, doc.title);
12}

Methods

list

List documents in the project.

create

Upload a new document.

get

Retrieve a specific document.

update

Update a document.

delete

Delete a document and all its chunks.

search

Perform a semantic search across all documents.

listChunks

List chunks belonging to a document.

getChunk

Retrieve a specific chunk from a document.

deleteChunk

Delete a specific chunk from a document.