{ "opencollection": "1.0.0", "info": { "name": "Proompty Chat Documents API", "version": "1.1.0" }, "items": [ { "info": { "name": "Documents", "type": "folder" }, "items": [ { "info": { "name": "Retrieve details about a specific document within a designated topic in the Proompty API. By sending a GET request to this endpoint with the corresponding topicId and documentId parameters, users can access information such as the document's content, creation date, and any associated metadata. The API responds with the document object in JSON format, containing the relevant details. In case the requested document or topic is not found, appropriate error responses are returned (404 for document 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/documents/:documentId", "params": [ { "name": "topicId", "value": "", "type": "path" }, { "name": "documentId", "value": "", "type": "path" } ] }, "docs": "Get a document by ID" }, { "info": { "name": "Delete a specific document within a designated topic in the Proompty API. Users can send a DELETE request to this endpoint with the relevant topicId and documentId parameters to remove the specified document from the topic. The API responds with a success message in JSON format, confirming that the document has been successfully deleted. In case the requested document or topic is not found, appropriate error responses are returned (404 for document not found, 500 for other errors), ensuring users receive accurate feedback regarding the status of their request.", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.proompty.com/api/topics/:topicId/documents/:documentId", "params": [ { "name": "topicId", "value": "", "type": "path" }, { "name": "documentId", "value": "", "type": "path" } ] }, "docs": "Delete a document by ID" }, { "info": { "name": "Upload a document to a specific topic. Users can send a POST request to this endpoint with the relevant topicId parameter and a document file to upload a new document to the specified topic. The API responds with a JSON object containing the uploaded document details and any relevant metadata. This endpoint enables users to efficiently upload and manage documents within topics, facilitating seamless access and sharing of resources across the Proompty platform. In case the document already exists within the specified topic, the endpoint returns an appropriate error response (409), indicating that the document is already present in the topic.", "type": "http" }, "http": { "method": "POST", "url": "https://app.proompty.com/api/topics/:topicId/documents/upload", "params": [ { "name": "topicId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Upload a document to a topic" } ] } ], "bundled": true }