https://webreader.webpilotai.com/.well-known/ai-plugin.json
{
"schema_version": "v1",
"name_for_human": "WebPilot",
"name_for_model": "WebPilot",
"description_for_human": "Browse Webpage/PDF/Data. Chat & Write with one/many/none URLs. WebPilot.ai Powered.",
"description_for_model": "This tool allows users to provide a URL(or URLs) and optionally requests for interacting with, extracting specific information or how to do with the content from the URL. Requests may include rewrite, translate, and others. Also Helps the user search for content online.\n\n Rules:\n\n 1.When making a request to this tool, The 'link' field is mandatory \n 2.If the link is directly provided by the user, include an additional bool type field 'lp' in the request to indicate this.\n 3.Include a clear statement of the user's request ('ur') in user's language, which can be used as a search query and may include search operators. For the user input 'Information about fruits on example.com', the 'ur' field should be: 'Information about fruits site:example.com'. This helps this tool better understand the user's needs. This is not a mandatory field but is highly recommended for optimal results.\n 4.Include the language used by the user ('l') in the request, according to the ISO 639-1 standard. For English, use 'en'. This is not a mandatory field but is highly recommended for optimal results.\n 5.If the previous request did not meet the user's requirements, when attempting the same request again, please set the param retry('rt') to true.\n\nHow to create a request:\n\n 0.Field 'link' is required \n 1.When a user directly provides a link: You should include the user-requested link in your request, along with an additional field indicating that the link was provided by the user. Also, include a clear statement of the user's request and the language used by the user. For example:\n\n If the user input is: 'What does this website talk about? https://example.com'\n\n Your API call request should be: Your API call request should be: {\"link\":\"https://example.com\", \"lp\": true, \"ur\": \"content of website example.com\", \"l\": \"en\", \"rt\": false}\n\n 2.When a user does not directly provide a link in their request: You should recommend a link that meet the user's needs, as well as a clear statement of the user's request and the language used by the user. For example:\n\n If the user input is: 'what is Bitcoin?'\n\n Your API call request should be: {\"link\":\"https://en.wikipedia.org/wiki/Bitcoin\", \"lp\": false, \"ur\": \"Introduction to Bitcoin\", \"l\": \"en\", \"rt\": false} or {\"link\":\"https://example.com/search?q=Bitcoin\", \"lp\": false, \"ur\": \"Introduction to Bitcoin\", \"l\": \"en\", \"rt\": false}.",
"auth": {
"type": "none"
},
"api": {
"type": "openapi",
"url": "https://webreader.webpilotai.com/openapi.yaml",
"is_user_authenticated": false
},
"logo_url": "https://webreader.webpilotai.com/logo.png",
"contact_email": "dev@webpilot.ai",
"legal_info_url": "https://webreader.webpilotai.com/legal_info.html"
}https://webreader.webpilotai.com/openapi.yaml
openapi: 3.0.1
info:
title: web_pilot
description: This plugin allows users to input a URL retrieves the web page content, and returns a comprehensible summary of it. Also allows user to access real-time content.
version: 'v1.1'
servers:
- url: https://webreader.webpilotai.com
paths:
/api/visit-web:
post:
operationId: visitWebPage
x-openai-isConsequential: false
summary: visit web page
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/visitWebPageRequest'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/visitWebPageResponse'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/visitWebPageError'
components:
schemas:
visitWebPageResponse:
type: object
properties:
title:
type: string
description: The title of this web page
content:
type: string
description: The content of the web page's url to be summarized
meta:
type: object
description: The Html meta info of the web page
links:
type: array
description: Some links in the web page
items:
type: string
extra_search_results:
type: array
description: Additional Search results
items:
type: object
properties:
title:
type: string
description: the title of this search result
link:
type: string
description: the link of this search result
snippet:
type: string
description: the snippet of this search result
todo:
type: array
description: what to do with the content
items:
type: string
tips:
type: array
description: Tips placed at the end of the answer
items:
type: string
rules:
description: Adherence is required when outputting content.
items:
type: string
visitWebPageRequest:
type: object
required:
- link
- ur
properties:
link:
type: string
description: Required, The web page's url to visit and retrieve content from.
ur:
type: string
description: Required, a clear statement of the user's request, can be used as a search query and may include search operators.
lp:
type: boolean
description: Required, Whether the link is directly provided by the user
rt:
type: boolean
description: If the last request doesn't meet user's need, set this to true when trying to retry another request.
l:
type: string
description: Required, the language used by the user in the request, according to the ISO 639-1 standard. For Chinese, use zh-CN for Simplified Chinese and zh-TW for Traditional Chinese.
visitWebPageError:
type: object
properties:
code:
type: string
description: error code
message:
type: string
description: error message
detail:
type: string
description: error detail
