Skip to content
OpenGTM

Scrape Url

POST
/api/v2/scrape
curl --request POST \
  --url http://localhost:8000/api/v2/scrape \
  --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
ScrapeRequest
object
url
required
Url
string
Examplegenerated
{
  "url": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ScrapeResponse
object
description
Description
string
""
extracted_emails
Extracted Emails
Array<string>
default:
html_content
Html Content
string
""
method
Method
string
""
preview_text
Preview Text
string
""
status
required
Status
string
title
Title
string
""
url
required
Url
string
word_count
Word Count
integer
0
Example
{
  "description": "",
  "extracted_emails": [],
  "html_content": "",
  "method": "",
  "preview_text": "",
  "title": "",
  "word_count": 0
}

422

Section titled “422”

Validation Error

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