Skip to main content
POST
Create URL source

Authorizations

better-auth.session_token
string
cookie
required

Session cookie set by Better Auth on sign-in.

x-workspace-id
string
header
required

Workspace UUID. Required on all /api/* endpoints.

Body

application/json

Create a URL-type content source. SSRF-validated public HTTPS/HTTP URL only.

name
string
required
Required string length: 1 - 200
url
string<uri>
required
Maximum string length: 2000
crawlMode
enum<string>
Available options:
single,
sitemap
syncIntervalMs
integer
Required range: 3600000 <= x <= 604800000
maxPages
integer
Required range: 1 <= x <= 200

Response

Source created and first sync enqueued

id
string<uuid>
required
workspaceId
string<uuid>
required
type
string
required
name
string
required
config
object | null
required
syncStatus
string
required
createdAt
string
required
updatedAt
string
required
{key}
any