Pieces for Developers
  • Products
  • API Reference
  • Piece
    • / [GET]
      GET
  • WellKnown
    • /.well-known/health [GET]
      GET
    • /.well-known/stream/health [WS]
      GET
    • /.well-known/version [Get]
      GET
  • Activities
    • /activities [GET]
      GET
    • /activities/{activity}/delete [POST]
      POST
  • Allocation
    • /allocation/update [POST]
      POST
    • /allocation/{allocation} [GET]
      GET
  • Allocations
    • /allocations [GET]
      GET
    • /allocations/connect [POST]
      POST
    • /allocations/create [POST]
      POST
    • /allocations/delete [POST]
      POST
    • /allocations/disconnect [POST]
      POST
    • /allocations/reconnect [POST]
      POST
  • Analyses
    • Your GET endpoint
      GET
  • Anchor
    • /anchor/update [POST]
      POST
    • /anchor/{anchor} [GET]
      GET
    • /anchor/{anchor}/assets/associate/{asset} [POST]
      POST
    • /anchor/{anchor}/assets/disassociate/{asset} [POST]
      POST
    • /anchor/{anchor}/conversations/associate/{conversation} [POST]
      POST
    • /anchor/{anchor}/conversations/disassociate/{conversation} [POST]
      POST
    • /anchor/{anchor}/messages/associate/{message} [POST]
      POST
    • /anchor/{anchor}/messages/disassociate/{message} [POST]
      POST
    • /anchor/{anchor}/persons/associate/{person} [POST]
      POST
    • /anchor/{anchor}/persons/disassociate/{person} [POST]
      POST
    • /anchor/{anchor}/rename [POST]
      POST
    • '/anchor/{anchor}/scores/increment' [POST]
      POST
    • /anchor/{anchor}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /anchor/{anchor}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • AnchorPoint
    • /anchor_point/update [POST]
      POST
    • /anchor_point/{anchor_point} [GET]
      GET
    • '/anchor_point/{anchor_point}/scores/increment' [POST]
      POST
  • AnchorPoints
    • /anchor_points [GET]
      GET
    • /anchor_points/create [POST]
      POST
    • /anchor_points/{anchor_point}/delete [POST]
      POST
  • Anchors
    • /anchors [GET]
      GET
    • /anchors/search [POST]
      POST
    • /anchors/{anchor}/delete [POST]
      POST
  • Annotation
    • /annotation/update [POST]
      POST
    • /annotation/{annotation} [GET]
      GET
    • '/annotation/{annotation}/scores/increment' [POST]
      POST
  • Annotations
    • /annotations [GET]
      GET
    • /annotations/create [POST]
      POST
    • /annotations/search [POST]
      POST
    • /annotations/stream/identifiers [WS]
      GET
    • /annotations/{annotation}/delete [POST]
      POST
  • Application
    • /application/update [GET]
      POST
  • Applications
    • /applications [GET]
      GET
    • /applications/external [GET]
      GET
    • /applications/external/related [GET]
      GET
    • /applications/register [POST]
      POST
    • /applications/session/close [POST]
      POST
    • /applications/session/open [POST]
      POST
  • Asset
    • /asset/reclassify [POST]
      POST
    • /asset/update [POST] Scoped to Asset
      POST
    • /asset/{asset} [GET] Scoped To Asset
      GET
    • /asset/{asset} [POST] Scoped to an Asset
      POST
    • /asset/{asset}/activities [GET]
      GET
    • /asset/{asset}/persons/associate/{anchor} [POST]
      POST
    • /asset/{asset}/anchors/disassociate/{anchor} [POST]
      POST
    • /asset/{asset}/conversations [GET]
      GET
    • /asset/{asset}/conversations/associate/{conversation} [POST]
      POST
    • /asset/{asset}/conversations/disassociate/{conversation} [POST]
      POST
    • /asset/{asset}/export [GET]
      GET
    • /asset/{asset}/formats [GET] Scoped To Asset
      GET
    • /asset/{asset}/hints/associate/{hint} [POST]
      POST
    • /asset/{asset}/hints/disassociate/{hint} [POST]
      POST
    • /asset/{asset}/persons/associate/{person} [POST]
      POST
    • /asset/{asset}/persons/disassociate/{person} [POST]
      POST
    • /asset/{asset}/scores/increment [POST]
      POST
    • /asset/{asset}/tags/associate/{tag} [POST]
      POST
    • /asset/{asset}/tags/disassociate/{tag} [POST]
      POST
    • /asset/{asset}/websites/associate/{website} [POST]
      POST
    • /asset/{asset}/websites/disassociate/{website} [POST]
      POST
    • /asset/{asset}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /asset/{asset}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • Assets
    • /assets [GET] Scoped to Assets
      GET
    • /assets/create [POST] Scoped to Asset
      POST
    • /assets/draft [POST]
      POST
    • /assets/identifiers [GET]
      GET
    • /assets/pseudo [GET]
      GET
    • Your GET endpoint
      GET
    • /assets/related [GET]
      GET
    • /assets/search?query=string [GET]
      GET
    • /assets/search [POST]
      POST
    • /assets/stream [WS]
      GET
    • /assets/stream/identifiers [WS]
      GET
    • /assets/stream/transferables [WS]
      GET
    • /assets/{asset} [GET] Scoped to Assets
      GET
    • /assets/{asset}/delete [POST] Scoped to Asset
      POST
    • /assets/{asset}/formats [GET] Scoped To Assets
      GET
  • Backup
    • /backup [POST]
      POST
    • /backup/asset [POST]
      POST
    • /backup/{backup} [GET]
      GET
    • /backup/{backup}/creation/cancel [POST]
      POST
    • /backup/{backup}/creation/status [GET]
      GET
    • /backup/{backup}/restoration/cancel [POST]
      POST
    • /backup/{backup}/restoration/status [GET]
      GET
    • /backup/{backup}/restore [POST]
      POST
    • /backup/{backup}/restore/streamed [POST]
      POST
    • /backup/{backup}/restore/streamed/websocket [WS]
      GET
  • Backups
    • /backups [GET]
      GET
    • /backups/create [POST]
      POST
    • /backups/create/streamed [POST]
      POST
    • /backups/create/streamed/websocket [WS]
      GET
    • /backups/streamed/progress [WS]
      GET
    • /backups/{backup}/delete [POST]
      POST
  • Classification
    • Convert Generic Classification
      POST
  • CodeAnalyses
    • Your GET endpoint
      GET
  • Connector
    • /connect [POST]
      POST
    • /{application}/intention [POST]
      POST
    • /onboarded [POST]
      POST
    • /{application}/reaction [POST]
      POST
    • /{application}/suggestion [POST]
      POST
  • Conversation
    • /conversation/update [POST]
      POST
    • /conversation/{conversation} [GET]
      GET
    • /conversation/{conversation}/anchors/associate/{anchor} [POST]
      POST
    • /conversation/{conversation}/anchors/disassociate/{anchor} [POST]
      POST
    • /conversation/{conversation}/assets/associate/{asset} [POST]
      POST
    • /conversation/{conversation}/assets/disassociate/{asset} [POST]
      POST
    • /conversation/{conversation}/grounding/messages/associate/{message} [POST]
      POST
    • /conversation/{conversation}/grounding/messages/disassociate/{message} [POST]
      POST
    • /conversation/{conversation}/grounding/temporal/ranges/associate/{range} [POST]
      POST
    • /conversation/{conversation}/grounding/temporal_range/workstreams/disassociate/{range} [POST]
      POST
    • /conversation/{conversation}/messages [GET]
      GET
    • /conversation/{conversation}/rename [POST]
      POST
    • /conversation/{conversation}/scores/increment [POST]
      POST
    • /conversation/{conversation}/search [POST]
      POST
    • /conversation/{conversation}/summarize [POST]
      POST
    • /conversation/{conversation}/websites/associate/{website} [POST]
      POST
    • /website/{website}/websites/disassociate/{website} [POST]
      POST
    • /conversation/{conversation}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /conversation/{conversation}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • Conversations
    • /conversations [GET]
      GET
    • /conversations/create [POST]
      POST
    • /conversations/create/from_asset/{asset} [POST]
      POST
    • /conversations/identifiers [GET]
      GET
    • /conversations/search [POST]
      POST
    • /conversations/{conversation}/delete [POST]
      POST
  • Database
    • Your GET endpoint
      GET
    • /database/import [POST]
      POST
  • Discovery
    • /discovery/discover/assets [POST]
      POST
    • /discovery/discover/assets/html[POST]
      POST
    • /discovery/discover/sensitives [POST]
      POST
    • /discovery/discover/tags/related [POST]
      POST
  • Distribution
    • /distribution/update [POST]
      POST
    • /distribution/{distribution} [GET]
      GET
  • Distributions
    • /distributions [GET]
      GET
    • /distributions/create [POST]
      POST
    • /distributions/{distribution}/delete [POST]
      POST
  • ExternalProvider
    • /external_provider/api_key/create [POST]
      POST
    • /external_provider/api_key/delete [POST]
      POST
    • /external_provider/api_key/update [POST]
      POST
  • Format
    • /format/reclassify [POST]
      POST
    • [POST] /format/update/value
      POST
    • /format/{format} [GET] Scoped to Format
      GET
    • /format/{format}/analysis [GET]
      GET
  • Formats
    • /formats [GET] Scoped to Formats
      GET
    • /formats/{format} [GET] Scoped to Formats
      GET
  • Github
    • /github/gists/import [POST]
      POST
  • Hint
    • /hint/update [POST]
      POST
    • /hint/{hint} [POST]
      GET
    • /hint/{hint}/assets/associate/{asset} [POST]
      POST
    • /hint/{hint}/assets/disassociate/{asset} [POST]
      POST
    • '/hint/{hint}/scores/increment' [POST]
      POST
  • Hints
    • /hints [GET]
      GET
    • /hints/create [POST]
      POST
    • /hints/search [POST]
      POST
    • /hints/{hint}/delete [POST]
      POST
  • ImageAnalyses
    • Your GET endpoint
      GET
  • Linkify
    • /linkify [POST]
      POST
    • /linkify/multiple [POST]
      POST
    • [POST} /linkify/{share}/revoke
      POST
  • MachineLearning
    • /machine_learning/text/technical_language/generators/personification [GET]
      POST
    • /machine_learning/text/technical_language/parsers/segmentation [POST]
      POST
  • MacOS
    • /macos/assets/create [Post]
      POST
  • ConversationMessage
    • /message/update [GET]
      POST
    • /message/update/value [POST]
      POST
    • /message/{message} [GET]
      GET
    • /message/{message}/anchors/associate/{anchor} [POST]
      POST
    • /message/{message}/anchors/disassociate/{anchor} [POST]
      POST
    • /message/{message}/annotations/associate/{annotation} [POST]
      POST
    • /message/{message}/annotations/disassociate/{annotation} [POST]
      POST
    • /message/{message}/persons/associate/{person} [POST]
      POST
    • /message/{message}/persons/disassociate/{person} [POST]
      POST
    • '/message/{message}/scores/increment' [POST]
      POST
    • Associate a message with a website
      POST
    • /message/{message}/websites/disassociate/{website} [POST]
      POST
  • ConversationMessages
    • /messages [GET]
      GET
    • /messages/create [POST]
      POST
    • /messages/search [POST]
      POST
    • /messages/{message}/delete [POST]
      POST
  • Metrics
    • /metrics/formats [GET]
      GET
    • /metrics/formats/ordered [GET]
      GET
  • Model
    • /model/update [POST]
      POST
    • /model/{model} [GET]
      GET
    • /model/{model}/download [POST]
      POST
    • /model/{model}/download/cancel [POST]
      POST
    • /model/{model}/download/progress [WS]
      GET
    • /model/{model}/load [POST]
      POST
    • /model/{model}/unload [POST]
      POST
  • Models
    • /models [GET]
      GET
    • /models/create [POST]
      POST
    • /models/unload [POST]
      POST
    • /models/{model}/delete [POST]
      POST
    • /models/{model}/delete/cache [POST]
      POST
  • Notifications
    • Send notification
      POST
  • Auth0
    • https://auth.pieces.services/oauth/token [POST
      POST
    • https://auth.pieces.services/userinfo [GET
      GET
    • https://auth.pieces.services/v2/logout [GET
      GET
  • OCRAnalyses
    • Your GET endpoint
      GET
  • OpenAI
    • /open_ai/models/list [POST]
      POST
  • OS
    • /os/applet/launch [POST]
      POST
    • /os/applet/restart [POST]
      POST
    • /os/applet/terminate [POST]
      POST
    • /os/browser/url/open [POST]
      POST
    • /os/device/information [GET]
      GET
    • /os/filesystem/file/open [POST]
      POST
    • /os/filesystem/file/read/streamed [WS]
      GET
    • /os/filesystem/files/pick [POST]
      POST
    • /os/filesystem/folders/pick [POST]
      POST
    • /os/filesystem/path/verify [POST]
      POST
    • /os/link_provider [POST]
      POST
    • /os/memory/optimize [POST]
      POST
    • /os/permissions [GET]
      GET
    • /os/permissions/request [POST]
      POST
    • Your GET endpoint
      GET
    • /os/settings [GET]
      GET
    • /os/settings/stream [WS]
      GET
    • /os/settings/update [POST]
      POST
    • /os/sign_in
      POST
    • /os/sign_out [POST]
      POST
    • /os/terminate [POST]
      POST
    • /os/update/check [POST]
      POST
    • /os/update/check/stream [WS]
      GET
  • Person
    • /person/update [POST]
      POST
    • /person/{person} [GET]
      GET
    • /person/{person}/anchors/associate/{anchor} [POST]
      POST
    • /person/{person}/anchors/disassociate/{anchor} [POST]
      POST
    • /person/{person}/assets/associate/{asset} [POST]
      POST
    • /person/{person}/assets/disassociate/{asset} [POST]
      POST
    • /person/{person}/messages/associate/{message} [POST]
      POST
    • /person/{person}/messages/disassociate/{message} [POST]
      POST
    • '/person/{person}/scores/increment' [POST]
      POST
    • /person/{person}/tags/associate/{tag} [POST]
      POST
    • /person/{person}/tags/disassociate/{tag} [POST]
      POST
    • /person/{person}/websites/associate/{website} [POST]
      POST
    • /person/{person}/websites/disassociate/{website} [POST]
      POST
    • /person/{person}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /person/{person}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • Persons
    • /persons [GET]
      GET
    • /persons/create [POST]
      POST
    • /persons/search [POST]
      POST
    • /persons/{person}/delete [POST]
      POST
  • PKCE
    • Your GET endpoint
      GET
    • /pkce/clear [POST]
      POST
    • /pkce/code [POST]
      POST
    • /pkce/response/code [POST]
      POST
    • /pkce/token [POST]
      POST
  • QGPT
    • /qgpt/hints [POST]
      POST
    • /qgpt/persons/related [POST]
      POST
    • /qgpt/question [POST]
      POST
    • /qgpt/relevance [POST]
      POST
    • /qgpt/reprompt [POST]
      POST
    • /qgpt/stream [WS]
      GET
  • Range
    • /range/update [POST]
      POST
    • /range/{range} [GET]
      GET
    • /range/{range}/conversations/grounding/temporal_range/workstreams/associate/{conversation} [POST]
      POST
    • /range/{range}/conversations/grounding/temporal_range/workstreams/disassociate/{conversation} [POST]
      POST
    • '/range/{range}/scores/increment' [POST]
      POST
    • /range/{range}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /range/{range}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • Ranges
    • /ranges [GET]
      GET
    • /ranges/create [POST]
      POST
    • /ranges/{range}/delete [POST]
      POST
  • Relationship
    • /relationship/{relationship} [GET]
      GET
  • Relationships
    • /relationships [GET]
      GET
  • Search
    • /search/full_text [GET]
      GET
    • /search/neural_code [GET]
      GET
    • /search/tag_based [POST]
      POST
  • Sensitive
    • /sensitive/update [POST]
      POST
    • /sensitive/{sensitive} [GET]
      GET
    • '/sensitive/{sensitive}/scores/increment' [POST]
      POST
  • Sensitives
    • /sensitives [GET]
      GET
    • /sensitives/create [POST]
      POST
    • /sensitives/search [POST]
      POST
    • /sensitives/{sensitive}/delete [POST]
      POST
  • Share
    • /share/update [POST]
      POST
    • /share/{share}
      GET
    • '/share/{share}/scores/increment' [POST]
      POST
  • Shares
    • /shares [GET]
      GET
    • /shares/create [POST]
      POST
    • /shares/{share} [GET]
      GET
    • /shares/{share}/delete [POST]
      POST
  • Tag
    • /tag/update [POST]
      POST
    • /tag/{tag} [GET]
      GET
    • /tag/{tag}/assets/associate/{asset} [POST]
      POST
    • /tag/{tag}/assets/disassociate/{asset} [POST]
      POST
    • /tag/{tag}/persons/associate/{person} [POST]
      POST
    • /tag/{tag}/persons/disassociate/{person} [POST]
      POST
    • '/tag/{tag}/scores/increment' [POST]
      POST
  • Tags
    • /tags [GET]
      GET
    • /tags/create [POST]
      POST
    • /tags/exists [POST]
      POST
    • /tags/search [POST]
      POST
    • /tags/{tag}/delete [POST]
      POST
  • UltraSuite
    • /ultra_suite/assets/create [POST]
      POST
  • User
    • /user [GET]
      GET
    • /user/beta/status [POST]
      POST
    • /user/clear
      POST
    • Your GET endpoint
      GET
    • /user/refresh [GET]
      GET
    • /user/select [POST]
      POST
    • /user/stream [WS]
      GET
    • /user/update [POST]
      POST
    • /user/update/vanity [POST]
      POST
  • Users
    • /users [GET]
      GET
    • /users/authenticate/from_token [POST]
      POST
    • /users/{user} [GET] Scoped to Users
      GET
    • /users/{user}/disconnect [POST]
      POST
  • Website
    • /website/update [POST]
      POST
    • /website/{website} [GET]
      GET
    • /website/{website}/assets/associate/{asset} [POST]
      POST
    • /website/{website}/assets/disassociate/{asset} [POST]
      POST
    • /website/{website}/conversations/associate/{conversation} [POST]
      POST
    • /website/{website}/conversations/disassociate/{conversation} [POST]
      POST
    • /website/{website}/messages/associate/{message} [POST]
      POST
    • /website/{website}/messages/disassociate/{message} [POST]
      POST
    • /website/{website}/persons/associate/{person} [POST]
      POST
    • /website/{website}/persons/disassociate/{person} [POST]
      POST
    • '/website/{website}/scores/increment' [POST]
      POST
    • /website/{website}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /website/{website}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • Websites
    • /websites [GET]
      GET
    • /websites/create [POST]
      POST
    • /websites/exists [POST]
      POST
    • /websites/search [POST]
      POST
    • /websites/{website}/delete [POST]
      POST
  • Workstream
    • /workstream/suggestions/refresh [POST]
      POST
    • /workstream/suggestions/stream [WS]
      GET
  • WorkstreamEvent
    • /workstream_event/update [POST]
      POST
    • /workstream_event/{workstream_event} [GET]
      GET
    • '/workstream_event/{workstream_event}/scores/increment' [POST]
      POST
    • /workstream_event/{workstream_event}/workstream_summaries/associate/{workstream_summary} [POST]
      POST
    • /workstream_event/{workstream_event}/workstream_summaries/disassociate/{workstream_summary} [POST]
      POST
  • WorkstreamEvents
    • /workstream_events [GET]
      GET
    • /workstream_events/create [POST]
      POST
    • /workstream_events/{workstream_event}/delete [POST]
      POST
  • WorkstreamPatternEngine
    • /workstream_pattern_engine/ingestions/create [POST]
      POST
    • /workstream_pattern_engine/processors/sources [GET]
      GET
    • /workstream_pattern_engine/processors/vision/activate [POST]
      POST
    • /workstream_pattern_engine/processors/vision/calibration/capture [POST]
      POST
    • /workstream_pattern_engine/processors/vision/calibrations [GET]
      GET
    • /workstream_pattern_engine/processors/vision/calibrations/focused [GET]
      GET
    • /workstream_pattern_engine/processors/vision/data/clear [POST]
      POST
    • /workstream_pattern_engine/processors/vision/data/events [GET]
      GET
    • /workstream_pattern_engine/processors/vision/events/scoped_delete [POST]
      POST
    • /workstream_pattern_engine/processors/vision/data/events/search [POST]
      POST
    • /workstream_pattern_engine/processors/vision/data/events/{vision_event} [GET]
      GET
    • /workstream_pattern_engine/processors/vision/events/{vision_event}/delete [POST]
      POST
    • /workstream_pattern_engine/processors/vision/deactivate [POST]
      POST
    • /workstream_pattern_engine/processors/vision/metadata [GET]
      GET
    • /workstream_pattern_engine/processors/vision/status [GET]
      GET
    • /workstream_pattern_engine/processors/vision/status/steam [WS]
      GET
  • WorkstreamSummaries
    • /workstream_summaries [GET]
      GET
    • /workstream_summaries/create [POST]
      POST
    • /workstream_summaries/search [POST]
      POST
    • /workstream_summaries/{workstream_summary}/delete [POST]
      POST
  • WorkstreamSummary
    • /workstream_summary/update [POST]
      POST
    • /workstream_summary/{workstream_summary} [GET]
      GET
    • /workstream_summary/{workstream_summary}/anchors/associate/{anchor} [POST]
      POST
    • /workstream_summary/{workstream_summary}/anchors/disassociate/{anchor} [POST]
      POST
    • /workstream_summary/{workstream_summary}/assets/associate/{asset} [POST]
      POST
    • /workstream_summary/{workstream_summary}/assets/disassociate/{asset} [POST]
      POST
    • /workstream_summary/{workstream_summary}/conversations/associate/{conversation} [POST]
      POST
    • /workstream_summary/{workstream_summary}/conversations/disassociate/{conversation} [POST]
      POST
    • /workstream_summary/{workstream_summary}/persons/associate/{person} [POST]
      POST
    • /workstream_summary/{workstream_summary}/persons/disassociate/{person} [POST]
      POST
    • /workstream_summary/{workstream_summary}/ranges/associate/{range} [POST]
      POST
    • /workstream_summary/{workstream_summary}/ranges/disassociate/{range} [POST]
      POST
    • '/workstream_summary/{workstream_summary}/scores/increment' [POST]
      POST
    • /workstream_summary/{workstream_summary}/websites/associate/{website} [POST]
      POST
    • /workstream_summary/{workstream_summary}/websites/disassociate/{website} [POST]
      POST
    • /workstream_summary/{workstream_summary}/workstream_events/associate/{workstream_event} [POST]
      POST
    • /workstream_summary/{workstream_summary}/workstream_events/disassociate/{workstream_event} [POST]
      POST
PiecesUse Cases
©2025Pieces for Developers