Skip to content
This repository was archived by the owner on Aug 1, 2025. It is now read-only.

ConvertApi.md

Latest commit

 

History

History
326 lines (218 loc) · 10.5 KB

ConvertApi.md

File metadata and controls

326 lines (218 loc) · 10.5 KB

imager200_python_sdk.ConvertApi

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

Method HTTP request Description
convert_async_get GET /convert
convert_async_post POST /convert
convert_sync_get GET /convert/sync
convert_sync_post POST /convert/sync

convert_async_get

InfoResponse convert_async_get(url, target_format=target_format)

Example

  • Api Key Authentication (ApiKeyAuth):
import imager200_python_sdk
from imager200_python_sdk.models.info_response import InfoResponse
from imager200_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.imager200.io
# See configuration.py for a list of all supported configuration parameters.
configuration = imager200_python_sdk.Configuration(
    host = "https://api.imager200.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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with imager200_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = imager200_python_sdk.ConvertApi(api_client)
    url = 'url_example' # str | image url, supported formats jpeg,png,bmp,gif
    target_format = 'target_format_example' # str |  (optional)

    try:
        api_response = api_instance.convert_async_get(url, target_format=target_format)
        print("The response of ConvertApi->convert_async_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConvertApi->convert_async_get: %s\n" % e)

Parameters

Name Type Description Notes
url str image url, supported formats jpeg,png,bmp,gif
target_format str [optional]

Return type

InfoResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created * Location - the temporary url of an image in case a post operation id is not provided
400 Bad Request -

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

convert_async_post

InfoResponse convert_async_post(body, target_format=target_format)

Example

  • Api Key Authentication (ApiKeyAuth):
import imager200_python_sdk
from imager200_python_sdk.models.info_response import InfoResponse
from imager200_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.imager200.io
# See configuration.py for a list of all supported configuration parameters.
configuration = imager200_python_sdk.Configuration(
    host = "https://api.imager200.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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with imager200_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = imager200_python_sdk.ConvertApi(api_client)
    body = None # bytearray | image binary data, acceptable formats: jpeg,png,bmp,gif
    target_format = 'target_format_example' # str |  (optional)

    try:
        api_response = api_instance.convert_async_post(body, target_format=target_format)
        print("The response of ConvertApi->convert_async_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConvertApi->convert_async_post: %s\n" % e)

Parameters

Name Type Description Notes
body bytearray image binary data, acceptable formats: jpeg,png,bmp,gif
target_format str [optional]

Return type

InfoResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created * Location - the temporary url of an image in case a post operation id is not provided
400 Bad Request -

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

convert_sync_get

bytearray convert_sync_get(url, target_format=target_format)

Example

  • Api Key Authentication (ApiKeyAuth):
import imager200_python_sdk
from imager200_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.imager200.io
# See configuration.py for a list of all supported configuration parameters.
configuration = imager200_python_sdk.Configuration(
    host = "https://api.imager200.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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with imager200_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = imager200_python_sdk.ConvertApi(api_client)
    url = 'url_example' # str | image url, supported formats jpeg,png,bmp,gif
    target_format = 'target_format_example' # str |  (optional)

    try:
        api_response = api_instance.convert_sync_get(url, target_format=target_format)
        print("The response of ConvertApi->convert_sync_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConvertApi->convert_sync_get: %s\n" % e)

Parameters

Name Type Description Notes
url str image url, supported formats jpeg,png,bmp,gif
target_format str [optional]

Return type

bytearray

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: image/bmp, image/gif, image/jpeg, image/png, application/json

HTTP response details

Status code Description Response headers
200 response contains the image file -
400 Bad Request -

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

convert_sync_post

bytearray convert_sync_post(body, target_format=target_format)

Example

  • Api Key Authentication (ApiKeyAuth):
import imager200_python_sdk
from imager200_python_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.imager200.io
# See configuration.py for a list of all supported configuration parameters.
configuration = imager200_python_sdk.Configuration(
    host = "https://api.imager200.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: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

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

# Enter a context with an instance of the API client
with imager200_python_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = imager200_python_sdk.ConvertApi(api_client)
    body = None # bytearray | image binary data, acceptable formats: jpeg,png,bmp,gif
    target_format = 'target_format_example' # str |  (optional)

    try:
        api_response = api_instance.convert_sync_post(body, target_format=target_format)
        print("The response of ConvertApi->convert_sync_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ConvertApi->convert_sync_post: %s\n" % e)

Parameters

Name Type Description Notes
body bytearray image binary data, acceptable formats: jpeg,png,bmp,gif
target_format str [optional]

Return type

bytearray

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: image/bmp, image/gif, image/jpeg, image/png, application/json

HTTP response details

Status code Description Response headers
200 response contains the image file -
400 Bad Request -

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