Skip to main content

WorkstreamPatternEngine API

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

MethodHTTP requestDescription
workstreamPatternEngineProcessorsVisionActivatePOST /workstream_pattern_engine/processors/vision/activate/workstream_pattern_engine/processors/vision/activate [POST]
workstreamPatternEngineProcessorsVisionDataClearPOST /workstream_pattern_engine/processors/vision/data/clear/workstream_pattern_engine/processors/vision/data/clear [POST]
workstreamPatternEngineProcessorsVisionDeactivatePOST /workstream_pattern_engine/processors/vision/deactivate/workstream_pattern_engine/processors/vision/deactivate [POST]
workstreamPatternEngineProcessorsVisionStatusGET /workstream_pattern_engine/processors/vision/status/workstream_pattern_engine/processors/vision/status [GET]

workstreamPatternEngineProcessorsVisionActivate

WorkstreamPatternEngineStatus workstreamPatternEngineProcessorsVisionActivate()

This will activate your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April)

Example

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

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

const body: Pieces.WorkstreamPatternEngineProcessorsVisionActivateRequest = {
// WorkstreamPatternEngineStatus (optional)
workstreamPatternEngineStatus: ,
};

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

Parameters

NameTypeDescriptionNotes
workstreamPatternEngineStatusWorkstreamPatternEngineStatus

Return type

WorkstreamPatternEngineStatus

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden, this is not available for non-beta used until mid to late April.-
500Internal Server Error-

workstreamPatternEngineProcessorsVisionDataClear

workstreamPatternEngineProcessorsVisionDataClear()

This will clear the data for the Workstream Pattern Engine, specifically for our vision data. This boy will accept ranges of time that the user wants to remove the processing from.

Example

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

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

const body: Pieces.WorkstreamPatternEngineProcessorsVisionDataClearRequest = {
// WorkstreamPatternEngineDataCleanupRequest (optional)
workstreamPatternEngineDataCleanupRequest: ,
};

apiInstance.workstreamPatternEngineProcessorsVisionDataClear(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
workstreamPatternEngineDataCleanupRequestWorkstreamPatternEngineDataCleanupRequest

Return type

void (empty response body)

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
204No Content-
403Forbidden, this is not available for non-beta used until mid to late April.-
500Internal Server Error-

workstreamPatternEngineProcessorsVisionDeactivate

WorkstreamPatternEngineStatus workstreamPatternEngineProcessorsVisionDeactivate()

This will deactivate your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April)

Example

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

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

const body: Pieces.WorkstreamPatternEngineProcessorsVisionDeactivateRequest = {
// WorkstreamPatternEngineStatus (optional)
workstreamPatternEngineStatus: ,
};

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

Parameters

NameTypeDescriptionNotes
workstreamPatternEngineStatusWorkstreamPatternEngineStatus

Return type

WorkstreamPatternEngineStatus

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden, this is not available for non-beta used until mid to late April.-
500Internal Server Error-

workstreamPatternEngineProcessorsVisionStatus

WorkstreamPatternEngineStatus workstreamPatternEngineProcessorsVisionStatus()

This will get a snapshot of the status your Workstream Pattern Engine. This is used to aggregate information on your user's desktop, specifically recording the application in focus and aggregating relevant context that will then be used to ground the copilot conversations, as well as the feed. Note: required to be a beta user to use this feature until this is live(roughly mid to late April)

Example

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

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

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

Parameters

This endpoint does not need any parameters.

Return type

WorkstreamPatternEngineStatus

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200OK-
403Forbidden, this is not available for non-beta used until mid to late April.-
500Internal Server Error-