{
  "opencollection": "1.0.0",
  "info": {
    "name": "Proompty Chat Prompt API",
    "version": "1.1.0"
  },
  "items": [
    {
      "info": {
        "name": "Prompt",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves user information within the Proompty API system. By sending a GET request to this endpoint, users can obtain detailed data pertaining to their profile and associated claims. This includes essential user attributes such as email, full name, avatar URL, subscription plan, and role. Additionally, the response includes claims regarding the user's subscription status, role type, and other pertinent details. In the event that the requested user is not found, a 404 error response is returned, indicating the absence of the specified user within the system.\n",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.proompty.com/api/topics/:topicId/prompts/:promptId/chat",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              },
              {
                "name": "promptId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Chat with a Prompt AI with a message or a binary stream using content-type: application/octet-stream (see Request body dropdown)\n"
        },
        {
          "info": {
            "name": "Retrieve details about a specific prompt within a designated topic in the Proompty API. By sending a GET request to this endpoint with the corresponding topicId and promptId parameters, users can access information such as the prompt's content, creation date, and any associated metadata. The API responds with the prompt object in JSON format, containing the relevant details. In case the requested prompt or topic is not found, appropriate error responses are returned (404 for prompt not found, 500 for other errors), ensuring users receive accurate feedback regarding the status of their request.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.proompty.com/api/topics/:topicId/prompts/:promptId",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              },
              {
                "name": "promptId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a Prompt"
        },
        {
          "info": {
            "name": "Proompty Update a specific prompt within a designated topic. Users can send a PUT request to this endpoint with the corresponding topicId and promptId parameters, along with a JSON payload containing the updated prompt information. This enables users to modify aspects of the prompt such as its content, metadata, or any other relevant properties. Upon successful execution, the endpoint responds with the updated prompt object in JSON format, providing confirmation of the changes made. In case the specified prompt or topic is not found, the endpoint returns an appropriate error response (404 for prompt not found, 500 for other errors), ensuring transparent communication and accurate handling of requests.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.proompty.com/api/topics/:topicId/prompts/:promptId",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              },
              {
                "name": "promptId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a Prompt"
        },
        {
          "info": {
            "name": "Remove a specific prompt associated with a particular topic. To utilize this endpoint, users send a DELETE request with the relevant topicId and promptId parameters. Upon successful execution, the specified prompt is permanently deleted from the system. The API responds with a confirmation message indicating the successful deletion of the prompt. In the event that the requested prompt or topic is not found, appropriate error responses are returned (404 for prompt not found, 500 for other errors). This endpoint provides users with the capability to manage prompts effectively within their topics, ensuring streamlined content management within the Proompty platform.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.proompty.com/api/topics/:topicId/prompts/:promptId",
            "params": [
              {
                "name": "topicId",
                "value": "",
                "type": "path"
              },
              {
                "name": "promptId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes a Prompt"
        }
      ]
    }
  ],
  "bundled": true
}