Scam Spotter

Scam Spotter · Acciones GPT

Scam Reporting and Retrieval API

API to report potential scam activities and retrieve similar reported scams for analysis.

  • POST /report_scamreportScam

    Report a potential scam activity, so you help others who encounter similar scams.

  • POST /retrieve_similar_scamsretrieveSimilarScams

    Retrieve similar scam reports based on the provided query. The results might be irrelevant, you need to filter and decide what to present to the user.

Esquema original API
{
  "openapi": "3.1.0",
  "info": {
    "title": "Scam Reporting and Retrieval API",
    "description": "API to report potential scam activities and retrieve similar reported scams for analysis.",
    "version": "v1.0.0"
  },
  "servers": [
    {
      "url": "https://api.duke.sg/"
    }
  ],
  "paths": {
    "/report_scam": {
      "post": {
        "description": "Report a potential scam activity, so you help others who encounter similar scams.",
        "operationId": "reportScam",
        "parameters": [],
        "requestBody": {
          "description": "Scam report details.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "channel": {
                    "type": "string",
                    "description": "The channel through which the scam message was received.",
                    "example": "email"
                  },
                  "sender_info": {
                    "type": "string",
                    "description": "Information about the sender.",
                    "example": "sender@example.com"
                  },
                  "message": {
                    "type": "string",
                    "description": "Content of the scam message. You should help the user to summarize everything to make it concise.",
                    "example": "You have won a lottery!"
                  },
                  "country": {
                    "type": "string",
                    "description": "Country of the receiver.",
                    "example": "USA"
                  },
                  "language": {
                    "type": "string",
                    "description": "Language of the scam message.",
                    "example": "English"
                  },
                  "additional_info": {
                    "type": "string",
                    "description": "Any additional information regarding the scam.",
                    "example": "Suspicious links in the message"
                  }
                },
                "required": [
                  "message"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Scam report received successfully."
          },
          "400": {
            "description": "Bad request when data is missing or incorrect."
          },
          "401": {
            "description": "Unauthorized access due to missing or invalid API key."
          }
        }
      }
    },
    "/retrieve_similar_scams": {
      "post": {
        "description": "Retrieve similar scam reports based on the provided query. The results might be irrelevant, you need to filter and decide what to present to the user.",
        "operationId": "retrieveSimilarScams",
        "parameters": [],
        "requestBody": {
          "description": "Query for retrieving similar scam reports.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "channel": {
                    "type": "string",
                    "description": "The channel through which the scam message was received.",
                    "example": "email"
                  },
                  "sender_info": {
                    "type": "string",
                    "description": "Information about the sender.",
                    "example": "sender@example.com"
                  },
                  "message": {
                    "type": "string",
                    "description": "Content of the scam message.",
                    "example": "You have won a lottery!"
                  },
                  "country": {
                    "type": "string",
                    "description": "Country of the receiver.",
                    "example": "USA"
                  },
                  "language": {
                    "type": "string",
                    "description": "Language of the scam message.",
                    "example": "English"
                  },
                  "additional_info": {
                    "type": "string",
                    "description": "Any additional information regarding the scam.",
                    "example": "Suspicious links in the message"
                  }
                },
                "required": [
                  "message"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "List of similar scam reports.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "channel": {
                        "type": "string"
                      },
                      "sender_info": {
                        "type": "string"
                      },
                      "message": {
                        "type": "string"
                      },
                      "event_time": {
                        "type": "string",
                        "format": "date-time"
                      },
                      "country": {
                        "type": "string"
                      },
                      "language": {
                        "type": "string"
                      },
                      "additional_info": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request when query data is missing or incorrect."
          },
          "401": {
            "description": "Unauthorized access due to missing or invalid API key."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {}
  }
}