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 Projects API

The projects API from Sweep — 17 operation(s) for projects.

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

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

This API exposes 22 operations across 17 paths, and defines 48 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.

22 operations 17 paths 48 schemas 3 DELETE5 GET9 PATCH5 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 Projects API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 22

Across 17 paths, the API surfaces 22 operations — 3 DELETE, 5 GET, 9 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

projects 22
POST
/projects
AiProjectsController_createProject body → 201
GET
/projects
AiProjectsController_listProjects 1 param → 200
GET
/projects/agent-ids
AiProjectsController_listProjectAgentIds → 200
GET
/projects/by-agent/{agentId}
AiProjectsController_getProjectByAgent 1 param → 200
POST
/projects/{projectId}/duplicate
AiProjectsController_duplicateProject 1 param body → 201
GET
/projects/{projectId}
AiProjectsController_getProject 1 param → 200
PATCH
/projects/{projectId}
AiProjectsController_updateProject 1 param body → 200
DELETE
/projects/{projectId}
AiProjectsController_deleteProject 1 param → 200
PATCH
/projects/{projectId}/prompts/reset
AiProjectsController_resetAllPrompts 1 param → 200
PATCH
/projects/{projectId}/sections/{sectionId}/prompts/reset
AiProjectsController_resetSectionPrompts 2 params → 200
PATCH
/projects/{projectId}/prompts/{promptId}/complete
AiProjectsController_completePrompt 2 params → 200
GET
/projects/{projectId}/prompts/{promptId}/chats
AiProjectsController_getPromptHistory 2 params → 200
PATCH
/projects/{projectId}/sections/reorder
AiProjectsController_reorderSections 1 param body → 200
POST
/projects/{projectId}/sections
AiProjectsController_addSection 1 param body → 201
PATCH
/projects/{projectId}/sections/{sectionId}
AiProjectsController_updateSection 2 params body → 200
DELETE
/projects/{projectId}/sections/{sectionId}
AiProjectsController_deleteSection 2 params → 200
POST
/projects/{projectId}/sections/{sectionId}/items
AiProjectsController_addSectionItem 2 params body → 201
PATCH
/projects/{projectId}/items/{itemId}/move
AiProjectsController_moveItem 2 params body → 200
PATCH
/projects/{projectId}/items/{itemId}
AiProjectsController_updateSectionItem 2 params body → 200
DELETE
/projects/{projectId}/items/{itemId}
AiProjectsController_deleteSectionItem 2 params → 200
PATCH
/projects/{projectId}/sections/{sectionId}/items/reorder
AiProjectsController_reorderItems 2 params body → 200
POST
/projects/{projectId}/memory
AiProjectsController_addToMemory 1 param body → 201

Schemas 48

The contract defines 48 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
AddSectionDto
object
3 properties 3 required
SweepAssignmentRule
object
6 properties 6 required
MoveItemDto
object
2 properties 2 required
User
object
15 properties 13 required
SweepExitCriteria
object
6 properties 3 required
AiProjectPrompt
object
9 properties 9 required
ReorderItemsDto
object
1 property 1 required
FunnelLinkDto
object
4 properties 3 required
AiAgent
object
15 properties 15 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
CreateArtifactSectionDto
object
1 property 1 required
LeadingObjectDto
object
4 properties 3 required
UpdateSectionDto
object
2 properties
AiProjectSection
object
9 properties 9 required
AiProjectOriginTemplate
object
3 properties 3 required
AiAgentMetadataElement
object
5 properties 5 required
ReorderSectionsDto
object
2 properties 2 required
AiArtifact
object
16 properties 16 required
CreateFileSectionDto
object
2 properties 1 required
AddSectionItemDto
object
4 properties
AddToMemoryDto
object
1 property 1 required
RoleGroupAccountRole
object
3 properties 3 required
UpdateSectionItemDto
object
3 properties
AiProject
object
14 properties 12 required
CreatePromptDto
object
3 properties 2 required
FunnelDeployment
object
9 properties 9 required
CreatePromptSectionDto
object
3 properties 3 required
CrmOrg
object
24 properties 24 required
Account
object
16 properties 16 required
AiChat
object
18 properties 18 required
UpdateProjectDto
object
4 properties
DuplicateProjectDto
object
3 properties 2 required
Org
object
3 properties 3 required
SweepStage
object
12 properties 5 required
RoleGroupOrgRole
object
5 properties 5 required
CreateTemplateFileRefDto
object
3 properties 3 required
AiProjectSectionItem
object
12 properties 12 required
CreateProjectDto
object
9 properties 1 required
AiAgentFileCache
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-projects-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 Retrievers API
Sweep AI Session API
Sweep AI Stream API
Sweep AI User Skills API
Sweep Assignment Groups API
Where this information came from

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