Skip to content

endpoints

This module contains the URL endpoints for the AI Horde API.

AI_HORDE_BASE_URL module-attribute 

AI_HORDE_BASE_URL = 'https://aihorde.net/api/'

AI_HORDE_API_ENDPOINT_SUBPATH

Bases: GENERIC_API_ENDPOINT_SUBPATH

The URL actions 'paths' to the endpoints.

Includes the find/replace strings in brackets for path (non-query) variables.

Source code in horde_sdk/ai_horde_api/endpoints.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class AI_HORDE_API_ENDPOINT_SUBPATH(GENERIC_API_ENDPOINT_SUBPATH):
    """The URL actions 'paths' to the endpoints.

    Includes the find/replace strings in brackets for path (non-query) variables.
    """

    swagger = "/swagger.json"

    # Note that the leading slash is included for consistency with the swagger docs,
    # but it is dropped when the URL is actually constructed (see `url_with_path` in `horde_sdk.generic_api.endpoints`)
    v2_stats_img_models = "/v2/stats/img/models"
    v2_stats_img_totals = "/v2/stats/img/totals"
    v2_stats_text_models = "/v2/stats/text/models"
    v2_stats_text_totals = "/v2/stats/text/totals"

    v2_generate_async = "/v2/generate/async"

    v2_generate_pop = "/v2/generate/pop"
    v2_generate_pop_multi = "/v2/generate/pop_multi"
    v2_generate_submit = "/v2/generate/submit"

    # Note that `{id}`` (or any variable wrapped in curly braces) is dynamically replaced with the appropriate value
    # when a request being prepared for submission. The fields that are replaced are defined in the `AIHordePathData`
    # class in `metadata.py`.
    #
    # See `horde_shared_models\generic_api\generic_client.py` for the actual replacement

    v2_generate_check = "/v2/generate/check/{id}"
    v2_generate_status = "/v2/generate/status/{id}"

    v2_generate_text_async = "/v2/generate/text/async"
    v2_generate_text_submit = "/v2/generate/text/submit"

    v2_generate_text_pop = "/v2/generate/text/pop"
    v2_generate_text_status = "/v2/generate/text/status/{id}"

    v2_generate_rate_id = "/v2/generate/rate/{id}"

    v2_interrogate_async = "/v2/interrogate/async"
    v2_interrogate_status = "/v2/interrogate/status/{id}"
    v2_interrogate_pop = "/v2/interrogate/pop"
    v2_interrogate_submit = "/v2/interrogate/submit"

    v2_kudos_award = "/v2/kudos/award"
    v2_kudos_transfer = "/v2/kudos/transfer"

    v2_sharedkeys_create = "/v2/sharedkeys"
    v2_sharedkeys = "/v2/sharedkeys/{sharedkey_id}"

    v2_status_heartbeat = "/v2/status/heartbeat"
    v2_status_modes = "/v2/status/modes"
    v2_status_news = "/v2/status/news"

    v2_status_models_all = "/v2/status/models"
    v2_status_models_single = "/v2/status/models/{model_name}"

    v2_status_performance = "/v2/status/performance"

    v2_teams_all = "/v2/teams"
    v2_teams_single = "/v2/teams/{team_id}"

    v2_find_user = "/v2/find_user"
    """Note that this is an API key lookup, not a user ID lookup."""

    v2_users_all = "/v2/users"
    v2_users_single = "/v2/users/{user_id}"

    v2_workers_all = "/v2/workers"
    v2_workers_single = "/v2/workers/{worker_id}"
    v2_workers_single_name = "/v2/workers/name/{worker_name}"

    v2_filters = "/v2/filters"
    v2_filters_regex = "/v2/filters/regex"
    v2_filters_regex_single = "/v2/filters/{filter_id}"

    v2_operations_block_worker_ipaddr_single = "/v2/operations/block_worker_ipaddr/{worker_id}"
    v2_operations_ipaddr = "/v2/operations/ipaddr"
    v2_operations_ipaddr_single = "/v2/operations/ipaddr/{ipaddr}"

    v2_documents_privacy = "/v2/documents/privacy"
    v2_documents_sponsors = "/v2/documents/sponsors"
    v2_documents_terms = "/v2/documents/terms"

    v2_collections = "/v2/collections"
    v2_collections_by_name = "/v2/collection_by_name/{collection_name}"
    v2_collections_by_id = "/v2/collections/{collection_id}"

    v2_styles_image = "/v2/styles/image"
    v2_styles_image_by_id = "/v2/styles/image/{style_id}"
    v2_styles_image_by_name = "/v2/styles/image_by_name/{style_name}"

    v2_styles_image_example_by_style_id = "/v2/styles/image/{style_id}/example"
    v2_styles_image_example_by_style_id_example_id = "/v2/styles/image/{style_id}/example/{example_id}"

    v2_styles_text = "/v2/styles/text"
    v2_styles_text_by_id = "/v2/styles/text/{style_id}"
    v2_styles_text_by_name = "/v2/styles/text_by_name/{style_name}"

    v2_workers_messages = "/v2/workers/messages"
    v2_workers_messages_single = "/v2/workers/messages/{message_id}"

