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 Ai retrievers controller get me #
GET /ai-retrievers/parse/{objectName} Ai retrievers controller get object parsed data #
GET /ai-retrievers/objects/{objectName}/sweep-automations Ai retrievers controller get object sweep automations #
GET /ai-retrievers/field-consumers/sfdc Ai retrievers controller get field consumers #
GET /ai-retrievers/field-consumers/sweep Ai retrievers controller get field sweep consumers #
GET /ai-retrievers/configuration/{configurationName} Ai retrievers controller get configuration by name #
GET /ai-retrievers/configuration/{configurationName}/nacl Ai retrievers controller get configuration nacl #
GET /ai-retrievers/objects/{objectName}/nacl Ai retrievers controller get object nacl #
GET /ai-retrievers/sweep-automation/{automationName}/matches Ai retrievers controller get automation matches #
GET /ai-retrievers/sweep-automation/{automationName} Ai retrievers controller get automation by name #
GET /ai-retrievers/best-practices Ai retrievers controller get best practices #
GET /ai-retrievers/issues/{agentId}/map Ai retrievers controller get issue map #
GET /ai-retrievers/issues/{agentId} Ai retrievers controller search issues #
GET /ai-retrievers/issues/{agentId}/history Ai retrievers controller get issues history #
GET /ai-retrievers/configuration/{configurationName}/dependencies Ai retrievers controller get configuration dependencies #
GET /ai-retrievers/configuration/{configurationName}/consumers Ai retrievers controller get configuration consumers #
GET /ai-retrievers/sweep-automation/{automationName}/dependencies Ai retrievers controller get sweep automation dependencies #
GET /ai-retrievers/configuration/{configurationName}/cpq-relationships Ai retrievers controller get cpq relationships #
GET /ai-retrievers/configuration/{configurationName}/cpq-relationships/implementations Ai retrievers controller get cpq relationships implementations #
GET /ai-retrievers/sweep-territories Ai retrievers controller get sweep territories #
GET /ai-retrievers/users/{userId} Ai retrievers controller get user #
GET /ai-retrievers/sweep-time-off Ai retrievers controller get sweep time off #
GET /ai-retrievers/records/{recordId} Ai retrievers controller get record data #
POST /ai-retrievers/run-soql Ai retrievers controller get any soql query #
POST /ai-retrievers/run-soql-next Ai retrievers controller get any soql query more #
POST /ai-retrievers/event-monitoring/list-events Ai retrievers controller list event monitoring events #
POST /ai-retrievers/event-monitoring/aggregate Ai retrievers controller aggregate event monitoring events #
POST /ai-retrievers/run-aggregate-soql Ai retrievers controller run aggregate soql query #
POST /ai-retrievers/run-detailed-soql Ai retrievers controller run detailed soql query #
GET /ai-retrievers/salesforce-limits Ai retrievers controller get org limits #
GET /ai-retrievers/sobject-describe/{objectName} Ai retrievers controller get SObject describe #
GET /ai-retrievers/sweep-assignment-groups Ai retrievers controller get sweep assignment groups #
GET /ai-retrievers/report-type-fields Ai retrievers controller get report type fields #
GET /ai-retrievers/report-types Ai retrievers controller get report types #
POST /ai-retrievers/deploy-metadata-xml Ai retrievers controller deploy metadata xml #
POST /ai-retrievers/deploy-salesforce-records Deploy (CREATE or UPDATE) Salesforce records via the REST Data API. #
GET /ai-retrievers/retrieve-metadata-xml Ai retrievers controller retrieve metadata xml #
POST /ai-retrievers/configurations-ai-summaries Ai retrievers controller get configurations ai summaries #
GET /ai-retrievers/permission-set-definition Ai retrievers controller get permission set definition #
GET /ai-retrievers/profile-definition Ai retrievers controller get profile definition #
GET /ai-retrievers/records/{recordId}/documents Ai retrievers controller get record documents #
GET /ai-retrievers/metadata-types/{metadataTypeName} Ai retrievers controller list metadata #
GET /ai-retrievers/metadata-types/settings/{settingsType} Ai retrievers controller get settings nacl or types #
PUT /ai-retrievers/funnel-map/{funnelMapId} Ai retrievers controller update funnel map with metadata #
POST /ai-retrievers/search-metadata Ai retrievers controller search metadata post #
GET /ai-retrievers/recordtypes-with-potential-leading-fields Ai retrievers controller get record types with potential leading fields #
GET /ai-retrievers/objects/counters Ai retrievers controller query documentation object counters #
GET /ai-retrievers/audit-trail Ai retrievers controller query audit trail #
GET /ai-retrievers/mcp-connections Ai retrievers controller get mcp connections #
GET /ai-retrievers/search-snowflake-elements Ai retrievers controller search snowflake elements #
GET /ai-retrievers/snowflake-element-by-name/{name} Ai retrievers controller get snowflake element by name #
GET /ai-retrievers/snowflake-element/{metadataId}/implementation Ai retrievers controller get snowflake element implementation #
GET /ai-retrievers/snowflake-element/{metadataId}/relationships Ai retrievers controller get snowflake element relationships #
GET /ai-retrievers/snowflake-elements/{elementType} Ai retrievers controller list snowflake elements #
POST /ai-retrievers/snowflake-element-summaries Ai retrievers controller get snowflake element summaries #
GET /ai-retrievers/snowflake-element-distribution Ai retrievers controller get snowflake element distribution #
GET /ai-retrievers/servicenow-table/{tableName}/fields Ai retrievers controller get service now table fields #
GET /ai-retrievers/search-servicenow-elements Ai retrievers controller search service now elements #
GET /ai-retrievers/servicenow-element-by-name/{name} Ai retrievers controller get service now element by name #
GET /ai-retrievers/servicenow-element/{metadataId}/implementation Ai retrievers controller get service now element implementation #
GET /ai-retrievers/servicenow-element/{metadataId}/relationships Ai retrievers controller get service now element relationships #
GET /ai-retrievers/servicenow-elements/{elementType} Ai retrievers controller list service now elements #
POST /ai-retrievers/servicenow-element-summaries Ai retrievers controller get service now element summaries #
GET /ai-retrievers/servicenow-element-distribution Ai retrievers controller get service now element distribution #
GET /ai-retrievers/search-data360-elements Ai retrievers controller search data360 elements #
GET /ai-retrievers/data360-element-by-name/{name} Ai retrievers controller get data360 element by name #
GET /ai-retrievers/data360-element/{metadataId}/implementation Ai retrievers controller get data360 element implementation #
GET /ai-retrievers/data360-element/{metadataId}/relationships Ai retrievers controller get data360 element relationships #
GET /ai-retrievers/data360-element/{metadataId}/child-count Ai retrievers controller get data360 element child count #
GET /ai-retrievers/data360-element-distribution Ai retrievers controller get data360 element distribution #
GET /ai-retrievers/data360-elements/{elementType} Ai retrievers controller list data360 elements #
POST /ai-retrievers/data360-element-summaries Ai retrievers controller get data360 element summaries #
GET /ai-retrievers/search-workato-elements Ai retrievers controller search workato elements #
GET /ai-retrievers/workato-element-by-name/{name} Ai retrievers controller get workato element by name #
GET /ai-retrievers/workato-element/{metadataId}/implementation Ai retrievers controller get workato element implementation #
GET /ai-retrievers/workato-element/{metadataId}/relationships Ai retrievers controller get workato element relationships #
GET /ai-retrievers/workato-element/{metadataId}/child-count Ai retrievers controller get workato element child count #
GET /ai-retrievers/workato-element-distribution Ai retrievers controller get workato element distribution #
POST /ai-retrievers/workato-elements/{elementType} Ai retrievers controller list workato elements #
GET /ai-retrievers/workato-recipes-referencing-field Ai retrievers controller list workato recipes referencing field #
POST /ai-retrievers/workato-element-summaries Ai retrievers controller get workato element summaries #
POST /ai-retrievers/retrieve-metadata-types Ai retrievers controller retrieve metadata types #
POST /ai-retrievers/agent-files Ai retrievers controller create agent file #
PUT /ai-retrievers/agent-files Ai retrievers controller update agent file #
GET /ai-retrievers/artifacts/latest Ai retrievers controller get latest artifact #
GET /ai-retrievers/projects/{projectId} Project tools controller get project #
PATCH /ai-retrievers/projects/{projectId} Project tools controller update project #
GET /ai-retrievers/projects/{projectId}/prompts/search Project tools controller search prompts #
POST /ai-retrievers/projects/{projectId}/sections Project tools controller create section #
PATCH /ai-retrievers/projects/{projectId}/sections/{sectionId} Project tools controller update section #
DELETE /ai-retrievers/projects/{projectId}/sections/{sectionId} Project tools controller delete section #
POST /ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts Project tools controller create prompt #
PATCH /ai-retrievers/projects/{projectId}/prompts/{promptId} Project tools controller update prompt #
DELETE /ai-retrievers/projects/{projectId}/prompts/{promptId} Project tools controller delete prompt #
PATCH /ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts/reorder Project tools controller reorder prompts #

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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

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:


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