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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sweep

Sweep Ai Agents API

The Ai Agents API from Sweep — 42 operation(s) for ai agents.

Documentation Provider Profile APIs.io OpenAPI GitHub

Sweep Ai Agents 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 Agents. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 49 operations across 42 paths, and defines 51 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.

49 operations 42 paths 51 schemas 7 DELETE20 GET12 PATCH10 POST

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 Agents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 49

Across 42 paths, the API surfaces 49 operations — 7 DELETE, 20 GET, 12 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.

Ai Agents 49
GET
/ai-agents
AiAgentsController_getAgents → 200
POST
/ai-agents
AiAgentsController_createAgent body → 201
PATCH
/ai-agents/{agentId}/name
AiAgentsController_renameAgent 1 param body → 200
PATCH
/ai-agents/{agentId}/user-instructions
AiAgentsController_editAgentUserInstructions 1 param body → 200
PATCH
/ai-agents/{agentId}/system-instructions
AiAgentsController_editAgentSystemInstructions 1 param body → 200
PATCH
/ai-agents/{agentId}/configurations
AiAgentsController_patchAgentConfigurations 1 param body → 200
DELETE
/ai-agents/{agentId}
AiAgentsController_deleteAgent 1 param → 200
POST
/ai-agents/{agentId}/files/upload-url
AiAgentsController_generateFileUploadUrl 1 param body → 201
POST
/ai-agents/{agentId}/files/confirm-upload
AiAgentsController_confirmFileUpload 1 param body → 201
DELETE
/ai-agents/{agentId}/files/{fileId}
AiAgentsController_deleteAgentFile 2 params → 200
GET
/ai-agents/{agentId}/files/{fileId}/download-url
AiAgentsController_generateFileDownloadUrl 2 params → 200
GET
/ai-agents/{agentId}/files/{fileId}/preview
AiAgentsController_generateFilePreview 2 params → 200
POST
/ai-agents/{agentId}/chats/{chatId}/add-to-agent
AiAgentsController_addChatToAgentFiles 2 params → 201
POST
/ai-agents/{agentId}/chats
AiAgentsController_createChat 2 params body → 201
GET
/ai-agents/{agentId}/chats
AiAgentsController_getAiChats 1 param → 200
PATCH
/ai-agents/chats/{chatId}
AiAgentsController_sendMessage 2 params body → 200
GET
/ai-agents/chats/{chatId}
AiAgentsController_getChat 1 param → 200
DELETE
/ai-agents/chats/{chatId}
AiAgentsController_deleteChat 1 param → 200
DELETE
/ai-agents/stream/{id}
AiAgentsController_cancelStream 3 params → 200
GET
/ai-agents/stream/{id}
AiAgentsController_streamChatResponse 3 params → 200
POST
/ai-agents/{agentId}/chats/{chatId}/mcp-tool-approval
AiAgentsController_handleMcpToolApproval 2 params body → 201
PATCH
/ai-agents/chats/{chatId}/name
AiAgentsController_rename 1 param → 200
PATCH
/ai-agents/chats/{chatId}/favorite
AiAgentsController_setIsFavorite 1 param → 200
GET
/ai-agents/monitoring/{agentId}/metadata-elements
AiAgentsController_getMonitoringMetadataElements 1 param → 200
GET
/ai-agents/monitoring/{agentId}/issues
AiAgentsController_getMonitoringV2PotentialIssues 1 param → 200
PATCH
/ai-agents/monitoring/{agentId}/issues/{issueId}
AiAgentsController_setMonitoringIssueStatus 2 params body → 200
POST
/ai-agents/{agentId}/folders
AiAgentsController_createFolder 1 param → 201
GET
/ai-agents/{agentId}/folders
AiAgentsController_getFolders 1 param → 200
PATCH
/ai-agents/{agentId}/folders/{folderId}/name
AiAgentsController_renameFolder 2 params → 200
DELETE
/ai-agents/{agentId}/folders/{folderId}
AiAgentsController_deleteFolder 3 params → 200
PATCH
/ai-agents/{agentId}/chats/{chatId}/folder
AiAgentsController_setChatFolder 2 params → 200
GET
/ai-agents/chats
AiAgentsController_getAiChatsDeprecated 1 param → 200
GET
/ai-agents/{agentId}/chats/sfdc
AiAgentsController_getSupportSalesforceChats 1 param → 200
GET
/ai-agents/chats/search
AiAgentsController_searchDeprecated 1 param → 200
GET
/ai-agents/{agentId}/chats/search
AiAgentsController_search 2 params → 200
DELETE
/ai-agents/chats/{chatId}/messages/{messageIndex}
AiAgentsController_deleteChatMessagePair 2 params body → 200
POST
/ai-agents/chats/{chatId}/feedback/{runId}
AiAgentsController_submitFeedback 2 params body → 201
POST
/ai-agents/{agentId}/best-practices
AiAgentsController_addBestPracticesToAgent 1 param body → 201
DELETE
/ai-agents/{agentId}/best-practices
AiAgentsController_removeBestPracticesFromAgent 1 param body → 200
GET
/ai-agents/{agentId}/artifacts
AiAgentsController_getArtifacts 1 param → 200
GET
/ai-agents/artifacts/by-artifact-id/{artifactId}/versions
AiAgentsController_getArtifactVersionsSummaries 1 param → 200
GET
/ai-agents/artifacts/shared/{id}
Resolve a company-share link. :id may be a logical artifactId (stable) or a legacy version UUID. Returns the currently shared version for that family, or the latest version when nothing is shared and…
AiAgentsController_getSharedArtifact 1 param → 200
GET
/ai-agents/artifacts/{versionId}
AiAgentsController_getArtifact 1 param → 200
PATCH
/ai-agents/artifacts/{id}/share
AiAgentsController_shareArtifact 1 param → 200
PATCH
/ai-agents/artifacts/{id}/public
AiAgentsController_setArtifactPublic 1 param → 200
GET
/ai-agents/artifacts/{id}/public-url-token
AiAgentsController_getArtifactPublicToken 1 param → 200
GET
/ai-agents/table-artifacts/{tableId}
AiAgentsController_getTableArtifact 1 param → 200
GET
/ai-agents/build-definitions/{buildDefinitionId}
AiAgentsController_getBuildDefinition 1 param → 200
POST
/ai-agents/process-mining/{funnelMapId}
AiAgentsController_processMiningSingleRequest 1 param body → 201

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are CrmOrg (24 properties), AiChat (18 properties), AiArtifact (16 properties), Account (16 properties). Each schema is shown below with its type and property counts.

