Book Title Generator

Generates book titles using prompts

Try Demo

Endpoints

POST https://api.magicapi.dev/api/v1/capix/title/generate/booktitle/v1/

Description

This endpoint generates a title based on the provided description and mode. It is part of the Capix API version 2.

Headers

  • x-magicapi-key: (string) A required header for authentication. Replace API_KEY with your actual API key.

  • Content-Type: (string) This should be set to application/json to indicate that the request body contains JSON data.

Request Body

The request body should be a JSON object with the following fields:

  • mode: (string) The mode in which the title should be generated. Example values include Formal, Casual, etc.

  • description: (string) A brief description that will be used to generate the title.

Example Request Body

{
  "mode": "Formal",
  "description": "let us dive"
}

Error Handling

If the request is invalid or the token is missing/incorrect, the server will respond with an appropriate HTTP status code and a message indicating the error.

Example Error Responses

  • 401 Unauthorized

    {
      "error": "Invalid token."
    }
  • 400 Bad Request

    {
      "error": "Invalid request body."
    }

Notes

  • Ensure that the token header contains a valid API key.

  • The mode field should be one of the accepted values. Check the API documentation or contact support if you are unsure about the valid modes.

  • The description field should be a concise and meaningful string to get the best results from the title generation.

Code Examples

curl -X 'POST' \
  'https://api.magicapi.dev/api/v1/capix/title/generate/booktitle/v1/' \
  -H 'accept: application/json' \
  -H 'x-magicapi-key: API_KEY' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'description=let%20us%20dive&mode=Formal'

It returns response like this

{
    "titles":[
        "Journey of Echoes",
        " Whispered Reflections",
        " Depths Unveiled"
    ]
}

Last updated