> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Update a knowledge base > Update a knowledge base's name, description, `config`, or refresh cadence. Only the fields you send are changed; omitted fields keep their current value. Returns the updated base. Requires the `knowledge:write` scope (admin / owner / developer). ## OpenAPI ````yaml /openapi.yaml put /api/v1/knowledge-bases/{id} openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway - name: Risk description: >- Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping, URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one composite verdict queryable before a send or a call. - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/knowledge-bases/{id}: put: tags: - Knowledge Bases summary: Update a knowledge base description: >- Update a knowledge base's name, description, `config`, or refresh cadence. Only the fields you send are changed; omitted fields keep their current value. Returns the updated base. Requires the `knowledge:write` scope (admin / owner / developer). parameters: - schema: type: string in: path name: id required: true description: Knowledge base ID (`kb_…`). requestBody: required: true content: application/json: schema: type: object properties: name: type: string maxLength: 200 description: New name for the knowledge base. description: type: string maxLength: 1000 description: New summary of what this base contains. refresh_schedule: type: string enum: - manual - hourly - daily - weekly description: >- New recurring re-scrape cadence for external-source documents. config: type: object additionalProperties: true description: >- Replacement configuration blob (source connectors, search config). example: name: Support Help Center (EN) refresh_schedule: weekly responses: '200': description: The updated knowledge base. content: application/json: schema: type: object required: - data - meta properties: data: $ref: '#/components/schemas/KnowledgeBase' meta: $ref: '#/components/schemas/ResponseMeta' components: schemas: KnowledgeBase: type: object description: >- A knowledge base — the RAG container documents are uploaded into and that AI agents search at answer time. properties: id: type: string description: Knowledge base ID (`kb_…`). name: type: string description: Human-readable name. description: type: string nullable: true description: Optional summary of what the base contains. status: type: string description: Lifecycle status (e.g. `active`). document_count: type: integer description: >- Number of top-level documents (excludes internal chunk rows). Saturates at 10000 for very large bases. chunk_count: type: integer description: Total number of embedded chunks across all documents. refresh_schedule: type: string enum: - manual - hourly - daily - weekly description: Recurring re-scrape cadence for external-source documents. next_refresh_at: type: string format: date-time nullable: true description: >- When the next scheduled refresh is due (null when the cadence is `manual`). last_refresh_at: type: string format: date-time nullable: true description: When the base was last refreshed. config: type: object additionalProperties: true description: >- Base configuration (source connectors, search config). Omitted from list rows to keep them lean. created_at: type: string format: date-time updated_at: type: string format: date-time ResponseMeta: type: object required: - request_id - timestamp additionalProperties: false properties: request_id: type: string description: Unique request identifier (also returned as X-Request-Id header) timestamp: type: string format: date-time docs_url: type: string format: uri nullable: true securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````