Sweep

Sweep AI Retrievers API

The AI Retrievers API from Sweep — 91 operation(s) for ai retrievers.

GitHub OpenAPI

Operations 95

GET /ai-retrievers/whoami #
GET /ai-retrievers/parse/{objectName} #
GET /ai-retrievers/objects/{objectName}/sweep-automations #
GET /ai-retrievers/field-consumers/sfdc #
GET /ai-retrievers/field-consumers/sweep #
GET /ai-retrievers/configuration/{configurationName} #
GET /ai-retrievers/configuration/{configurationName}/nacl #
GET /ai-retrievers/objects/{objectName}/nacl #
GET /ai-retrievers/sweep-automation/{automationName}/matches #
GET /ai-retrievers/sweep-automation/{automationName} #
GET /ai-retrievers/best-practices #
GET /ai-retrievers/issues/{agentId}/map #
GET /ai-retrievers/issues/{agentId} #
GET /ai-retrievers/issues/{agentId}/history #
GET /ai-retrievers/configuration/{configurationName}/dependencies #
GET /ai-retrievers/configuration/{configurationName}/consumers #
GET /ai-retrievers/sweep-automation/{automationName}/dependencies #
GET /ai-retrievers/configuration/{configurationName}/cpq-relationships #
GET /ai-retrievers/configuration/{configurationName}/cpq-relationships/implementations #
GET /ai-retrievers/sweep-territories #
GET /ai-retrievers/users/{userId} #
GET /ai-retrievers/sweep-time-off #
GET /ai-retrievers/records/{recordId} #
POST /ai-retrievers/run-soql #
POST /ai-retrievers/run-soql-next #
POST /ai-retrievers/event-monitoring/list-events #
POST /ai-retrievers/event-monitoring/aggregate #
POST /ai-retrievers/run-aggregate-soql #
POST /ai-retrievers/run-detailed-soql #
GET /ai-retrievers/salesforce-limits #
GET /ai-retrievers/sobject-describe/{objectName} #
GET /ai-retrievers/sweep-assignment-groups #
GET /ai-retrievers/report-type-fields #
GET /ai-retrievers/report-types #
POST /ai-retrievers/deploy-metadata-xml #
POST /ai-retrievers/deploy-salesforce-records Deploy (CREATE or UPDATE) Salesforce records via the REST Data API. NOTE: Salesforce REST API limits writes to 200 records per call. The Python client enforces this cap; we do not #
GET /ai-retrievers/retrieve-metadata-xml #
POST /ai-retrievers/configurations-ai-summaries #
GET /ai-retrievers/permission-set-definition #
GET /ai-retrievers/profile-definition #
GET /ai-retrievers/records/{recordId}/documents #
GET /ai-retrievers/metadata-types/{metadataTypeName} #
GET /ai-retrievers/metadata-types/settings/{settingsType} #
PUT /ai-retrievers/funnel-map/{funnelMapId} #
POST /ai-retrievers/search-metadata #
GET /ai-retrievers/recordtypes-with-potential-leading-fields #
GET /ai-retrievers/objects/counters #
GET /ai-retrievers/audit-trail #
GET /ai-retrievers/mcp-connections #
GET /ai-retrievers/search-snowflake-elements #
GET /ai-retrievers/snowflake-element-by-name/{name} #
GET /ai-retrievers/snowflake-element/{metadataId}/implementation #
GET /ai-retrievers/snowflake-element/{metadataId}/relationships #
GET /ai-retrievers/snowflake-elements/{elementType} #
POST /ai-retrievers/snowflake-element-summaries #
GET /ai-retrievers/snowflake-element-distribution #
GET /ai-retrievers/servicenow-table/{tableName}/fields #
GET /ai-retrievers/search-servicenow-elements #
GET /ai-retrievers/servicenow-element-by-name/{name} #
GET /ai-retrievers/servicenow-element/{metadataId}/implementation #
GET /ai-retrievers/servicenow-element/{metadataId}/relationships #
GET /ai-retrievers/servicenow-elements/{elementType} #
POST /ai-retrievers/servicenow-element-summaries #
GET /ai-retrievers/servicenow-element-distribution #
GET /ai-retrievers/search-data360-elements #
GET /ai-retrievers/data360-element-by-name/{name} #
GET /ai-retrievers/data360-element/{metadataId}/implementation #
GET /ai-retrievers/data360-element/{metadataId}/relationships #
GET /ai-retrievers/data360-element/{metadataId}/child-count #
GET /ai-retrievers/data360-element-distribution #
GET /ai-retrievers/data360-elements/{elementType} #
POST /ai-retrievers/data360-element-summaries #
GET /ai-retrievers/search-workato-elements #
GET /ai-retrievers/workato-element-by-name/{name} #
GET /ai-retrievers/workato-element/{metadataId}/implementation #
GET /ai-retrievers/workato-element/{metadataId}/relationships #
GET /ai-retrievers/workato-element/{metadataId}/child-count #
GET /ai-retrievers/workato-element-distribution #
POST /ai-retrievers/workato-elements/{elementType} #
GET /ai-retrievers/workato-recipes-referencing-field #
POST /ai-retrievers/workato-element-summaries #
POST /ai-retrievers/retrieve-metadata-types #
POST /ai-retrievers/agent-files #
PUT /ai-retrievers/agent-files #
GET /ai-retrievers/artifacts/latest #
GET /ai-retrievers/projects/{projectId} #
PATCH /ai-retrievers/projects/{projectId} #
GET /ai-retrievers/projects/{projectId}/prompts/search #
POST /ai-retrievers/projects/{projectId}/sections #
PATCH /ai-retrievers/projects/{projectId}/sections/{sectionId} #
DELETE /ai-retrievers/projects/{projectId}/sections/{sectionId} #
POST /ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts #
PATCH /ai-retrievers/projects/{projectId}/prompts/{promptId} #
DELETE /ai-retrievers/projects/{projectId}/prompts/{promptId} #
PATCH /ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts/reorder #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-ai-retrievers-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/conventions/sweep-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/errors/sweep-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sweep-ai-retrievers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sweep-ai-retrievers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep AI Retrievers API
  description: This is a publicly available Sweep API.
  version: '0.1'
  contact: {}
