Skip to content

ContentGenerationRendersApi.md

Latest commit

 

History

History
172 lines (116 loc) · 5.41 KB

ContentGenerationRendersApi.md

File metadata and controls

172 lines (116 loc) · 5.41 KB

wordlift_client.ContentGenerationRendersApi

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

Method HTTP request Description
render_template POST /content-generations/renders Render
render_template_collection POST /content-generations/renders-collection Render

render_template

str render_template(render_request)

Render

GET with body payload - no resources created

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.render_request import RenderRequest
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.ContentGenerationRendersApi(api_client)
    render_request = wordlift_client.RenderRequest() # RenderRequest | 

    try:
        # Render
        api_response = await api_instance.render_template(render_request)
        print("The response of ContentGenerationRendersApi->render_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGenerationRendersApi->render_template: %s\n" % e)

Parameters

Name Type Description Notes
render_request RenderRequest

Return type

str

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status code Description Response headers
200 Found. -
401 Authentication Failure -
404 Not Found -

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

render_template_collection

List[str] render_template_collection(render_request)

Render

GET with body payload - no resources created

Example

  • Api Key Authentication (ApiKey):
import wordlift_client
from wordlift_client.models.render_request import RenderRequest
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.ContentGenerationRendersApi(api_client)
    render_request = [wordlift_client.RenderRequest()] # List[RenderRequest] | 

    try:
        # Render
        api_response = await api_instance.render_template_collection(render_request)
        print("The response of ContentGenerationRendersApi->render_template_collection:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ContentGenerationRendersApi->render_template_collection: %s\n" % e)

Parameters

Name Type Description Notes
render_request List[RenderRequest]

Return type

List[str]

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Found. -
401 Authentication Failure -
404 Not Found -

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