Skip to main content
POST
Add a web link document

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Body

application/json
name
string
required

Document display name.

Required string length: 1 - 100
Example:

"Company Blog"

url
string<uri>
required

URL to index (http or https).

Example:

"https://example.com/blog"

description
string | null

Optional description.

Maximum string length: 500

Response

Web link document created.

success
boolean
data
object