Sweep

Sweep AI Prompts API

The AI Prompts API from Sweep — 5 operation(s) for ai prompts.

GitHub OpenAPI

Operations 9

GET /ai-prompts/prompt-groups #
POST /ai-prompts/prompt-groups #
GET /ai-prompts #
POST /ai-prompts #
PATCH /ai-prompts/prompt-groups/{groupId} #
DELETE /ai-prompts/prompt-groups/{groupId} #
PATCH /ai-prompts/{promptId} #
DELETE /ai-prompts/{promptId} #
POST /ai-prompts/optimize #

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-prompts-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-prompts-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

sweep-ai-prompts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep AI Prompts 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:
- name: AI Prompts
paths:
  /ai-prompts/prompt-groups:
    get:
      operationId: AiPromptsController_getPromptGroups
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PromptGroupResponseDto'
      security:
      - bearer: []
      tags:
      - AI Prompts
    post:
      operationId: AiPromptsController_createPromptGroup
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePromptGroupDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptGroupResponseDto'
      security:
      - bearer: []
      tags:
      - AI Prompts
  /ai-prompts:
    get:
      operationId: AiPromptsController_getPrompts
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PromptResponseDto'
      security:
      - bearer: []
      tags:
      - AI Prompts
    post:
      operationId: AiPromptsController_createPrompt
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePromptDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptResponseDto'
      security:
      - bearer: []
      tags:
      - AI Prompts
  /ai-prompts/prompt-groups/{groupId}:
    patch:
      operationId: AiPromptsController_updatePromptGroup
      parameters:
      - name: groupId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePromptGroupDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptGroupResponseDto'
      security:
      - bearer: []
      tags:
      - AI Prompts
    delete:
      operationId: AiPromptsController_deletePromptGroup
      parameters:
      - name: groupId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Prompts
  /ai-prompts/{promptId}:
    patch:
      operationId: AiPromptsController_updatePrompt
      parameters:
      - name: promptId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePromptDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PromptResponseDto'
      security:
      - bearer: []
      tags:
      - AI Prompts
    delete:
      operationId: AiPromptsController_deletePrompt
      parameters:
      - name: promptId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - AI Prompts
  /ai-prompts/optimize:
    post:
      operationId: AiPromptsController_optimizePrompt
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptimizePromptDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: string
      security:
      - bearer: []
      tags:
      - AI Prompts
components:
  schemas:
    UpdatePromptDto:
      type: object
      properties:
        name:
          type: string
        promptText:
          type: string
        promptGroupId:
          type: string
    OptimizePromptDto:
      type: object
      properties:
        promptText:
          type: string
      required:
      - promptText
    UpdatePromptGroupDto:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        isPinned:
          type: boolean
    PromptResponseDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        promptText:
          type: string
        promptGroupId:
          type:
          - string
          - 'null'
        accountId:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        createdById:
          type: string
        updatedById:
          type: string
      required:
      - id
      - name
      - promptText
      - accountId
      - createdAt
      - updatedAt
    PromptGroupResponseDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        isPinned:
          type: boolean
        iconName:
          type: string
        accountId:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        createdById:
          type: string
        updatedById:
          type: string
      required:
      - id
      - name
      - isPinned
      - accountId
      - createdAt
      - updatedAt
    CreatePromptDto:
      type: object
      properties:
        name:
          type: string
        promptText:
          type: string
        promptGroupId:
          type: string
      required:
      - name
      - promptText
    CreatePromptGroupDto:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        isPinned:
          type: boolean
        iconName:
          type: string
      required:
      - name
      - isPinned
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http