swagger class-attribute instance-attribute 

swagger = '/swagger.json'

v2_stats_img_models class-attribute instance-attribute 

v2_stats_img_models = '/v2/stats/img/models'

v2_stats_img_totals class-attribute instance-attribute 

v2_stats_img_totals = '/v2/stats/img/totals'

v2_stats_text_models class-attribute instance-attribute 

v2_stats_text_models = '/v2/stats/text/models'

v2_stats_text_totals class-attribute instance-attribute 

v2_stats_text_totals = '/v2/stats/text/totals'

v2_generate_async class-attribute instance-attribute 

v2_generate_async = '/v2/generate/async'

v2_generate_pop class-attribute instance-attribute 

v2_generate_pop = '/v2/generate/pop'

v2_generate_pop_multi class-attribute instance-attribute 

v2_generate_pop_multi = '/v2/generate/pop_multi'

v2_generate_submit class-attribute instance-attribute 

v2_generate_submit = '/v2/generate/submit'

v2_generate_check class-attribute instance-attribute 

v2_generate_check = '/v2/generate/check/{id}'

v2_generate_status class-attribute instance-attribute 

v2_generate_status = '/v2/generate/status/{id}'

v2_generate_text_async class-attribute instance-attribute 

v2_generate_text_async = '/v2/generate/text/async'

v2_generate_text_submit class-attribute instance-attribute 

v2_generate_text_submit = '/v2/generate/text/submit'

v2_generate_text_pop class-attribute instance-attribute 

v2_generate_text_pop = '/v2/generate/text/pop'

v2_generate_text_status class-attribute instance-attribute 

v2_generate_text_status = '/v2/generate/text/status/{id}'

v2_generate_rate_id class-attribute instance-attribute 

v2_generate_rate_id = '/v2/generate/rate/{id}'

v2_interrogate_async class-attribute instance-attribute 

v2_interrogate_async = '/v2/interrogate/async'

v2_interrogate_status class-attribute instance-attribute 

v2_interrogate_status = '/v2/interrogate/status/{id}'

v2_interrogate_pop class-attribute instance-attribute 

v2_interrogate_pop = '/v2/interrogate/pop'

v2_interrogate_submit class-attribute instance-attribute 

v2_interrogate_submit = '/v2/interrogate/submit'

v2_kudos_award class-attribute instance-attribute 

v2_kudos_award = '/v2/kudos/award'

v2_kudos_transfer class-attribute instance-attribute 

v2_kudos_transfer = '/v2/kudos/transfer'

v2_sharedkeys_create class-attribute instance-attribute 

v2_sharedkeys_create = '/v2/sharedkeys'

v2_sharedkeys class-attribute instance-attribute 

v2_sharedkeys = '/v2/sharedkeys/{sharedkey_id}'

v2_status_heartbeat class-attribute instance-attribute 

v2_status_heartbeat = '/v2/status/heartbeat'

v2_status_modes class-attribute instance-attribute 

v2_status_modes = '/v2/status/modes'

v2_status_news class-attribute instance-attribute 

v2_status_news = '/v2/status/news'

v2_status_models_all class-attribute instance-attribute 

v2_status_models_all = '/v2/status/models'

v2_status_models_single class-attribute instance-attribute 

v2_status_models_single = '/v2/status/models/{model_name}'

v2_status_performance class-attribute instance-attribute 

v2_status_performance = '/v2/status/performance'

v2_teams_all class-attribute instance-attribute 

v2_teams_all = '/v2/teams'

v2_teams_single class-attribute instance-attribute 

v2_teams_single = '/v2/teams/{team_id}'

v2_find_user class-attribute instance-attribute 

v2_find_user = '/v2/find_user'

Note that this is an API key lookup, not a user ID lookup.

v2_users_all class-attribute instance-attribute 

v2_users_all = '/v2/users'

v2_users_single class-attribute instance-attribute 

v2_users_single = '/v2/users/{user_id}'

v2_workers_all class-attribute instance-attribute 

v2_workers_all = '/v2/workers'

