The Skycloud LLM API v1 is a collection of RESTful HTTP endpoints designed to facilitate interaction with Skycloud's Large Language Model (LLM). Adhering to standard REST principles, the API allows users to authenticate, interact with the LLM, manage available models, and upload files for advanced processing.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22644769","collectionId":"c0b23135-a9e5-4747-9806-8d058fc43a8c","publishedId":"2sAXxWbVfe","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-20T14:15:03.000Z"},"item":[{"name":"Autorization","item":[{"name":"Login","id":"bff4e4f4-dee8-4b05-9770-59a557803a68","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\" : \"api@api.com\",\n \"password\" : \"987654321\"\n}","options":{"raw":{"language":"json"}}},"url":"https://skycloud.ir/api/v1/auth/login","urlObject":{"path":["auth","login"],"host":["https://skycloud.ir/api/v1"],"query":[],"variable":[]}},"response":[{"id":"104d4b88-e448-44b8-9e40-c541a7429fa5","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerThis endpoint enables users to interact with the currently selected Large Language Model (LLM) in real-time. Note: Before using this function, a model must be set via the Set Model endpoint. Without selecting a model, the API will not be able to process any chat requests. The user sends a message or query, and the model responds with an intelligent reply based on the context.
\n","urlObject":{"path":["llm","chat"],"host":["https://skycloud.ir/api/v1"],"query":[],"variable":[]}},"response":[{"id":"6c699416-f1b6-4bdf-998f-ee65b4c918ae","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"text\": \"Users can fetch a list of available models through the API and then set a single active model for interaction. Only one model can be selected at a time, making it simple and efficient for users to work with their chosen model.
\n","urlObject":{"path":["llm","fetch-models"],"host":["https://skycloud.ir/api/v1"],"query":[],"variable":[]}},"response":[{"id":"4649d60d-24cf-49c2-a0bc-4db93e8fd547","name":"Ok","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://skycloud.ir/api/v1/llm/fetch-models"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 19 Oct 2024 11:29:38 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"message\": \"Data fetched successfully.\",\n \"data\": [\n \"After fetching the list of available models, this endpoint allows users to set a specific model as the active one. Once set, this model will be used for all future interactions (such as chat or file uploads) until another model is selected.
\n","urlObject":{"path":["llm","set-model"],"host":["https://skycloud.ir/api/v1"],"query":[],"variable":[]}},"response":[{"id":"40c5c607-5a90-43f2-81ee-3eda973c0a86","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"model\": \"This endpoint allows users to upload files for analysis by the selected LLM model. Files could include text documents or other content that the model can process to provide insights or summaries.
\n","urlObject":{"path":["llm","upload-file"],"host":["https://skycloud.ir/api/v1"],"query":[],"variable":[]}},"response":[{"id":"d4457d2f-ff0d-4842-9615-421b66c7d163","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":"https://skycloud.ir/api/v1/llm/upload-file"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 19 Oct 2024 12:14:31 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"message\": \"File uploaded successfully.\"\n}"},{"id":"f9821687-4995-4a70-9112-1c6fb85ac410","name":"No active package","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":"https://skycloud.ir/api/v1/llm/upload-file"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 19 Oct 2024 12:05:19 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 403,\n \"message\": \"No active package found. Please purchase a package.\"\n}"},{"id":"3766d64a-c90c-419e-b618-3884c7bcbc3e","name":"File Missing or Invalid","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":"https://skycloud.ir/api/v1/llm/upload-file"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 19 Oct 2024 12:51:35 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 400,\n \"message\": \"Validation failed.\"\n}"},{"id":"2d9276d9-3432-4248-8a44-824e63987345","name":"Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}],"options":{"raw":{"language":"json"}}},"url":"https://skycloud.ir/api/v1/llm/upload-file"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 19 Oct 2024 12:54:52 GMT"},{"key":"Server","value":"Apache/2.4.41 (Ubuntu)"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Connection","value":"close"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 500,\n \"message\": \"An unexpected error occurred while uploading the file. Please try again later.\"\n}"}],"_postman_id":"054009cb-917b-4e94-92c7-b2d2daf488e5"}],"id":"35c0ab4d-cdfa-470b-be85-394abf46691a","_postman_id":"35c0ab4d-cdfa-470b-be85-394abf46691a","description":""}],"event":[{"listen":"prerequest","script":{"id":"c572aee9-37cc-45ea-ae07-3bfe5c6fccc5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"78c763d4-415a-44bb-8496-1c87805e88e1","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"https://skycloud.ir/api/v1"},{"key":"bearer_token","value":""}]}