Get website text

GEThttps://api.envoapi.com/v1/websites/text

Fetch a public website page and retrieve its final URL, title and visible text with EnvoAPI. Scripts, styles and hidden content are removed, and JavaScript rendering is included when needed.

Authorization headerReturns application/json

GET/v1/websites/text

curl "https://api.envoapi.com/v1/websites/text?url=https%3A%2F%2Fexample.org%2F" \  --header "Authorization: Bearer $ENVO_API_KEY" \  --header "Accept: application/json"

const response = await fetch(  "https://api.envoapi.com/v1/websites/text?url=https%3A%2F%2Fexample.org%2F",  {    headers: {      Authorization: `Bearer ${process.env.ENVO_API_KEY}`,      Accept: "application/json",    },  },);const body = await response.json();

import osimport requestsresponse = requests.get(    "https://api.envoapi.com/v1/websites/text",    params={"url": "https://example.org/"},    headers={        "Authorization": f"Bearer {os.environ['ENVO_API_KEY']}",        "Accept": "application/json",    },)body = response.json()

application/json

200 OKVisible page text, extracted after rendering when required. Treat returned text as untrusted content.

{  "data": {    "url": "https://example.org/",    "title": "Example website",    "text": "Example website\n\nIllustrative content."  },  "meta": {    "creditCost": 2  }}

400 invalid_requestA request parameter is missing or invalid.Errors guide

{  "error": {    "code": "invalid_request",    "message": "A request parameter is missing or invalid.",    "retryable": false,    "details": []  },  "meta": {    "requestId": "example"  }}

401 invalid_api_keyYour API key is invalid or inactive.Errors guide

{  "error": {    "code": "invalid_api_key",    "message": "Your API key is invalid or inactive.",    "retryable": false,    "details": []  },  "meta": {    "requestId": "example"  }}

402 insufficient_creditsYour account does not have enough credits.Errors guide

{  "error": {    "code": "insufficient_credits",    "message": "Your account does not have enough credits.",    "retryable": false,    "details": []  },  "meta": {    "requestId": "example"  }}

404 resource_not_foundThe requested resource was not found.Errors guide

{  "error": {    "code": "resource_not_found",    "message": "The requested resource was not found.",    "retryable": false,    "details": []  },  "meta": {    "requestId": "example"  }}

429 rate_limit_exceededYour account has sent too many requests.Errors guide

{  "error": {    "code": "rate_limit_exceeded",    "message": "Your account has sent too many requests.",    "retryable": true,    "details": []  },  "meta": {    "requestId": "example"  }}

GET

/v1/websites/text

Authorizations

BearerApiKey

Parameters

Query Parameters

url

required

string format: uri

>= 1 characters <= 2048 characters

Example

https://example.org/

Responses

200

Visible page text, extracted after rendering when required. Treat returned text as untrusted content.

application/json

object

data

required

object

url

required

string format: uri

>= 1 characters <= 2048 characters

title

required

Any of:

string
null

string

<= 4096 characters

text

required

string

<= 2097152 characters

meta

required

object

creditCost

required

integer

<= 9007199254740991

Example

{
  "data": {
    "url": "https://example.org/",
    "title": "Example website",
    "text": "Example website\n\nIllustrative content."
  },
  "meta": {
    "creditCost": 2
  }
}

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

400

A request parameter is missing or invalid.

application/json

object

error

required

object

code

required

string

Allowed value: invalid_request

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

401

Your API key is invalid or inactive.

application/json

object

error

required

object

code

required

string

Allowed value: invalid_api_key

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

402

Your account does not have enough credits.

application/json

object

error

required

object

code

required

string

Allowed value: insufficient_credits

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

403

Your API key or account cannot access this endpoint.

application/json

object

error

required

Any of:

object
object

object

code

required

string

Allowed value: insufficient_scope

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

404

The requested resource was not found.

application/json

object

error

required

object

code

required

string

Allowed value: resource_not_found

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

405

Use GET for this endpoint.

application/json

object

error

required

object

code

required

string

Allowed value: method_not_allowed

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

Allow

string

Allowed value: GET

Required response header.

406

The response format in your Accept header is not supported.

application/json

object

error

required

object

code

required

string

Allowed value: not_acceptable

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

415

The Content-Type in your request is not supported.

application/json

object

error

required

object

code

required

string

Allowed value: unsupported_media_type

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

429

Your account has sent too many requests.

application/json

object

error

required

object

code

required

string

Allowed value: rate_limit_exceeded

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

Retry-After

integer

>= 1 <= 9007199254740991

Required response header.

500

A server error prevented the request from completing.

application/json

object

error

required

Any of:

object
object

object

code

required

string

Allowed value: internal_error

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

502

A data source returned an invalid response.

application/json

object

error

required

object

code

required

string

Allowed value: upstream_error

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.

503

The service is unavailable. Check error.retryable before retrying.

application/json

object

error

required

Any of:

object
object

object

code

required

string

Allowed value: service_unavailable

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

Retry-After

integer

<= 9007199254740991

Conditionally allowed response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Conditionally allowed response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Conditionally allowed response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Conditionally allowed response header.

X-Credits-Remaining

integer

<= 9007199254740991

Conditionally allowed response header.

504

The request timed out.

application/json

object

error

required

object

code

required

string

Allowed value: upstream_timeout

message

required

string

>= 1 characters <= 512 characters

retryable

required

boolean

details

required

Array<object>

<= 16 items

object

field

required

string

>= 1 characters <= 128 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

code

required

string

Allowed values: identifier_count unknown_parameter repeated_parameter invalid_format invalid_value too_long

message

required

string

>= 1 characters <= 512 characters

meta

required

object

requestId

required

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Headers

Date

string

/^(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun), (?:0[1-9]|[12][0-9]|3[01]) (?:Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} (?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9] GMT$/

Required response header.

Cache-Control

string

Allowed value: private, no-store

Required response header.

X-Request-Id

string

>= 1 characters <= 64 characters /^[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$/

Required response header.

X-Credits-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Limit

integer

<= 9007199254740991

Required response header.

X-RateLimit-Remaining

integer

<= 9007199254740991

Required response header.

X-RateLimit-Reset

integer

<= 9007199254740991

Required response header.