Creates a document from a URL. The URL content will be crawled and indexed when linked to an agent. The document is immediately ready (no upload step needed).
ready
cURL
curl --request POST \ --url https://api.vocobase.com/api/v2/documents/web-link \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Company Blog", "url": "https://example.com/blog", "description": "<string>" } '
{ "success": true, "data": { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "description": "<string>", "type": "pdf", "status": "uploading", "file_size": 123, "mime_type": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" } }
API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.
rg_live_xxxx
Document display name.
1 - 100
"Company Blog"
URL to index (http or https).
"https://example.com/blog"
Optional description.
500
Web link document created.
Show child attributes