Skip to main content

Discovery API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
discoveryDiscoverAssetsPOST /discovery/discover/assets/discovery/discover/assets [POST]
discoveryDiscoverAssetsHtmlPOST /discovery/discover/assets/html/discovery/discover/assets/html[POST]
discoveryDiscoverSensitivesPOST /discovery/discover/sensitives/discovery/discover/sensitives [POST]
discoveryDiscoverTagsRelatedPOST /discovery/discover/tags/related/discovery/discover/tags/related [POST]

discoveryDiscoverAssets

DiscoveredAssets discoveryDiscoverAssets()

This is the endpoint used for bulk import. In both cases of the bulk import flow, fragments or files. When we already have "snippets" or fragments to discover and now our job is to check if they are actually valid snippets(clustering). Otherwise, we should have a file to parse && snippitize and then run through the clustering.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.DiscoveryApi(configuration)

const body: Pieces.DiscoveryDiscoverAssetsRequest = {
// boolean | For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior. (optional)
automatic: true,
// SeededDiscoverableAssets | The discovery/discover/assets endpoint will accept seededDiscoverableAssets, that represetns an iterable of multiple fragments or files. (optional)
seededDiscoverableAssets: ,
};

apiInstance.discoveryDiscoverAssets(body).then((data: DiscoveredAssets) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededDiscoverableAssetsSeededDiscoverableAssetsThe discovery/discover/assets endpoint will accept seededDiscoverableAssets, that represetns an iterable of multiple fragments or files.
automatic[boolean]For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior.(optional) defaults to true

Return type

DiscoveredAssets

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

discoveryDiscoverAssetsHtml

DiscoveredHtmlWebpages discoveryDiscoverAssetsHtml()

This is the discover discover assets html endpoint. The goal of this endpoint is to either take an iterable of urls and pages(an html string) and extract all the assets from the iterable.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.DiscoveryApi(configuration)

const body: Pieces.DiscoveryDiscoverAssetsHtmlRequest = {
// boolean | For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior. (optional)
automatic: true,
// SeededDiscoverableHtmlWebpages (optional)
seededDiscoverableHtmlWebpages: ,
};

apiInstance.discoveryDiscoverAssetsHtml(body).then((data: DiscoveredHtmlWebpages) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededDiscoverableHtmlWebpagesSeededDiscoverableHtmlWebpages
automatic[boolean]For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior.(optional) defaults to true

Return type

DiscoveredHtmlWebpages

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

discoveryDiscoverSensitives

DiscoveredSensitives discoveryDiscoverSensitives()

This endpoint will accept an array of text values, and attampt to extract sensitive data out of it.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.DiscoveryApi(configuration)

const body: Pieces.DiscoveryDiscoverSensitivesRequest = {
// boolean | For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior. (optional)
automatic: true,
// SeededDiscoverableSensitives (optional)
seededDiscoverableSensitives: ,
};

apiInstance.discoveryDiscoverSensitives(body).then((data: DiscoveredSensitives) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededDiscoverableSensitivesSeededDiscoverableSensitives
automatic[boolean]For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior.(optional) defaults to true

Return type

DiscoveredSensitives

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-

discoveryDiscoverTagsRelated

DiscoveredRelatedTags discoveryDiscoverTagsRelated()

This will take in a tag or multiple tags and return all the tags that are related to the tag or tag provide in the body.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.DiscoveryApi(configuration)

const body: Pieces.DiscoveryDiscoverTagsRelatedRequest = {
// boolean | For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior. (optional)
automatic: true,
// SeededDiscoverableRelatedTags (optional)
seededDiscoverableRelatedTags: ,
};

apiInstance.discoveryDiscoverTagsRelated(body).then((data: DiscoveredRelatedTags) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededDiscoverableRelatedTagsSeededDiscoverableRelatedTags
automatic[boolean]For most cases set to true. If this is set to true we will handle the behavior automically or else we will not proactively handle specific behavior but we will let the developer decide the behavior.(optional) defaults to true

Return type

DiscoveredRelatedTags

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-