Skip to content

Latest commit

 

History

History

Core

README.md

Pieces.Os.Core - the C# library for the Pieces Isomorphic OpenAPI

Endpoints for Assets, Formats, Users, Asset, Format, User.

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • SDK version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://pieces.app

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Pieces.Os.Core.Api;
using Pieces.Os.Core.Client;
using Pieces.Os.Core.SdkModel;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using Pieces.Os.Core.Api;
using Pieces.Os.Core.Client;
using Pieces.Os.Core.SdkModel;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://localhost:1000";
            // Configure API key authorization: application
            config.ApiKey.Add("X-Application-ID", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-Application-ID", "Bearer");

            var apiInstance = new ActivitiesApi(config);
            var transferables = true;  // bool? | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional) 
            var seededActivity = new SeededActivity(); // SeededActivity |  (optional) 

            try
            {
                // /activities/create [POST]
                Activity result = apiInstance.ActivitiesCreateNewActivity(transferables, seededActivity);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling ActivitiesApi.ActivitiesCreateNewActivity: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
ActivitiesApi ActivitiesCreateNewActivity POST /activities/create /activities/create [POST]
ActivitiesApi ActivitiesDeleteSpecificActivity POST /activities/{activity}/delete /activities/{activity}/delete [POST]
ActivitiesApi ActivitiesSnapshot GET /activities /activities [GET]
ActivitiesApi ActivitiesStreamIdentifiers GET /activities/stream/identifiers /activities/stream/identifiers [WS]
ActivityApi ActivitiesSpecificActivitySnapshot GET /activity/{activity} /activity/{activity} [GET]
ActivityApi ActivityIdentifiersSnapshot GET /activity/identifiers /activity/identifiers [GET]
ActivityApi ActivityUpdate POST /activity/update /activity/update [POST]
AllocationApi AllocationSnapshot GET /allocation/{allocation} /allocation/{allocation} [GET]
AllocationApi AllocationUpdate POST /allocation/update /allocation/update [POST]
AllocationsApi AllocationsConnectNewCloud POST /allocations/connect /allocations/connect [POST]
AllocationsApi AllocationsCreateNewAllocation POST /allocations/create /allocations/create [POST]
AllocationsApi AllocationsDeleteAllocation POST /allocations/delete /allocations/delete [POST]
AllocationsApi AllocationsDisconnectCloud POST /allocations/disconnect /allocations/disconnect [POST]
AllocationsApi AllocationsReconnectCloud POST /allocations/reconnect /allocations/reconnect [POST]
AllocationsApi AllocationsSnapshot GET /allocations /allocations [GET]
AnalysesApi AnalysesSnapshot GET /analyses Your GET endpoint
AnchorApi AnchorAssociateAsset POST /anchor/{anchor}/assets/associate/{asset} /anchor/{anchor}/assets/associate/{asset} [POST]
AnchorApi AnchorAssociateConversation POST /anchor/{anchor}/conversations/associate/{conversation} /anchor/{anchor}/conversations/associate/{conversation} [POST]
AnchorApi AnchorAssociateMessage POST /anchor/{anchor}/messages/associate/{message} /anchor/{anchor}/messages/associate/{message} [POST]
AnchorApi AnchorAssociatePerson POST /anchor/{anchor}/persons/associate/{person} /anchor/{anchor}/persons/associate/{person} [POST]
AnchorApi AnchorAssociateWorkstreamSummary POST /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST]
AnchorApi AnchorDisassociateAsset POST /anchor/{anchor}/assets/disassociate/{asset} /anchor/{anchor}/assets/disassociate/{asset} [POST]
AnchorApi AnchorDisassociateConversation POST /anchor/{anchor}/conversations/disassociate/{conversation} /anchor/{anchor}/conversations/disassociate/{conversation} [POST]
AnchorApi AnchorDisassociateMessage POST /anchor/{anchor}/messages/disassociate/{message} /anchor/{anchor}/messages/disassociate/{message} [POST]
AnchorApi AnchorDisassociatePerson POST /anchor/{anchor}/persons/disassociate/{person} /anchor/{anchor}/persons/disassociate/{person} [POST]
AnchorApi AnchorDisassociateWorkstreamSummary POST /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST]
AnchorApi AnchorRename POST /anchor/{anchor}/rename /anchor/{anchor}/rename [POST]
AnchorApi AnchorScoresIncrement POST /anchor/{anchor}/scores/increment '/anchor/{anchor}/scores/increment' [POST]
AnchorApi AnchorSpecificAnchorSnapshot GET /anchor/{anchor} /anchor/{anchor} [GET]
AnchorApi AnchorUpdate POST /anchor/update /anchor/update [POST]
AnchorPointApi AnchorPointScoresIncrement POST /anchor_point/{anchor_point}/scores/increment '/anchor_point/{anchor_point}/scores/increment' [POST]
AnchorPointApi AnchorPointSpecificAnchorPointSnapshot GET /anchor_point/{anchor_point} /anchor_point/{anchor_point} [GET]
AnchorPointApi AnchorPointUpdate POST /anchor_point/update /anchor_point/update [POST]
AnchorPointsApi AnchorPointsCreateNewAnchorPoint POST /anchor_points/create /anchor_points/create [POST]
AnchorPointsApi AnchorPointsDeleteSpecificAnchorPoint POST /anchor_points/{anchor_point}/delete /anchor_points/{anchor_point}/delete [POST]
AnchorPointsApi AnchorPointsSnapshot GET /anchor_points /anchor_points [GET]
AnchorPointsApi AnchorPointsStreamIdentifiers GET /anchor_points/stream/identifiers /anchor_points/stream/identifiers [WS]
AnchorsApi AnchorsCreateNewAnchor POST /anchors/create /anchors/create [POST]
AnchorsApi AnchorsDeleteSpecificAnchor POST /anchors/{anchor}/delete /anchors/{anchor}/delete [POST]
AnchorsApi AnchorsSnapshot GET /anchors /anchors [GET]
AnchorsApi AnchorsStreamIdentifiers GET /anchors/stream/identifiers /anchors/stream/identifiers [WS]
AnchorsApi SearchAnchors POST /anchors/search /anchors/search [POST]
AnnotationApi AnnotationScoresIncrement POST /annotation/{annotation}/scores/increment '/annotation/{annotation}/scores/increment' [POST]
AnnotationApi AnnotationSpecificAnnotationSnapshot GET /annotation/{annotation} /annotation/{annotation} [GET]
AnnotationApi AnnotationUpdate POST /annotation/update /annotation/update [POST]
AnnotationsApi AnnotationsCreateNewAnnotation POST /annotations/create /annotations/create [POST]
AnnotationsApi AnnotationsDeleteSpecificAnnotation POST /annotations/{annotation}/delete /annotations/{annotation}/delete [POST]
AnnotationsApi AnnotationsSnapshot GET /annotations /annotations [GET]
AnnotationsApi AnnotationsStreamIdentifiers GET /annotations/stream/identifiers /annotations/stream/identifiers [WS]
AnnotationsApi SearchAnnotations POST /annotations/search /annotations/search [POST]
ApplicationApi ApplicationUpdate POST /application/update /application/update [GET]
ApplicationsApi ApplicationsExternalRelated GET /applications/external/related /applications/external/related [GET]
ApplicationsApi ApplicationsExternalSnapshot GET /applications/external /applications/external [GET]
ApplicationsApi ApplicationsRegister POST /applications/register /applications/register [POST]
ApplicationsApi ApplicationsSessionClose POST /applications/session/close /applications/session/close [POST]
ApplicationsApi ApplicationsSessionOpen POST /applications/session/open /applications/session/open [POST]
ApplicationsApi ApplicationsSnapshot GET /applications /applications [GET]
ApplicationsApi ApplicationsSpecificApplicationSnapshot GET /applications/{application} /applications/{application} [GET]
ApplicationsApi ApplicationsStreamIdentifiers GET /applications/stream/identifiers /applications/stream/identifiers [WS]
AssetApi AssetAssociateAnchor POST /asset/{asset}/anchors/associate/{anchor} /asset/{asset}/persons/associate/{anchor} [POST]
AssetApi AssetAssociateConversation POST /asset/{asset}/conversations/associate/{conversation} /asset/{asset}/conversations/associate/{conversation} [POST]
AssetApi AssetAssociateHint POST /asset/{asset}/hints/associate/{hint} /asset/{asset}/hints/associate/{hint} [POST]
AssetApi AssetAssociatePerson POST /asset/{asset}/persons/associate/{person} /asset/{asset}/persons/associate/{person} [POST]
AssetApi AssetAssociateTag POST /asset/{asset}/tags/associate/{tag} /asset/{asset}/tags/associate/{tag} [POST]
AssetApi AssetAssociateWebsite POST /asset/{asset}/websites/associate/{website} /asset/{asset}/websites/associate/{website} [POST]
AssetApi AssetAssociateWorkstreamSummary POST /asset/{asset}/workstream_summaries/associate/{workstream_summary} /asset/{asset}/workstream_summaries/associate/{workstream_summary} [POST]
AssetApi AssetDisassociateAnchor POST /asset/{asset}/anchors/disassociate/{anchor} /asset/{asset}/anchors/disassociate/{anchor} [POST]
AssetApi AssetDisassociateConversation POST /asset/{asset}/conversations/disassociate/{conversation} /asset/{asset}/conversations/disassociate/{conversation} [POST]
AssetApi AssetDisassociateHint POST /asset/{asset}/hints/disassociate/{hint} /asset/{asset}/hints/disassociate/{hint} [POST]
AssetApi AssetDisassociatePerson POST /asset/{asset}/persons/disassociate/{person} /asset/{asset}/persons/disassociate/{person} [POST]
AssetApi AssetDisassociateTag POST /asset/{asset}/tags/disassociate/{tag} /asset/{asset}/tags/disassociate/{tag} [POST]
AssetApi AssetDisassociateWebsite POST /asset/{asset}/websites/disassociate/{website} /asset/{asset}/websites/disassociate/{website} [POST]
AssetApi AssetDisassociateWorkstreamSummary POST /asset/{asset}/workstream_summaries/disassociate/{workstream_summary} /asset/{asset}/workstream_summaries/disassociate/{workstream_summary} [POST]
AssetApi AssetFormats GET /asset/{asset}/formats /asset/{asset}/formats [GET] Scoped To Asset
AssetApi AssetReclassify POST /asset/reclassify /asset/reclassify [POST]
AssetApi AssetScoresIncrement POST /asset/{asset}/scores/increment /asset/{asset}/scores/increment [POST]
AssetApi AssetSnapshot GET /asset/{asset} /asset/{asset} [GET] Scoped To Asset
AssetApi AssetSnapshotPost POST /asset/{asset} /asset/{asset} [POST] Scoped to an Asset
AssetApi AssetSpecificAssetActivities GET /asset/{asset}/activities /asset/{asset}/activities [GET]
AssetApi AssetSpecificAssetConversations GET /asset/{asset}/conversations /asset/{asset}/conversations [GET]
AssetApi AssetSpecificAssetExport GET /asset/{asset}/export /asset/{asset}/export [GET]
AssetApi AssetUpdate POST /asset/update /asset/update [POST] Scoped to Asset
AssetsApi AssetsCreateNewAsset POST /assets/create /assets/create [POST] Scoped to Asset
AssetsApi AssetsDeleteAsset POST /assets/{asset}/delete /assets/{asset}/delete [POST] Scoped to Asset
AssetsApi AssetsDraft POST /assets/draft /assets/draft [POST]
AssetsApi AssetsGetRecommendedAssets GET /assets/recommended Your GET endpoint
AssetsApi AssetsGetRelatedAssets GET /assets/related /assets/related [GET]
AssetsApi AssetsIdentifiersSnapshot GET /assets/identifiers /assets/identifiers [GET]
AssetsApi AssetsPseudoSnapshot GET /assets/pseudo /assets/pseudo [GET]
AssetsApi AssetsSearchWithFilters POST /assets/search /assets/search [POST]
AssetsApi AssetsSnapshot GET /assets /assets [GET] Scoped to Assets
AssetsApi AssetsSpecificAssetFormatsSnapshot GET /assets/{asset}/formats /assets/{asset}/formats [GET] Scoped To Assets
AssetsApi AssetsSpecificAssetSnapshot GET /assets/{asset} /assets/{asset} [GET] Scoped to Assets
AssetsApi AssetsStreamIdentifiers GET /assets/stream/identifiers /assets/stream/identifiers [WS]
AssetsApi GetAssetsStreamTransferables GET /assets/stream/transferables /assets/stream/transferables [WS]
AssetsApi SearchAssets GET /assets/search /assets/search?query=string [GET]
AssetsApi StreamAssets GET /assets/stream /assets/stream [WS]
Auth0Api Auth0Logout GET /v2/logout https://auth.pieces.services/v2/logout [GET]
Auth0Api AuthorizeAuth0 GET /authorize https://auth.pieces.services/authorize [GET]
Auth0Api ExchangeForAuth0Token POST /oauth/token https://auth.pieces.services/oauth/token [POST]
Auth0Api GetAuth0UserInfo GET /userinfo https://auth.pieces.services/userinfo [GET]
BackupApi Backup POST /backup /backup [POST]
BackupApi BackupAsset POST /backup/asset /backup/asset [POST]
BackupApi BackupRestoreSpecificBackup POST /backup/{backup}/restore /backup/{backup}/restore [POST]
BackupApi BackupRestoreSpecificBackupStreamed POST /backup/{backup}/restore/streamed /backup/{backup}/restore/streamed [POST]
BackupApi BackupRestoreSpecificBackupStreamedWebsocket GET /backup/{backup}/restore/streamed/websocket /backup/{backup}/restore/streamed/websocket [WS]
BackupApi BackupSpecificBackupSnapshot GET /backup/{backup} /backup/{backup} [GET]
BackupApi BackupSpecificCreationCancel POST /backup/{backup}/creation/cancel /backup/{backup}/creation/cancel [POST]
BackupApi BackupSpecificCreationStatus GET /backup/{backup}/creation/status /backup/{backup}/creation/status [GET]
BackupApi BackupSpecificRestorationCancel POST /backup/{backup}/restoration/cancel /backup/{backup}/restoration/cancel [POST]
BackupApi BackupSpecificRestorationStatus GET /backup/{backup}/restoration/status /backup/{backup}/restoration/status [GET]
BackupsApi BackupsCreateNewBackup POST /backups/create /backups/create [POST]
BackupsApi BackupsCreateNewBackupStreamed POST /backups/create/streamed /backups/create/streamed [POST]
BackupsApi BackupsCreateNewBackupStreamedWebsocket GET /backups/create/streamed/websocket /backups/create/streamed/websocket [WS]
BackupsApi BackupsDeleteSpecificBackup POST /backups/{backup}/delete /backups/{backup}/delete [POST]
BackupsApi BackupsSnapshot GET /backups /backups [GET]
BackupsApi BackupsStreamedProgress GET /backups/streamed/progress /backups/streamed/progress [WS]
ClassificationApi ConvertGenericClassification POST /classification/generic/convert Convert Generic Classification
CodeAnalysesApi CodeAnalysesSnapshot GET /code_analyses Your GET endpoint
ConnectorApi Connect POST /connect /connect [POST]
ConnectorApi Intention POST /{application}/intention /{application}/intention [POST]
ConnectorApi Onboarded POST /{application}/onboarded /onboarded [POST]
ConnectorApi React POST /{application}/reaction /{application}/reaction [POST]
ConnectorApi Suggest POST /{application}/suggestion /{application}/suggestion [POST]
ConnectorApi Track POST /{application}/track /{application}/track [POST]
ConversationApi ConversationAssociateAnchor POST /conversation/{conversation}/anchors/associate/{anchor} /conversation/{conversation}/anchors/associate/{anchor} [POST]
ConversationApi ConversationAssociateAsset POST /conversation/{conversation}/assets/associate/{asset} /conversation/{conversation}/assets/associate/{asset} [POST]
ConversationApi ConversationAssociateGroundingTemporalRangeWorkstream POST /conversation/{conversation}/grounding/temporal_range/workstreams/associate/{range} /conversation/{conversation}/grounding/temporal/ranges/associate/{range} [POST]
ConversationApi ConversationAssociateWebsite POST /conversation/{conversation}/websites/associate/{website} /conversation/{conversation}/websites/associate/{website} [POST]
ConversationApi ConversationAssociateWorkstreamSummary POST /conversation/{conversation}/workstream_summaries/associate/{workstream_summary} /conversation/{conversation}/workstream_summaries/associate/{workstream_summary} [POST]
ConversationApi ConversationDisassociateAnchor POST /conversation/{conversation}/anchors/disassociate/{anchor} /conversation/{conversation}/anchors/disassociate/{anchor} [POST]
ConversationApi ConversationDisassociateAsset POST /conversation/{conversation}/assets/disassociate/{asset} /conversation/{conversation}/assets/disassociate/{asset} [POST]
ConversationApi ConversationDisassociateGroundingTemporalRangeWorkstream POST /conversation/{conversation}/grounding/temporal_range/workstreams/disassociate/{range} /conversation/{conversation}/grounding/temporal_range/workstreams/disassociate/{range} [POST]
ConversationApi ConversationDisassociateWebsite POST /conversation/{conversation}/websites/disassociate/{website} /website/{website}/websites/disassociate/{website} [POST]
ConversationApi ConversationDisassociateWorkstreamSummary POST /conversation/{conversation}/workstream_summaries/disassociate/{workstream_summary} /conversation/{conversation}/workstream_summaries/disassociate/{workstream_summary} [POST]
ConversationApi ConversationGetSpecificConversation GET /conversation/{conversation} /conversation/{conversation} [GET]
ConversationApi ConversationGroundingMessagesAssociateMessage POST /conversation/{conversation}/grounding/messages/associate/{message} /conversation/{conversation}/grounding/messages/associate/{message} [POST]
ConversationApi ConversationGroundingMessagesDisassociateMessage POST /conversation/{conversation}/grounding/messages/disassociate/{message} /conversation/{conversation}/grounding/messages/disassociate/{message} [POST]
ConversationApi ConversationScoresIncrement POST /conversation/{conversation}/scores/increment /conversation/{conversation}/scores/increment [POST]
ConversationApi ConversationSpecificConversationMessages GET /conversation/{conversation}/messages /conversation/{conversation}/messages [GET]
ConversationApi ConversationSpecificConversationRename POST /conversation/{conversation}/rename /conversation/{conversation}/rename [POST]
ConversationApi ConversationSummarize POST /conversation/{conversation}/summarize /conversation/{conversation}/summarize [POST]
ConversationApi ConversationUpdate POST /conversation/update /conversation/update [POST]
ConversationApi SearchConversationSpecificMessages POST /conversation/{conversation}/search /conversation/{conversation}/search [POST]
ConversationMessageApi MessageAssociateAnchor POST /message/{message}/anchors/associate/{anchor} /message/{message}/anchors/associate/{anchor} [POST]
ConversationMessageApi MessageAssociateAnnotation POST /message/{message}/annotations/associate/{annotation} /message/{message}/annotations/associate/{annotation} [POST]
ConversationMessageApi MessageAssociatePerson POST /message/{message}/persons/associate/{person} /message/{message}/persons/associate/{person} [POST]
ConversationMessageApi MessageAssociateWebsite POST /message/{message}/websites/associate/{website} Associate a message with a website
ConversationMessageApi MessageDisassociateAnchor POST /message/{message}/anchors/disassociate/{anchor} /message/{message}/anchors/disassociate/{anchor} [POST]
ConversationMessageApi MessageDisassociateAnnotation POST /message/{message}/annotations/disassociate/{annotation} /message/{message}/annotations/disassociate/{annotation} [POST]
ConversationMessageApi MessageDisassociatePerson POST /message/{message}/persons/disassociate/{person} /message/{message}/persons/disassociate/{person} [POST]
ConversationMessageApi MessageDisassociateWebsite POST /message/{message}/websites/disassociate/{website} /message/{message}/websites/disassociate/{website} [POST]
ConversationMessageApi MessageScoresIncrement POST /message/{message}/scores/increment '/message/{message}/scores/increment' [POST]
ConversationMessageApi MessageSpecificMessageSnapshot GET /message/{message} /message/{message} [GET]
ConversationMessageApi MessageSpecificMessageUpdate POST /message/update /message/update [GET]
ConversationMessageApi MessageUpdateValue POST /message/update/value /message/update/value [POST]
ConversationMessagesApi ConversationMessagesStreamIdentifiers GET /messages/stream/identifiers /messages/stream/identifiers [WS]
ConversationMessagesApi MessagesCreateSpecificMessage POST /messages/create /messages/create [POST]
ConversationMessagesApi MessagesDeleteSpecificMessage POST /messages/{message}/delete /messages/{message}/delete [POST]
ConversationMessagesApi MessagesSnapshot GET /messages /messages [GET]
ConversationMessagesApi SearchMessages POST /messages/search /messages/search [POST]
ConversationsApi ConversationsCreateFromAsset POST /conversations/create/from_asset/{asset} /conversations/create/from_asset/{asset} [POST]
ConversationsApi ConversationsCreateSpecificConversation POST /conversations/create /conversations/create [POST]
ConversationsApi ConversationsDeleteSpecificConversation POST /conversations/{conversation}/delete /conversations/{conversation}/delete [POST]
ConversationsApi ConversationsIdentifiersSnapshot GET /conversations/identifiers /conversations/identifiers [GET]
ConversationsApi ConversationsSnapshot GET /conversations /conversations [GET]
ConversationsApi ConversationsStreamIdentifiers GET /conversations/stream/identifiers /conversations/stream/identifiers [WS]
ConversationsApi SearchConversations POST /conversations/search /conversations/search [POST]
DatabaseApi DatabaseExport GET /database/export Your GET endpoint
DatabaseApi DatabaseImport POST /database/import /database/import [POST]
DiscoveryApi DiscoveryDiscoverAssets POST /discovery/discover/assets /discovery/discover/assets [POST]
DiscoveryApi DiscoveryDiscoverAssetsHtml POST /discovery/discover/assets/html /discovery/discover/assets/html[POST]
DiscoveryApi DiscoveryDiscoverSensitives POST /discovery/discover/sensitives /discovery/discover/sensitives [POST]
DiscoveryApi DiscoveryDiscoverTagsRelated POST /discovery/discover/tags/related /discovery/discover/tags/related [POST]
DistributionApi DistributionUpdate POST /distribution/update /distribution/update [POST]
DistributionApi DistributionsSpecificDistributionSnapshot GET /distribution/{distribution} /distribution/{distribution} [GET]
DistributionsApi DistributionsCreateNewDistribution POST /distributions/create /distributions/create [POST]
DistributionsApi DistributionsDeleteSpecificDistribution POST /distributions/{distribution}/delete /distributions/{distribution}/delete [POST]
DistributionsApi DistributionsSnapshot GET /distributions /distributions [GET]
ExternalProviderApi ExternalProviderApiKeyCreate POST /external_provider/api_key/create /external_provider/api_key/create [POST]
ExternalProviderApi ExternalProviderApiKeyDelete POST /external_provider/api_key/delete /external_provider/api_key/delete [POST]
ExternalProviderApi ExternalProviderApiKeyUpdate POST /external_provider/api_key/update /external_provider/api_key/update [POST]
FormatApi FormatAnalysis GET /format/{format}/analysis /format/{format}/analysis [GET]
FormatApi FormatReclassify POST /format/reclassify /format/reclassify [POST]
FormatApi FormatSnapshot GET /format/{format} /format/{format} [GET] Scoped to Format
FormatApi FormatUpdateValue POST /format/update/value [POST] /format/update/value
FormatsApi FormatsSnapshot GET /formats /formats [GET] Scoped to Formats
FormatsApi FormatsSpecificFormatSnapshot GET /formats/{format} /formats/{format} [GET] Scoped to Formats
FormatsApi FormatsStreamIdentifiers GET /formats/stream/identifiers /formats/stream/identifiers [WS]
GithubApi ImportGithubGists POST /github/gists/import /github/gists/import [POST]
HintApi HintAssociateAsset POST /hint/{hint}/assets/associate/{asset} /hint/{hint}/assets/associate/{asset} [POST]
HintApi HintDisassociateAsset POST /hint/{hint}/assets/disassociate/{asset} /hint/{hint}/assets/disassociate/{asset} [POST]
HintApi HintScoresIncrement POST /hint/{hint}/scores/increment '/hint/{hint}/scores/increment' [POST]
HintApi HintSpecificHintSnapshot GET /hint/{hint} /hint/{hint} [POST]
HintApi HintUpdate POST /hint/update /hint/update [POST]
HintsApi HintsCreateNewHint POST /hints/create /hints/create [POST]
HintsApi HintsDeleteSpecificHint POST /hints/{hint}/delete /hints/{hint}/delete [POST]
HintsApi HintsSnapshot GET /hints /hints [GET]
HintsApi HintsStreamIdentifiers GET /hints/stream/identifiers /hints/stream/identifiers [WS]
HintsApi SearchHints POST /hints/search /hints/search [POST]
ImageAnalysesApi ImageAnalysesSnapshot GET /image_analyses Your GET endpoint
LinkifyApi Linkify POST /linkify /linkify [POST]
LinkifyApi LinkifyMultiple POST /linkify/multiple /linkify/multiple [POST]
LinkifyApi LinkifyShareRevoke POST /linkify/{share}/revoke [POST} /linkify/{share}/revoke
MacOSApi AssetsCreateNewAssetFromMacos POST /macos/assets/create /macos/assets/create [Post]
MachineLearningApi PersonificationTechnicalLanguageGeneration POST /machine_learning/text/technical_language/generators/personification /machine_learning/text/technical_language/generators/personification [GET]
MachineLearningApi SegmentTechnicalLanguage POST /machine_learning/text/technical_language/parsers/segmentation /machine_learning/text/technical_language/parsers/segmentation [POST]
MetricsApi GetMetricsFormats GET /metrics/formats /metrics/formats [GET]
MetricsApi MetricsFormatsOrdered GET /metrics/formats/ordered /metrics/formats/ordered [GET]
ModelApi ModelScoresIncrement POST /model/{model}/scores/increment '/model/{model}/scores/increment' [POST]
ModelApi ModelSpecificModelDownload POST /model/{model}/download /model/{model}/download [POST]
ModelApi ModelSpecificModelDownloadCancel POST /model/{model}/download/cancel /model/{model}/download/cancel [POST]
ModelApi ModelSpecificModelDownloadProgress GET /model/{model}/download/progress /model/{model}/download/progress [WS]
ModelApi ModelSpecificModelLoad POST /model/{model}/load /model/{model}/load [POST]
ModelApi ModelSpecificModelUnload POST /model/{model}/unload /model/{model}/unload [POST]
ModelApi ModelUpdate POST /model/update /model/update [POST]
ModelApi ModelsSpecificModelSnapshot GET /model/{model} /model/{model} [GET]
ModelsApi ModelsCreateNewModel POST /models/create /models/create [POST]
ModelsApi ModelsDeleteSpecificModel POST /models/{model}/delete /models/{model}/delete [POST]
ModelsApi ModelsDeleteSpecificModelCache POST /models/{model}/delete/cache /models/{model}/delete/cache [POST]
ModelsApi ModelsSnapshot GET /models /models [GET]
ModelsApi ModelsStreamIdentifiers GET /models/stream/identifiers /models/stream/identifiers [WS]
ModelsApi UnloadModels POST /models/unload /models/unload [POST]
NotificationsApi SendLocalNotification POST /notifications/local/send Send notification
OCRAnalysesApi OcrAnalysesSnapshot GET /ocr_analyses Your GET endpoint
OSApi LinkProvider POST /os/link_provider /os/link_provider [POST]
OSApi OsAppletLaunch POST /os/applet/launch /os/applet/launch [POST]
OSApi OsAppletRestart POST /os/applet/restart /os/applet/restart [POST]
OSApi OsAppletTerminate POST /os/applet/terminate /os/applet/terminate [POST]
OSApi OsBrowserUrlOpen POST /os/browser/url/open /os/browser/url/open [POST]
OSApi OsDeviceInformation GET /os/device/information /os/device/information [GET]
OSApi OsFilesystemFileOpen POST /os/filesystem/file/open /os/filesystem/file/open [POST]
OSApi OsFilesystemFileReadStreamed GET /os/filesystem/file/read/streamed /os/filesystem/file/read/streamed [WS]
OSApi OsFilesystemPathVerify POST /os/filesystem/path/verify /os/filesystem/path/verify [POST]
OSApi OsFilesystemPickFiles POST /os/filesystem/files/pick /os/filesystem/files/pick [POST]
OSApi OsFilesystemPickFolders POST /os/filesystem/folders/pick /os/filesystem/folders/pick [POST]
OSApi OsMemoryOptimize POST /os/memory/optimize /os/memory/optimize [POST]
OSApi OsMetadata GET /os/metadata /os/metadata [GET]
OSApi OsPermissions GET /os/permissions /os/permissions [GET]
OSApi OsPermissionsRequest POST /os/permissions/request /os/permissions/request [POST]
OSApi OsRestart GET /os/restart Your GET endpoint
OSApi OsSettingsSnapshot GET /os/settings /os/settings [GET]
OSApi OsSettingsStream GET /os/settings/stream /os/settings/stream [WS]
OSApi OsSettingsUpdate POST /os/settings/update /os/settings/update [POST]
OSApi OsTerminate POST /os/terminate /os/terminate [POST]
OSApi OsUpdateCheck POST /os/update/check /os/update/check [POST]
OSApi OsUpdateCheckStream GET /os/update/check/stream /os/update/check/stream [WS]
OSApi SignIntoOS POST /os/sign_in
OSApi SignOutOfOS POST /os/sign_out /os/sign_out [POST]
OllamaApi OllamaInstall POST /ollama/install /ollama/install [POST]
OllamaApi OllamaInstallCancel POST /ollama/install/{identifier}/cancel /ollama/install/{identifier}/cancel [POST]
OllamaApi OllamaInstallSnapshot GET /ollama/install/{identifier} /ollama/install/{identifier} [GET]
OllamaApi OllamaInstallsSnapshot GET /ollama/installs /ollama/installs [GET]
OllamaApi OllamaStatusCheck GET /ollama/status /ollama/status [GET]
OllamaApi OllamaStatusCheckStream GET /ollama/status/stream /ollama/status/stream [WS]
OllamaApi OllamaUninstall POST /ollama/uninstall /ollama/uninstall [POST]
OllamaApi OllamaUpdate POST /ollama/update /ollama/update [POST]
OllamaApi OllamaUpdateCancel POST /ollama/update/{identifier}/cancel /ollama/update/{identifier}/cancel [POST]
OllamaApi OllamaUpdateSnapshot GET /ollama/update/{identifier} /ollama/update/{identifier} [GET]
OllamaApi OllamaUpdatesSnapshot GET /ollama/updates /ollama/updates [GET]
OpenAIApi OpenAiModelsList POST /open_ai/models/list /open_ai/models/list [POST]
PKCEApi ClearPKCE POST /pkce/clear /pkce/clear [POST]
PKCEApi GenerateCode POST /pkce/code /pkce/code [POST]
PKCEApi GenerateToken POST /pkce/token /pkce/token [POST]
PKCEApi GetChallenge GET /pkce/challenge Your GET endpoint
PKCEApi RespondWithCode POST /pkce/response/code /pkce/response/code [POST]
PersonApi PersonAssociateAnchor POST /person/{person}/anchors/associate/{anchor} /person/{person}/anchors/associate/{anchor} [POST]
PersonApi PersonAssociateAsset POST /person/{person}/assets/associate/{asset} /person/{person}/assets/associate/{asset} [POST]
PersonApi PersonAssociateMessage POST /person/{person}/messages/associate/{message} /person/{person}/messages/associate/{message} [POST]
PersonApi PersonAssociateTag POST /person/{person}/tags/associate/{tag} /person/{person}/tags/associate/{tag} [POST]
PersonApi PersonAssociateWebsite POST /person/{person}/websites/associate/{website} /person/{person}/websites/associate/{website} [POST]
PersonApi PersonAssociateWorkstreamSummary POST /person/{person}/workstream_summaries/associate/{workstream_summary} /person/{person}/workstream_summaries/associate/{workstream_summary} [POST]
PersonApi PersonDisassociateAnchor POST /person/{person}/anchors/disassociate/{anchor} /person/{person}/anchors/disassociate/{anchor} [POST]
PersonApi PersonDisassociateAsset POST /person/{person}/assets/disassociate/{asset} /person/{person}/assets/disassociate/{asset} [POST]
PersonApi PersonDisassociateMessage POST /person/{person}/messages/disassociate/{message} /person/{person}/messages/disassociate/{message} [POST]
PersonApi PersonDisassociateTag POST /person/{person}/tags/disassociate/{tag} /person/{person}/tags/disassociate/{tag} [POST]
PersonApi PersonDisassociateWebsite POST /person/{person}/websites/disassociate/{website} /person/{person}/websites/disassociate/{website} [POST]
PersonApi PersonDisassociateWorkstreamSummary POST /person/{person}/workstream_summaries/disassociate/{workstream_summary} /person/{person}/workstream_summaries/disassociate/{workstream_summary} [POST]
PersonApi PersonScoresIncrement POST /person/{person}/scores/increment '/person/{person}/scores/increment' [POST]
PersonApi PersonSnapshot GET /person/{person} /person/{person} [GET]
PersonApi UpdatePerson POST /person/update /person/update [POST]
PersonsApi PersonsCreateNewPerson POST /persons/create /persons/create [POST]
PersonsApi PersonsDeletePerson POST /persons/{person}/delete /persons/{person}/delete [POST]
PersonsApi PersonsSnapshot GET /persons /persons [GET]
PersonsApi PersonsStreamIdentifiers GET /persons/stream/identifiers /persons/stream/identifiers [WS]
PersonsApi SearchPersons POST /persons/search /persons/search [POST]
PieceApi HtmlShare GET / / [GET]
QGPTApi Hints POST /qgpt/hints /qgpt/hints [POST]
QGPTApi PersonsRelated POST /qgpt/persons/related /qgpt/persons/related [POST]
QGPTApi QgptStream GET /qgpt/stream /qgpt/stream [WS]
QGPTApi Question POST /qgpt/question /qgpt/question [POST]
QGPTApi Relevance POST /qgpt/relevance /qgpt/relevance [POST]
QGPTApi Reprompt POST /qgpt/reprompt /qgpt/reprompt [POST]
RangeApi RangeAssociateConversationGroundingTemporalRangeWorkstreams POST /range/{range}/conversations/grounding/temporal_range/workstreams/associate/{conversation} /range/{range}/conversations/grounding/temporal_range/workstreams/associate/{conversation} [POST]
RangeApi RangeAssociateWorkstreamSummary POST /range/{range}/workstream_summaries/associate/{workstream_summary} /range/{range}/workstream_summaries/associate/{workstream_summary} [POST]
RangeApi RangeDisassociateConversationGroundingTemporalRangeWorkstreams POST /range/{range}/conversations/grounding/temporal_range/workstreams/disassociate/{conversation} /range/{range}/conversations/grounding/temporal_range/workstreams/disassociate/{conversation} [POST]
RangeApi RangeDisassociateWorkstreamSummary POST /range/{range}/workstream_summaries/disassociate/{workstream_summary} /range/{range}/workstream_summaries/disassociate/{workstream_summary} [POST]
RangeApi RangeScoresIncrement POST /range/{range}/scores/increment '/range/{range}/scores/increment' [POST]
RangeApi RangeUpdate POST /range/update /range/update [POST]
RangeApi RangesSpecificRangeSnapshot GET /range/{range} /range/{range} [GET]
RangesApi RangesCreateNewRange POST /ranges/create /ranges/create [POST]
RangesApi RangesDeleteSpecificRange POST /ranges/{range}/delete /ranges/{range}/delete [POST]
RangesApi RangesSnapshot GET /ranges /ranges [GET]
RangesApi RangesStreamIdentifiers GET /ranges/stream/identifiers /ranges/stream/identifiers [WS]
RelationshipApi RelationshipsSpecificRelationshipSnapshot GET /relationship/{relationship} /relationship/{relationship} [GET]
RelationshipsApi RelationshipsSnapshot GET /relationships /relationships [GET]
SearchApi FullTextSearch GET /search/full_text /search/full_text [GET]
SearchApi NeuralCodeSearch GET /search/neural_code /search/neural_code [GET]
SearchApi TagBasedSearch POST /search/tag_based /search/tag_based [POST]
SensitiveApi SensitiveScoresIncrement POST /sensitive/{sensitive}/scores/increment '/sensitive/{sensitive}/scores/increment' [POST]
SensitiveApi SensitiveSnapshot GET /sensitive/{sensitive} /sensitive/{sensitive} [GET]
SensitiveApi UpdateSensitive POST /sensitive/update /sensitive/update [POST]
SensitivesApi SearchSensitives POST /sensitives/search /sensitives/search [POST]
SensitivesApi SensitivesCreateNewSensitive POST /sensitives/create /sensitives/create [POST]
SensitivesApi SensitivesDeleteSensitive POST /sensitives/{sensitive}/delete /sensitives/{sensitive}/delete [POST]
SensitivesApi SensitivesSnapshot GET /sensitives /sensitives [GET]
SensitivesApi SensitivesStreamIdentifiers GET /sensitives/stream/identifiers /sensitives/stream/identifiers [WS]
ShareApi ShareScoresIncrement POST /share/{share}/scores/increment '/share/{share}/scores/increment' [POST]
ShareApi ShareSnapshot GET /share/{share} /share/{share}
ShareApi ShareUpdate POST /share/update /share/update [POST]
SharesApi SharesCreateNewShare POST /shares/create /shares/create [POST]
SharesApi SharesDeleteShare POST /shares/{share}/delete /shares/{share}/delete [POST]
SharesApi SharesSnapshot GET /shares /shares [GET]
SharesApi SharesSpecificShareSnapshot GET /shares/{share} /shares/{share} [GET]
TagApi TagAssociateAsset POST /tag/{tag}/assets/associate/{asset} /tag/{tag}/assets/associate/{asset} [POST]
TagApi TagAssociatePerson POST /tag/{tag}/persons/associate/{person} /tag/{tag}/persons/associate/{person} [POST]
TagApi TagDisassociateAsset POST /tag/{tag}/assets/disassociate/{asset} /tag/{tag}/assets/disassociate/{asset} [POST]
TagApi TagDisassociatePerson POST /tag/{tag}/persons/disassociate/{person} /tag/{tag}/persons/disassociate/{person} [POST]
TagApi TagScoresIncrement POST /tag/{tag}/scores/increment '/tag/{tag}/scores/increment' [POST]
TagApi TagUpdate POST /tag/update /tag/update [POST]
TagApi TagsSpecificTagSnapshot GET /tag/{tag} /tag/{tag} [GET]
TagsApi SearchTags POST /tags/search /tags/search [POST]
TagsApi TagsCreateNewTag POST /tags/create /tags/create [POST]
TagsApi TagsDeleteSpecificTag POST /tags/{tag}/delete /tags/{tag}/delete [POST]
TagsApi TagsExists POST /tags/exists /tags/exists [POST]
TagsApi TagsSnapshot GET /tags /tags [GET]
TagsApi TagsStreamIdentifiers GET /tags/stream/identifiers /tags/stream/identifiers [WS]
UltraSuiteApi AssetsCreateUltraSuiteAsset POST /ultra_suite/assets/create /ultra_suite/assets/create [POST]
UserApi ClearUser POST /user/clear /user/clear
UserApi RefreshUser GET /user/refresh /user/refresh [GET]
UserApi SelectUser POST /user/select /user/select [POST]
UserApi StreamUser GET /user/stream /user/stream [WS]
UserApi UpdateUser POST /user/update /user/update [POST]
UserApi UserAccessToken GET /user/access_token '/user/access_token' [GET]
UserApi UserBetaStatus POST /user/beta/status /user/beta/status [POST]
UserApi UserProviders GET /user/providers Your GET endpoint
UserApi UserSnapshot GET /user /user [GET]
UserApi UserUpdateVanity POST /user/update/vanity /user/update/vanity [POST]
UsersApi AuthenticateFromOauthToken POST /users/authenticate/from_token /users/authenticate/from_token [POST]
UsersApi UsersDisconnectUser POST /users/{user}/disconnect /users/{user}/disconnect [POST]
UsersApi UsersSnapshot GET /users /users [GET]
UsersApi UsersSpecificUserSnapshot GET /users/{user} /users/{user} [GET] Scoped to Users
WebsiteApi WebsiteAssociateAsset POST /website/{website}/assets/associate/{asset} /website/{website}/assets/associate/{asset} [POST]
WebsiteApi WebsiteAssociateConversation POST /website/{website}/conversations/associate/{conversation} /website/{website}/conversations/associate/{conversation} [POST]
WebsiteApi WebsiteAssociateMessage POST /website/{website}/messages/associate/{message} /website/{website}/messages/associate/{message} [POST]
WebsiteApi WebsiteAssociatePerson POST /website/{website}/persons/associate/{person} /website/{website}/persons/associate/{person} [POST]
WebsiteApi WebsiteAssociateWorkstreamSummary POST /website/{website}/workstream_summaries/associate/{workstream_summary} /website/{website}/workstream_summaries/associate/{workstream_summary} [POST]
WebsiteApi WebsiteDisassociateAsset POST /website/{website}/assets/disassociate/{asset} /website/{website}/assets/disassociate/{asset} [POST]
WebsiteApi WebsiteDisassociateConversation POST /website/{website}/conversations/disassociate/{conversation} /website/{website}/conversations/disassociate/{conversation} [POST]
WebsiteApi WebsiteDisassociateMessage POST /website/{website}/messages/disassociate/{message} /website/{website}/messages/disassociate/{message} [POST]
WebsiteApi WebsiteDisassociatePerson POST /website/{website}/persons/disassociate/{person} /website/{website}/persons/disassociate/{person} [POST]
WebsiteApi WebsiteDisassociateWorkstreamSummary POST /website/{website}/workstream_summaries/disassociate/{workstream_summary} /website/{website}/workstream_summaries/disassociate/{workstream_summary} [POST]
WebsiteApi WebsiteScoresIncrement POST /website/{website}/scores/increment '/website/{website}/scores/increment' [POST]
WebsiteApi WebsiteUpdate POST /website/update /website/update [POST]
WebsiteApi WebsitesSpecificWebsiteSnapshot GET /website/{website} /website/{website} [GET]
WebsitesApi SearchWebsites POST /websites/search /websites/search [POST]
WebsitesApi WebsitesCreateNewWebsite POST /websites/create /websites/create [POST]
WebsitesApi WebsitesDeleteSpecificWebsite POST /websites/{website}/delete /websites/{website}/delete [POST]
WebsitesApi WebsitesExists POST /websites/exists /websites/exists [POST]
WebsitesApi WebsitesSnapshot GET /websites /websites [GET]
WebsitesApi WebsitesStreamIdentifiers GET /websites/stream/identifiers /websites/stream/identifiers [WS]
WellKnownApi GetInstallationPath GET /.well-known/installation/path /.well-known/installation/path [Get]
WellKnownApi GetWellKnownHealth GET /.well-known/health /.well-known/health [GET]
WellKnownApi GetWellKnownStreamHealth GET /.well-known/stream/health /.well-known/stream/health [WS]
WellKnownApi GetWellKnownVersion GET /.well-known/version /.well-known/version [Get]
WorkstreamApi WorkstreamSuggestionsRefresh POST /workstream/suggestions/refresh /workstream/suggestions/refresh [POST]
WorkstreamApi WorkstreamSuggestionsStream GET /workstream/suggestions/stream /workstream/suggestions/stream [WS]
WorkstreamEventApi WorkstreamEventAssociateWorkstreamSummary POST /workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary} /workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary} [POST]
WorkstreamEventApi WorkstreamEventDisassociateWorkstreamSummary POST /workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary} /workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary} [POST]
WorkstreamEventApi WorkstreamEventScoresIncrement POST /workstream_event/{workstream_event}/scores/increment '/workstream_event/{workstream_event}/scores/increment' [POST]
WorkstreamEventApi WorkstreamEventUpdate POST /workstream_event/update /workstream_event/update [POST]
WorkstreamEventApi WorkstreamEventsSpecificWorkstreamEventSnapshot GET /workstream_event/{workstream_event} /workstream_event/{workstream_event} [GET]
WorkstreamEventsApi WorkstreamEventsCreateNewWorkstreamEvent POST /workstream_events/create /workstream_events/create [POST]
WorkstreamEventsApi WorkstreamEventsDeleteSpecificWorkstreamEvent POST /workstream_events/{workstream_event}/delete /workstream_events/{workstream_event}/delete [POST]
WorkstreamEventsApi WorkstreamEventsSnapshot GET /workstream_events /workstream_events [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineCreateIngestion POST /workstream_pattern_engine/ingestions/create /workstream_pattern_engine/ingestions/create [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsSources GET /workstream_pattern_engine/processors/sources /workstream_pattern_engine/processors/sources [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionActivate POST /workstream_pattern_engine/processors/vision/activate /workstream_pattern_engine/processors/vision/activate [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionCalibrationCapture POST /workstream_pattern_engine/processors/vision/calibration/capture /workstream_pattern_engine/processors/vision/calibration/capture [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionCalibrationsFocused GET /workstream_pattern_engine/processors/vision/calibrations/focused /workstream_pattern_engine/processors/vision/calibrations/focused [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionCalibrationsSnapshot GET /workstream_pattern_engine/processors/vision/calibrations /workstream_pattern_engine/processors/vision/calibrations [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionDataClear POST /workstream_pattern_engine/processors/vision/data/clear /workstream_pattern_engine/processors/vision/data/clear [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionDeactivate POST /workstream_pattern_engine/processors/vision/deactivate /workstream_pattern_engine/processors/vision/deactivate [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionEventDeleteSpecificVisionEvent POST /workstream_pattern_engine/processors/vision/data/events/{vision_event}/delete /workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionEventsScopedDelete POST /workstream_pattern_engine/processors/vision/data/events/scoped_delete /workstream_pattern_engine/processors/vision/events/scoped_delete [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionEventsSearch POST /workstream_pattern_engine/processors/vision/data/events/search /workstream_pattern_engine/processors/vision/data/events/search [POST]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionEventsSnapshot GET /workstream_pattern_engine/processors/vision/data/events /workstream_pattern_engine/processors/vision/data/events [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionEventsSpecificSnapshot GET /workstream_pattern_engine/processors/vision/data/events/{vision_event} /workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionMetadata GET /workstream_pattern_engine/processors/vision/metadata /workstream_pattern_engine/processors/vision/metadata [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionStatus GET /workstream_pattern_engine/processors/vision/status /workstream_pattern_engine/processors/vision/status [GET]
WorkstreamPatternEngineApi WorkstreamPatternEngineProcessorsVisionStatusStream GET /workstream_pattern_engine/processors/vision/status/stream /workstream_pattern_engine/processors/vision/status/stream [WS]
WorkstreamPatternEngineSourceApi WorkstreamPatternEngineSourceScoresIncrement POST /workstream_pattern_engine/source/{source}/scores/increment '/workstream_pattern_engine/source/{source}/scores/increment' [POST]
WorkstreamPatternEngineSourceApi WorkstreamPatternEngineSourceUpdate POST /workstream_pattern_engine/source/update /workstream_pattern_engine/source/update [POST]
WorkstreamPatternEngineSourceApi WorkstreamPatternEngineSourcesSpecificSourceSnapshot GET /workstream_pattern_engine/source/{source} /workstream_pattern_engine/source/{source} [GET]
WorkstreamPatternEngineSourcesApi WorkstreamPatternEngineSearchSources POST /workstream_pattern_engine/sources/search /workstream_pattern_engine/sources/search [POST]
WorkstreamPatternEngineSourcesApi WorkstreamPatternEngineSourcesCreateNewSource POST /workstream_pattern_engine/sources/create /workstream_pattern_engine/sources/create [POST]
WorkstreamPatternEngineSourcesApi WorkstreamPatternEngineSourcesDeleteSpecificSource POST /workstream_pattern_engine/sources/{source}/delete /workstream_pattern_engine/sources/{source}/delete [POST]
WorkstreamPatternEngineSourcesApi WorkstreamPatternEngineSourcesSnapshot GET /workstream_pattern_engine/sources /workstream_pattern_engine/sources [GET]
WorkstreamPatternEngineSourcesApi WorkstreamPatternEngineSourcesStreamIdentifiers GET /workstream_pattern_engine/sources/stream/identifiers /workstream_pattern_engine/sources/stream/identifiers [WS]
WorkstreamSummariesApi SearchWorkstreamSummaries POST /workstream_summaries/search /workstream_summaries/search [POST]
WorkstreamSummariesApi WorkstreamSummariesCreateNewWorkstreamSummary POST /workstream_summaries/create /workstream_summaries/create [POST]
WorkstreamSummariesApi WorkstreamSummariesDeleteSpecificWorkstreamSummary POST /workstream_summaries/{workstream_summary}/delete /workstream_summaries/{workstream_summary}/delete [POST]
WorkstreamSummariesApi WorkstreamSummariesSnapshot GET /workstream_summaries /workstream_summaries [GET]
WorkstreamSummaryApi WorkstreamSummariesSpecificWorkstreamSummarySnapshot GET /workstream_summary/{workstream_summary} /workstream_summary/{workstream_summary} [GET]
WorkstreamSummaryApi WorkstreamSummaryAssociateAnchor POST /workstream_summary/{workstream_summary}/anchors/associate/{anchor} /workstream_summary/{workstream_summary}/anchors/associate/{anchor} [POST]
WorkstreamSummaryApi WorkstreamSummaryAssociateAsset POST /workstream_summary/{workstream_summary}/assets/associate/{asset} /workstream_summary/{workstream_summary}/assets/associate/{asset} [POST]
WorkstreamSummaryApi WorkstreamSummaryAssociateConversation POST /workstream_summary/{workstream_summary}/conversations/associate/{conversation} /workstream_summary/{workstream_summary}/conversations/associate/{conversation} [POST]
WorkstreamSummaryApi WorkstreamSummaryAssociatePerson POST /workstream_summary/{workstream_summary}/persons/associate/{person} /workstream_summary/{workstream_summary}/persons/associate/{person} [POST]
WorkstreamSummaryApi WorkstreamSummaryAssociateRange POST /workstream_summary/{workstream_summary}/ranges/associate/{range} /workstream_summary/{workstream_summary}/ranges/associate/{range} [POST]
WorkstreamSummaryApi WorkstreamSummaryAssociateWebsite POST /workstream_summary/{workstream_summary}/websites/associate/{website} /workstream_summary/{workstream_summary}/websites/associate/{website} [POST]
WorkstreamSummaryApi WorkstreamSummaryAssociateWorkstreamEvent POST /workstream_summary/{workstream_summary}/workstream_events/associate/{workstream_event} /workstream_summary/{workstream_summary}/workstream_events/associate/{workstream_event} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociateAnchor POST /workstream_summary/{workstream_summary}/anchors/disassociate/{anchor} /workstream_summary/{workstream_summary}/anchors/disassociate/{anchor} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociateAsset POST /workstream_summary/{workstream_summary}/assets/disassociate/{asset} /workstream_summary/{workstream_summary}/assets/disassociate/{asset} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociateConversation POST /workstream_summary/{workstream_summary}/conversations/disassociate/{conversation} /workstream_summary/{workstream_summary}/conversations/disassociate/{conversation} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociatePerson POST /workstream_summary/{workstream_summary}/persons/disassociate/{person} /workstream_summary/{workstream_summary}/persons/disassociate/{person} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociateRange POST /workstream_summary/{workstream_summary}/ranges/disassociate/{range} /workstream_summary/{workstream_summary}/ranges/disassociate/{range} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociateWebsite POST /workstream_summary/{workstream_summary}/websites/disassociate/{website} /workstream_summary/{workstream_summary}/websites/disassociate/{website} [POST]
WorkstreamSummaryApi WorkstreamSummaryDisassociateWorkstreamEvent POST /workstream_summary/{workstream_summary}/workstream_events/disassociate/{workstream_event} /workstream_summary/{workstream_summary}/workstream_events/disassociate/{workstream_event} [POST]
WorkstreamSummaryApi WorkstreamSummaryScoresIncrement POST /workstream_summary/{workstream_summary}/scores/increment '/workstream_summary/{workstream_summary}/scores/increment' [POST]
WorkstreamSummaryApi WorkstreamSummaryUpdate POST /workstream_summary/update /workstream_summary/update [POST]

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

auth0

  • Type: OAuth
  • Flow: implicit
  • Authorization URL:
  • Scopes: N/A

auth0

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

auth0

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes: N/A

authorization

  • Type: OAuth
  • Flow: implicit
  • Authorization URL:
  • Scopes: N/A

authorization

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

authorization

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes: N/A

application

  • Type: API key
  • API key parameter name: X-Application-ID
  • Location: HTTP header