AI-Horde API Model to SDK Class Map

This is a mapping of the AI-Horde API models (defined at https://stablehorde.net/api/, see also the swagger doc) to the SDK classes.

Payloads

API Endpoint	HTTP Method	SDK Request Type
/v2/collection_by_name/{collection_name}	GET	CollectionByNameRequest
/v2/collections	GET	AllCollectionsRequest
/v2/collections	POST	CreateCollectionRequest
/v2/collections/{collection_id}	GET	CollectionByIDRequest
/v2/collections/{collection_id}	DELETE	DeleteCollectionRequest
/v2/collections/{collection_id}	PATCH	UpdateCollectionRequest
/v2/documents/privacy	GET	AIHordeGetPrivacyPolicyRequest
/v2/documents/sponsors	GET	AIHordeGetSponsorsRequest
/v2/documents/terms	GET	AIHordeGetTermsRequest
/v2/filters	POST	FilterPromptSuspicionRequest
/v2/filters	GET	FiltersListRequest
/v2/filters	PUT	PutNewFilterRequest
/v2/filters/regex	GET	FilterRegexRequest
/v2/filters/{filter_id}	DELETE	DeleteFilterRequest
/v2/filters/{filter_id}	PATCH	PatchExistingFilter
/v2/filters/{filter_id}	GET	SingleFilterRequest
/v2/find_user	GET	FindUserRequest
/v2/generate/async	POST	ImageGenerateAsyncRequest
/v2/generate/check/{id}	GET	ImageGenerateCheckRequest
/v2/generate/pop	POST	ImageGenerateJobPopRequest
/v2/generate/rate/{id}	POST	RateRequest
/v2/generate/status/{id}	DELETE	DeleteImageGenerateRequest
/v2/generate/status/{id}	GET	ImageGenerateStatusRequest
/v2/generate/submit	POST	ImageGenerationJobSubmitRequest
/v2/generate/text/async	POST	TextGenerateAsyncRequest
/v2/generate/text/pop	POST	TextGenerateJobPopRequest
/v2/generate/text/status/{id}	DELETE	DeleteTextGenerateRequest
/v2/generate/text/status/{id}	GET	TextGenerateStatusRequest
/v2/generate/text/submit	POST	TextGenerationJobSubmitRequest
/v2/interrogate/async	POST	AlchemyAsyncRequest
/v2/interrogate/pop	POST	AlchemyPopRequest
/v2/interrogate/status/{id}	DELETE	AlchemyDeleteRequest
/v2/interrogate/status/{id}	GET	AlchemyStatusRequest
/v2/interrogate/submit	POST	AlchemyJobSubmitRequest
/v2/kudos/award	POST	KudosAwardRequest
/v2/kudos/transfer	POST	KudosTransferRequest
/v2/operations/block_worker_ipaddr/{worker_id}	PUT	BlockWorkerIPAddressRequest
/v2/operations/block_worker_ipaddr/{worker_id}	DELETE	DeleteWorkerIPAddressRequest
/v2/operations/ipaddr	GET	SingleIPTimeoutsRequest
/v2/operations/ipaddr	POST	BlockIPAddressRequest
/v2/operations/ipaddr	DELETE	DeleteIPAddressRequest
/v2/sharedkeys	PUT	SharedKeyCreateRequest
/v2/sharedkeys/{sharedkey_id}	DELETE	SharedKeyDeleteRequest
/v2/sharedkeys/{sharedkey_id}	GET	SharedKeyDetailsRequest
/v2/sharedkeys/{sharedkey_id}	PATCH	SharedKeyModifyRequest
/v2/stats/img/models	GET	ImageStatsModelsRequest
/v2/stats/img/totals	GET	ImageStatsModelsTotalRequest
/v2/stats/text/models	GET	TextStatsModelsRequest
/v2/stats/text/totals	GET	TextStatsModelsTotalRequest
/v2/status/heartbeat	GET	AIHordeHeartbeatRequest
/v2/status/models	GET	HordeStatusModelsAllRequest
/v2/status/models/{model_name}	GET	HordeStatusModelsSingleRequest
/v2/status/news	GET	NewsRequest
/v2/status/performance	GET	HordePerformanceRequest
/v2/styles/image	GET	AllStylesImageRequest
/v2/styles/image	POST	CreateStyleImageRequest
/v2/styles/image/{style_id}	DELETE	DeleteStyleImageRequest
/v2/styles/image/{style_id}	PATCH	ModifyStyleImageRequest
/v2/styles/image/{style_id}	GET	SingleStyleImageByIDRequest
/v2/styles/image/{style_id}/example	POST	StyleImageExampleAddRequest
/v2/styles/image/{style_id}/example/{example_id}	DELETE	StyleImageExampleDeleteRequest
/v2/styles/image/{style_id}/example/{example_id}	PATCH	StyleImageExampleModifyRequest
/v2/styles/image_by_name/{style_name}	GET	SingleStyleImageByNameRequest
/v2/styles/text	GET	AllStylesTextRequest
/v2/styles/text	POST	CreateStyleTextRequest
/v2/styles/text/{style_id}	DELETE	DeleteStyleTextRequest
/v2/styles/text/{style_id}	PATCH	ModifyStyleTextRequest
/v2/styles/text/{style_id}	GET	SingleStyleTextByIDRequest
/v2/styles/text_by_name/{style_name}	GET	SingleStyleTextByNameRequest
/v2/teams	GET	AllTeamDetailsRequest
/v2/teams	POST	CreateTeamRequest
/v2/teams/{team_id}	DELETE	DeleteTeamRequest
/v2/teams/{team_id}	PATCH	ModifyTeamRequest
/v2/teams/{team_id}	GET	SingleTeamDetailsRequest
/v2/users	GET	ListUsersDetailsRequest
/v2/users/{user_id}	DELETE	DeleteUserRequest
/v2/users/{user_id}	PUT	ModifyUserRequest
/v2/users/{user_id}	GET	SingleUserDetailsRequest
/v2/workers	GET	AllWorkersDetailsRequest
/v2/workers/messages	GET	AllWorkerMessagesRequest
/v2/workers/messages	POST	CreateWorkerMessageRequest
/v2/workers/messages/{message_id}	DELETE	DeleteWorkerMessageRequest
/v2/workers/messages/{message_id}	GET	SingleWorkerMessageRequest
/v2/workers/name/{worker_name}	GET	SingleWorkerNameDetailsRequest
/v2/workers/{worker_id}	DELETE	DeleteWorkerRequest
/v2/workers/{worker_id}	PUT	ModifyWorkerRequest
/v2/workers/{worker_id}	GET	SingleWorkerDetailsRequest

Responses

API Endpoint	HTTP Status Code	SDK Response Type
/v2/collection_by_name/{collection_name}	200	ResponseModelCollection
/v2/collections	200	CreateCollectionResponse
/v2/collections/{collection_id}	200	UpdateCollectionResponse
/v2/documents/privacy	200	HordeDocument
/v2/documents/sponsors	200	HordeDocument
/v2/documents/terms	200	HordeDocument
/v2/filters	201	FilterDetails
/v2/filters/regex	200	FilterRegexResponse
/v2/filters/{filter_id}	200	FilterDetails
/v2/find_user	200	UserDetailsResponse
/v2/generate/async	200	ImageGenerateAsyncDryRunResponse
/v2/generate/async	202	ImageGenerateAsyncResponse
/v2/generate/check/{id}	200	ImageGenerateCheckResponse
/v2/generate/pop	200	ImageGenerateJobPopResponse
/v2/generate/rate/{id}	200	RateResponse
/v2/generate/status/{id}	200	ImageGenerateStatusResponse
/v2/generate/submit	200	JobSubmitResponse
/v2/generate/text/async	200	TextGenerateAsyncDryRunResponse
/v2/generate/text/async	202	TextGenerateAsyncResponse
/v2/generate/text/pop	200	TextGenerateJobPopResponse
/v2/generate/text/status/{id}	200	TextGenerateStatusResponse
/v2/generate/text/submit	200	JobSubmitResponse
/v2/interrogate/async	202	AlchemyAsyncResponse
/v2/interrogate/pop	200	AlchemyJobPopResponse
/v2/interrogate/status/{id}	200	AlchemyStatusResponse
/v2/interrogate/submit	200	AlchemyJobSubmitResponse
/v2/kudos/award	200	KudosAwardResponse
/v2/kudos/transfer	200	KudosTransferResponse
/v2/operations/block_worker_ipaddr/{worker_id}	200	DeleteWorkerIPAddressResponse
/v2/operations/ipaddr	200	IPTimeoutListResponse
/v2/sharedkeys	200	ExpiryStrSharedKeyDetailsResponse
/v2/sharedkeys/{sharedkey_id}	200	ExpiryStrSharedKeyDetailsResponse
/v2/stats/img/models	200	ImageStatsModelsResponse
/v2/stats/img/totals	200	ImageStatsModelsTotalResponse
/v2/stats/text/models	200	TextStatsModelResponse
/v2/stats/text/totals	200	TextStatsModelsTotalResponse
/v2/status/heartbeat	200	AIHordeHeartbeatResponse
/v2/status/models	200	HordeStatusModelsAllResponse
/v2/status/models/{model_name}	200	HordeStatusModelsSingleResponse
/v2/status/news	200	NewsResponse
/v2/status/performance	200	HordePerformanceResponse
/v2/styles/image	200	ModifyStyleImageResponse
/v2/styles/image/{style_id}	200	StyleStable
/v2/styles/image/{style_id}/example	200	StyleImageExampleModifyResponse
/v2/styles/image/{style_id}/example/{example_id}	200	StyleImageExampleModifyResponse
/v2/styles/image_by_name/{style_name}	200	StyleStable
/v2/styles/text	200	ModifyStyleTextResponse
/v2/styles/text/{style_id}	200	StyleKobold
/v2/styles/text_by_name/{style_name}	200	StyleKobold
/v2/teams	200	ModifyTeam
/v2/teams/{team_id}	200	TeamDetails
/v2/users	200	ListUsersDetailsResponse
/v2/users/{user_id}	200	UserDetailsResponse
/v2/workers	200	AllWorkersDetailsResponse
/v2/workers/messages	200	ResponseModelMessage
/v2/workers/messages/{message_id}	200	ResponseModelMessage
/v2/workers/name/{worker_name}	200	SingleWorkerDetailsResponse
/v2/workers/{worker_id}	200	SingleWorkerDetailsResponse