> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Add a website to the Knowledge > Add a website to the Knowledge: its start address, the scope under it (the address's own path unless given), how often it is read again (weekly unless said, or daily) and how to read it (instruction, up to 600 chars; suggest_agent_source_instruction writes one from its first pages). Nothing is read yet: parse_agent_source starts the read. A file is uploaded in the app. Contract: - MCP tool `create_agent_source`, registry package `mcp.unibox/agent_sources`, mount `unibox.knowledge`. - Operation `create`, response envelope `create`. - Flags: none. ## OpenAPI ````yaml /api-reference/unibox/openapi.yaml post /api/agent-sources openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.unibox' description: >- The team inbox and the AI SDR: every LinkedIn and email thread in one place (conversations, messages, the timeline events), the manual tasks a thread spawns, the sender profiles the team speaks through with their LinkedIn account and mailboxes, and the one agent per team with its scenarios, plans and runs. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.unibox`, 125 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/unibox/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: agent_answers description: >- Registry package `mcp.unibox/agent_answers`, served on MCP mount `unibox.knowledge`. - name: agent_conversation_uploads description: >- Registry package `mcp.unibox/agent_conversation_uploads`, served on MCP mount `unibox.agent-memory`. - name: agent_examples description: >- Registry package `mcp.unibox/agent_examples`, served on MCP mount `unibox.agent-memory`. - name: agent_hints description: >- Registry package `mcp.unibox/agent_hints`, served on MCP mount `unibox.agent-memory`. - name: agent_plans description: >- Registry package `mcp.unibox/agent_plans`, served on MCP mount `unibox.agent`. - name: agent_runs description: >- Registry package `mcp.unibox/agent_runs`, served on MCP mount `unibox.agent-memory`. - name: agent_scenarios description: >- Registry package `mcp.unibox/agent_scenarios`, served on MCP mount `unibox.agent`. - name: agent_source_parses description: >- Registry package `mcp.unibox/agent_source_parses`, served on MCP mount `unibox.knowledge`. - name: agent_sources description: >- Registry package `mcp.unibox/agent_sources`, served on MCP mount `unibox.knowledge`. - name: agent_tests description: >- Registry package `mcp.unibox/agent_tests`, served on MCP mount `unibox.agent-memory`. - name: agents description: >- Registry package `mcp.unibox/agents`, served on MCP mount `unibox.website`. - name: conversation_events description: >- Registry package `mcp.unibox/conversation_events`, served on MCP mount `unibox.inbox`. - name: conversations description: >- Registry package `mcp.unibox/conversations`, served on MCP mount `unibox.inbox`. - name: messages description: >- Registry package `mcp.unibox/messages`, served on MCP mount `unibox.inbox`. - name: sender_profiles description: >- Registry package `mcp.unibox/sender_profiles`, served on MCP mount `unibox.sender-profiles`. - name: tasks description: Registry package `mcp.unibox/tasks`, served on MCP mount `unibox.inbox`. - name: timeline description: >- Registry package `mcp.unibox/timeline`, served on MCP mount `unibox.inbox`. paths: /api/agent-sources: post: tags: - agent_sources summary: Add a website to the Knowledge description: >- Add a website to the Knowledge: its start address, the scope under it (the address's own path unless given), how often it is read again (weekly unless said, or daily) and how to read it (instruction, up to 600 chars; suggest_agent_source_instruction writes one from its first pages). Nothing is read yet: parse_agent_source starts the read. A file is uploaded in the app. Contract: - MCP tool `create_agent_source`, registry package `mcp.unibox/agent_sources`, mount `unibox.knowledge`. - Operation `create`, response envelope `create`. - Flags: none. operationId: create_agent_source requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAgentSourceRequest' responses: '200': description: '`create` success envelope.' content: application/json: schema: $ref: '#/components/schemas/CreateAgentSourceResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: CreateAgentSourceRequest: type: object description: Request body of `create_agent_source`. properties: agent_sid: type: string minLength: 18 maxLength: 18 pattern: ^ub_ag_ description: >- The AI SDR it is made for (ub_ag_…, block 10, 2026-10-30); left out, the team's default agent. kind: type: string enum: - website description: >- website, the only kind a call adds (a file is uploaded in the app); may be left out. url: type: string minLength: 4 maxLength: 2048 description: >- The start address (https when no scheme is given; a public host). The pages under it are read. scope: type: string nullable: true maxLength: 1024 description: >- The path the pages are read under ("/docs"); the address's own path unless given, / for the whole site. refresh: type: string nullable: true enum: - weekly - daily description: 'How often it is read again by itself: weekly unless said, or daily.' instruction: type: string nullable: true maxLength: 600 description: >- How to read it, in plain words: what the document is, what to read out (the questions a lead would ask), what to skip, how exact. Up to 600 chars. required: - url CreateAgentSourceResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - create item: type: object properties: sid: type: string description: Knowledge document sid (ub_as_…). team_sid: type: string description: Owning team (ts_tm_…, external - gs.service.id). agent_sid: type: string description: The team's agent (ub_ag_…). kind: type: string enum: - file - website description: >- file: a file the team uploaded; website: a start address and the pages under it (a help center is a website). title: type: string description: >- The name the list shows: a file's name until renamed, a website's host and path. status: type: string enum: - reading - read - failed description: >- reading while a parse runs (progress says page n of m), read once a parse finished (its answers wait for the OK or are in Knowledge), failed with the reason in failure. instruction: type: string nullable: true description: >- How the parse reads it, in the person's words, up to 600 chars: what to read out, what to skip, how exact. Suggested from the first pages (suggest_agent_source_instruction), edited by the person; null until one is written. file: type: object nullable: true properties: name: type: string description: The file's name as uploaded. format: type: string enum: - pdf - docx - txt - md mime: type: string description: Its media type as uploaded. bytes: type: integer minimum: 0 exclusiveMinimum: true description: Its size, 20 MB at most. pages: type: integer nullable: true minimum: 0 exclusiveMinimum: true description: >- Its pages (a PDF's, a Word file's as Word counted them); null for a text file. required: - name - format - mime - bytes - pages description: A file's file; null for a website. website: type: object nullable: true properties: url: type: string description: The start address. scope: type: string description: The path under which pages are read; / for the whole site. refresh: type: string enum: - weekly - daily description: How often it is read again by itself. pages: type: integer nullable: true minimum: 0 description: How many pages the last read took; null until read. required: - url - scope - refresh - pages description: A website's address, scope, refresh and pages; null for a file. progress: type: object properties: done: type: integer minimum: 0 total: type: integer minimum: 0 required: - done - total description: >- How far the parse got: page n of m ("Reading, page 9 of 22"); 0 of 0 before the pages are known. failure: type: object nullable: true properties: reason: type: string enum: - unreadable - no_text - too_large - website_unreachable - nothing_found - model_failed message: type: string description: What to do, in the words the list shows. required: - reason - message description: Why the parse gave up; null unless failed. read_at: type: string nullable: true description: ISO 8601 UTC of the last parse that finished; null until then. next_refresh_at: type: string nullable: true description: >- A website: ISO 8601 UTC of its next read by itself; null for a file. created_by: type: object properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: 'Internal audit context: the cluster that served the write.' trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: Who added it. created_at: type: string description: ISO 8601 UTC. updated_at: type: string description: ISO 8601 UTC. required: - sid - team_sid - agent_sid - kind - title - status - instruction - file - website - progress - failure - read_at - next_refresh_at - created_by - created_at - updated_at already_exists: type: boolean meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - operation - item - already_exists - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.