[POST] Add Web URL

The Web URL feature allows you to add web pages and URLs to your context collection. This enables the AI to analyze and understand content from external websites.

How it works

Submit URL: Provide a web page URL to be crawled and indexed
Content Extraction: The system automatically extracts text content from the webpage
Context Integration: The extracted content becomes part of your user context
AI Analysis: The AI can now reference and analyze this web content in conversations

API Endpoint

Authorization

X-API-Key<token>

In: header

Request Body

urlstring

URL of the webpage to add

path?string

Path to store the webpage

Default"/web"

name?string

Display name for the webpage

Default"new-web-page"

screenshot?string

Base64 encoded screenshot (optional)

Default""

sub_user_name?string

Sub-user name for multi-user systems

Default"default"

Response Body

curl -X POST "https://api.synvo.ai/webpage/add" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d 'url=string'

curl -X POST "https://api.synvo.ai/webpage/add" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'url=string'

{
  "filename": "string",
  "path": "string",
  "file_id": "string",
  "timestamp": "string"
}

Empty

Use Cases

Research: Add research papers, articles, or documentation
News: Include current news articles for context
Documentation: Reference external documentation or guides
Social Media: Analyze social media posts or profiles
E-commerce: Include product pages or reviews

Best Practices

Ensure the URL is publicly accessible
Check that the website allows crawling
Use HTTPS URLs when possible
Consider the content length and complexity