postiz_python_client.MediaApi

All URIs are relative to http://localhost

Method	HTTP request	Description
media_controller_delete_media	DELETE /media/{id}
media_controller_generate_image	POST /media/generate-image
media_controller_generate_image_from_text	POST /media/generate-image-with-prompt
media_controller_generate_video	POST /media/generate-video
media_controller_generate_video_allowed	GET /media/generate-video/{type}/allowed
media_controller_get_media	GET /media
media_controller_get_videos	GET /media/video-options
media_controller_save_media	POST /media/save-media
media_controller_save_media_information	POST /media/information
media_controller_upload_file	POST /media/{endpoint}
media_controller_upload_server	POST /media/upload-server
media_controller_upload_simple	POST /media/upload-simple
media_controller_video_function	POST /media/video/function

media_controller_delete_media

media_controller_delete_media(id)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    id = 'id_example' # str | 

    try:
        api_instance.media_controller_delete_media(id)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_delete_media: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

media_controller_generate_image

media_controller_generate_image()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)

    try:
        api_instance.media_controller_generate_image()
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_generate_image: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_generate_image_from_text

media_controller_generate_image_from_text()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)

    try:
        api_instance.media_controller_generate_image_from_text()
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_generate_image_from_text: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_generate_video

media_controller_generate_video(body)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    body = None # object | 

    try:
        api_instance.media_controller_generate_video(body)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_generate_video: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_generate_video_allowed

media_controller_generate_video_allowed(type)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    type = 'type_example' # str | 

    try:
        api_instance.media_controller_generate_video_allowed(type)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_generate_video_allowed: %s\n" % e)

Parameters

Name	Type	Description	Notes
type	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

media_controller_get_media

media_controller_get_media(page)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    page = 3.4 # float | 

    try:
        api_instance.media_controller_get_media(page)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_get_media: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	float

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

media_controller_get_videos

media_controller_get_videos()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)

    try:
        api_instance.media_controller_get_videos()
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_get_videos: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		-

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

media_controller_save_media

media_controller_save_media()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)

    try:
        api_instance.media_controller_save_media()
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_save_media: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_save_media_information

media_controller_save_media_information(body)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    body = None # object | 

    try:
        api_instance.media_controller_save_media_information(body)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_save_media_information: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_upload_file

media_controller_upload_file(endpoint)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    endpoint = 'endpoint_example' # str | 

    try:
        api_instance.media_controller_upload_file(endpoint)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_upload_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
endpoint	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_upload_server

media_controller_upload_server()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)

    try:
        api_instance.media_controller_upload_server()
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_upload_server: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_upload_simple

media_controller_upload_simple()

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)

    try:
        api_instance.media_controller_upload_simple()
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_upload_simple: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

media_controller_video_function

media_controller_video_function(body)

Example

import postiz_python_client
from postiz_python_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = postiz_python_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with postiz_python_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postiz_python_client.MediaApi(api_client)
    body = None # object | 

    try:
        api_instance.media_controller_video_function(body)
    except Exception as e:
        print("Exception when calling MediaApi->media_controller_video_function: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201		-

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

FilesExpand file tree

MediaApi.md

Latest commit

History

MediaApi.md

File metadata and controls

postiz_python_client.MediaApi

media_controller_delete_media

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_generate_image

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_generate_image_from_text

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_generate_video

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_generate_video_allowed

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_get_media

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_get_videos

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_save_media

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_save_media_information

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_upload_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

media_controller_upload_server

Example

Parameters