Entity Data contract

Terminate Feature Flag For Entity

Terminate Feature Flag For Entity

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/{flagName}/terminate

Path parameters

entityId*string

flagName*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityFeatureFlags (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/featureFlags/{flagName}/terminate', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
    }
  }
}

Get entity level flags of an Entity

Get entity level flags of a particular Entity

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/forEntityId/{forEntityId}/featureFlags

Path parameters

entityId*string

forEntityId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

flagsEntityFeatureFlags (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/forEntityId/{forEntityId}/featureFlags', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
    }
  }
}

Get All Data Contracts for an Entity

Get all Data Contracts for specific entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts

Path parameters

entityId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityDataContract (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  }
}

Add new data contract

Add new data contract info of specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

namestring

descriptionstring

sourcestring

fieldsarray of object

tagsarray of string

Response

200400401500

Successful response

Body

application/json

successboolean

datasetIdstring

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Get specific data contract

Get specific data contract of an entity.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}

Path parameters

entityId*string

dataContractId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityDataContract (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
  }
}

Update data contract

Update data contract of specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/update

Path parameters

entityId*string

dataContractId*string

Query parameters

Header parameters

Body

application/json

namestring

descriptionstring

sourcestring

fieldsarray of object

tagsarray of string

Response

200400401500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Delete data contracts

Delete data contracts of specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/delete

Path parameters

entityId*string

dataContractId*string

Query parameters

Header parameters

Response

200400401500

Successful response

Body

application/json

successboolean

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/delete', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "success": true
}

Chat with Data Contract for Entity

Chat with the specified Data Contract for a specific entity.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/chat

Path parameters

entityId*string

dataContractId*string

Query parameters

Header parameters

Body

application/json

userInputstring

User input for the chat conversation.

isInternalboolean

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

Response

200400401500

Successful response

Body

application/json

successboolean

datastring

queryCountnumber

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/chat', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Upload CSV and Create Data Contract

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/uploadcsv

Path parameters

entityId*string

Query parameters

Header parameters

Body

multipart/form-data

uploaded_filestring (binary)

Response

200400401500

Successful response

Body

application/json

successboolean

dataEntityDataContract (object)

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/uploadcsv', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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"
  }
}

Fetch schema fields from Google Sheet

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

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/googlesheet

Path parameters

entityId*string

Query parameters

Header parameters

Body

application/json

googleSheetLinkstring

Response

200400401500

Successful response

Body

application/json

successboolean

datasetIdstring

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/googlesheet', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Auto Generate the description

Auto Generate the description using AI

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/autoGenerate

Path parameters

entityId*string

dataContractId*string

Query parameters

Header parameters

Body

application/json

fieldsarray of object

Response

200400401500

Successful response

Body

application/json

successboolean

resstring

Request

JavaScriptCurl

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/dataContracts/{dataContractId}/autoGenerate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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