Skip to content
vocapable.Docs

Suggest sourced business facts from a public website for review

POST
/v1/knowledge/website-preview
curl --request POST \
  --url https://api.vocapable.com/v1/knowledge/website-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WebsiteKnowledgeRequest
object
url
required
Url
string
>= 1 characters <= 2048 characters
Examplegenerated
{
  "url": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WebsiteKnowledgePreview
object
requested_url
required
Requested Url
string
fetched_at
required
Fetched At
string format: date-time
sources
required
Sources
Array<object>
WebsiteSource
object
url
required
Url
string
title
required
Title
string
content_sha256
required
Content Sha256
string
facts
required
Facts
Array<object>
WebsiteFact
object
label
required
Label
string
>= 1 characters <= 120 characters
text
required
Text
string
>= 1 characters <= 1200 characters
source_url
required
Source Url
string
>= 1 characters <= 2048 characters
evidence
required
Evidence
string
>= 10 characters <= 800 characters
notices
required
Notices
Array<string>
coverage
Any of:
WebsiteCrawlCoverage
object
discovered_pages
Discovered Pages
integer
0
read_pages
Read Pages
integer
0
skipped_pages
Skipped Pages
integer
0
failed_pages
Failed Pages
integer
0
limit_reached
Limit Reached
boolean
scanned_urls
Scanned Urls
Array<string>
skipped_urls
Skipped Urls
Array<string>
failed_urls
Failed Urls
Array<string>
Example
{
  "coverage": {
    "discovered_pages": 0,
    "read_pages": 0,
    "skipped_pages": 0,
    "failed_pages": 0,
    "limit_reached": false
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}