Entity Data contract

Terminate Feature Flag For Entity

get

Terminate Feature Flag For Entity

Path parameters

entityIdstringrequired

flagNamestringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/{flagName}/terminate?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Get entity level flags of an Entity

post

Get entity level flags of a particular Entity

Path parameters

entityIdstringrequired

forEntityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/forEntityId/{forEntityId}/featureFlags?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "flags": {
    "entityId": "entity123",
    "flagName": "Flag Name",
    "description": "Flag description",
    "isActive": true,
    "isEnabled": true,
    "createdAt": "2023-06-27T12:45:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

Successful response

Get All Data Contracts for an Entity

get

Get all Data Contracts for specific entity.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "createdBy": "user123",
    "name": "Data Contract Name",
    "description": "Data Contract Description",
    "tags": [
      [
        "tag1",
        "tag2"
      ]
    ],
    "source": "URL",
    "fields": [
      {
        "name": "FieldName",
        "description": "Field Description",
        "validationRules": {
          "type": "string",
          "required": false,
          "unique": false,
          "nonnull": false,
          "minLength": 0,
          "maxLength": 255,
          "enum": [
            "value1",
            "value2"
          ],
          "regex": "^\\d{3}-\\d{2}-\\d{4}$",
          "min": 0,
          "max": 100
        }
      }
    ],
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "updatedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Add new data contract

post

Add new data contract info of specific entity.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

namestringoptional

Example: Data Contract Name

descriptionstringoptional

Example: Data Contract Description

sourcestringoptional

Example: URL

fieldsobject[]optional

tagsstring[]optional

Example: ["tag1","tag2"]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Data Contract Name",
    "description": "Data Contract Description",
    "source": "URL",
    "fields": [
      {
        "name": "FieldName",
        "description": "Field Description",
        "validationRules": {
          "type": "string",
          "required": false,
          "unique": false,
          "nonnull": false,
          "minLength": 0,
          "maxLength": 255,
          "enum": [
            [
              "value1",
              "value2"
            ]
          ],
          "regex": "^\\d{3}-\\d{2}-\\d{4}$",
          "min": 0,
          "max": 100
        }
      }
    ],
    "tags": [
      [
        "tag1",
        "tag2"
      ]
    ]
  }'

200

400

401

500

200

{
  "success": true,
  "datasetId": "id-123"
}

Successful response

Get specific data contract

get

Get specific data contract of an entity.

Path parameters

entityIdstringrequired

dataContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "createdBy": "user123",
    "name": "Data Contract Name",
    "description": "Data Contract Description",
    "tags": [
      [
        "tag1",
        "tag2"
      ]
    ],
    "source": "URL",
    "fields": [
      {
        "name": "FieldName",
        "description": "Field Description",
        "validationRules": {
          "type": "string",
          "required": false,
          "unique": false,
          "nonnull": false,
          "minLength": 0,
          "maxLength": 255,
          "enum": [
            "value1",
            "value2"
          ],
          "regex": "^\\d{3}-\\d{2}-\\d{4}$",
          "min": 0,
          "max": 100
        }
      }
    ],
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "updatedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Update data contract

post

Update data contract of specific entity.

Path parameters

entityIdstringrequired

dataContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

namestringoptional

Example: Data Contract Name

descriptionstringoptional

Example: Data Contract Description

sourcestringoptional

Example: URL

fieldsobject[]optional

tagsstring[]optional

Example: ["tag1","tag2"]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/update?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Data Contract Name",
    "description": "Data Contract Description",
    "source": "URL",
    "fields": [
      {
        "name": "FieldName",
        "description": "Field Description",
        "validationRules": {
          "type": "string",
          "required": false,
          "unique": false,
          "nonnull": false,
          "minLength": 0,
          "maxLength": 255,
          "enum": [
            [
              "value1",
              "value2"
            ]
          ],
          "regex": "^\\d{3}-\\d{2}-\\d{4}$",
          "min": 0,
          "max": 100
        }
      }
    ],
    "tags": [
      [
        "tag1",
        "tag2"
      ]
    ]
  }'

200

400

401

500

200

{
  "success": true
}

Successful response

Delete data contracts

post

Delete data contracts of specific entity.

Path parameters

entityIdstringrequired

dataContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/delete?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true
}

Successful response

Chat with Data Contract for Entity

post

Chat with the specified Data Contract for a specific entity.

Path parameters

entityIdstringrequired

dataContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

userInputstringoptional

User input for the chat conversation.

isInternalbooleanoptional

Flag indicating whether the request is internal (true/false).

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/chat?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "userInput": "text",
    "isInternal": true
  }'

200

400

401

500

200

{
  "success": true,
  "data": "Generated chat response",
  "queryCount": 42
}

Successful response

Upload CSV and Create Data Contract

post

Upload a CSV file to create a new data contract for a specific entity.

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

uploaded_filestring · binaryoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/uploadcsv?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: multipart/form-data' \
  --form 'uploaded_file=binary'

200

400

401

500

200

{
  "success": true,
  "data": {
    "entityId": "entity123",
    "createdBy": "user123",
    "name": "Data Contract Name",
    "description": "Data Contract Description",
    "tags": [
      [
        "tag1",
        "tag2"
      ]
    ],
    "source": "URL",
    "fields": [
      {
        "name": "FieldName",
        "description": "Field Description",
        "validationRules": {
          "type": "string",
          "required": false,
          "unique": false,
          "nonnull": false,
          "minLength": 0,
          "maxLength": 255,
          "enum": [
            "value1",
            "value2"
          ],
          "regex": "^\\d{3}-\\d{2}-\\d{4}$",
          "min": 0,
          "max": 100
        }
      }
    ],
    "isDeleted": false,
    "createdAt": "2023-06-27T12:45:00Z",
    "updatedAt": "2023-06-27T12:45:00Z"
  }
}

Successful response

Fetch schema fields from Google Sheet

post

Fetch only the fields in schema from Google Sheets & add new data contract

Path parameters

entityIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

googleSheetLinkstringoptional

Example: https://docs.google.com/spreadsheets/d/18L1234555555/

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/googlesheet?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "googleSheetLink": "https://docs.google.com/spreadsheets/d/18L1234555555/"
  }'

200

400

401

500

200

{
  "success": true,
  "datasetId": "u-123"
}

Successful response

Auto Generate the description

post

Auto Generate the description using AI

Path parameters

entityIdstringrequired

dataContractIdstringrequired

Query parameters

entityIdstringrequired

The Id of the entity.

Example: dummy-entityid

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

fieldsobject[]optional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/autoGenerate?entityId=dummy-entityid&userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "fields": [
      {
        "name": "FieldName",
        "description": "Field Description",
        "validationRules": {
          "type": "string",
          "required": false,
          "unique": false,
          "nonnull": false,
          "minLength": 0,
          "maxLength": 255,
          "enum": [
            [
              "value1",
              "value2"
            ]
          ],
          "regex": "^\\d{3}-\\d{2}-\\d{4}$",
          "min": 0,
          "max": 100
        }
      }
    ]
  }'

200

400

401

500

200

{
  "success": true,
  "res": "Generated description message"
}

Successful response