🌴
Guardian
  • Guardian
    • 🌏Getting Started
      • 🏜️Discovering Environmental assets on Hedera
      • 🎓Guardian Glossary
      • 📖Installation Guide
        • 🗒️Prerequisites
        • 🛠️Installation
          • 🔨Building from source and run using Docker
            • Deploying Guardian using default Environment
            • Deploying Guardian using a specific Environment ( DEVELOP )
            • Deploying Guardian using a specific Environment (QA)
          • 🔨Building from Pre-build containers
          • 🔨Build executables and run manually
          • ☁️Cloud Deployment
          • ⬆️Upgrading
          • 🔙Backup tools
          • 🏡Setting up environment parameters
          • 📁Summary of URLs and Ports
          • 💻Launching Guardian
          • 🧪How to perform Unit Tests?
        • 🔨How to Configure Hedera Local Node
        • 🔨How to Configure HashiCorp Vault
        • 🔨How to create Operator ID and Operator Key
        • 🔨How to generate Web3.Storage API values
        • 🔨How to Change Explorer URL
        • 🔨How to Restore Account from Database/Hashicorp Vault during Setup
      • 🙏Contributing
        • 🚇Contribute a New Policy
      • 📖Frameworks/Libraries
        • 💻Guardian CLI
      • ⚙️API Guideline
      • 🔐Guardian Vault
      • 🌎Environments
        • 🌎Multi session consistency according to Environment
        • 🔑Dynamic Vault/KMS path configuration according to the environment
        • 🏡Ecosystem Environments
      • 📃Change Log
      • 🛣️Roadmap
      • 🚨License
      • 📞Contact
      • 🔐Security
      • 🔑Meeco authentication
        • 🔡How it works
    • 👷Architecture
      • ⬇️Deep Dive Architecture
      • 🔺High Level Architecture
      • 👏Policies,Projects and Topics Mapping Architecture
      • ➗MRV Splitting Logic
      • 🔑Internal (with Vault)Signing Sequence Diagram
      • 🔥FireBlocks Signing Sequence Diagram
    • 📇Global Indexer
      • 💻Indexer User Guide
      • ⚙️Indexer APIs
        • Full Text Indexer Search
        • Returns Standard Registries
        • Returns Registry as per MessageID
        • Returns Registry Users
        • Returns Registry User as per MessageID
        • Returns Policies
        • Returns policy as per MessageID
        • Returns Tools
        • Returns Tool as per MessageID
        • Returns Modules
        • Returns Module as per MessageID
        • Returns Schemas
        • Returns Schema as per MessageID
        • Returns Schema Tree
        • Returns Tokens
        • Returns Token as per TokenID
        • Returns Roles
        • Returns Role as per MessageID
        • Returns DIDs
        • Returns DID as per MessageID
        • Returns DID Relationships
        • Returns VP Documents
        • Returns VP Document as per MessageID
        • Returns VP Relationships
        • Returns VC Documents
        • Returns VC Document as per MessageID
        • Returns VC Relationships
        • Returns NFTs
        • Returns NFT as per Serial No.
        • Returns Topics
        • Returns Topic as per TopicID
        • Returns Contracts
        • Returns Contract as per MessageID
        • Returns Landing Page Analytics
        • Returns Project Coordinates
        • Returns Search Policy Results
    • 🗺️Map Related APIs
      • Returning map API Key
      • Returning Sentinel API Key
    • 🗄️Standard Registry
      • 🛠️Schemas
        • 📂Available Schema Types
        • 📂Property Glossary
        • ℹ️Types of Schemas
        • ℹ️Schema Versioning & Deprecation Policy
        • 📹How to design a Schema of a Methodology
        • 💻Creating Schema using UI
        • ⚙️Schema APIs
          • Listing of Schema
          • Publishing Schema based on Schema ID
          • Updating Schema
          • Deleting a Schema
          • Schema Preview from IPFS
          • Schema Preview from Zip
          • Export message IDs of Schema
          • Export Files from Schema
          • Creation of Schema related to the topic
          • Returns all Schemas related to the topic
          • Importing Zip file containing Schema
          • Importing Schema from IPFS
          • Returning Schema by SchemaID
        • ⚙️System Schema APIs
          • Returns Schema by Type
          • Creates New System Schema
          • Returns Schema by Username
          • Updates the Schema
          • Delete System Schema
          • Publishes the Schema
          • Schema Type
          • Returns Map API Key
        • ⚙️Schema APIs for Asynchronous Execution
          • Creation of Schema
          • Publishing Schema
          • Previews the Schema from IPFS
          • Importing Schema from IPFS
          • Importing Schema from .zip
        • 📁Schema Differentiation
          • 💻Schema Differentiation using UI
          • ⚙️Schema Differentiation APIs
            • Compare Schemas
            • Exports Schema Differentiation Results
        • 📁Example Data
          • 💻Adding Example data using UI
        • 📂Schema Tree
          • 💻Schema Tree UI
          • ⚙️API for Returning Schema Tree
        • 📁Tag Schema
          • 💻Creating Tag Schemas using UI
          • ⚙️Schema Tags APIs
            • Returning all Schema Tags
            • Creating new Schema Tag
            • Deleting Schema Tag
            • Updating Schema Tag
            • Publishing Schema
            • Returning list of published schemas
      • 🛠️Policies
        • 🎓Policy Glossary
        • 📁Versioning and Deprecation Policy
          • ℹ️Policy Versioning & Deprecation Policy
          • ℹ️API Versioning & Deprecation Policy
        • 🔩Policy Creation
          • 🔄Available Policy Workflow Blocks
            • InterfaceContainerBlock
            • PolicyRolesBlock
            • InterfaceStepBlock
            • requestVCDocumentBlock
            • sendToGuardianBlock
            • reassigningBlock
            • InformationBlock
            • InterfaceDocumentsSourceBlock
            • paginationAddon
            • DocumentsSourceAddOn
            • filtersAddOnBlock
            • InterfaceActionBlock
            • externalDataBlock
            • retirementDocumentBlock
            • calculateContainerBlock & calculateMathAddOnBlock
            • reportBlock & reportItemBlock
            • switchBlock
            • aggregateDocumentBlock
            • TimerBlock
            • revokeBlock
            • setRelationshipsBlock
            • buttonBlock
            • documentValidatorBlock
            • tokenActionBlock
            • tokenConfirmationBlock
            • mintDocumentBlock
            • Events
            • groupManagerBlock
            • multiSignBlock
            • customLogicBlock
            • splitBlock
            • wipeDocumentBlock
            • Create Token Block
            • impactAddon
            • Http Request Block
            • historyAddon
            • selectiveAttributes Block
            • tagsManagerBlock
            • extractDataBlock
            • externalTopicBlock
            • messagesReportBlock
            • notificationBlock
          • 💻Creating Policy using UI
          • 💻Creating a Policy through Policy Configurator
            • Getting Started with the Policy Workflows
            • Policy Workflow Step 1
            • Policy Workflow Step 2
            • Policy Workflow Step 3
            • Policy Workflow Step 4
            • Policy Workflow Step 5
            • Policy Workflow Step 6
            • Policy Workflow Step 7
            • Policy Workflow Step 8
            • Policy Workflow Step 9
            • Policy Workflow Step 10
            • Policy Workflow Step 11
            • Policy Workflow Step 12
            • Policy Workflow Step 13
            • Policy Workflow Step 14
            • Policy Workflow Step 15
            • Policy Workflow Step 16
            • Policy Workflow Step 17
            • Policy Workflow Step 18
            • Policy Workflow Step 19
            • Policy Workflow Step 20
            • Policy Workflow Step 21
            • Policy Workflow Step 22
            • Policy Workflow Step 23
            • Policy Workflow Step 24
            • Policy Workflow Step 25
            • Policy Workflow Wrap Up
          • ⚙️Creating a Policy using APIs
            • Prerequesite Steps
            • Creation of a Policy
            • Policy Listing
            • Import a Policy from IPFS
            • Policy Preview from IPFS
            • Retrieves Policy Configuration
            • Updates Policy Configuration
            • Publish a Policy
            • Policy Validation
            • Retrieval of Data from Root Policy Block
            • Request Block Data
            • Sends Data to Specified Block
            • Returns Block ID by tag
            • Exporting Message ID
            • Export to zip file
            • Import from zip file
            • Retrieves Block Data by Tag
            • Sends Data to specified Block by Tag
            • Returns list of Groups of a particular user
            • Make the selected Group active
            • Creating link between policies
            • Requesting Multi Policy Config
            • Importing Policy from a Zip file with Metadata
          • ⚙️APIs for Asynchronous Execution
            • Creates new Policy
            • Publishing a Policy
            • Importing a Policy from IPFS
            • Importing a Policy from file
            • Policy Review
            • Importing Policy from a Zip file with Metadata
        • 📁Dry Run
          • 💻Dry Run Mode using UI
          • ⚙️Dry Run Mode using APIs
            • Running Policy without making any changes
            • Returning all Virtual Users
            • Creating Virtual Account
            • Logging Virtual User
            • Restarting the execution of Policy
            • Returns List of Transactions
            • Returns List of Artifacts
            • Returns List of IPFS Files
            • Returning Policy to Editing
        • 💻Roles and Groups
          • 💻Creating Roles and Groups using Policy Configurator UI
        • 📁Record/Replay
          • 💻Policy execution record and replay using UI
          • ⚙️Record/Replay APIs
            • Get Recording
            • Start Recording
            • Stop Recording
            • Get Recorded Actions
            • Run record from zip file
            • Stop Running
            • Get Running Results
            • Get Running Details
            • Fast Forward
            • Retry Step
            • Skip Step
        • 📁Global Policy Search & Compare
          • 💻Global search and comparison UI
          • 💻Policy Differentiation using UI
          • ⚙️Policy Compare and Search APIs
            • Comparing Policies
            • Searching Policies
            • Exports Comparison results
        • 🔍Block/Policy Discoverability
          • 💻Search Policy using UI
          • ⚙️Search Policy APIs
            • Search Policy
          • 💻Search Block using UI
          • ⚙️Search Block APIs
            • Searching Same Blocks
        • 📂Document Comparison
          • 💻Document Comparison using UI
          • ⚙️Document Comparison APIs
            • Compare Documents
            • Export Comparison Results
        • 📂Tools
          • 💻Tools using UI
          • ⚙️Tools APIs
            • Creating new Tool
            • Returns list of tools
            • Creating new tool asynchronously
            • Deletes the Tool
            • Retrieves Tool Configuration
            • Updates Tool Configuration
            • Publishes Tool onto IPFS
            • Publishes Tool into IPFS asynchronously
            • Validates Selected Tool
            • Returns Tools and its artifacts in zip format
            • Retrieves Hedera Message ID
            • Previews Imported Tool from IPFS
            • Imported Tool from IPFS
            • Previews Imported Tool from Zip
            • Importing Tool from Zip
            • Imports new tool from Zip Asynchronously
            • Imports new tool from IPFS Asynchronously
            • Returns List of Tools
            • Importing Tool from a Zip file
            • Importing Tool from a Zip file asynchronously
        • 📁Modules
          • 💻Modules using UI
          • ⚙️Modules APIs
            • Returns all Modules
            • Creating new Module
            • Returns Module Menu
            • Retrieves Module Configuration
            • Updates Module Configuration
            • Delete the Module
            • Publishing Module onto IPFS
            • Returns Hedera ID for specific Module
            • Exporting Module in zip format
            • Import Module from IPFS
            • Import module from zip file
            • Preview Module from IPFS
            • Preview Module from zip file
            • Validates Module
          • 📁Modules Differentiation
            • 💻Module Differentiation using UI
            • ⚙️Module Differentiation APIs
              • Returns result of Module Comparison
              • Exports Comparison Result
        • 📁Tagging
          • 💻Tagging using UI
          • ⚙️Tagging APIs
            • Creating Tag
            • Searching Tag
            • Deleting Tag
            • Synchronization of tags
        • 📁Themes
          • 💻Themes using UI
          • ⚙️Themes APIs
            • Returning all themes
            • Creating theme
            • Updating theme Configuration
            • Deleting theme
            • Returning zip file containing themes
            • Importing theme
        • 📁Policy Wizard
          • 💻Demo on Policy Wizard using UI
          • ⚙️Policy Wizard APIs
            • Creating new Policy
            • Getting Policy Configuration
        • 📂Auto Suggestion
          • 💻Demo using UI
          • ⚙️Auto Suggestion APIs
            • Get next and nested suggested block types
            • Get suggestions configuration
            • Set suggestions configuration
        • 📁Auto Testing of the Policies
          • 💻Auto Testing using UI
          • ⚙️Auto Testing Policies APIs
            • Adding new Test to the policy
            • Returning Policy Test by ID
            • Running the Policy Test
            • Stopping the Specified Test
            • Deleting the Specified Test
            • Returning details of the most recent test run
        • 📔Library of Policy Examples
          • 💻Creating and using Roles
          • 🔢Data input via Forms, using Roles to partition user activities.
          • 🪙Token Operations
          • 🔎MRV Document Operations
          • ⛓️TrustChain reports
          • ➗MRV aggregation and splitting for minting tokens
        • 💻Demo on Integrating external policies using UI
      • 🔑Bring your own DIDs
        • 💻Bring your own (BYO) DIDs UI
        • ⚙️APIs
          • Validate DID Format
          • Validate DID Keys
      • 📁Import/Export in Excel
        • 💻Import and Export Excel file User Guide
        • ⚙️Import/Export Schemas/Policies APIs
          • Import Schemas in Excel file format into a policy
          • Asynchronously Imports Schemas in Excel file format into a policy
          • Previews Schema from Excel file
          • Returns Schema in Excel file format
          • Returns list of Schemas
          • Exporting Policy to Excel
          • Import Schemas in Excel file format into a Policy
          • Asynchronously Imports Schemas in Excel file format into a policy
          • Policy Preview from Excel file
      • 📁Project Comparison
        • 💻Project Comparison using UI
        • ⚙️Project Comparison APIs
          • Comparing Project Data Documents
          • Comparing VP Documents - V1
          • Retrieves all Properties
          • Search Projects by filters
      • 🔑Selective Disclosure
        • 📔User Guide
        • 🔐Selective Disclosure Demo
      • 📈Usage Statistics
        • 💻Statistics
        • ⚙️APIs related to Statistics
          • Returns the status of the current report
          • Update current report
          • Returns all reports
          • Returns report data by report uuid
          • Export report data in a csv file format
          • Export report data in a xlsx file format
          • Returns all dashboards
          • Returns dashboard by uuid
          • Returns Metrics
      • 📒Artifacts
        • 💻Importing/Deleting Artifacts using UI
        • ⚙️Artifacts APIs
          • Returns all Artifacts
          • (deprecated) Returns all Artifacts
          • Upload Artifacts
          • (deprecated) Upload Artifacts
          • Delete Artifact
          • (deprecated) Delete Artifact
      • 💻Asynchronous Tasks Status
      • 🔔Notifications
        • 💻User Guide
        • ⚙️APIs related to Notification
          • Get All Notifications
          • Get new Notifications
          • Get Progresses
          • Read All Notifications
          • Delete Notifications
      • 📁Discontinuing Policy Workflow
        • 💻User Guide
        • ⚙️APIs related to Discontinuing Policy workflow
          • Discontinue Policy
          • MigratePolicy Data
          • Migrate Policy Data Asynchronous
          • Get Policy Documents
      • 📁Live Project Data Migration
        • ↔️Live Project Data Migration UI
        • ⚙️APIs related to Live Project Data Migration
          • Getting Policy Data
          • Uploading Policy Data
          • Getting Policy Tag Block Map
          • Getting Policy Virtual Keys
          • Uploading Policy Virtual Keys
      • 🔥FireBlocks Raw Signing
        • Fireblocks signing in Guardian UI
        • Getting Keys from FireBlocks UI
      • 🙍Roles & Permissions
        • 💻Roles and Permissions User Guide
        • ⚙️APIs related to Roles & Permissions
          • Returns list of all permissions
          • Returns list of all roles
          • Creates a New Role
          • Updates Role Configuration
          • Deletes Role
          • Setting Default Role
          • Returns list of all users for whom the current user can change the role
          • Retrieves information about the user (roles, permissions assigned policies)
          • Updates User Roles (only SR)
          • Returns list of all Policies
          • Assigns Policies to a User - Only SR
          • Updates user roles (for ordinary uses)
          • Assigns policies to a user (for ordinary users)
      • 📁TrustChain
        • ⚙️TrustChain APIs
          • Requesting
          • Building and returning
      • 🏜️External Events
        • 🛠️Monitoring Tools
          • ⛏️Application-events module
        • ⚙️Send Data using the External Data APIs
          • Sends Data from External Source
      • 📱Mobile Support for Data Interface
        • 📱Mobile operation for the Standard Registry
      • 🛠️Standard Registry Operations
        • ⚙️Settings APIs
          • Displaying Current Settings
          • Adding Settings
        • ⚙️Logs APIs
          • Returning Logs
          • Returning Log Attributes
        • ⚙️Task Statuses APIs
          • Returning Task Statuses
      • 📹Demo Experience
    • 🤵Users
      • 🛠️User Operations
        • ⚙️Account APIs
          • Authentication Process
          • User listing except Standard Registry and Auditor
          • User Balance
          • User Session
          • User Login
          • Registering new account
          • Returns all Standard Registries
          • Returns Access Token
        • Profile APIs
          • User Account Balance
          • User Account Information
          • Setting User Credentials
          • Setting User Credentials Asynchronously
      • 📱Mobile Support for Data Interface
        • 📱Mobile Operation for the user
      • 🛠️User Profile Setup
      • 🤖AI Search
        • 💻AI Search using UI
        • ⚙️AI Search APIs
          • Returns response
          • Rebuilds vector based on policy data
      • 🔎Guided Search of Methodologies
        • 💻Search using UI
        • ⚙️Search APIs
          • Retrieves list of all categories
          • List of policies that are best suited for given parameters
      • ✖️Multi Policy
        • 💻Configuring Multi Policy using UI
    • 🪙Tokens
      • 💻Creating Token using UI
      • 📒Token Template
        • Creating Token Template using UI
        • Creating Token through UI using Token Template
      • 📖Token Authenticity
        • ℹ️Establishing Token Authenticity
      • 🛠️Token Operations
        • ⚙️Token APIs
          • Token Listing
          • Creation of Token
          • User Info for selected token
          • Associates the user with token
          • Disassociates the user with token
          • Grants KYC for the user
          • Revoke KYC of the user
          • Freeze Tokens of a user
          • UnFreeze Tokens of a user
          • Returns Token Serials
        • ⚙️APIs for Asynchronous Execution
          • Token Creation
          • Associating User with the Hedera Token
          • Disassociating User with the Hedera Token
          • Setting KYC for the User
          • Unsetting KYC for the User
      • 📔Token Retirement Contract
        • 💻Creating Contract using UI
        • ⚙️Retirement APIs
          • Returning all contracts
          • Creating new Contract
          • Importing new Contract
          • Get Contract Permissions
          • Removing Contract
          • Returns a list of all Wipe requests
          • Enabling Wipe Requests
          • Disabling Wipe Requests
          • Approving Wipe Requests
          • Rejecting Wipe Requests
          • Clearing Wipe Requests
          • Adding Wipe Admin
          • Removing Wipe Admin
          • Adding Wipe Manager
          • Removing Wipe Manager
          • Adding Wipe Wiper
          • Removing Wipe Wiper
          • Syncing Retire Pools
          • Returning list of all Retire Requests
          • Returning list of all Retire Pools
          • Deleting Retire Requests
          • Deleting Retire Pools
          • Setting Retire Pools
          • Unsetting Retire Pool
          • Unsetting Retire Request
          • Retiring Tokens
          • Approving Retire Request
          • Cancelling Retire Request
          • Adding Retire Admin
          • Removing Retire Admin
          • Returning all Retired VCs
    • 👾Automation Testing
      • 💻Performing API Automation Testing
      • 💻Performing UI Automation Testing
    • 📕Logging Configuration using Pino Library
    • 📔Guidance for Open Source Policy Submissions
    • 📝Demo Guide
      • 🔋Renewable Energy Credits
        • 📖Introduction to International Renewable Energy Credit Standard (iREC)
        • ⚙️iREC API Demo Guide
        • ⚙️Demo Using APIs and UI
        • 💻iREC 5 Demo UI Guide
        • ⚙️iREC 5 json
        • 💻iREC 7 User Journey UI Demo Guide
        • 💻iREC 7 Demo UI Guide
      • ☘️Carbon Offsets
        • 📖Introduction to Verra Redd+
        • 💻Verra Redd VM0007 Demo UI Guide
        • 💻Verra Redd_3 User Journey Demo UI Guide
        • 🎍VM0017 Adoption of Sustainable Agricultural Land Management, v1.0
        • 🎍VM0042 Methodology for Improved Agricultural Land Management
        • 🌲Verra VM0047 - Afforestation, Reforestation, and Revegetation (ARR) v0.1
        • 🌲Gold Standard Afforestation and Reforestation (AR) v2.0
        • 🍃Dovu Methodologies
        • 🍀Dovu MMCM
        • ♨️Improved Cookstove
        • ♨️GoldStandard - Metered Energy Cooking
        • 🍀Carbon Reduction Measurement - GHG Corporate Standard Policy Guid
        • 🏢VM0044 Methodology for Biochar Utilization in Soil and Non-Soil Applications
        • 🏭CDM AMS-III.AR : Substituting fossil fuel based lighting with LED/CFL lighting systems
        • 🏨CDM AMS II.G: Energy Efficiency Measures in Thermal Applications of Non-Renewable Biomass
        • 🏭CDM AMS III.D: Methane Recovery in Animal Manure Management Systems
        • 🏭CDM AMS III.BB: Electrification of communities through grid extension
        • 🏭CDM AR-ACM0003: Methodology for Afforestation and Reforestation of Lands Except Wetlands
        • 🏭CDM ACM0001: Flaring or Use of Landfill Gas
        • 🏭CDM ACM0002: Grid-Connected Electricity Generation from Renewable Sources
        • 🏭CDM ACM0006: Electricity and Heat Generation from Biomass
        • 🏢CDM ACM0007: Conversion from Single Cycle to Combined Cycle Power Generation
        • 🏭CDM AMS-I.A.: Electricity Generation by the User
        • 🏭CDM AMS-I.C.: Thermal Energy Production with or Without Electricity
        • 🏨CDM AMS-I.F.: Renewable Electricity Generation for Captive Use and Mini-Grid
        • 🏭CDM AMS-II.J.: Demand-Side Activities for Efficient Lighting Technologies
        • 🏨CDM AMS-III.AV.: Low Greenhouse Gas Emitting Safe Drinking Water Production Systems
        • 🏭CDM AMS-III.F.: Avoidance of Methane Emissions Through Composting
        • 🏢CDM AMS-III.H.: Methane Recovery in Wastewater Treatment
        • 🏭CDM ACM0018: Electricity Generation from Biomass in Power-Only Plants
        • ⬇️Verra PWRM0001 :Plastic Waste Collection Methodology
        • 🏭VM0041 Methodology for the Reduction of Enteric Methane Emissions from Ruminants through the Use of
        • 🥇Carbon Sequestration through Accelerated Carbonation of Concrete Aggregate
        • 🏭AMS-I.D: Grid Connected Renewable Electricity Generation – v.18.0
        • 🏭PWRM0002 : Plastic Waste Recycling Methodology
        • 🍚Methane Emission Reduction by Adjusted Water Management Practice in Rice Cultivation
        • ⛽Verra VMR0006: Energy Efficiency and Fuel Switch Measures in Thermal Applications
        • 🌩️AMS-I.E Switch from Non-Renewable Biomass for Thermal Applications by the User
      • 🏭Carbon Emissions
        • 🏡Remote Work GHG Policy
          • 📖Introduction to Remote Work GHG
          • 💻GHG Policy User Journey UI Demo Guide
          • 💻Remote GHG Policy Demo Guide
        • 🏢Carbon Emissions Measurement - GHG Corporate Standard Policy Guide
        • 🏭atma GHG Scope II Carbon Emission Policy
        • 🏭Atma Scope 3 GHG Policy
        • 🏭GHGP Corporate Standard
        • 🏭GHGP Corporate Standard V2
    • ❓FAQs
    • 👬Community Standards
      • Guardian Policy Standards (GPS)
      • Guardian System Standards (GSS)
      • Proposal for Defining Standards
  • Feedback
    • Feedback in Pipelines
  • 📈Guardian in Production
    • 📄API Architecture Customization
    • 📉Monitoring tools
    • Performance Improvement
    • Cloud Infrastructure
    • Independent Packaged Deployment
Powered by GitBook

⚙️AI Search APIs

PreviousAI Search using UINextReturns response

Last updated 9 months ago

On this page

Was this helpful?

Edit on GitHub
Returns response
Rebuilds vector based on policy data