ChatScopeAI has an API service to accommodate integration with our regulatory database from all jurisdictions. Our main regulatory data on API service can be divided into two categories, including Regulations and Legislations. These data are useful for businesses and professionals to understand and track the dynamic regulatory changes to maintain compliance.
Before starting with the ChatScopeAI public API documentation, users may need to see what regulatory data is covered in our database and all API endpoints. We will explain the details of the public API documentation that is useful for users to comprehend the exact data needed before requesting and retrieving data using the API.
Regulations
Regulation is one of the categories on the ChatScopeAI API service. This is the main feature of ChatScopeAI to track and get the relevant answers from the official regulatory sources according to the chosen jurisdictions. This API category includes regulation lists, chat responses, and regulation analysis.
Regulation Lists
Regulation lists are the first API endpoint in this category. As the name suggests, it allows users to find the preview list of the related regulation they are searching for. This API endpoint response only displays the simple lists of the regulatory data with no analysis or no chat answers from AI.
The query parameter for Regulation Lists comprises country, limit, and query. Query is a mandatory parameter, while limit and country are optional parameters. However, to get a better response, we suggest users provide at least a query or regulations and the country or jurisdictions.
Regulation Lists on the API are exactly the same as the Regulation Lists feature on our app. This is an example of the listed regulation on immigration in Germany. Users will get insights from the AI summary and be able to access the link to redirect to the official German government website.
Chat Response
Chat Response is the second API endpoint in this category that provides the answer from the AI Chatbot. Unlike the regulation list, this is considered the main service from our API that answers based on the regulations users are searching for. Using this API is similar to using AI Legal Chatbot on the ChatScopeAI app.
To get a response in this endpoint, users need to fill the query parameters, particularly the mandatory parameter. Similar to the Regulation List, users need only fill in the query parameter to search for specific regulations. In addition, country, stream, and sources are optional parameters, but for a better response, users need to fill in all that are suitable for their needs.
Chat Response will give the answer that exactly matches the Legal Chatbot on the ChatScopeAI app. This will make it easier to get the summary from the relevant regulations users are looking for, but the difference only in the format; if users use the API, the response will be in JSON format.
Regulation Analysis
Regulation Analysis is on par with Chat Response as one of the main endpoints on the ChatScopeAI API service. As the name implies, this response is an analysis of specific regulations users are looking for. Thus, to get a better response for AI summary, the latest updates, and related regulations on specific jurisdictions.
Different from the previous API endpoint, it only requires one query parameter of regulation identification, also called uuid. Therefore, before using this API endpoint, users need to retrieve data from Chat Response or Regulations Lists to know the UUID. If the UUID is found, just paste it directly into the query parameter, and it will respond within a minute.
Regulation analysis can also be found on the ChatScopeAI app. Unlike the API service, regulation analysis on the app is located within the Legal Chatbot and is mentioned while users are searching for some of the regulations, for example, “What is the latest data privacy regulation in the European Union?” Check the analysis below.
Legislations API
Legislation is the law that is enacted by the legislative body in a country to preserve justice for the public. This API category is made to help businesses and professionals who need assistance to get instant legislation based on specific jurisdictions. In this category, there are only two API endpoints, including Search Legislations and Download Legislation File.
Search Legislations
Search legislation is the main API endpoint in this category. This endpoint allows users to search and retrieve data about the acts and statutes from legislation in certain jurisdictions instantly. By using search legislation, users will get the legislation title, the related text, and a concise AI summary of all of the legislation.
To request this API, users must fill in the mandatory parameter, query, for example, data privacy. There is only one mandatory query parameter in this API endpoint to retrieve legislation data, and there are other optional parameters, including country, fast, and limit. However, we recommend that users fill in the country to get a better response to specific legislation and make it easy to filter.
Search legislation in the API service is the same as the Legislation Search on the ChatScopeAI app. If users are considering using the app, this is an example of the same response for data privacy in the European Union.
Download Legislation File
The last endpoint in the Legislations API is Download Legislation File. It is an API endpoint that is used solely for verifying and checking the official legislation documents. Not only use our API to retrieve data from our database, users can use our API to download certain legislation documents users are looking for effortlessly.
Unlike other endpoints, Download Legislation File does not require an API token to download legislation documents. Just type the legislation URL, and users will get the document users needed right away. Also, there is only one parameter in this endpoint, namely id, as an identification from the response of selected legislation on the previous endpoint.
Download Legislation File is also available on ChatScopeAI. By clicking the action on the Legislation Search, users will be redirected to the official source of the legislation. This is useful to ensure that users recheck the provided information on the ChatScopeAI app. However, you do not need to worry, as all information stored in our database is based solely on verified documents.
Public API documentation is only an early journey to get to know more about our API service. Our API service might be an option for future collaboration to help you expand your business by getting all regulatory data quickly. If you like to try our API endpoints, it is time to visit our API documentation through this link: https://jureem.stoplight.io/docs/chatscopeai-1/8dxcjoq7dopo8-chat-scope-ai-api-documentation