v2_workers_single class-attribute instance-attribute 

v2_workers_single = '/v2/workers/{worker_id}'

v2_workers_single_name class-attribute instance-attribute 

v2_workers_single_name = '/v2/workers/name/{worker_name}'

v2_filters class-attribute instance-attribute 

v2_filters = '/v2/filters'

v2_filters_regex class-attribute instance-attribute 

v2_filters_regex = '/v2/filters/regex'

v2_filters_regex_single class-attribute instance-attribute 

v2_filters_regex_single = '/v2/filters/{filter_id}'

v2_operations_block_worker_ipaddr_single class-attribute instance-attribute 

v2_operations_block_worker_ipaddr_single = (
    "/v2/operations/block_worker_ipaddr/{worker_id}"
)

v2_operations_ipaddr class-attribute instance-attribute 

v2_operations_ipaddr = '/v2/operations/ipaddr'

v2_operations_ipaddr_single class-attribute instance-attribute 

v2_operations_ipaddr_single = (
    "/v2/operations/ipaddr/{ipaddr}"
)

v2_documents_privacy class-attribute instance-attribute 

v2_documents_privacy = '/v2/documents/privacy'

v2_documents_sponsors class-attribute instance-attribute 

v2_documents_sponsors = '/v2/documents/sponsors'

v2_documents_terms class-attribute instance-attribute 

v2_documents_terms = '/v2/documents/terms'

v2_collections class-attribute instance-attribute 

v2_collections = '/v2/collections'

v2_collections_by_name class-attribute instance-attribute 

v2_collections_by_name = (
    "/v2/collection_by_name/{collection_name}"
)

v2_collections_by_id class-attribute instance-attribute 

v2_collections_by_id = '/v2/collections/{collection_id}'

v2_styles_image class-attribute instance-attribute 

v2_styles_image = '/v2/styles/image'

v2_styles_image_by_id class-attribute instance-attribute 

v2_styles_image_by_id = '/v2/styles/image/{style_id}'

v2_styles_image_by_name class-attribute instance-attribute 

v2_styles_image_by_name = (
    "/v2/styles/image_by_name/{style_name}"
)

v2_styles_image_example_by_style_id class-attribute instance-attribute 

v2_styles_image_example_by_style_id = (
    "/v2/styles/image/{style_id}/example"
)

v2_styles_image_example_by_style_id_example_id class-attribute instance-attribute 

v2_styles_image_example_by_style_id_example_id = (
    "/v2/styles/image/{style_id}/example/{example_id}"
)

v2_styles_text class-attribute instance-attribute 

v2_styles_text = '/v2/styles/text'

v2_styles_text_by_id class-attribute instance-attribute 

v2_styles_text_by_id = '/v2/styles/text/{style_id}'

v2_styles_text_by_name class-attribute instance-attribute 

v2_styles_text_by_name = (
    "/v2/styles/text_by_name/{style_name}"
)

v2_workers_messages class-attribute instance-attribute 

v2_workers_messages = '/v2/workers/messages'

v2_workers_messages_single class-attribute instance-attribute 

v2_workers_messages_single = (
    "/v2/workers/messages/{message_id}"
)

get_ai_horde_swagger_url 

get_ai_horde_swagger_url() -> str

Get the URL for the AI Horde API swagger docs.

Source code in horde_sdk/ai_horde_api/endpoints.py 
119
120
121
122
123
124
def get_ai_horde_swagger_url() -> str:
    """Get the URL for the AI Horde API swagger docs."""
    return url_with_path(
        base_url=AI_HORDE_BASE_URL,
        path=AI_HORDE_API_ENDPOINT_SUBPATH.swagger,
    )

get_admin_only_endpoints 

get_admin_only_endpoints() -> set[str]

Return all of the endpoints that are admin-only.

Source code in horde_sdk/ai_horde_api/endpoints.py 
127
128
129
130
131
132
133
134
135
136
137
138
def get_admin_only_endpoints() -> set[str]:
    """Return all of the endpoints that are admin-only."""
    return {
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_status_modes,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_filters,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_filters_regex,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_filters_regex_single,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_operations_block_worker_ipaddr_single,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_operations_ipaddr,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_operations_ipaddr_single,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_kudos_award,
    }

get_deprecated_endpoints 

get_deprecated_endpoints() -> set[str]

Return all of the endpoints that are deprecated.

Source code in horde_sdk/ai_horde_api/endpoints.py 
141
142
143
144
145
146
def get_deprecated_endpoints() -> set[str]:
    """Return all of the endpoints that are deprecated."""
    return {
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_pop_multi,
        AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_rate_id,
    }