PEpeec
Reports

Get URL Content

Changed on

Return the scraped markdown content of a source URL. Use the URLs report to discover URLs.

post/sources/urls/content

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/sources/urls/content
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb

Request body

project_idstring

Required if using a company api key

urlstring uri required
max_lengthinteger

Maximum number of characters of content to return. Defaults to 100,000. If the stored content is longer, the response will be truncated and truncated=true.

versioninteger

Stored version to read, from List URL Content Versions. Defaults to the current content.

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "url": "https://example.com/blog/page1",
  "max_length": 100000,
  "version": 2
}

Response

Success

Example response

{
  "data": {
    "url": "https://example.com/blog/page1",
    "domain": "example.com"
  }
}

Changes

  • 9fdffdff48a5Revision changes
    • warning

      added the new REVIEW enum value to the / response property for the response status

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)