servers:
- url: https://api.sweep.io
  description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: AI Retrievers
paths:
  /ai-retrievers/whoami:
    get:
      operationId: AiRetrieversController_getMe
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/parse/{objectName}:
    get:
      operationId: AiRetrieversController_getObjectParsedData
      parameters:
      - name: objectName
        required: true
        in: path
        schema:
          type: string
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      - name: withFieldsUtilization
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/objects/{objectName}/sweep-automations:
    get:
      operationId: AiRetrieversController_getObjectSweepAutomations
      parameters:
      - name: objectName
        required: true
        in: path
        schema:
          type: string
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/field-consumers/sfdc:
    get:
      operationId: AiRetrieversController_getFieldConsumers
      parameters:
      - name: objectName
        required: true
        in: query
        schema:
          type: string
      - name: fieldName
        required: true
        in: query
        schema:
          type: string
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/field-consumers/sweep:
    get:
      operationId: AiRetrieversController_getFieldSweepConsumers
      parameters:
      - name: objectName
        required: true
        in: query
        schema:
          type: string
      - name: fieldName
        required: true
        in: query
        schema:
          type: string
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configuration/{configurationName}:
    get:
      operationId: AiRetrieversController_getConfigurationByName
      parameters:
      - name: configurationName
        required: true
        in: path
        schema:
          type: string
      - name: metadataType
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configuration/{configurationName}/nacl:
    get:
      operationId: AiRetrieversController_getConfigurationNacl
      parameters:
      - name: metadataId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/objects/{objectName}/nacl:
    get:
      operationId: AiRetrieversController_getObjectNacl
      parameters:
      - name: objectName
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sweep-automation/{automationName}/matches:
    get:
      operationId: AiRetrieversController_getAutomationMatches
      parameters:
      - name: automationName
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sweep-automation/{automationName}:
    get:
      operationId: AiRetrieversController_getAutomationByName
      parameters:
      - name: automationName
        required: true
        in: path
        schema:
          type: string
      - name: objectName
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/best-practices:
    get:
      operationId: AiRetrieversController_getBestPractices
      parameters:
      - name: bestPracticeId
        required: true
        in: query
        schema:
          type: string
      - name: keyword
        required: true
        in: query
        schema:
          type: string
      - name: name
        required: true
        in: query
        schema:
          type: string
      - name: applicableResourceType
        required: true
        in: query
        schema:
          type: string
      - name: severity
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/issues/{agentId}/map:
    get:
      operationId: AiRetrieversController_getIssueMap
      parameters:
      - name: agentId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/issues/{agentId}:
    get:
      operationId: AiRetrieversController_searchIssues
      parameters:
      - name: agentId
        required: true
        in: path
        schema:
          type: string
      - name: issueId
        required: true
        in: query
        schema:
          type: string
      - name: keyword
        required: true
        in: query
        schema:
          type: string
      - name: resourceType
        required: true
        in: query
        schema:
          type: string
      - name: resourceName
        required: true
        in: query
        schema:
          type: string
      - name: severity
        required: true
        in: query
        schema:
          type: string
      - name: status
        required: true
        in: query
        schema:
          type: string
      - name: resolvedInSalesforce
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/issues/{agentId}/history:
    get:
      operationId: AiRetrieversController_getIssuesHistory
      parameters:
      - name: agentId
        required: true
        in: path
        schema:
          type: string
      - name: configurationName
        required: true
        in: query
        schema:
          type: string
      - name: configurationType
        required: true
        in: query
        schema:
          type: string
      - name: bestPracticeName
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configuration/{configurationName}/dependencies:
    get:
      operationId: AiRetrieversController_getConfigurationDependencies
      parameters:
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      - name: metadataId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configuration/{configurationName}/consumers:
    get:
      operationId: AiRetrieversController_getConfigurationConsumers
      parameters:
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      - name: metadataId
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sweep-automation/{automationName}/dependencies:
    get:
      operationId: AiRetrieversController_getSweepAutomationDependencies
      parameters:
      - name: automationName
        required: true
        in: path
        schema:
          type: string
      - name: objectName
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configuration/{configurationName}/cpq-relationships:
    get:
      operationId: AiRetrieversController_getCpqRelationships
      parameters:
      - name: metadataId
        required: true
        in: query
        schema:
          type: string
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configuration/{configurationName}/cpq-relationships/implementations:
    get:
      operationId: AiRetrieversController_getCpqRelationshipsImplementations
      parameters:
      - name: metadataId
        required: true
        in: query
        schema:
          type: string
      - name: activeOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sweep-territories:
    get:
      operationId: AiRetrieversController_getSweepTerritories
      parameters:
      - name: id
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/users/{userId}:
    get:
      operationId: AiRetrieversController_getUser
      parameters:
      - name: userId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sweep-time-off:
    get:
      operationId: AiRetrieversController_getSweepTimeOff
      parameters:
      - name: userIds
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: includeInactive
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/records/{recordId}:
    get:
      operationId: AiRetrieversController_getRecordData
      parameters:
      - name: recordId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/run-soql:
    post:
      operationId: AiRetrieversController_getAnySoqlQuery
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SfdcRunSoqlQueryDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/run-soql-next:
    post:
      operationId: AiRetrieversController_getAnySoqlQueryMore
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SfdcRunSoqlNextQueryDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/event-monitoring/list-events:
    post:
      operationId: AiRetrieversController_listEventMonitoringEvents
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventMonitoringListEventsDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/event-monitoring/aggregate:
    post:
      operationId: AiRetrieversController_aggregateEventMonitoringEvents
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventMonitoringAggregateDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/run-aggregate-soql:
    post:
      operationId: AiRetrieversController_runAggregateSoqlQuery
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SfdcRunSoqlQueryDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/run-detailed-soql:
    post:
      operationId: AiRetrieversController_runDetailedSoqlQuery
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SfdcRunSoqlQueryDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/salesforce-limits:
    get:
      operationId: AiRetrieversController_getOrgLimits
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sobject-describe/{objectName}:
    get:
      operationId: AiRetrieversController_getSObjectDescribe
      parameters:
      - name: objectName
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/sweep-assignment-groups:
    get:
      operationId: AiRetrieversController_getSweepAssignmentGroups
      parameters:
      - name: groupId
        required: true
        in: query
        schema:
          type: string
      - name: nameContains
        required: true
        in: query
        schema:
          type: string
      - name: memberNameContains
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/report-type-fields:
    get:
      operationId: AiRetrieversController_getReportTypeFields
      parameters:
      - name: reportType
        required: true
        in: query
        schema:
          type: string
      - name: isCustomType
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/report-types:
    get:
      operationId: AiRetrieversController_getReportTypes
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/deploy-metadata-xml:
    post:
      operationId: AiRetrieversController_deployMetadataXml
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeployMetadataDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/deploy-salesforce-records:
    post:
      operationId: AiRetrieversController_deploySalesforceRecords
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploySalesforceRecordsDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      summary: 'Deploy (CREATE or UPDATE) Salesforce records via the REST Data API.


        NOTE: Salesforce REST API limits writes to 200 records per call. The Python

        client enforces this cap; we do not re-validate here.


        TODO: Gate with a dedicated @Permissions(''access:deploy-salesforce-records'')

        claim once defined. Currently access is controlled by ApiKeyAuthGuard

        + isBuildModeEnabled on the account.'
      tags:
      - AI Retrievers
  /ai-retrievers/retrieve-metadata-xml:
    get:
      operationId: AiRetrieversController_retrieveMetadataXml
      parameters:
      - name: metadataType
        required: true
        in: query
        schema:
          type: string
      - name: metadataXmlName
        required: true
        in: query
        schema:
          type: string
      - name: objectName
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/configurations-ai-summaries:
    post:
      operationId: AiRetrieversController_getConfigurationsAiSummaries
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationsSummariesDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/permission-set-definition:
    get:
      operationId: AiRetrieversController_getPermissionSetDefinition
      parameters:
      - name: id
        required: true
        in: query
        schema:
          type: string
      - name: sections
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: objects
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: countOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/profile-definition:
    get:
      operationId: AiRetrieversController_getProfileDefinition
      parameters:
      - name: id
        required: true
        in: query
        schema:
          type: string
      - name: sections
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: objects
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: countOnly
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/records/{recordId}/documents:
    get:
      operationId: AiRetrieversController_getRecordDocuments
      parameters:
      - name: recordId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/metadata-types/{metadataTypeName}:
    get:
      operationId: AiRetrieversController_listMetadata
      parameters:
      - name: metadataTypeName
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/metadata-types/settings/{settingsType}:
    get:
      operationId: AiRetrieversController_getSettingsNaclOrTypes
      parameters:
      - name: settingsType
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/funnel-map/{funnelMapId}:
    put:
      operationId: AiRetrieversController_updateFunnelMapWithMetadata
      parameters:
      - name: funnelMapId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FunnelMapUpdateFunnelMapDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FunnelMap'
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/search-metadata:
    post:
      operationId: AiRetrieversController_searchMetadataPost
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchMetadataDto'
      responses:
        '201':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/recordtypes-with-potential-leading-fields:
    get:
      operationId: AiRetrieversController_getRecordTypesWithPotentialLeadingFields
      parameters:
      - name: objectName
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/objects/counters:
    get:
      operationId: AiRetrieversController_queryDocumentationObjectCounters
      parameters:
      - name: objectNames
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: topN
        required: true
        in: query
        schema:
          type: number
      - name: sortBy
        required: true
        in: query
        schema:
          type: string
      - name: sortOrder
        required: true
        in: query
        schema:
          type: string
      - name: includeManaged
        required: true
        in: query
        schema:
          type: boolean
      - name: includeStandard
        required: true
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DocumentationObjectCounters'
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/audit-trail:
    get:
      operationId: AiRetrieversController_queryAuditTrail
      parameters:
      - name: date_from
        required: true
        in: query
        schema:
          format: date-time
          type: string
      - name: date_to
        required: true
        in: query
        schema:
          format: date-time
          type: string
      - name: limit
        required: true
        in: query
        schema:
          type: number
      - name: search_text
        required: true
        in: query
        schema:
          type: string
      - name: created_by_name
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/mcp-connections:
    get:
      operationId: AiRetrieversController_getMcpConnections
      parameters:
      - name: connectionIds
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/search-snowflake-elements:
    get:
      operationId: AiRetrieversController_searchSnowflakeElements
      parameters:
      - name: searchTerm
        required: true
        in: query
        schema:
          type: string
      - name: elementTypes
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      - name: schema
        required: true
        in: query
        schema:
          type: string
      - name: pageSize
        required: true
        in: query
        schema:
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/snowflake-element-by-name/{name}:
    get:
      operationId: AiRetrieversController_getSnowflakeElementByName
      parameters:
      - name: name
        required: true
        in: path
        schema:
          type: string
      - name: elementType
        required: true
        in: query
        schema:
          type: string
      - name: schema
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/snowflake-element/{metadataId}/implementation:
    get:
      operationId: AiRetrieversController_getSnowflakeElementImplementation
      parameters:
      - name: metadataId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/snowflake-element/{metadataId}/relationships:
    get:
      operationId: AiRetrieversController_getSnowflakeElementRelationships
      parameters:
      - name: metadataId
        required: true
        in: path
        schema:
          type: string
      - name: direction
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/snowflake-elements/{elementType}:
    get:
      operationId: AiRetrieversController_listSnowflakeElements
      parameters:
      - name: elementType
        required: true
        in: path
        schema:
          type: string
      - name: schema
        required: true
        in: query
        schema:
          type: string
      - name: limit
        required: true
        in: query
        schema:
          type: number
      - name: offset
        required: true
        in: query
        schema:
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/snowflake-element-summaries:
    post:
      operationId: AiRetrieversController_getSnowflakeElementSummaries
      parameters: []
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - AI Retrievers
  /ai-retrievers/snowflake-element-distribution:
    get:
      operationId: AiRetrieversController_getSnowflakeElementDistribution
      parameters:
      - name: nodeType
        required: true
        in: query
        schema:
          type: string
      - name: groupProperty
        required: true
        in: query
        schema:
          type: string
      - name: groupType
        required: true
        in: query
        schema:
          type: string
      - name: rel

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-ai-retrievers-api-openapi.yml