Skip to main content
POST
Add a website to the Knowledge

Authorizations

Authorization
string
header
required

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.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_agent_source.

url
string
required

The start address (https when no scheme is given; a public host). The pages under it are read.

Required string length: 4 - 2048
agent_sid
string

The AI SDR it is made for (ub_ag_…, block 10, 2026-10-30); left out, the team's default agent.

Required string length: 18
Pattern: ^ub_ag_
kind
enum<string>

website, the only kind a call adds (a file is uploaded in the app); may be left out.

Available options:
website
scope
string | null

The path the pages are read under ("/docs"); the address's own path unless given, / for the whole site.

Maximum string length: 1024
refresh
enum<string> | null

How often it is read again by itself: weekly unless said, or daily.

Available options:
weekly,
daily
instruction
string | null

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.

Maximum string length: 600

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required