BestPractice
object
15 properties 15 required
SweepFieldReference
object
2 properties 1 required
FunnelDetailsDto
object
6 properties 3 required
AiAgentBestPractice
object
5 properties 5 required
SweepAssignmentRule
object
6 properties 6 required
IncludeConfigurationDto
object
2 properties 2 required
User
object
15 properties 13 required
SweepExitCriteria
object
6 properties 3 required
AiProjectPrompt
object
9 properties 9 required
FunnelLinkDto
object
4 properties 3 required
ProcessMiningAgentDto
object
1 property 1 required
AiAgent
object
15 properties 15 required
McpToolApprovalDto
object
5 properties 2 required
FunnelSnapshot
object
15 properties 15 required
AiAgentFile
object
12 properties 12 required
FunnelPluginsDto
object
RoleGroup
object
14 properties 13 required
AiChatFolder
object
8 properties 8 required
AiTableArtifact
object
11 properties 11 required
LeadingObjectDto
object
4 properties 3 required
DeleteAiChatMessagePairDto
object
2 properties 2 required
EditAgentSystemInstructionsDto
object
1 property 1 required
McpToolApprovalDecisionDto
object
4 properties 4 required
AiProjectSection
object
9 properties 9 required
AiProjectOriginTemplate
object
3 properties 3 required
AiAgentMetadataElement
object
5 properties 5 required
AiArtifact
object
16 properties 16 required
EditAgentUserInstructionsDto
object
1 property 1 required
RoleGroupAccountRole
object
3 properties 3 required
AiChatMessageDto
object
5 properties 3 required
SubmitFeedbackDto
object
1 property 1 required
ManageBestPracticesDto
object
1 property 1 required
PatchAgentConfigurationsDto
object
1 property 1 required
AiProject
object
14 properties 12 required
FunnelDeployment
object
9 properties 9 required
ConfirmFileUploadDto
object
3 properties 3 required
CrmOrg
object
24 properties 24 required
SupportContextDto
object
3 properties
Account
object
16 properties 16 required
AiChat
object
18 properties 18 required
Org
object
3 properties 3 required
SweepStage
object
12 properties 5 required
RoleGroupOrgRole
object
5 properties 5 required
GenerateFileUploadUrlDto
object
3 properties 3 required
UpdateIssueDto
object
2 properties
AiProjectSectionItem
object
12 properties 12 required
ChatMessageDto
object
12 properties 1 required
AiBuildDefinition
object
7 properties 7 required
CreateAgentDto
object
7 properties 3 required
AiAgentFileCache
object
6 properties 6 required
EditAgentNameDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Sweep publishes across the network.

Sweep MCP Server
AE Profile APIs.io
Sweep Account Selection API
AE Profile APIs.io
Sweep Agentic Features API
AE Profile APIs.io
Sweep AI Artifacts (unauthenticated) API
AE Profile APIs.io
Sweep AI Attachments API
AE Profile APIs.io
Sweep AI Prompts API
AE Profile APIs.io
Sweep AI Retrievers API
AE Profile APIs.io
Sweep AI Session API
AE Profile APIs.io
Sweep AI Stream API
AE Profile APIs.io
Sweep AI User Skills API
AE Profile APIs.io
Sweep Assignment Groups API
AE Profile APIs.io
Sweep Automations API
AE Profile APIs.io
#AI Agents
← Back to S APIs
API Details
ID
sweep:sweep-ai-agents-api
Base URL
https://api.sweep.io
Docs
https://api.sweep.io/api
Provider
Sweep
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sweep-ai-agents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sweep-ai-agents-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Sweep Ai Agents 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.