Client

The main class to interact with API.

Attributes/Parameters	Methods
api_key	get_ai_response
version	get_image
suppress_warnings	get_joke
	close

Attributes

api_key

This your API authentication key.

Type: str

As of version 3, The API key is required to use the API. Get one from here.

version

The version of API to use. This defaults to "4"

Type: str

suppress_warnings

Determines if version or other warnings will be shown in console or not. Set this to True to stop warnings.

Warnings are usually printed on outdated versions of API.

Type: bool

Methods

get_ai_response

Gets random AI response.

This method takes version specific parameters. It is recommended to use version 4 to avoid timeout errors as version 3 AI endpoint was unstable.

Arguments (Version 4)

These are parameters for version 4.

message

The message to which the response is required.

Type: str

plan (Optional)

The plan to use for AI response.

Type: str

This must be one of from the plans list.

language (Optional)

The language of returned response. This defaults to en.

Type: str

server (Optional)

The server from which the response should be received. This defaults to primary. Set it to backup if the primary is down. Don't use unstable as it is quiet unstable.

Type: str

master (Optional)

The developer's name. Used in responses. Defaults to PGamerX This is basically what bot will say on "Who is your creator?" or related questions.

Type: str

bot (Optional)

The bot's name. This is used in responses. Defaults to RSA. This is basically what bot will say on "Who are you?" or "What is your name?" or related questions.

Type:str

uid (Optional)

The unique ID. This is used to create a separate session. Read Unique ID page for more info.

Type: str

Above parameters are version 4 specific. If you're using version 3, See next tab.

Arguments (Version 3)

Below arguments are specific to version 3.

message

The message to which the response is required.

Type: str

plan (Optional)

The plan to use for AI response.

Type: str

This must be one of from the plans list.

lang (Optional)

The language of returned response. This defaults to en.

Type: str

type (Optional)

The server from which the response should be received. This defaults to stable. Don't use unstable as it is quiet unstable.

Type: str

dev_name (Optional)

The developer's name. Used in responses. Defaults to PGamerX This is basically what bot will say on "Who is your creator?" or related questions.

Type: str

bot_name (Optional)

The bot's name. This is used in responses. Defaults to RSA. This is basically what bot will say on "Who are you?" or "What is your name?" or related questions.

Type:str

unique_id (Optional)

The unique ID. This is used to create a separate session. Read Unique ID page for more info.

Type: str

Above parameters are version 3 specific. If you're using version 4, See previous tab.

Returns

The response as a AI response object.

To get the response message, Use AIResponse.message

Type: AIResponse

Raises

randomstuff.BadAPIKey: The API key provided was invalid.

randomstuff.PlanNotAllowed: The plan is not available on your account because you haven't bought it.

randomstuff.InvalidPlanError: Provided plan was invalid

randomstuff.InvalidServerError: The server is either not responding or invalid.

get_image

Gets a random image.

Arguments

type(Optional)

The type of image. This is one of the types from image types. Defaults to any.

Type: str

Returns

The image imgur link as a string.

Type: str

Raises

randomstuff.AuthError: The API key provided was invalid.randomstuff.InvalidArgument: The image type was not valid.

get_joke

Gets a random joke.

Arguments

type(Optional)

The type of joke. This is one of the types from joke types. Defaults to any.

Type: str

Returns

The random joke as Joke object.

Type: Joke

Raises

randomstuff.BadAPIKey: The API key provided was invalid.

randomstuff.InvalidArgument: The joke type was not valid.

get_waifu

Gets a random waifu/anime image URL.

This is only available on version 4.

This requires at least pro plan or higher to access.

Arguments

type

The type of anime. Can be one from Anime Types

Type: str

plan

The plan to use. Can be one from Plan Types

Type: str

Returns

The random anime as Waifu object.

Type: Waifu

Raises

randomstuff.BadAPIKey: The API key provided was invalid.

randomstuff.InvalidArgument: The waifu type was not valid.

randomstuff.PlanNotAllowed: The plan is not available on your API key.

get_weather

Gets the weather of provided city.

This is only available on version 4.

Arguments

city

The city of which weather is required.

Type: str

close

Closes a session.

It is always recommended to close a session after usage.