Roleplay AI API

The Roleplay AI API provides conversational AI responses with different personalities for interactive roleplay.

Base URL

"https://openapi-idk8.onrender.com"

Endpoints

  • GET /roleplay/roles: Retrieve a list of available roles.
  • GET /roleplay: Get a response from the AI based on the provided query and role.

GET /roleplay/roles

Retrieves a list of available roles for the Roleplay AI.

Sample Request

GET "https://openapi-idk8.onrender.com/roleplay/roles"

Sample Response

{
  "List of available roles": [
    "friendly",
    "sarcastic",
    "joker",
    "storyteller",
    "pare",
    "geek",
    "motivational",
    "philosopher",
    "detective",
    "mentor",
    "informative",
    "legal",
    "music_composer",
    "ethics_advisor"
  ]
}

GET /roleplay

Gets a response from the AI based on the provided query and role.

Query Parameters

  • query: The input text to which the AI should respond. This parameter is required.
  • role: The role in which the AI should respond. This parameter is optional, and the default role is used if not provided.

Sample Request

GET "https://openapi-idk8.onrender.com/roleplay?query=Tell%20me%20a%20joke&role=joker"

Sample Response

{
  "api_name": "Roleplay AI API",
  "description": "A conversational AI with different personalities for interactive roleplay.",
  "author": "OpenAPI",
  "used_role": "joker",
  "response": "Why don't scientists trust atoms? Because they make up everything!"
}

Error Handling

If there is an error or the required query parameter is missing, the API responds with an appropriate error message and status code.

Additional Information

The role parameter allows the user to specify the AI's personality. The available roles are listed under the GET /roleplay/roles endpoint.

Disclaimer: Roleplay AI API

RolePlay AI API uses prompted roles to generate interactive and engaging roleplay scenarios.