How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sweep AI Retrievers API

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

Sweep AI Retrievers API is one of 70 APIs that Sweep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AI Retrievers. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 95 operations across 91 paths, and defines 66 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.sweep.io.

95 operations 91 paths 66 schemas 2 DELETE68 GET4 PATCH19 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.sweep.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Sweep AI Retrievers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 95

Across 91 paths, the API surfaces 95 operations — 2 DELETE, 68 GET, 4 PATCH, 19 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

AI Retrievers 95
GET
/ai-retrievers/whoami
AiRetrieversController_getMe → 200
GET
/ai-retrievers/parse/{objectName}
AiRetrieversController_getObjectParsedData 3 params → 200
GET
/ai-retrievers/objects/{objectName}/sweep-automations
AiRetrieversController_getObjectSweepAutomations 2 params → 200
GET
/ai-retrievers/field-consumers/sfdc
AiRetrieversController_getFieldConsumers 3 params → 200
GET
/ai-retrievers/field-consumers/sweep
AiRetrieversController_getFieldSweepConsumers 3 params → 200
GET
/ai-retrievers/configuration/{configurationName}
AiRetrieversController_getConfigurationByName 2 params → 200
GET
/ai-retrievers/configuration/{configurationName}/nacl
AiRetrieversController_getConfigurationNacl 1 param → 200
GET
/ai-retrievers/objects/{objectName}/nacl
AiRetrieversController_getObjectNacl 1 param → 200
GET
/ai-retrievers/sweep-automation/{automationName}/matches
AiRetrieversController_getAutomationMatches 1 param → 200
GET
/ai-retrievers/sweep-automation/{automationName}
AiRetrieversController_getAutomationByName 2 params → 200
GET
/ai-retrievers/best-practices
AiRetrieversController_getBestPractices 5 params → 200
GET
/ai-retrievers/issues/{agentId}/map
AiRetrieversController_getIssueMap 1 param → 200
GET
/ai-retrievers/issues/{agentId}
AiRetrieversController_searchIssues 8 params → 200
GET
/ai-retrievers/issues/{agentId}/history
AiRetrieversController_getIssuesHistory 4 params → 200
GET
/ai-retrievers/configuration/{configurationName}/dependencies
AiRetrieversController_getConfigurationDependencies 2 params → 200
GET
/ai-retrievers/configuration/{configurationName}/consumers
AiRetrieversController_getConfigurationConsumers 2 params → 200
GET
/ai-retrievers/sweep-automation/{automationName}/dependencies
AiRetrieversController_getSweepAutomationDependencies 2 params → 200
GET
/ai-retrievers/configuration/{configurationName}/cpq-relationships
AiRetrieversController_getCpqRelationships 2 params → 200
GET
/ai-retrievers/configuration/{configurationName}/cpq-relationships/implementations
AiRetrieversController_getCpqRelationshipsImplementations 2 params → 200
GET
/ai-retrievers/sweep-territories
AiRetrieversController_getSweepTerritories 1 param → 200
GET
/ai-retrievers/users/{userId}
AiRetrieversController_getUser 1 param → 200
GET
/ai-retrievers/sweep-time-off
AiRetrieversController_getSweepTimeOff 2 params → 200
GET
/ai-retrievers/records/{recordId}
AiRetrieversController_getRecordData 1 param → 200
POST
/ai-retrievers/run-soql
AiRetrieversController_getAnySoqlQuery body → 201
POST
/ai-retrievers/run-soql-next
AiRetrieversController_getAnySoqlQueryMore body → 201
POST
/ai-retrievers/event-monitoring/list-events
AiRetrieversController_listEventMonitoringEvents body → 201
POST
/ai-retrievers/event-monitoring/aggregate
AiRetrieversController_aggregateEventMonitoringEvents body → 201
POST
/ai-retrievers/run-aggregate-soql
AiRetrieversController_runAggregateSoqlQuery body → 201
POST
/ai-retrievers/run-detailed-soql
AiRetrieversController_runDetailedSoqlQuery body → 201
GET
/ai-retrievers/salesforce-limits
AiRetrieversController_getOrgLimits → 200
GET
/ai-retrievers/sobject-describe/{objectName}
AiRetrieversController_getSObjectDescribe 1 param → 200
GET
/ai-retrievers/sweep-assignment-groups
AiRetrieversController_getSweepAssignmentGroups 3 params → 200
GET
/ai-retrievers/report-type-fields
AiRetrieversController_getReportTypeFields 2 params → 200
GET
/ai-retrievers/report-types
AiRetrieversController_getReportTypes → 200
POST
/ai-retrievers/deploy-metadata-xml
AiRetrieversController_deployMetadataXml body → 201
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 re-validate here. T…
AiRetrieversController_deploySalesforceRecords body → 201
GET
/ai-retrievers/retrieve-metadata-xml
AiRetrieversController_retrieveMetadataXml 3 params → 200
POST
/ai-retrievers/configurations-ai-summaries
AiRetrieversController_getConfigurationsAiSummaries body → 201
GET
/ai-retrievers/permission-set-definition
AiRetrieversController_getPermissionSetDefinition 4 params → 200
GET
/ai-retrievers/profile-definition
AiRetrieversController_getProfileDefinition 4 params → 200
GET
/ai-retrievers/records/{recordId}/documents
AiRetrieversController_getRecordDocuments 1 param → 200
GET
/ai-retrievers/metadata-types/{metadataTypeName}
AiRetrieversController_listMetadata 1 param → 200
GET
/ai-retrievers/metadata-types/settings/{settingsType}
AiRetrieversController_getSettingsNaclOrTypes 1 param → 200
PUT
/ai-retrievers/funnel-map/{funnelMapId}
AiRetrieversController_updateFunnelMapWithMetadata 1 param body → 200
POST
/ai-retrievers/search-metadata
AiRetrieversController_searchMetadataPost body → 201
GET
/ai-retrievers/recordtypes-with-potential-leading-fields
AiRetrieversController_getRecordTypesWithPotentialLeadingFields 1 param → 200
GET
/ai-retrievers/objects/counters
AiRetrieversController_queryDocumentationObjectCounters 6 params → 200
GET
/ai-retrievers/audit-trail
AiRetrieversController_queryAuditTrail 5 params → 200
GET
/ai-retrievers/mcp-connections
AiRetrieversController_getMcpConnections 1 param → 200
GET
/ai-retrievers/search-snowflake-elements
AiRetrieversController_searchSnowflakeElements 4 params → 200
GET
/ai-retrievers/snowflake-element-by-name/{name}
AiRetrieversController_getSnowflakeElementByName 3 params → 200
GET
/ai-retrievers/snowflake-element/{metadataId}/implementation
AiRetrieversController_getSnowflakeElementImplementation 1 param → 200
GET
/ai-retrievers/snowflake-element/{metadataId}/relationships
AiRetrieversController_getSnowflakeElementRelationships 2 params → 200
GET
/ai-retrievers/snowflake-elements/{elementType}
AiRetrieversController_listSnowflakeElements 4 params → 200
POST
/ai-retrievers/snowflake-element-summaries
AiRetrieversController_getSnowflakeElementSummaries → 201
GET
/ai-retrievers/snowflake-element-distribution
AiRetrieversController_getSnowflakeElementDistribution 6 params → 200
GET
/ai-retrievers/servicenow-table/{tableName}/fields
AiRetrieversController_getServiceNowTableFields 2 params → 200
GET
/ai-retrievers/search-servicenow-elements
AiRetrieversController_searchServiceNowElements 3 params → 200
GET
/ai-retrievers/servicenow-element-by-name/{name}
AiRetrieversController_getServiceNowElementByName 2 params → 200
GET
/ai-retrievers/servicenow-element/{metadataId}/implementation
AiRetrieversController_getServiceNowElementImplementation 1 param → 200
GET
/ai-retrievers/servicenow-element/{metadataId}/relationships
AiRetrieversController_getServiceNowElementRelationships 2 params → 200
GET
/ai-retrievers/servicenow-elements/{elementType}
AiRetrieversController_listServiceNowElements 3 params → 200
POST
/ai-retrievers/servicenow-element-summaries
AiRetrieversController_getServiceNowElementSummaries → 201
GET
/ai-retrievers/servicenow-element-distribution
AiRetrieversController_getServiceNowElementDistribution 6 params → 200
GET
/ai-retrievers/search-data360-elements
AiRetrieversController_searchData360Elements 3 params → 200
GET
/ai-retrievers/data360-element-by-name/{name}
AiRetrieversController_getData360ElementByName 2 params → 200
GET
/ai-retrievers/data360-element/{metadataId}/implementation
AiRetrieversController_getData360ElementImplementation 1 param → 200
GET
/ai-retrievers/data360-element/{metadataId}/relationships
AiRetrieversController_getData360ElementRelationships 2 params → 200
GET
/ai-retrievers/data360-element/{metadataId}/child-count
AiRetrieversController_getData360ElementChildCount 2 params → 200
GET
/ai-retrievers/data360-element-distribution
AiRetrieversController_getData360ElementDistribution 6 params → 200
GET
/ai-retrievers/data360-elements/{elementType}
AiRetrieversController_listData360Elements 3 params → 200
POST
/ai-retrievers/data360-element-summaries
AiRetrieversController_getData360ElementSummaries → 201
GET
/ai-retrievers/search-workato-elements
AiRetrieversController_searchWorkatoElements 3 params → 200
GET
/ai-retrievers/workato-element-by-name/{name}
AiRetrieversController_getWorkatoElementByName 2 params → 200
GET
/ai-retrievers/workato-element/{metadataId}/implementation
AiRetrieversController_getWorkatoElementImplementation 1 param → 200
GET
/ai-retrievers/workato-element/{metadataId}/relationships
AiRetrieversController_getWorkatoElementRelationships 2 params → 200
GET
/ai-retrievers/workato-element/{metadataId}/child-count
AiRetrieversController_getWorkatoElementChildCount 2 params → 200
GET
/ai-retrievers/workato-element-distribution
AiRetrieversController_getWorkatoElementDistribution 6 params → 200
POST
/ai-retrievers/workato-elements/{elementType}
AiRetrieversController_listWorkatoElements 1 param body → 201
GET
/ai-retrievers/workato-recipes-referencing-field
AiRetrieversController_listWorkatoRecipesReferencingField 3 params → 200
POST
/ai-retrievers/workato-element-summaries
AiRetrieversController_getWorkatoElementSummaries → 201
POST
/ai-retrievers/retrieve-metadata-types
AiRetrieversController_retrieveMetadataTypes body → 201
POST
/ai-retrievers/agent-files
AiRetrieversController_createAgentFile → 201
PUT
/ai-retrievers/agent-files
AiRetrieversController_updateAgentFile → 200
GET
/ai-retrievers/artifacts/latest
AiRetrieversController_getLatestArtifact 1 param → 200
GET
/ai-retrievers/projects/{projectId}
ProjectToolsController_getProject 2 params → 200
PATCH
/ai-retrievers/projects/{projectId}
ProjectToolsController_updateProject 1 param body → 200
GET
/ai-retrievers/projects/{projectId}/prompts/search
ProjectToolsController_searchPrompts 3 params → 200
POST
/ai-retrievers/projects/{projectId}/sections
ProjectToolsController_createSection 1 param body → 201
PATCH
/ai-retrievers/projects/{projectId}/sections/{sectionId}
ProjectToolsController_updateSection 2 params body → 200
DELETE
/ai-retrievers/projects/{projectId}/sections/{sectionId}
ProjectToolsController_deleteSection 2 params → 200
POST
/ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts
ProjectToolsController_createPrompt 2 params body → 201
PATCH
/ai-retrievers/projects/{projectId}/prompts/{promptId}
ProjectToolsController_updatePrompt 2 params body → 200
DELETE
/ai-retrievers/projects/{projectId}/prompts/{promptId}
ProjectToolsController_deletePrompt 2 params → 200
PATCH
/ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts/reorder
ProjectToolsController_reorderPrompts 2 params body → 200

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are CrmOrg (24 properties), FunnelMap (23 properties), Funnel (21 properties), DocumentationObjectCounters (18 properties). Each schema is shown below with its type and property counts.

