The FoundationAPI offers a comprehensive suite of API products, tools, and resources designed to enhance your project management and organizational workflows. Our API enables you to seamlessly integrate and manage diverse multimedia content sources and complex file uploads across various projects and organizational units. With FoundationAPI, you can effectively streamline your data handling processes, ensure consistent access to updated resources, and enhance collaboration within your team. Whether you're adding new content sources, uploading files, or managing project data, FoundationAPI provides the necessary functionalities to support your evolving business needs.
\nWelcome to the FoundationAPI! Our API suite is designed to provide robust solutions for managing and integrating project and organizational resources efficiently. Follow these steps to begin using our APIs and maximize your productivity quickly:
\nRegister/Login: Start by creating an account or logging in on our platform.
\nGenerate API Key: Navigate to the integrations dashboard in your account settings. Generate a new API key, which you will use to authenticate your API requests.
\nUse HTTPS: FoundationAPI requires secure communication via HTTPS for all API requests. Ensure that your applications make requests over HTTPS to avoid redirections or security warnings.
\nConfigure Headers: Include your API key in the header of each request. This is typically done with a header such as x-api-key: .
JSON Responses: Our API communicates and responds with JSON data. Ensure your application can parse and handle JSON format.
\nManage Errors: In case of an error, the API will send a JSON response containing an error key with details about the issue. Implement error handling in your application to gracefully manage these situations.
Stay Updated: Keep an eye on API updates and changes. Subscribe to our newsletter or updates to receive notifications about new features or important changes.
\nSupport: If you encounter any issues or have questions, reach out to our support team through the help center or community forums.
\nBy following these steps, you can start leveraging the StreamlineAPI to enhance the efficiency and functionality of your projects and organizational workflows. Happy coding!
\nThe FoundationAPI uses API keys for authentication to ensure secure access to its services. This section explains how to obtain your API key, where to include it in your API requests, and how to handle common authentication errors.
\nCreate an Account or Log In: If you haven’t already, sign up or log in to your account on the FoundationAPI platform.
\nGenerate Your API Key: Once logged in, navigate to the API Keys section under your account settings. Click on \"Generate API Key\". Label your key with a recognizable name that reflects its usage context.
\nSecure Your Key: Store your API key securely and never share it in publicly accessible areas such as GitHub, client-side code, etc.
\nTo access the FoundationAPI endpoints, you must include your API key in each request. This is done using the X-Api-Key header as follows:
X-Api-Key: <your_api_key_here>\n\nEnsure this header is included in every API call to authenticate your requests successfully.
\nIf your request fails authentication, the API will return an error. Common authentication error statuses include:
\n401 Unauthorized: The API key was not provided, is invalid, or has been revoked. Verify that your API key is correct and included in the header of your request.
\n403 Forbidden: The API key doesn't have permissions to perform the requested operation. Ensure that your API key permissions align with the API endpoints you are attempting to access.
\nRegenerate Keys Periodically: For security purposes, regenerate your API keys periodically and update your applications accordingly.
\nLimit Permissions: If possible, limit the permissions associated with each key according to the use case, minimizing potential security risks.
\nBy following these guidelines, you can ensure that your interactions with the StreamlineAPI are secure and efficient. Remember to handle your API keys as sensitive information and manage them appropriately to avoid unauthorized access to your services.
\nThe FoundationAPI enforces rate limits and usage constraints to ensure fair usage and optimal performance for all users. This section details the limits on API requests and the policies around these limits.
\nRequests Per Minute: Each API key can make up to 300 requests per minute. This limit is designed to prevent abuse and ensure service availability for all users.
\nExcess Requests: If you exceed this rate limit, the API will return an HTTP 429 Too Many Requests status code. Subsequent requests will be rejected until the rate drops below the threshold.
\nMonthly Quota: Depending on your subscription plan, you may also have a monthly quota on the total number of requests or data transfer volume.
\nPlan-Based Limits: Specific limits are detailed in your account’s plan settings. To view or change your plan, visit the subscription management page on our platform.
\nIf you exceed the stipulated rate or usage limits:
\nError Response: An HTTP 429 status code will be sent, accompanied by a message explaining that the rate limit has been exceeded.
\nRetry-After Header: This header may be included in the 429 response, indicating how long to wait before making a new request.
\nCaching: Implement caching strategies to minimize redundant API calls.
\nThrottling: Employ client-side request throttling to spread your requests evenly and stay within rate limits.
\nMonitoring: Regularly monitor your API usage through the dashboard provided in your account to ensure you remain within established limits.
\nIf you consistently hit your rate or usage limits, consider upgrading your plan to accommodate higher limits. Details on different plans and how to upgrade are available on our website.
\nBy understanding and adhering to these rate and usage limits, you can optimize your use of the FoundationAPI and avoid service interruptions. We are committed to providing robust and reliable service to all our users, and we appreciate your cooperation in following these terms.
\nEach API response returns the following set of headers to help you identify your use status:
\nAn HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.
This documentation explains the error handling mechanism of our API, including the structure of error responses and the types of errors that clients might encounter. It is essential for clients to understand these errors to handle them effectively in their applications.
\nWhen an error occurs during the processing of a request, the API responds with a structured error object. The error handling logic ensures that clients receive a consistent and informative error response.
\nThe error object returned by the API has the following structure:
\n{\n \"status\": <HTTP status code>,\n \"type\": \"https://www.rfc-editor.org/rfc/rfc9110.html/<error type>\",\n \"title\": \"<error title>\",\n \"detail\": \"<error detail>\",\n \"instance\": \"<error instance>\"\n}\n\nThe error response will include the following header:
\nContent-Type: application/problem+json\n\nstatus: The HTTP status code of the error (e.g., 400, 401, 404, 500).
\ntype: A URL pointing to the error documentation.
\ntitle: A short, human-readable summary of the error.
\ndetail: A detailed description of the error.
\ninstance: A URI reference that identifies the specific occurrence of the problem.
\n{\n \"status\": 400,\n \"type\": \"https://www.rfc-editor.org/rfc/rfc9110.html/bad-request\",\n \"title\": \"Bad Request\",\n \"detail\": \"The request could not be understood or was missing required parameters.\",\n \"instance\": \"<request URI>\"\n}\n\n{\n \"status\": 401,\n \"type\": \"https://www.rfc-editor.org/rfc/rfc9110.html/unauthorized\",\n \"title\": \"Unauthorized\",\n \"detail\": \"Authentication failed or user does not have permissions for the requested operation.\",\n \"instance\": \"<request URI>\"\n}\n\n{\n \"status\": 403,\n \"type\": \"https://www.rfc-editor.org/rfc/rfc9110.html/forbidden\",\n \"title\": \"Forbidden\",\n \"detail\": \"Access to the requested resource is forbidden.\",\n \"instance\": \"<request URI>\"\n}\n\n{\n \"status\": 404,\n \"type\": \"https://www.rfc-editor.org/rfc/rfc9110.html/not-found\",\n \"title\": \"Not Found\",\n \"detail\": \"The requested resource was not found.\",\n \"instance\": \"<request URI>\"\n}\n\n{\n \"status\": 500,\n \"type\": \"https://www.rfc-editor.org/rfc/rfc9110.html/internal-server-error\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"An unexpected error occurred on the server.\",\n \"instance\": \"<request URI>\"\n}\n\nThe HttpErrorBase class is used to define and handle HTTP errors. It ensures that error responses are standardized.
status: HTTP status code.
\ntype: Type of the error.
\ntitle: Short, human-readable summary of the error.
\ndetail: Detailed description of the error.
\ninstance: URI reference identifying the specific occurrence of the problem.
\nThis documentation outlines how our API handles errors, the structure of error responses, and common error types. Understanding this information will help clients handle errors more effectively and ensure a smoother integration with our API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Get started here","slug":"get-started-here"},{"content":"API Overview","slug":"api-overview"},{"content":"Getting Started with FoundationAPI","slug":"getting-started-with-foundationapi"},{"content":"Authentication","slug":"authentication"},{"content":"Rate and Usage Limits","slug":"rate-and-usage-limits"},{"content":"API Error Handling Documentation","slug":"api-error-handling-documentation"}],"owner":"7322987","collectionId":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","publishedId":"2sA3JT2xvB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-05-17T11:01:56.000Z"},"item":[{"name":"Project","item":[{"name":"List all projects in org","id":"93868e3d-a5ba-4a42-bd1f-0f04203b1a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/api/v2/projects?limit=100&offset=0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["api","v2","projects"],"host":["https://api.sferal.ai"],"query":[{"key":"limit","value":"100"},{"key":"offset","value":"0"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"ed6abf88-cf62-4731-899d-caf928e907dd","name":"List all projects in org","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sferal.ai/v1/projects?limit=10&offset=0","host":["https://api.sferal.ai"],"path":["v1","projects"],"query":[{"key":"limit","value":"10"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Nov 2024 06:57:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"c29-A48EgnFNcOTP8YVmTLrRTYLDhLc\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=BIL8XCUGwjoo0znAVnWP0MsdyFC00uUSGEBbTRiIroq6FHGj%2B%2B%2BJtSTwzRtM9kuyl1ZOFMGTFotazwBEzHFaq9Vmo%2FrL6OnsO6MEphZUYtCYI9GLfZ198NJuDB%2FzTD9%2FKwnBTg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e1cde287eb0c9d1-OTP"},{"key":"Content-Encoding","value":"br"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=19751&sent=21&recv=23&lost=0&retrans=0&sent_bytes=5551&recv_bytes=1303&delivery_rate=276844&cwnd=256&unsent_bytes=0&cid=e9785a1b29cbced1&ts=10692&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": \"5268fc98-aed1-495c-bc17-c11d775ceb29\",\n \"name\": \"ESP32 S3\",\n \"description\": \"\",\n \"descriptionExtra\": null,\n \"projectType\": {\n \"id\": 1,\n \"name\": \"Chat\",\n \"shortName\": \"chat\"\n },\n \"embeddingStatus\": \"completed\",\n \"projChat\": {\n \"similarityScoreThreshold\": 0.8,\n \"embeddingChunkSize\": 1024,\n \"embeddingChunkOverlap\": 64,\n \"temperatureLlm\": 0.3,\n \"aiModelLlmId\": 16,\n \"aiModelEmbeddingId\": 11,\n \"autoShowInitialMessages\": 3,\n \"projectId\": \"5268fc98-aed1-495c-bc17-c11d775ceb29\",\n \"createdAt\": \"2024-09-20T11:34:00.219Z\",\n \"updatedAt\": \"2024-09-20T11:34:00.219Z\",\n \"basePrompt\": \"I want you to roleplay as \\\"AI Assistant\\\". You will provide me with answers from the given context. If the answer is not included in the context, try to give an answer that is as good, correct and comprehensive as possible based on your knowledge.\"\n }\n }\n ]\n}"}],"_postman_id":"93868e3d-a5ba-4a42-bd1f-0f04203b1a8e"},{"name":"Set chat settings","id":"abb1c2cc-10b8-4b2d-a23b-f2ac3404f885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"a6de2a9c-a99f-4330-a5d8-bae1c60ca85d\",\n \"similarityScoreThreshold\": 0.5, //optional\n \"embeddingChunkSize\": 512, //optional\n \"embeddingChunkOverlap\": 64, //optional\n \"temperatureLlm\": 0.3, //optional\n \"autoShowInitialMessages\": 3, //optional\n \"basePrompt\":\"I want you to roleplay as \\\"AI Assistant\\\". You will provide me with answers from the given context. If the answer is not included in the context, try to give an answer that is as good, correct and comprehensive as possible based on your knowledge.\" //optional\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/projects/settings/chat","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","projects","settings","chat"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[{"id":"a5e54939-8cd5-4464-bd9a-0834c5447486","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 5,\n \"similarityScoreThreshold\": 0.5,\n \"embeddingChunkSize\": 512,\n \"embeddingChunkOverlap\": 64,\n \"temperatureLlm\": 0.3,\n \"modelLlmDefault\": \"gpt_4\",\n \"autoShowInitialMessages\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/projects/settings/chat"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"64"},{"key":"ETag","value":"W/\"40-aZRTlqqXTQ7RVaFJBrycyBOyU/s\""},{"key":"Date","value":"Tue, 30 Jul 2024 07:58:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": \"Project settings updated successfully\"\n}"}],"_postman_id":"abb1c2cc-10b8-4b2d-a23b-f2ac3404f885"},{"name":"Create new project","id":"8571ef79-1763-43fc-952b-f7c0fabfd4c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"language\": \"ro-RO\",\n \"name\": \"Numele Proiectului Chatxxxxx\",\n \"description\": \"Aceasta este descrierea principală a proiectului.\",\n \"descriptionExtra\": \"Detalii suplimentare despre proiect.\",\n \"embeddingChunkSize\": 512,\n \"embeddingChunkOverlap\": 128,\n \"temperatureLlm\": 0.75,\n \"similarityScoreThreshold\": 0.8,\n \"autoShowInitialMessages\": 1,\n \"basePrompt\": \"Salut! Cum te pot ajuta astăzi?\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/projects","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","projects"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[{"id":"c6acf7ca-7947-4bb2-98fe-8a9aea408d79","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": 5,\n \"similarityScoreThreshold\": 0.5,\n \"embeddingChunkSize\": 512,\n \"embeddingChunkOverlap\": 64,\n \"temperatureLlm\": 0.3,\n \"modelLlmDefault\": \"gpt_4\",\n \"autoShowInitialMessages\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/projects/settings/chat"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"64"},{"key":"ETag","value":"W/\"40-aZRTlqqXTQ7RVaFJBrycyBOyU/s\""},{"key":"Date","value":"Tue, 30 Jul 2024 07:58:14 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": \"Project settings updated successfully\"\n}"}],"_postman_id":"8571ef79-1763-43fc-952b-f7c0fabfd4c4"},{"name":"Delete project","id":"dc14e769-2a8f-4390-b3ac-b1b633777c97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.sferal.ai/v1/projects/:projectId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","projects",":projectId"],"host":["https://api.sferal.ai"],"query":[],"variable":[{"type":"any","value":"3241433c-7551-415a-a45f-900dcad81d04","key":"projectId"}]}},"response":[],"_postman_id":"dc14e769-2a8f-4390-b3ac-b1b633777c97"}],"id":"a4fed0b2-5efc-4988-b7d6-8830e27ebcf2","description":"GET /v1/projects
This endpoint allows clients to fetch all projects from the organisation based on x-api-key. The client must provide a valid API key in the request headers. Also to perform listing you need x-api-key for Organisation
Ensure to provide a valid API key in the request headers. The key will be used to verify the client’s authorization to access the endpoint.
\nThe sourceId parameter in the URL path specifies the source to be fetched.
If the source is not found, the endpoint will return a 404 Not Found status with an appropriate error message.
In case of any errors during the process, a 400 Bad Request status code will be returned with the error message.
{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": \"5268fc98-xxxx-xxxx-xxxx-c11d775ceb29\",\n \"name\": \"Name of the source\",\n \"description\": \"\",\n \"descriptionExtra\": null,\n \"projectType\": {\n \"id\": 1,\n \"name\": \"Chat\",\n \"shortName\": \"chat\"\n },\n \"embeddingStatus\": \"completed\",\n \"projChat\": {\n \"similarityScoreThreshold\": 0.8,\n \"embeddingChunkSize\": 1024,\n \"embeddingChunkOverlap\": 64,\n \"temperatureLlm\": 0.3,\n \"aiModelLlmId\": 16,\n \"aiModelEmbeddingId\": 11,\n \"autoShowInitialMessages\": 3,\n \"projectId\": \"5268fc98-xxxx-xxxx-xxxx-c11d775ceb29\",\n \"createdAt\": \"2024-09-20T11:34:00.219Z\",\n \"updatedAt\": \"2024-09-20T11:34:00.219Z\",\n \"basePrompt\": \"I want you to roleplay as \\\"AI Assistant\\\". You will provide me with answers from the given context. If the answer is not included in the context, try to give an answer that is as good, correct and comprehensive as possible based on your knowledge.\"\n }\n }\n ]\n}\n\nPOST /v1/projects/settings/chat
This endpoint updates the chat settings for a specific project. The settings include parameters for similarity score threshold, embedding chunk size, embedding chunk overlap, temperature for the language model, and the default language model.
\nx-api-key (string, required): The API key to authenticate the request.{\n \"id\": 1,\n \"similarityScoreThreshold\": 0.5,\n \"embeddingChunkSize\": 1024,\n \"embeddingChunkOverlap\": 128,\n \"temperatureLlm\": 0.7,\n \"basePrompt\": \"your prompt here\" \n}\n\nid (integer, required): The ID of the project whose settings are to be updated.
similarityScoreThreshold (float, required)
Description: This parameter sets the threshold for similarity scoring, which determines how similar a new input must be to existing data to be considered a match.
\nRange: Between 0 and 1.
\n0: Allows for a very loose match (high tolerance for differences).
\n1: Requires an exact match (no tolerance for differences).
\nUsage: Lower values are useful for broad matches, while higher values ensure strict similarity.
\nembeddingChunkSize (integer, required)
Description: This parameter defines the size of the text chunks used for creating embeddings.
\nRange: Between 512 and 4096.
\n512: Smaller chunks, resulting in more detailed embeddings but potentially higher computational cost.
\n4096: Larger chunks, which can capture more context in a single embedding but might lose some granularity.
\nUsage: Choose smaller sizes for tasks needing detailed text analysis, and larger sizes for capturing broader context.
\nembeddingChunkOverlap (integer, required)
Description: This parameter specifies the overlap size between consecutive text chunks when creating embeddings.
\nRange: Between 4 and 256.
\n4: Minimal overlap, reducing redundancy but possibly missing some context.
\n256: Maximum overlap, ensuring more context is preserved but increasing computational load.
\nUsage: Higher overlap values are useful for maintaining context continuity, while lower values reduce processing time.
\ntemperatureLlm (float, required)
Description: This parameter controls the randomness of the language model's output.
\nRange: Between 0.1 and 1.
\n0.1: Low temperature, making the output more deterministic and focused.
\n1: High temperature, making the output more random and creative.
\nUsage: Use lower temperatures for tasks requiring precision and consistency, and higher temperatures for creative and varied responses.
\nbasePrompt (string, required)
{\n \"status\": 200,\n \"payload\": \"Project settings updated successfully\"\n}\n\nstatus (integer): The HTTP status code.
payload (string): The success message.
DELETE /v1/projects/:projectId
This endpoint is used to delete a specific chat project by its UUID. Also to perform a delete you need x-api-key for Organisation
x-api-key (string, required): The API key to authenticate the request.projectId (UUID, required): The unique identifier of the project to be deleted.
{\n \"status\": 204,\n \"payload\": \"Project deleted successfully\"\n}\n\nstatus: The HTTP status code indicating that the operation was successful and no content is being returned.
\npayload: A confirmation message indicating that the project was deleted successfully.
\nConversationID got from Get All Conversations
\n","type":"text/plain"},"type":"any","value":"dffeb46a-30bf-4918-9c09-c02a8b025691","key":"conversationId"}]}},"response":[{"id":"52ac5b99-f151-4aae-8472-dbd39f6b8b65","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sferal.ai/v1/chat/conversation/:conversationId","host":["https://api.sferal.ai"],"path":["v1","chat","conversation",":conversationId"],"variable":[{"key":"conversationId","value":"a4a6193c-8ac6-4dfd-9fb2-9b8fdc4b4c37"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"273"},{"key":"ETag","value":"W/\"111-6E0AWkHoYmbz9s3+oMRAvI2SKxY\""},{"key":"Date","value":"Thu, 25 Jul 2024 07:52:51 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": \"e7130de4-8315-48be-aeaa-d30922f2068a\",\n \"content\": \"Salut! Comment puis-je vous aider aujourd'hui?\",\n \"createdAt\": \"2024-07-25T07:52:22.921Z\"\n },\n {\n \"id\": \"880adc7f-eefa-483e-bc17-62a1288160b7\",\n \"content\": \"salut\",\n \"createdAt\": \"2024-07-25T07:52:15.683Z\"\n }\n ]\n}"}],"_postman_id":"1577a176-0979-47f9-aaed-e58ea3403cfd"},{"name":"Create conversation","id":"bb18fa82-4513-4fd4-9492-feb649235227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"api\",\n \"projectId\": \"6a60cfb7-67c6-4ab4-b039-5daaaf2c1e13\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/chats/conversations/create","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","chats","conversations","create"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[{"id":"7ff2f7ab-f8d1-4dfb-be7b-014a772c3803","name":"200","originalRequest":{"method":"POST","header":[],"url":"https://api.sferal.ai/v1/chat/conversations/create"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"170"},{"key":"ETag","value":"W/\"aa-8zX2dqIEmTGVxulATOchzrokJXo\""},{"key":"Date","value":"Thu, 25 Jul 2024 07:58:31 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"payload\": {\n \"id\": \"74cdd1e0-3d82-46ff-b9ff-84e88518d53b\",\n \"name\": \"API-test\",\n \"dspyEnabled\": false,\n \"createdAt\": \"2024-07-25T07:58:31.545Z\",\n \"createdByUserId\": null\n }\n}"}],"_postman_id":"bb18fa82-4513-4fd4-9492-feb649235227"},{"name":"Message dpsy","id":"9b2fcd25-ac2d-4360-acb9-11fdb3612d68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"content\":\"ce parti sunt trecute in contract?\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/chats/conversations/:conversationId/message","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","chats","conversations",":conversationId","message"],"host":["https://api.sferal.ai"],"query":[],"variable":[{"type":"any","value":"conversationID","key":"conversationId"}]}},"response":[{"id":"701c89fc-c154-4108-9d59-d9a453a02000","name":"200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"content\":\"ce parti sunt trecute in contract?\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.sferal.ai/v1/chat/conversations/:conversationId/message","host":["https://api.sferal.ai"],"path":["v1","chat","conversations",":conversationId","message"],"variable":[{"key":"conversationId","value":"74cdd1e0-3d82-46ff-b9ff-84e88518d53b"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1057"},{"key":"ETag","value":"W/\"421-Gm2DYn7Rv+2VDhQ/DhPm0HyTT4M\""},{"key":"Date","value":"Thu, 25 Jul 2024 07:59:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"statusCode\": 201,\n \"message\": \"Messages created successfully\",\n \"data\": [\n {\n \"id\": \"c40ab991-9e19-4422-8f08-052e2ff26cd6\",\n \"content\": \"ce parti sunt trecute in contract?\"\n },\n {\n \"id\": \"095f1685-39e2-46ee-9147-af0f99e68404\",\n \"content\": \"Într-un contract tipic, părțile trecute sunt de obicei:\\n\\n1. Numele și datele de identificare ale părților implicate (de exemplu, numele complet, adresa, CNP-ul sau codul de identificare fiscală).\\n2. Obiectul contractului, adică descrierea detaliată a ceea ce se va realiza sau furniza.\\n3. Drepturile și obligațiile fiecărei părți.\\n4. Termenii și condițiile contractului, inclusiv durata acestuia.\\n5. Modalitățile de plată și termenele de plată.\\n6. Clauze de confidențialitate, dacă este cazul.\\n7. Clauze de reziliere și condițiile în care contractul poate fi încheiat înainte de termen.\\n8. Semnăturile părților implicate și data semnării contractului.\\n\\nAcestea sunt elementele de bază, dar un contract poate conține și alte clauze specifice în funcție de natura acordului.\"\n }\n ]\n}"}],"_postman_id":"9b2fcd25-ac2d-4360-acb9-11fdb3612d68"},{"name":"Message stream","event":[{"listen":"test","script":{"id":"3c3b83e5-eb41-4886-88d9-b19b0e82d23c","exec":["pm.test(\"Streaming Response\", function () {"," var response = pm.response.text();"," "," // Assuming the response is a JSON stream, parse it accordingly"," // This example assumes a JSON array stream, you need to adjust according to your actual response format"," var jsonResponse = [];"," try {"," jsonResponse = JSON.parse(response);"," } catch (e) {"," console.error(\"Failed to parse JSON\", e);"," }",""," // Process the response"," pm.expect(jsonResponse).to.be.an('array');"," jsonResponse.forEach(function (item) {"," console.log(\"Streamed item:\", item);"," });","});",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"40982519-498a-49fe-b0a6-91e0764e5f68","exec":[""],"type":"text/javascript","packages":{}}}],"id":"05a76caf-0fa1-4790-b8e4-e2cc4218094d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\n \"content\":\"salut, ce imformatii imi poti oferi?\"\n // \"projectId\": \"6dbfe8d7-e202-41f4-aa28-4ed6cff2cdd8\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/chats/conversations/:conversationId/message/stream","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","chats","conversations",":conversationId","message","stream"],"host":["https://api.sferal.ai"],"query":[],"variable":[{"type":"any","value":"66b18a46-e0ae-4766-b279-9ff73eb4dc84","key":"conversationId"}]}},"response":[{"id":"38c73a3e-2917-467f-b247-929e341fe2b9","name":"Message stream","originalRequest":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\n \"content\":\"salut\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.sferal.ai/v1/chat/conversations/:conversationId/message/stream","host":["https://api.sferal.ai"],"path":["v1","chat","conversations",":conversationId","message","stream"],"variable":[{"key":"conversationId","value":"502562bd-61b9-4e2a-8287-f8ddc3a9c701"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 27 May 2024 12:20:46 GMT"},{"key":"Content-Type","value":"text/event-stream"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Cache-Control","value":"no-cache"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=1AAKp2XFspYF3lHElT4%2FjH2AAEthhnoFx9j2qewfxixbdbXokOrmQA1HIpDD4oniaghZVbrpHveIo24d6HaPnowrdDC4sO%2BgJr9ams9Y6V%2BaDeNs%2FSMwp%2ByeonQGwMikMQSTyeTP9LHbJxNp\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/csp-reporting.cloudflare.com\\/cdn-cgi\\/script_monitor\\/report?m=PJQn_cWFnUUzfrAhVdlpqVMdc2tRMJclXzNX3DTukic-1716812446-1.0.1.1-pQY_EzK39Wb75bqYjT0M5jM3CZWxo.DvIS0EdOMEuNnuy7yud23UP.5RYcWyDv0czk0E3vSeBBB6h5d9fO7HJZkfUw4ASrGAY9606WgKnrbJMkQnD8DGH_.x_aPtOyzZFzoP0pmyYSLd3NMtW2XPK0S_7TywREtXoXAlpLvwMkk\"}],\"group\":\"cf-csp-endpoint\",\"max_age\":86400}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Content-Security-Policy-Report-Only","value":"script-src 'none'; connect-src 'none'; report-uri https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report?m=PJQn_cWFnUUzfrAhVdlpqVMdc2tRMJclXzNX3DTukic-1716812446-1.0.1.1-pQY_EzK39Wb75bqYjT0M5jM3CZWxo.DvIS0EdOMEuNnuy7yud23UP.5RYcWyDv0czk0E3vSeBBB6h5d9fO7HJZkfUw4ASrGAY9606WgKnrbJMkQnD8DGH_.x_aPtOyzZFzoP0pmyYSLd3NMtW2XPK0S_7TywREtXoXAlpLvwMkk; report-to cf-csp-endpoint"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"88a5f5fedb28625b-OTP"}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"Salut\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"!\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" Sp\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"une\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"-mi\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" te\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" rog\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" cum\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" te\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" pot\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\" aj\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"uta\"}]}\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"?\"}]}\n"},{"id":"fcb535df-32de-4969-86ec-bcac7ed92a44","name":"Message stream","originalRequest":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\n \"content\":\"salut, ce imformatii imi poti oferi?\",\n \"projectId\": \"6a60cfb7-67c6-4ab4-b039-5daaaf2c1e12\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.sferal.ai/v1/chats/conversations/:conversationId/message/stream","host":["https://api.sferal.ai"],"path":["v1","chats","conversations",":conversationId","message","stream"],"variable":[{"key":"conversationId","value":"b1e40251-110b-424b-a837-81bd0883b74d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Thu, 26 Sep 2024 13:13:41 GMT"},{"key":"Content-Type","value":"text/event-stream"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Cache-Control","value":"no-cache"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2BkGOmZSIHYbZhP0EH59J3xp%2BLwnYWBonED01vLIhSlIaoNVcdnhoW%2Fd6yvU%2FfT%2FGLwAgGU2%2Fugco7V4HQSf2vJqlIbVqfc2B%2BkqlI0sUBOZx1l3ccSCvckfZil%2FqABzy1Kl%2FqQ%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c938341689f70c6-OTP"}],"cookie":[],"responseTime":null,"body":"{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"Salut\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"!\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" Pot\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" să\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" î\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ți\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" ofer\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" informa\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ții\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" despre\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" o\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" gam\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ă\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" larg\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ă\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" de\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" sub\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"iect\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"e\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" inclus\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"iv\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" \"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ști\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"in\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ță\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" tehn\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ologie\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" ist\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"orie\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" cultur\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ă\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" săn\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ăt\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ate\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" și\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" multe\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" al\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"tele\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\".\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" Dacă\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" ai\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" o\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" între\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"bare\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" specific\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ă\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" sau\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" un\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" domen\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"iu\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" de\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" interes\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\",\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" te\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" rog\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" să\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" î\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"mi\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" sp\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ui\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" și\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" voi\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" înc\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"erca\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" să\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" î\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ți\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" ofer\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" cele\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" mai\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" bune\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" ră\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"sp\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"uns\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"uri\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\" pos\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"ibile\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\".\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"\"}]}\n{\"success\":true,\"statusCode\":200,\"message\":\"\",\"data\":[{\"id\":\"8f9f5da3-7445-460c-93eb-46a7bb8c820f\",\"role\":\"user\",\"context\":null,\"content\":\"salut, ce imformatii imi poti oferi?\"},{\"role\":\"assistant\",\"content\":\"\"}]}"}],"_postman_id":"05a76caf-0fa1-4790-b8e4-e2cc4218094d"},{"name":"Message no stream","event":[{"listen":"test","script":{"id":"3c3b83e5-eb41-4886-88d9-b19b0e82d23c","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"c48d8e8c-eb97-4513-ba03-153837dc87a9","exec":[""],"type":"text/javascript","packages":{}}}],"id":"0e9cbd3a-a5c9-4612-88af-b7016b5556d2","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\n \"content\":\"salut cat fac 2 plus 2?\",\n \"projectId\": \"9f9e83a0-329f-4e8d-9bad-3bbfe6cd2c87\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/chats/conversations/:conversationId/message/no-stream","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","chats","conversations",":conversationId","message","no-stream"],"host":["https://api.sferal.ai"],"query":[],"variable":[{"type":"any","value":"e5e079fb-d396-4f59-873a-9bcdeebd4ca0","key":"conversationId"}]}},"response":[{"id":"f42d6171-c3c6-4bf3-a454-6a3fecd57843","name":"200","originalRequest":{"method":"POST","header":[{"key":"","value":""}],"body":{"mode":"raw","raw":"{\n \"content\":\"salut cat fac 2 plus 2?\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.sferal.ai/v1/chat/conversations/:conversationId/message/no-stream","host":["https://api.sferal.ai"],"path":["v1","chat","conversations",":conversationId","message","no-stream"],"variable":[{"key":"conversationId","value":"74cdd1e0-3d82-46ff-b9ff-84e88518d53b"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"107"},{"key":"ETag","value":"W/\"6b-PTk9np4u1Z8vRAQQng0Dim9VQrA\""},{"key":"Date","value":"Thu, 25 Jul 2024 08:35:59 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"payload\": [\n {\n \"id\": \"04b84fd2-207f-4550-b7b4-ef49cdb4ae10\",\n \"content\": \"Salut! 2 plus 2 fac 4.\"\n }\n ]\n}"}],"_postman_id":"0e9cbd3a-a5c9-4612-88af-b7016b5556d2"},{"name":"Get message","id":"be9df4f7-c053-4ab1-a07f-30974a7ace3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/v1/chats/conversations/:conversationId/message/:messageId?projectId=7a81d338-f813-4aad-b7f0-e8129b3a9903","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","chats","conversations",":conversationId","message",":messageId"],"host":["https://api.sferal.ai"],"query":[{"key":"projectId","value":"7a81d338-f813-4aad-b7f0-e8129b3a9903"}],"variable":[{"type":"any","value":"15c68185-0479-4111-835d-5204411a314e","key":"conversationId"},{"type":"any","value":"3765bcf7-3ac0-4642-b164-3b43609a9015","key":"messageId"}]}},"response":[{"id":"524fcb77-bf31-4d96-94c0-02b2164dd4a2","name":"200","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sferal.ai/v1/chat/conversations/:conversationId/message/:messageId","host":["https://api.sferal.ai"],"path":["v1","chat","conversations",":conversationId","message",":messageId"],"variable":[{"key":"conversationId","value":"74cdd1e0-3d82-46ff-b9ff-84e88518d53b"},{"key":"messageId","value":"04b84fd2-207f-4550-b7b4-ef49cdb4ae10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"105"},{"key":"ETag","value":"W/\"69-0Ggxx7fft0Tutp5PdwBMZ47sTfs\""},{"key":"Date","value":"Thu, 25 Jul 2024 08:36:36 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": {\n \"id\": \"04b84fd2-207f-4550-b7b4-ef49cdb4ae10\",\n \"content\": \"Salut! 2 plus 2 fac 4.\"\n }\n}"}],"_postman_id":"be9df4f7-c053-4ab1-a07f-30974a7ace3c"},{"name":"Delete conversation","id":"27a1bf92-6cc2-45a5-8b10-d635ff182395","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.sferal.ai/v1/chats/conversation/:conversationId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","chats","conversation",":conversationId"],"host":["https://api.sferal.ai"],"query":[],"variable":[{"type":"any","value":"conversationID","key":"conversationId"}]}},"response":[{"id":"ccba29ce-ee4b-4b8e-a259-61d353b0a696","name":"204","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://api.sferal.ai/v1/chat/conversation/:conversationId","host":["https://api.sferal.ai"],"path":["v1","chat","conversation",":conversationId"],"variable":[{"key":"conversationId","value":"74cdd1e0-3d82-46ff-b9ff-84e88518d53b"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"1b-EmJKLoJbTyeq++/obsup6o3qAJE\""},{"key":"Date","value":"Thu, 25 Jul 2024 08:37:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"27a1bf92-6cc2-45a5-8b10-d635ff182395"}],"id":"20ffab49-7807-4c9c-8514-fc2195286471","description":"The Project Chat API provides endpoints for managing conversations and messages within a project. The API uses Express and Dayjs for date handling, and verifies API keys for authentication. Below are the available endpoints and their details.
\nGET /v1/chats/conversationsFetches all conversations within the specified date range.
\nHeaders:
\nx-api-key (string): API key for authentication.Query Parameters:
\nlimit (integer, optional): Number of conversations to return (default is 100).
offset (integer, optional): Offset for pagination (default is 0).
start (string, optional): Start date in ISO format (default is one month ago).
end (string, optional): End date in ISO format (default is current date).
Responses:
\n{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": \"502562bd-61b9-4e2a-8287-f8ddc3a9c701\",\n \"modelLlmDefault\": null,\n \"createdAt\": \"2024-05-27T11:29:57.367Z\",\n \"messages\": [\n {\n \"id\": \"87477574-5221-446b-9b69-fd4eff07c4a4\",\n \"role\": \"ASSISTANT\",\n \"context\": \"\",\n \"content\": \"Hello! How can I assist you today?\",\n \"modelLlm\": \"gpt_4\",\n \"createdAt\": \"2024-05-27T11:29:58.884Z\"\n }\n ],\n \"_count\": {\n \"messages\": 2\n }\n }\n ]\n}\n\nGET /v1/chats/conversations/:conversationIdFetches a specific conversation by its ID.
\nHeaders:
\nx-api-key (string): API key for authentication.Query Parameters:
\nlimit (integer, optional): Number of messages to return (default is 100).
offset (integer, optional): Offset for pagination (default is 0).
Responses:
\n{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": \"4c03ac21-496e-475c-9caf-4e69e6f04493\",\n \"role\": \"ASSISTANT\",\n \"context\": \"\",\n \"content\": \"Salut! Cum te pot ajuta astăzi?\",\n \"modelLlm\": \"gpt_4\",\n \"createdAt\": \"2024-05-28T09:52:31.756Z\"\n }\n ]\n}\n\nDELETE /v1/chats/conversations/:conversationIdSoft deletes a conversation by its ID.
\nHeaders:
\nx-api-key (string): API key for authentication.Responses:
\n204 No Content: Conversation deleted successfully.GET /v1/chats/conversations/:conversationId/messages/:messageIdFetches a specific message by its ID within a conversation.
\nHeaders:
\nx-api-key (string): API key for authentication.Responses:
\n{\n \"status\": 200,\n \"payload\": {\n \"id\": \"2b82af55-ac20-499a-92f9-a883a99d6d6d\",\n \"role\": \"ASSISTANT\",\n \"context\": \"\",\n \"content\": \"Salut! Cum te pot ajuta astăzi?\",\n \"modelLlm\": \"gpt_4\"\n }\n}\n\nPOST /v1/chats/conversationsCreates a new conversation.
\nHeaders:
\nx-api-key (string): API key for authentication.Body Parameters:
\nIf you came with the organisation x-api-key , you need to provide the projectId
{\n \"name\": \"api\",\n \"projectId\": \"6a60cfb7-67c6-4ab4-b039-5daaaf2c1e12\"\n}\n\nelse if you came with project x-api-key :
{\n \"name\": \"api\"\n}\n\nResponses:
\n{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": \"a4a6193c-8ac6-4dfd-9fb2-9b8fdc4b4c37\",\n \"name\": \"nea ion - salut\",\n \"createdAt\": \"2024-07-25T07:52:15.331Z\",\n \"createdByUserId\": \"941f7b83-f35c-4255-8c17-d9211e6f64a2\",\n \"messages\": [\n {\n \"id\": \"e7130de4-8315-48be-aeaa-d30922f2068a\",\n \"content\": \"Salut! Comment puis-je vous aider aujourd'hui?\",\n \"createdAt\": \"2024-07-25T07:52:22.921Z\"\n }\n ],\n \"_count\": {\n \"messages\": 2\n }\n }\n ]\n}\n\nPOST /v1/chats/conversations/:conversationId/messagesCreates a new message within a conversation.
\nHeaders:
\nx-api-key (string): API key for authentication.Body Parameters:
\n{\n \"content\":\"Salut\"\n}\n\nResponses:
\n{\n \"status\": 201,\n \"payload\": [\n {\n \"id\": \"be9d5971-18a0-455c-beb8-5d02d283b2d9\",\n \"role\": \"USER\",\n \"context\": null,\n \"content\": \"Salut\",\n \"modelLlm\": \"gpt_4\"\n },\n {\n \"id\": \"b36bf14b-b1c3-469a-a902-e4dfa3fc2e24\",\n \"role\": \"ASSISTANT\",\n \"context\": \"\",\n \"content\": \"Desigur, te pot ajuta cu plăcere! Îmi poți oferi mai multe detalii despre ce anume dorești să afli? Astfel, îți voi putea oferi informații mai precise și utile.\",\n \"modelLlm\": \"gpt_4\"\n }\n ]\n}\n\n500 Internal Server Error: An error occurred while creating the message.POST /v1/chats/conversations/:conversationId/messages/streamCreates a new message within a conversation.
\nHeaders:
\nx-api-key (string): API key for authentication.Body Parameters:
\n{\n \"content\":\"Salut\"\n}\n\nResponses:
\n{\"status\":201,\"payload\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"Salut\"}]}\n\n500 Internal Server Error: An error occurred while creating thHttpErrorBase: Base class for HTTP errors.
InternalServerError: Represents an internal server error.
When an error occurs, the API will return an appropriate HTTP status code along with a message indicating the error.
\nEnsure to include the x-api-key header in all requests for authentication.
Handle pagination using the limit and offset parameters to manage large data sets effectively.
Use ISO format for date parameters to ensure consistency.
\nPOST /v1/chats/conversations/:conversationId/messages/no-streamCreates a new message within a conversation.
\nHeaders:
\nx-api-key (string): API key for authentication.Body Parameters:
\n{\n \"content\":\"Salut\"\n}\n\nResponses:
\n{\"success\":true,\"statusCode\":201,\"message\":\"Messages created successfully\",\"data\":[{\"id\":\"4cab6c11-46e9-4283-97a4-843f46bd167d\",\"role\":\"USER\",\"context\":null,\"content\":\"salut\",\"modelLlm\":\"gpt_4\"},{\"content\":\"Salut\"}]}\n\nEnsure to include the x-api-key header in all requests for authentication.
Handle pagination using the limit and offset parameters to manage large data sets effectively.
Use ISO format for date parameters to ensure consistency.
\nOPTIONAL
\n","type":"text/plain"},"key":"name","value":"te"},{"description":{"content":"OPTIONAL
\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"OPTIONAL
\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"2b447758-0cff-4678-b633-c7102b1c27d4"},{"name":"update tag","id":"bb98f761-79d8-4caf-a803-ac037468fd8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"test3\",\n \"description\":\"tete\",\n \"color\":\"tete\",\n \"sourceTagCategoryId\": \"1\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources/tag/1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","tag","1"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb98f761-79d8-4caf-a803-ac037468fd8d"},{"name":"add tag sources","id":"1cb00087-29b7-40ca-a868-57fd2b6265d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"sourceIds\":[142],\n \"sourceTagIds\":[2]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources/add-tag","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","add-tag"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"1cb00087-29b7-40ca-a868-57fd2b6265d7"},{"name":"create tag","id":"fa0a5a85-eeea-4c37-87d8-849c42a27102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"test\",\n \"description\":\"test\",\n \"color\":\"red\"\n // \"sourceTagCategoryId\": 6 //optional\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources/tag","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","tag"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa0a5a85-eeea-4c37-87d8-849c42a27102"},{"name":"delete tag","id":"4a708b74-df4f-4eb6-b424-ad7c9e470304","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.sferal.ai/v1/sources/tag/10","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","tag","10"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a708b74-df4f-4eb6-b424-ad7c9e470304"},{"name":"remove tag source","id":"9af57653-11b4-4ede-a7a9-edf458e23871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"sourceId\": 0,\n \"sourceTagId\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources/delete-tag","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","delete-tag"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"9af57653-11b4-4ede-a7a9-edf458e23871"}],"id":"d60edf17-b9bf-4168-9df0-190bfa42b37e","_postman_id":"d60edf17-b9bf-4168-9df0-190bfa42b37e","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}}},{"name":"List all sources","id":"a4931071-dba4-453e-a0a5-57d78887e0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/v1/sources","description":"limit < 100
\noffset > 0
\ntype constants.SourceTypes(audio_video_file,audio_video_link,document_file,link_web,text,text_embedding,audio_call)
\nsubType constants.SourceSubTypes(audio_video_link->channel,video | document_file->.pdf,.docx,.txt)
\nnameFilter
\nrootId
\nstatus: \"pending\" | \"completed\" | \"error\" | \"completed_with_errors\"
\nstatusNegated: true/false
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources"],"host":["https://api.sferal.ai"],"query":[{"disabled":true,"key":"limit","value":"100"},{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"key":"flat","value":"true"},{"disabled":true,"key":"type","value":"audio_video_link"},{"disabled":true,"key":"subType","value":"video"},{"disabled":true,"key":"nameFilter","value":"bu"},{"disabled":true,"key":"rootId","value":"142"},{"disabled":true,"key":"status","value":"completed, pending"},{"disabled":true,"key":"statusNegated","value":"true"},{"disabled":true,"key":"metadata[name]","value":"andu"}],"variable":[]}},"response":[{"id":"ae6a61e1-eea9-4314-8d4e-39fa7d89d004","name":"List all sources","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sferal.ai/v1/sources?limit=1&offset=0","host":["https://api.sferal.ai"],"path":["v1","sources"],"query":[{"key":"limit","value":"1"},{"key":"offset","value":"0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Nov 2024 06:59:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"296-/hnXrHu/6xCNaEsdlZr2nTzGeDs\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=svdzpaNPzJaj8fRTtCvuLwUtL8dsrgGFuELANLaRe8lZbwa5ePeu7iN%2FHrh05xP4LFQ3goBEWg1Kmx%2FuptH66hpU%2BA5natcEAk54zNJbhH2vVSmzt2G46Tep%2BRNuWijlmLj6Wg%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e1ce1658879c9d1-OTP"},{"key":"Content-Encoding","value":"br"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=18950&sent=159&recv=159&lost=0&retrans=0&sent_bytes=13725&recv_bytes=3875&delivery_rate=417225&cwnd=256&unsent_bytes=0&cid=e9785a1b29cbced1&ts=143348&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": {\n \"sources\": [\n {\n \"id\": 1732,\n \"name\": \"esp32-s3-wroom-1_wroom-1u_datasheet_en.pdf\",\n \"content\": \"http://backend.foundationx.ai/v2/uploads/uploads/6df0a8d95085d3456f543a7d93546e36\",\n \"type\": \"document_file\",\n \"subType\": null,\n \"status\": \"completed_with_errors\",\n \"sizeFile\": 1240353,\n \"sizeLength\": 0,\n \"sizeCountLinks\": 0,\n \"sizeCountDocuments\": 38,\n \"origin\": null,\n \"parentId\": null,\n \"rootId\": 1732,\n \"projects\": [\n {\n \"status\": \"completed\",\n \"project\": {\n \"id\": \"5268fc98-aed1-495c-bc17-c11d775ceb29\",\n \"name\": \"ESP32 S3\"\n }\n }\n ],\n \"parent\": null,\n \"sourceTags\": [],\n \"createdAt\": \"2024-09-20T11:35:01.322Z\",\n \"updatedAt\": \"2024-09-20T11:35:07.628Z\",\n \"teams\": [],\n \"scopes\": [\n \"read\",\n \"write\",\n \"delete\"\n ]\n }\n ],\n \"count\": 1\n }\n}"}],"_postman_id":"a4931071-dba4-453e-a0a5-57d78887e0ec"},{"name":"Get status sources","id":"117a4459-b1b3-4165-8baf-8c056046467f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sourceIds\":[142]\n // \"projectId\": \"6573f788-2b2a-49a1-9106-b765b645646e\" //optional\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources/status","description":"projectId - can be from api-key or from body or not at all (if not at all then it will look at organisations sources)
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","status"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[{"id":"94c48914-ea2d-4d52-83b2-e400e0d4bcfb","name":"Get status sources","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sourceIds\":[1732]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Nov 2024 07:00:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"17a-tc+K8BRgqyaBNZFxOcd0ZtUMJsI\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=TCjvOUqSqqIkkgf1%2BWNMKdroKOCI9hU%2BXQf%2BDAnENDeGujFQsW%2FHgSWfG7ONte0jn3Y9Mrul5XZI3qNpRcsgQktw8lSOQn4nJxUg6ARlu1SLLUsEKabi6g8RnZYTZzxTQIcvMA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e1ce27e3ad2c9d1-OTP"},{"key":"Content-Encoding","value":"br"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=19297&sent=206&recv=206&lost=0&retrans=0&sent_bytes=15813&recv_bytes=4303&delivery_rate=417225&cwnd=256&unsent_bytes=0&cid=e9785a1b29cbced1&ts=188251&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": 1732,\n \"name\": \"esp32-s3-wroom-1_wroom-1u_datasheet_en.pdf\",\n \"content\": \"http://backend.foundationx.ai/v2/uploads/uploads/6df0a8d95085d3456f543a7d93546e36\",\n \"type\": \"document_file\",\n \"text\": null,\n \"status\": \"completed_with_errors\",\n \"projects\": [\n {\n \"status\": \"completed\",\n \"project\": {\n \"id\": \"5268fc98-aed1-495c-bc17-c11d775ceb29\",\n \"name\": \"ESP32 S3\"\n }\n }\n ],\n \"sourceTags\": []\n }\n ]\n}"}],"_postman_id":"117a4459-b1b3-4165-8baf-8c056046467f"},{"name":"Save sources to Organisation","id":"c3ab6ee1-a574-4ccd-b001-aa6e684378ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"fx-xxxx"}],"body":{"mode":"raw","raw":"{\n \"sources\": [\n {\n \"name\": \"https://www.acasa.ro\",\n \"type\": \"link_web\",\n \"downloadDocuments\": false,\n \"maxDepth\": 0,\n \"keepOriginalHtml\" : true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/sources","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[{"id":"4e250781-ca3f-49a6-b7f9-053798bcf6dd","name":"201","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"fx-xxxx"}],"body":{"mode":"raw","raw":"{{body}}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/organisation/sources"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"226"},{"key":"ETag","value":"W/\"e2-Vz+ED/zFjEmpdxpI5BWEy2KxL/c\""},{"key":"Date","value":"Thu, 25 Jul 2024 08:40:05 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"payload\": [\n {\n \"name\": \"https://foundationx.ai\",\n \"type\": \"link_web\",\n \"content\": \"https://foundationx.ai\",\n \"organisationId\": \"1772c4ac-ba8c-4a4f-b427-5926d808ebc9\",\n \"createdByUserId\": \"941f7b83-f35c-4255-8c17-d9211e6f64a2\"\n }\n ]\n}"}],"_postman_id":"c3ab6ee1-a574-4ccd-b001-aa6e684378ff"},{"name":"Get text from source","id":"f8984f58-14ce-4620-8477-6c24e0442566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/v1/sources/text/:sourceId","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","sources","text",":sourceId"],"host":["https://api.sferal.ai"],"query":[],"variable":[{"type":"any","value":"142","key":"sourceId"}]}},"response":[{"id":"783dbed5-7601-4c6a-a6a6-38f5a37ac01a","name":"Get text from source","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.sferal.ai/v1/sources/text/:sourceId","host":["https://api.sferal.ai"],"path":["v1","sources","text",":sourceId"],"variable":[{"key":"sourceId","value":"1733"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 13 Nov 2024 09:11:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-XSS-Protection","value":"0"},{"key":"RateLimit-Policy","value":"50;w=1"},{"key":"RateLimit-Limit","value":"50"},{"key":"RateLimit-Remaining","value":"49"},{"key":"RateLimit-Reset","value":"1"},{"key":"ETag","value":"W/\"313-oB6KGNRWppQhlyYwol+BOfj3fXE\""},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=aEDlGdOf1BQy35EQFNgstqLA1GXkgu4vmpgw0NaBUpB7BT1BPNyJ%2BUezvshKAs%2FE0mtNywmm6d1o7%2FT8Qa9z5uy0dzxPcNXIOh9y30x4aenWBEkzsHvF8OpTcBppoc%2Fof6B2dw%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8e1da1f5ecc3e3e1-OTP"},{"key":"Content-Encoding","value":"br"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=14563&sent=4&recv=5&lost=0&retrans=0&sent_bytes=2817&recv_bytes=933&delivery_rate=146373&cwnd=249&unsent_bytes=0&cid=6f3e85f6ed5b1cdc&ts=69&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"payload\": {\n \"id\": 1733,\n \"name\": \"esp32-s3-wroom-1_wroom-1u_datasheet_en.pdf\",\n \"content\": \"http://backend.foundationx.ai/v2/uploads/uploads/6df0a8d95085d3456f543a7d93546e36\",\n \"type\": \"document_file\",\n \"status\": \"completed\",\n \"text\": \"# ESP32-S3-WROOM-1 ESP32-S3-WROOM-1U\\n## Datasheet\\n\\n2.4 GHz Wi-Fi (802.11 b/g/n) and Bluetooth[®] 5 (LE) module\\n\\nBuilt around ESP32-S3 series of SoCs, Xtensa[®] dual-core 32-bit LX7 microprocessor\\n\\nFlash up to 16 MB, PSRAM up to 16 MB\\n\\nUp to 36 GPIOs, rich set of peripherals\\n\\nOn-board PCB antenna or external antenna connector\\n\\nESP32-S3-WROOM-1 ESP32-S3-WROOM-1U\\n\\nVersion 1.3\\n\\nEspressif Systems\\n\\nCopyright © 2023\\n\\n\\n-----\\n\\n\"\n }\n}"}],"_postman_id":"f8984f58-14ce-4620-8477-6c24e0442566"},{"name":"Save file to Organisation","id":"f54594e1-d51c-41f5-9da7-37e637df0e44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"fx-xxxx"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"postman-cloud:///1ef59368-dd75-4420-836c-6e8f1dd3cf7d"},{"key":"metadata","value":"{\"key\":\"value\"}","type":"text"},{"key":"callback","value":"GET /v1/sources
This endpoint allows clients to fetch and filter sources based on various parameters. The response will include a list of sources and a count of the total number of sources that match the filter criteria.
\n{\n \"status\": 200,\n \"payload\": [\n {\n \"id\": 11,\n \"name\": \"AlienTuning.ro – Chip Tuning | Engine Remapping | ECU Programming | DPF Solution\",\n \"content\": \"https://www.alientuning.ro\",\n \"type\": \"link_web\",\n \"subType\": null,\n \"status\": \"completed\",\n \"sizeFile\": 0,\n \"sizeLength\": 0,\n \"sizeCountLinks\": 0,\n \"sizeCountDocuments\": 0,\n \"origin\": null,\n \"parentId\": 10,\n \"rootId\": 10,\n \"projects\": [],\n \"parent\": {\n \"name\": \"https://www.alientuning.ro\"\n },\n \"createdAt\": \"2024-06-27T10:38:54.707Z\",\n \"updatedAt\": \"2024-06-27T10:38:54.707Z\"\n }\n ],\n \"count\": 1\n}\n\nlimit: Controls the number of sources returned in the response. Use this to paginate results. If not specified, defaults to 100.
\noffset: Helps in paginating the results by specifying the starting point in the collection of sources. Default is 0.
\ntype: Filters sources by their type. Only sources of the specified type will be returned.
\nsubType: Further refines the type filter by specifying the subtype of the source.
\nnameFilter: Searches for sources by their name. Useful for finding specific sources by a keyword in their name.
\nflat: When set to true, the response will include all sources and their children.
\nrootId: Filters the sources to return only those that are children of the specified root source.
\nstatus: Allows filtering sources by their status. Multiple statuses can be specified as a comma-separated list.
\nstatusNegated: If set to true, the status filter will exclude sources with the specified statuses.
\nAll parameters are optional. If not specified, default values will be used.
\nThe status parameter can take multiple values separated by commas.
POST /v1/sources
This endpoint is used for adding multiple sources to the organisation. It accepts a list of sources, each with its unique properties such as name, content URL, and type. The request must include an API key for authentication and the content type should be set to application/json.
x-api-key: - This header is used for API authentication.
\nContent-Type: application/json - Specifies the media type of the resource.
{\n \"sources\": [\n {\n \"name\": \"https://www.termene.ro\",\n \"type\": \"link_web\"\n },\n {\n \"name\": \"https://www.youtube.com/watch?v=r8y0RnNymOo&list=RDCMUCNO8Lmy6s5ibqudOZ6vjNLA&start_radio=1&ab_channel=ChillVibesClub\",\n \"type\": \"audio_video_link\"\n }\n ]\n}\n\nname: This key holds the actual source data. Depending on the type, this can be a URL or raw text.
type: This key defines the method of processing the source data. Supported types are link_web, audio_video_link.
link_web
\nDescription: This type is used for web URLs.
\nProcessing Method: FoundationX will perform web scraping on the URL provided in the name key.
Example:
\n{ \"name\": \"https://www.termene.ro\", \"type\": \"link_web\"}\n\naudio_video_link
\nDescription: This type is used for audio or video URLs.
\nProcessing Method: FoundationX will use Whisper to extract the text from the audio or video link provided in the name key.
Example:
\n{ \"name\": \"https://www.youtube.com/watch?v=r8y0RnNymOo&list=RDCMUCNO8Lmy6s5ibqudOZ6vjNLA&start_radio=1&ab_channel=ChillVibesClub\", \"type\": \"audio_video_link\"}\n\nThis request is typically used when users need to register new content sources for a project. The body of the request specifies each source’s details, enabling the API to process and store them appropriately.
\nGET /v1/sources/text/:sourceId
This endpoint allows clients to fetch the text content of a specific source by its ID. The client must provide a valid API key in the request headers.
\n{\n \"status\": 200,\n \"payload\": {\n \"id\": 123,\n \"name\": \"Example Source\",\n \"type\": \"document_file\",\n \"subType\": \".pdf\",\n \"content\": \"This is the text content of the source.\"\n }\n}\n\nx-api-key: The API key required for authorization. Must be included in the request headers.
\nsourceId: The ID of the source whose text content is to be fetched. Must be included in the URL path.
\nEnsure to provide a valid API key in the request headers. The key will be used to verify the client’s authorization to access the endpoint.
\nThe sourceId parameter in the URL path specifies the source to be fetched.
If the source is not found, the endpoint will return a 404 Not Found status with an appropriate error message.
In case of any errors during the process, a 400 Bad Request status code will be returned with the error message.
POST /v1/sources/upload
This endpoint facilitates the uploading of files to a organisation's resource pool. It supports file uploads along with metadata about the file and an option to specify whether the file should be embedded directly within the project database or referenced externally.
\nfile: Path to the file on the user’s device (e.g., /Users/username/Downloads/file.pdf). The user selects the file through the Postman interface.
metadata: JSON string containing additional metadata about the file.
\ncallback: URL where API can you call when file is ready
\n{ \"sourceId\":1234, \"status\": \"complete\", \"text\":\"text\"}Use this endpoint when you need to upload documents or other files related to a specific organisation. The metadata can include details like the file’s origin, its intended use, or any other relevant information that helps manage the file within the project.
\nPOST /v1/sources/link
This can be done only with an x-api-key generated in the projects api keys.
\nThis endpoint is used for link sources to a project. It accepts an id of source. The request must include an API key for authentication and the content type should be set to application/json.
x-api-key: - This header is used for API authentication.
\nContent-Type: application/json - Specifies the media type of the resource.
{\n \"sourceIds\": [1,2,3,4]\n}\n\n{\n \"status\": 200,\n \"payload\": \"Sources will be linked to project, the embedding process started\"\n}\n\nThis request is typically used when users need to register new content sources for a project. The body of the request specifies each source’s details, enabling the API to process and store them appropriately.
\n","_postman_id":"f6ba0af5-c2d2-4a6e-bcc1-692693d94682","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}}},{"name":"NER","item":[{"name":"List workflows","id":"b7f19167-12a6-4fef-a3d9-44ab2e7d4a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/v1/ner/list-workflows?limit=10&offset=0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","ner","list-workflows"],"host":["https://api.sferal.ai"],"query":[{"disabled":true,"key":"model","value":""},{"disabled":true,"key":"type","value":null},{"key":"limit","value":"10"},{"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"b7f19167-12a6-4fef-a3d9-44ab2e7d4a71"},{"name":"List workflow runs","id":"d332b8a3-87cf-40dd-911d-877b5839ec3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/v1/ner/list-workflow-runs?workflowId=8&limit=10&offset=0","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","ner","list-workflow-runs"],"host":["https://api.sferal.ai"],"query":[{"key":"workflowId","value":"8"},{"key":"limit","value":"10"},{"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"d332b8a3-87cf-40dd-911d-877b5839ec3f"},{"name":"Results","id":"becdd57c-d0ad-4e7d-9aad-c8bcd50f65d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.sferal.ai/v1/ner/results?workflowId=8&workflowRunId=24&exportBy=sources","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","ner","results"],"host":["https://api.sferal.ai"],"query":[{"key":"workflowId","value":"8"},{"key":"workflowRunId","value":"24"},{"description":{"content":"sources
\n","type":"text/plain"},"key":"exportBy","value":"sources"}],"variable":[]}},"response":[],"_postman_id":"becdd57c-d0ad-4e7d-9aad-c8bcd50f65d0"},{"name":"Create workflow preview","id":"afda5cd2-af87-4b45-9061-1ca79cf004e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sources\":[1022],\n \"workflowId\":8\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/ner/create-workflow-preview","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","ner","create-workflow-preview"],"host":["https://api.sferal.ai"],"query":[{"disabled":true,"key":"workflowId","value":"8"}],"variable":[]}},"response":[],"_postman_id":"afda5cd2-af87-4b45-9061-1ca79cf004e7"},{"name":"Run workflow","id":"de877029-2158-43d3-9b66-7e829ddb8cb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"resetResults\":false,\n \"workflowId\":8,\n \"workflowRunId\":24\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sferal.ai/v1/ner/run-workflow","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"fx-xxxx"}]},"isInherited":true,"source":{"_postman_id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","id":"4f86d1d7-e2e7-4669-a21e-db9065f56fa8","name":"API documentation","type":"collection"}},"urlObject":{"path":["v1","ner","run-workflow"],"host":["https://api.sferal.ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"de877029-2158-43d3-9b66-7e829ddb8cb6"}],"id":"f2934fbc-ffc2-453c-8f00-4edf6208aef0","description":"This documentation covers the endpoints related to NER workflows and their executions.
\nAll endpoints are prefixed with https://api.sferal.ai
GET /v1/ner/list-workflows
Retrieves a paginated list of NER workflows.
\nQuery Parameters:
\nlimit (optional): Number of items per page. Default: 10
offset (optional): Pagination offset. Default: 0
model (optional): Filter by model
type (optional): Filter by type
Example Request:
\nGET /v1/ner/list-workflows?limit=10&offset=0
GET /v1/ner/list-workflow-runs
Retrieves a paginated list of execution runs for a specific workflow.
\nQuery Parameters:
\nworkflowId (required): ID of the workflow
limit (optional): Number of items per page. Default: 10
offset (optional): Pagination offset. Default: 0
Example Request:****GET /v1/ner/list-workflow-runs?workflowId=8&limit=10&offset=0
GET /v1/ner/results
Retrieves the results of a specific workflow run.
\nQuery Parameters:
\nworkflowId (required): ID of the workflow
workflowRunId (required): ID of the workflow run
exportBy (required): Export format, e.g., \"sources\"
Example Request:****GET /v1/ner/results?workflowId=8&workflowRunId=24&exportBy=sources
POST /v1/ner/create-workflow-preview
Creates a preview for a workflow execution.
\nRequest Body:
\n{\n \"sources\": [1022],\n \"workflowId\": 8\n}\n\nPOST /v1/ner/run-workflow
Executes a workflow with specified parameters.
\nRequest Body:
\n{\n \"resetResults\": false,\n \"workflowId\": 8,\n \"workflowRunId\": 24\n}\n\nParameters:
\nresetResults: Boolean flag to reset previous results
workflowId: ID of the workflow to execute
workflowRunId: ID of the workflow run
List available workflows using GET /list-workflows
Create a preview for specific sources using POST /create-workflow-preview
Execute the workflow using POST /run-workflow
Monitor execution status using GET /list-workflow-runs
Retrieve results using GET /results