Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.h3aven.com/llms.txt

Use this file to discover all available pages before exploring further.

Schema: 
{
  "type": "object",
  "required": ["name", "parameters"],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the entity"
    },
    "parameters": {
      "type": "array",
      "description": "Array of parameter definitions for the entity",
      "items": {
        "type": "object",
        "required": ["label", "type"],
        "properties": {
          "label": {
            "type": "string",
            "description": "Display label for the parameter"
          },
          "type": {
            "type": "string",
            "enum": [
              "ATTACHMENT",
              "IMAGE",
              "SIGNATURE",
              "CHECKBOX",
              "CPF",
              "TIME",
              "USER",
              "URL",
              "HTML",
              "CEP",
              "CPFCNPJ",
              "CNPJ",
              "DATE",
              "DATETIME",
              "EMAIL",
              "LIST",
              "NUMBER",
              "PHONE",
              "RADIO",
              "SELECT",
              "TEXT",
              "TEXTAREA",
              "TABLE",
              "TOGGLE",
              "CURRENCY",
              "LOCATION",
              "CERTIDOES",
              "PERCENTAGE",
              "ENTITY_RELATION",
              "SECTION",
            ],
            "description": "Type of the parameter"
          },
          "optionItems": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Available options for SELECT, CHECKBOX, TOGGLE & RADIO type parameters"
          },
          "entityRelationId": {
            "type": "string",
            "description": "Target entity and parameter for ENTITY_RELATION (format: 'EntityName.parameterLabel')"
          },
          "entityRelationAuxParamIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Additional parameters to display for ENTITY_RELATION"
          }
        },
        "allOf": [
          {
            "if": {
              "properties": { "type": { "const": "SELECT" | "CHECKBOX" | "TOGGLE" | "RADIO" } }
            },
            "then": {
              "required": ["optionItems"]
            }
          },
          {
            "if": {
              "properties": { "type": { "const": "ENTITY_RELATION" } }
            },
            "then": {
              "required": ["entityRelationId"]
            }
          }
        ]
      }
    }
  }
}
Simple request
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    }
  ]
}
Simple request with optionItems: 
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    },
    {
      "label": "sex",
      "type": "SELECT",
      "optionItems": ["Male", "Female"]
    }
  ]
}
Relation with another entity: 
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    },
    {
      "label": "address",
      "type": "ENTITY_RELATION",
      "entityRelationId": "Address.street"
    }
  ]
}
Relation with another entity with aux params: 
{
  "name": "User",
  "parameters": [
    {
      "label": "name",
      "type": "TEXT"
    },
    {
      "label": "age",
      "type": "NUMBER"
    },
    {
      "label": "address",
      "type": "ENTITY_RELATION",
      "entityRelationId": "Address.street"
      "entityRelationAuxParamIds": ["Address.city","Address.state"]
    }
  ]
}