BestPractice
object
15 properties 15 required
SweepFieldReference
object
2 properties 1 required
FreePosition
object
2 properties 2 required
FunnelMapHubspot
object
8 properties 8 required
SfdcRunSoqlNextQueryDto
object
FunnelDetailsDto
object
6 properties 3 required
AiAgentBestPractice
object
5 properties 5 required
SweepAssignmentRule
object
6 properties 6 required
User
object
15 properties 13 required
SweepExitCriteria
object
6 properties 3 required
AiProjectPrompt
object
9 properties 9 required
DeployMetadataDto
object
FunnelLinkDto
object
4 properties 3 required
FunnelMapStickyNote
object
11 properties 11 required
ThirdPartyFunnel
object
13 properties 12 required
RetrieveMetadataTypesDto
object
ReorderProjectToolsPromptsDto
object
1 property 1 required
FunnelMapSection
object
8 properties 8 required
AiAgent
object
15 properties 15 required
FunnelSnapshot
object
15 properties 15 required
AiAgentFile
object
12 properties 12 required
RoleGroup
object
14 properties 13 required
AiChatFolder
object
8 properties 8 required
WorkatoEdgePredicateDto
object
3 properties 3 required
AiTableArtifact
object
11 properties 11 required
FunnelMapThirdParty
object
8 properties 8 required
FunnelMapText
object
10 properties 10 required
LeadingObjectDto
object
4 properties 3 required
AiProjectSection
object
9 properties 9 required
AiProjectOriginTemplate
object
3 properties 3 required
UpdateProjectToolsDto
object
3 properties
WorkatoListElementsDto
object
3 properties
AiAgentMetadataElement
object
5 properties 5 required
AiArtifact
object
16 properties 16 required
FunnelMapUpdateFunnelMapDto
object
2 properties 2 required
UpdateProjectToolsPromptDto
object
3 properties
Funnel
object
21 properties 21 required
EventMonitoringListEventsDto
object
8 properties 3 required
EventMonitoringAggregateDto
object
7 properties 4 required
RoleGroupAccountRole
object
3 properties 3 required
CreateProjectToolsPromptDto
object
4 properties 3 required
FunnelMapRecordType
object
9 properties 9 required
AiAgentFileCache
object
6 properties 6 required
AiProject
object
14 properties 12 required
FunnelDeployment
object
9 properties 9 required
SweepFieldToFunnelMapPin
object
4 properties 4 required
CrmOrg
object
24 properties 24 required
FunnelMapMember
object
8 properties 8 required
FunnelMap
object
23 properties 23 required
SearchMetadataDto
object
Account
object
16 properties 16 required
SfdcRunSoqlQueryDto
object
ConfigurationsSummariesDto
object
AiChat
object
18 properties 18 required
CreateProjectToolsSectionDto
object
3 properties 2 required
Org
object
3 properties 3 required
DocumentationObjectCounters
object
18 properties 18 required
SweepStage
object
12 properties 5 required
BIFlagDto
object
2 properties 2 required
RoleGroupOrgRole
object
5 properties 5 required
FunnelMapMetadataElement
object
12 properties 12 required
UpdateProjectToolsSectionDto
object
2 properties
DeploySalesforceRecordsDto
object
4 properties 3 required
AiProjectSectionItem
object
12 properties 12 required
BISettingsDto
object
1 property 1 required
FunnelPluginsDto
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-ai-retrievers-api-openapi.yml Raw ↑

Other APIs Sweep publishes across the network.

Sweep MCP Server
Sweep Account Selection API
Sweep Agentic Features API
Sweep Ai Agents API
Sweep AI Artifacts (unauthenticated) API
Sweep AI Attachments API
Sweep AI Prompts API
Sweep AI Session API
Sweep AI Stream API
Sweep AI User Skills API
Sweep Assignment Groups API
Sweep Automations API
Where this information came from

This is an independent, third-party profile of Sweep AI Retrievers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.