API Evangelist overlay for Nuix REST-API Reference

overlay: 1.0.0
info:
  title: API Evangelist overlay for Nuix REST-API Reference
  version: 1.0.0
extends: ../openapi/_original/nuix-core-engine-rest-api-openapi.yml
x-generated: '2026-10-21'
x-method: generated
x-source: openapi/nuix-core-engine-rest-api-openapi.yml
x-rationale: Adds provenance, a link to the provider reference docs, and per-operation agent hints (read_only
  from GET, confirmation for DELETE/cancel/job actions) without editing the captured spec.
actions:
- target: $.info
  description: Record API Evangelist provenance without mutating the original.
  update:
    x-api-evangelist:
      provider: nuix
      generated: '2026-10-21'
      source: openapi/nuix-core-engine-rest-api-openapi.yml
      deployment: Self-hosted. Nuix ships this API inside customer-installed software (Enterprise Collection
        Center server / Nuix REST service); there is no public multi-tenant host, so servers[] stays templated/local.
- target: $
  description: Link the provider-published reference documentation.
  update:
    externalDocs:
      description: Nuix developer documentation
      url: https://developer.nuix.com/latest/
- target: $.paths['/v1/asyncFunctions'].get
  description: 'Agent hint for getAsyncFunctionStatusesQueueDeprecated: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/asyncFunctionsQueue'].get
  description: 'Agent hint for getAsyncFunctionStatuses: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/asyncFunctions'].get
  description: 'Agent hint for getAsyncFunctionStatusesQueue: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/asyncFunctions/{key}'].get
  description: 'Agent hint for getAsyncFunctionStatus: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/asyncFunctions/{key}'].delete
  description: 'Agent hint for cancelAsyncFunction: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/asyncFunctions/processingJobs/{key}'].delete
  description: 'Agent hint for cancelProcessingJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/authenticatedUsers/login'].put
  description: 'Agent hint for login: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/authenticatedUsers/{username}'].delete
  description: 'Agent hint for deleteEnvironment: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/itemTags'].post
  description: 'Agent hint for bulkTag: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemTags'].delete
  description: 'Agent hint for bulkRemoveTag: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/itemTags'].patch
  description: 'Agent hint for patchItemTags: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/asyncFunctions/{key}/status'].put
  description: 'Agent hint for setAsyncFunctionStatus: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/tags'].get
  description: 'Agent hint for getTags: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/tags'].post
  description: 'Agent hint for createTagsForCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/tags'].delete
  description: 'Agent hint for deleteTagsForCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/tags'].patch
  description: 'Agent hint for patchCaseTags: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/excludedItems'].put
  description: 'Agent hint for bulkExcludeAsFunction: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/includedItems'].put
  description: 'Agent hint for bulkIncludeAsFunction: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/clusterRuns'].get
  description: 'Agent hint for getClusterRuns: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/clusterRuns'].post
  description: 'Agent hint for createClusterRun: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/clusterRuns/{clusterRunNameOrGuid}/items'].get
  description: 'Agent hint for getClusterRunItems: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/clusterRuns/{clusterRunNameOrGuid}'].delete
  description: 'Agent hint for deleteClusterRun: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/bulkSearchers'].post
  description: 'Agent hint for bulkSearchers: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/domains'].get
  description: 'Agent hint for getDomains: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}'].get
  description: 'Agent hint for openCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}'].delete
  description: 'Agent hint for deleteCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/childCases/{childCaseId}'].put
  description: 'Agent hint for addChildCaseToCompoundCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/childCases'].get
  description: 'Agent hint for getChildCases: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/childCases'].post
  description: 'Agent hint for addChildCasesToCompoundCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/close'].post
  description: 'Agent hint for closeCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/exclusions'].get
  description: 'Agent hint for getExclusions: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/markupSets'].get
  description: 'Agent hint for getMarkupSets: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/markupSets'].post
  description: 'Agent hint for createMarkupSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/markupSet'].get
  description: 'Agent hint for getMarkupSetDeprecated: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemTypes'].get
  description: 'Agent hint for getItemTypes: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs/{reviewJobNameOrGuid}'].get
  description: 'Agent hint for getReviewJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs/{reviewJobNameOrGuid}'].delete
  description: 'Agent hint for deleteReviewJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/reviewJobs'].get
  description: 'Agent hint for getFastReviewJobs: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs'].post
  description: 'Agent hint for createReviewJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs/{reviewJobNameOrGuid}/items'].get
  description: 'Agent hint for addItemsToReviewJob_1: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs/{reviewJobNameOrGuid}/items'].post
  description: 'Agent hint for addItemsToReviewJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/keyStores'].get
  description: 'Agent hint for getCaseKeystores: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/keyStores'].post
  description: 'Agent hint for addKeyStoreToCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/keyStores'].delete
  description: 'Agent hint for deleteKeystoreFromCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/itemProperties/{propertyName}'].post
  description: 'Agent hint for getItemProperties: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases'].post
  description: 'Agent hint for createCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/subset'].post
  description: 'Agent hint for createCaseSubset: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/metadataFields'].get
  description: 'Agent hint for getCaseMetadataFields: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/batches'].get
  description: 'Agent hint for getCaseBatches: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/history'].get
  description: 'Agent hint for getCaseHistory: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/custodians'].get
  description: 'Agent hint for getCustodians: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/custodians'].post
  description: 'Agent hint for newCustodian: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/custodians/{custodian}'].get
  description: 'Agent hint for getCustodian_1: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/custodians/{custodian}'].put
  description: 'Agent hint for updateCustodian: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/custodians/{custodian}'].delete
  description: 'Agent hint for deleteCustodian_1: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/custodians/{custodian}/items'].post
  description: 'Agent hint for assignCustodianToItems: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/custodian'].put
  description: 'Agent hint for assignCustodian: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/custodian'].delete
  description: 'Agent hint for unassignCustodian: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/items/{itemGuid}/custodian'].get
  description: 'Agent hint for getItemCustodian: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/entityTypes'].get
  description: 'Agent hint for getEntityTypes: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs/{reviewJobNameOrGuid}/tags'].get
  description: 'Agent hint for getTagsFromReviewJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/reviewJobs/{reviewJobNameOrGuid}/reviewers'].get
  description: 'Agent hint for getReviewersFromReviewJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/originalExtensions'].get
  description: 'Agent hint for getOriginalExtensions: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/languages'].get
  description: 'Agent hint for getLanguages: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/investigatorTimeZone'].get
  description: 'Agent hint for getInvestigatorTimeZone: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/investigatorTimeZone'].put
  description: 'Agent hint for setInvestigatorTimeZone: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/markupSet/{markupSetNameOrGuid}'].put
  description: 'Agent hint for updateMarkupSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/markupSet/{markupSetNameOrGuid}'].post
  description: 'Agent hint for createMarkupSetDeprecated: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/markupSet/{markupSetNameOrGuid}'].delete
  description: 'Agent hint for deleteMarkupSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/auditReportFile'].get
  description: 'Agent hint for getAuditFile: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/auditVerificationFile'].post
  description: 'Agent hint for uploadAuditFile: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/auditFiles'].delete
  description: 'Agent hint for deleteAllAuditFiles: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/auditStatus'].get
  description: 'Agent hint for checkAuditStatus: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/thumbnails'].post
  description: 'Agent hint for generateThumbnails: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/thumbnails'].delete
  description: 'Agent hint for deleteCaseThumbnailFolder: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/promoteToDiscover/{discoverCaseId}'].post
  description: 'Agent hint for submitPromoteToDiscoverJob: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/caseFunctions'].get
  description: 'Agent hint for getCaseFunctions: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/caseFunctions'].post
  description: 'Agent hint for performCaseFunction: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/wordCounts'].post
  description: 'Agent hint for wordCounts: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/auditSizes'].post
  description: 'Agent hint for auditSizes: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/fileSizes'].post
  description: 'Agent hint for fileSizes: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemSizes'].post
  description: 'Agent hint for itemSizes: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/asyncFunctions/wordCounts'].post
  description: 'Agent hint for wordCountsAsync: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/familyStatistics'].post
  description: 'Agent hint for familyStatistics: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/asyncFunctions/familyStatistics'].post
  description: 'Agent hint for familyStatisticsAsync: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/count'].get
  description: 'Agent hint for count: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/count'].post
  description: 'Agent hint for countPost: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/customMetadata'].get
  description: 'Agent hint for getCustomMetadata: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/customMetadata'].put
  description: 'Agent hint for addCustomMetadata: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/customMetadata'].delete
  description: 'Agent hint for deleteCustomMetadata: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/itemCustomMetadata'].post
  description: 'Agent hint for bulkAddCustomMetadata: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemCustomMetadata'].delete
  description: 'Agent hint for bulkDeleteCustomMetadata: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/itemCustomMetadata'].patch
  description: 'Agent hint for patchItemCustomMetadata: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/export'].put
  description: 'Agent hint for export: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/tags/{tagName}'].put
  description: 'Agent hint for renameTagsForCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/slipsheets'].put
  description: 'Agent hint for generateSlipsheets: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/stores'].put
  description: 'Agent hint for populateStores: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence'].post
  description: 'Agent hint for bulkIngestionIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/repository'].post
  description: 'Agent hint for ingestRepoIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/file'].post
  description: 'Agent hint for ingestFileIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/loadFile'].post
  description: 'Agent hint for ingestLoadFileIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/mail'].post
  description: 'Agent hint for ingestMailstoreIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/exchange'].post
  description: 'Agent hint for ingestExchangeIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/sharepoint'].post
  description: 'Agent hint for ingestSharepointIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/sql'].post
  description: 'Agent hint for ingestSqlIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/oracle'].post
  description: 'Agent hint for ingestOracleIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/ev'].post
  description: 'Agent hint for ingestEnterpriseVaultIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/s3'].post
  description: 'Agent hint for ingestS3IntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/centera'].post
  description: 'Agent hint for ingestCenteraIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/splitFiles'].post
  description: 'Agent hint for ingestSplitFilesIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/dropbox'].post
  description: 'Agent hint for ingestDropboxIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/ssh'].post
  description: 'Agent hint for ingestSSHIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/twitter'].post
  description: 'Agent hint for ingestTwitterIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/ms365'].post
  description: 'Agent hint for ingestMs365IntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/slack'].post
  description: 'Agent hint for ingestSlackIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/evidence/documentum'].post
  description: 'Agent hint for ingestDocumentumIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items'].put
  description: 'Agent hint for reloadItemsFromSourceIntoSimpleCase: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/inventory/locations'].get
  description: 'Agent hint for getInventoryLocations: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/inventory'].put
  description: 'Agent hint for scanInventory: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/inventory/{caseId}'].get
  description: 'Agent hint for getCaseDigest: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/inventory/digest'].get
  description: 'Agent hint for getInventoryDigest: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/itemText'].get
  description: 'Agent hint for getItemText: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/tags'].get
  description: 'Agent hint for getItemTags: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/searchHits'].post
  description: 'Agent hint for getSearchHits: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/tags/{tagName}'].put
  description: 'Agent hint for tagItem: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/tags/{tagName}'].delete
  description: 'Agent hint for removeTagFromItem: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/items/{itemGuid}'].get
  description: 'Agent hint for getItemByFields: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/topLevelItems'].get
  description: 'Agent hint for getTopLevelItemsByCaseId: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/download'].get
  description: 'Agent hint for downloadItem: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemBinaries/{itemGuid}'].get
  description: 'Agent hint for downloadItemBinary: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/view'].get
  description: 'Agent hint for downloadItemBestFormat: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/comment'].get
  description: 'Agent hint for getItemComment: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/items/{itemGuid}/comment'].put
  description: 'Agent hint for modifyItemComment: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemShingles'].put
  description: 'Agent hint for getItemsShingles: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemSets/{itemSetNameOrGuid}'].get
  description: 'Agent hint for getItemSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemSets/{itemSetNameOrGuid}'].put
  description: 'Agent hint for renameItemSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemSets/{itemSetNameOrGuid}'].delete
  description: 'Agent hint for deleteItemSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: true
- target: $.paths['/cases/{caseId}/itemSets'].get
  description: 'Agent hint for getItemSets: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/cases/{caseId}/itemSets'].post
  description: 'Agent hint for asyncCreateItemSet: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: false
      requires_confirmation: false


# --- truncated at 32 KB (46 KB total) ---
# Full source: https://artifacts.apis.io/nuix/overlays/nuix-core-engine-rest-api-overlay.yaml