Sweep

Sweep Ai Agents API

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

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 49

GET /ai-agents Ai agents controller get agents #
POST /ai-agents Ai agents controller create agent #
PATCH /ai-agents/{agentId}/name Ai agents controller rename agent #
PATCH /ai-agents/{agentId}/user-instructions Ai agents controller edit agent user instructions #
PATCH /ai-agents/{agentId}/system-instructions Ai agents controller edit agent system instructions #
PATCH /ai-agents/{agentId}/configurations Ai agents controller patch agent configurations #
DELETE /ai-agents/{agentId} Ai agents controller delete agent #
POST /ai-agents/{agentId}/files/upload-url Ai agents controller generate file upload url #
POST /ai-agents/{agentId}/files/confirm-upload Ai agents controller confirm file upload #
DELETE /ai-agents/{agentId}/files/{fileId} Ai agents controller delete agent file #
GET /ai-agents/{agentId}/files/{fileId}/download-url Ai agents controller generate file download url #
GET /ai-agents/{agentId}/files/{fileId}/preview Ai agents controller generate file preview #
POST /ai-agents/{agentId}/chats/{chatId}/add-to-agent Ai agents controller add chat to agent files #
POST /ai-agents/{agentId}/chats Ai agents controller create chat #
GET /ai-agents/{agentId}/chats Ai agents controller get ai chats #
PATCH /ai-agents/chats/{chatId} Ai agents controller send message #
GET /ai-agents/chats/{chatId} Ai agents controller get chat #
DELETE /ai-agents/chats/{chatId} Ai agents controller delete chat #
DELETE /ai-agents/stream/{id} Ai agents controller cancel stream #
GET /ai-agents/stream/{id} Ai agents controller stream chat response #
POST /ai-agents/{agentId}/chats/{chatId}/mcp-tool-approval Ai agents controller handle mcp tool approval #
PATCH /ai-agents/chats/{chatId}/name Ai agents controller rename #
PATCH /ai-agents/chats/{chatId}/favorite Ai agents controller set is favorite #
GET /ai-agents/monitoring/{agentId}/metadata-elements Ai agents controller get monitoring metadata elements #
GET /ai-agents/monitoring/{agentId}/issues Ai agents controller get monitoring V2Potential issues #
PATCH /ai-agents/monitoring/{agentId}/issues/{issueId} Ai agents controller set monitoring issue status #
POST /ai-agents/{agentId}/folders Ai agents controller create folder #
GET /ai-agents/{agentId}/folders Ai agents controller get folders #
PATCH /ai-agents/{agentId}/folders/{folderId}/name Ai agents controller rename folder #
DELETE /ai-agents/{agentId}/folders/{folderId} Ai agents controller delete folder #
PATCH /ai-agents/{agentId}/chats/{chatId}/folder Ai agents controller set chat folder #
GET /ai-agents/chats Ai agents controller get ai chats deprecated #
GET /ai-agents/{agentId}/chats/sfdc Ai agents controller get support salesforce chats #
GET /ai-agents/chats/search Ai agents controller search deprecated #
DELETE /ai-agents/chats/{chatId}/messages/{messageIndex} Ai agents controller delete chat message pair #
POST /ai-agents/chats/{chatId}/feedback/{runId} Ai agents controller submit feedback #
POST /ai-agents/{agentId}/best-practices Ai agents controller add best practices to agent #
DELETE /ai-agents/{agentId}/best-practices Ai agents controller remove best practices from agent #
GET /ai-agents/{agentId}/artifacts Ai agents controller get artifacts #
GET /ai-agents/artifacts/by-artifact-id/{artifactId}/versions Ai agents controller get artifact versions summaries #
GET /ai-agents/artifacts/shared/{id} Resolve a company-share link. #
GET /ai-agents/artifacts/{versionId} Ai agents controller get artifact #
PATCH /ai-agents/artifacts/{id}/share Ai agents controller share artifact #
PATCH /ai-agents/artifacts/{id}/public Ai agents controller set artifact public #
GET /ai-agents/artifacts/{id}/public-url-token Ai agents controller get artifact public token #
GET /ai-agents/table-artifacts/{tableId} Ai agents controller get table artifact #
GET /ai-agents/build-definitions/{buildDefinitionId} Ai agents controller get build definition #
POST /ai-agents/process-mining/{funnelMapId} Ai agents controller process mining single request #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://artifacts.apis.io/sweep/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sweep/openapi/sweep-ai-agents-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/sweep/conventions/sweep-conventions.yml
🔗
DataModel
https://artifacts.apis.io/sweep/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://artifacts.apis.io/sweep/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:sweep-ai-agents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Ai Agents 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 (63 KB total) ---
# Full source: https://artifacts.apis.io/sweep/openapi/sweep-ai-agents-api-openapi.yml