WebPagesApi.md

wordlift_client.WebPagesApi

All URIs are relative to https://api.wordlift.io

Method	HTTP request	Description
get_web_page	GET /web-pages	Get

get_web_page

WebPage get_web_page(url)

Get

Get extracted web page content

Example

• Api Key Authentication (ApiKey):

import wordlift_client
from wordlift_client.models.web_page import WebPage
from wordlift_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.wordlift.io
# See configuration.py for a list of all supported configuration parameters.
configuration = wordlift_client.Configuration(
    host = "https://api.wordlift.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.WebPagesApi(api_client)
    url = 'url_example' # str | Url to extract

    try:
        # Get
        api_response = await api_instance.get_web_page(url)
        print("The response of WebPagesApi->get_web_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebPagesApi->get_web_page: %s\n" % e)

Parameters

Name	Type	Description	Notes
url	str	Url to extract

Return type

WebPage

Authorization

ApiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
401	Authentication Failure	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]