Spaces:
Sleeping
Sleeping
File size: 22,307 Bytes
4d26b95 2211d3a 4d26b95 2211d3a 4d26b95 2211d3a ad3cafa 2211d3a 4d26b95 2211d3a ad3cafa | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 | openapi: 3.1.0
info:
# Do not change the title, if the title changes, the import paths will be broken
title: Api
version: 0.1.0
description: Guardian Agent API — dark pattern detection and checkout protection
servers:
- url: /api
description: Base API path
tags:
- name: health
description: Health operations
- name: analysis
description: Dark pattern analysis
- name: trust
description: Site trust ratings
- name: reports
description: Detection reports and history
- name: stats
description: Usage statistics and summaries
paths:
/healthz:
get:
operationId: healthCheck
tags: [health]
summary: Health check
description: Returns server health status
responses:
"200":
description: Healthy
content:
application/json:
schema:
$ref: "#/components/schemas/HealthStatus"
/analysis/detect:
post:
operationId: detectDarkPatterns
tags: [analysis]
summary: Detect dark patterns on a page
description: Analyzes page content for dark patterns using AI classification
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DetectDarkPatternsBody"
responses:
"200":
description: Detection result
content:
application/json:
schema:
$ref: "#/components/schemas/DarkPatternReport"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/analysis/classify-upsell:
post:
operationId: classifyUpsell
tags: [analysis]
summary: Classify an upsell page type
description: Identifies what type of upsell/add-on screen is being shown
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ClassifyUpsellBody"
responses:
"200":
description: Upsell classification result
content:
application/json:
schema:
$ref: "#/components/schemas/UpsellClassification"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/trust:
get:
operationId: listTrustRatings
tags: [trust]
summary: List all site trust ratings
description: Returns trust ratings for all tracked domains
responses:
"200":
description: List of trust ratings
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/TrustRating"
/trust/{domain}:
get:
operationId: getTrustRating
tags: [trust]
summary: Get trust rating for a domain
description: Returns the trust rating and history for a specific domain
parameters:
- name: domain
in: path
required: true
schema:
type: string
responses:
"200":
description: Trust rating
content:
application/json:
schema:
$ref: "#/components/schemas/TrustRating"
"404":
description: Domain not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
put:
operationId: upsertTrustRating
tags: [trust]
summary: Create or update trust rating for a domain
description: Updates the trust rating after a checkout interaction
parameters:
- name: domain
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpsertTrustRatingBody"
responses:
"200":
description: Updated trust rating
content:
application/json:
schema:
$ref: "#/components/schemas/TrustRating"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/reports:
get:
operationId: listReports
tags: [reports]
summary: List detection reports
description: Returns recent dark pattern detection reports
parameters:
- name: domain
in: query
required: false
schema:
type: ["string", "null"]
- name: limit
in: query
required: false
schema:
type: ["integer", "null"]
responses:
"200":
description: List of reports
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/DetectionReport"
post:
operationId: createReport
tags: [reports]
summary: Save a detection report
description: Stores a dark pattern detection report for a session
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateReportBody"
responses:
"201":
description: Report created
content:
application/json:
schema:
$ref: "#/components/schemas/DetectionReport"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/reports/{id}:
get:
operationId: getReport
tags: [reports]
summary: Get a detection report by ID
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Detection report
content:
application/json:
schema:
$ref: "#/components/schemas/DetectionReport"
"404":
description: Report not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/stats/summary:
get:
operationId: getStatsSummary
tags: [stats]
summary: Get overall statistics summary
description: Returns aggregated stats — total scans, patterns detected, money saved estimates
responses:
"200":
description: Statistics summary
content:
application/json:
schema:
$ref: "#/components/schemas/StatsSummary"
/stats/pattern-breakdown:
get:
operationId: getPatternBreakdown
tags: [stats]
summary: Get pattern detection breakdown
description: Returns counts by dark pattern type across all reports
responses:
"200":
description: Pattern breakdown
content:
application/json:
schema:
$ref: "#/components/schemas/PatternBreakdown"
/demo/scan:
post:
operationId: demoScan
tags: [analysis]
summary: All-in-one demo scan
description: Detects dark patterns, saves report, and updates trust rating in one call. Perfect for live demos.
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/DemoScanBody"
responses:
"200":
description: Scan result with saved report
content:
application/json:
schema:
$ref: "#/components/schemas/DemoScanResult"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/demo/fee-estimate:
post:
operationId: demoFeeEstimate
tags: [analysis]
summary: Estimate true final price
description: Uses AI to estimate hidden fees and total true price for a given site and listing price
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/FeeEstimateBody"
responses:
"200":
description: Fee estimate result
content:
application/json:
schema:
$ref: "#/components/schemas/FeeEstimateResult"
"400":
description: Invalid request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/stats/top-offenders:
get:
operationId: getTopOffenders
tags: [stats]
summary: Get top offending domains
description: Returns the domains with the most detected dark patterns
parameters:
- name: limit
in: query
required: false
schema:
type: ["integer", "null"]
responses:
"200":
description: Top offending domains
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/DomainOffenderSummary"
components:
schemas:
HealthStatus:
type: object
properties:
status:
type: string
required:
- status
ErrorResponse:
type: object
properties:
error:
type: string
required:
- error
DetectDarkPatternsBody:
type: object
properties:
domain:
type: string
description: The website domain being analyzed
pageText:
type: string
description: Extracted text content from the page
timerElements:
type: array
items:
type: string
description: Text from countdown timer elements found on the page
stockAlerts:
type: array
items:
type: string
description: Text from stock/scarcity alert elements
buttonLabels:
type: array
items:
type: string
description: Text from all buttons on the page
formFields:
type: array
items:
$ref: "#/components/schemas/FormFieldInfo"
description: Form field info including pre-checked state
priceStrings:
type: array
items:
type: string
description: All price strings found on the page
required:
- domain
- pageText
FormFieldInfo:
type: object
properties:
id:
type: string
label:
type: string
type:
type: string
checked:
type: ["boolean", "null"]
optional:
type: ["boolean", "null"]
required:
- id
- label
- type
DarkPatternReport:
type: object
properties:
domain:
type: string
falseUrgency:
$ref: "#/components/schemas/FalseUrgencyResult"
falseScarcity:
$ref: "#/components/schemas/FalseScarcityResult"
confirmShaming:
$ref: "#/components/schemas/ConfirmShamingResult"
hiddenFees:
$ref: "#/components/schemas/HiddenFeesResult"
preCheckedAddOns:
$ref: "#/components/schemas/PreCheckedAddOnsResult"
misdirection:
$ref: "#/components/schemas/MisdirectionResult"
trustScore:
type: integer
description: Trust score 0-100
summary:
type: string
description: Human-readable summary of findings
required:
- domain
- falseUrgency
- falseScarcity
- confirmShaming
- hiddenFees
- preCheckedAddOns
- misdirection
- trustScore
- summary
FalseUrgencyResult:
type: object
properties:
detected:
type: boolean
evidence:
type: string
isTimerFake:
type: ["boolean", "null"]
required:
- detected
- evidence
FalseScarcityResult:
type: object
properties:
detected:
type: boolean
evidence:
type: string
required:
- detected
- evidence
ConfirmShamingResult:
type: object
properties:
detected:
type: boolean
shamingText:
type: string
rewrittenText:
type: string
required:
- detected
- shamingText
- rewrittenText
HiddenFeesResult:
type: object
properties:
detected:
type: boolean
feeItems:
type: array
items:
$ref: "#/components/schemas/FeeItem"
totalExtra:
type: ["number", "null"]
required:
- detected
- feeItems
FeeItem:
type: object
properties:
label:
type: string
amount:
type: number
required:
- label
- amount
PreCheckedAddOnsResult:
type: object
properties:
detected:
type: boolean
fieldIds:
type: array
items:
type: string
addOnLabels:
type: array
items:
type: string
required:
- detected
- fieldIds
- addOnLabels
MisdirectionResult:
type: object
properties:
detected:
type: boolean
hiddenDeclineText:
type: string
required:
- detected
- hiddenDeclineText
ClassifyUpsellBody:
type: object
properties:
domain:
type: string
pageText:
type: string
description: Text content of the upsell page
required:
- domain
- pageText
UpsellClassification:
type: object
properties:
type:
type: string
enum:
- insurance
- breakfast
- room_upgrade
- seat_selection
- newsletter
- sms_alerts
- warranty
- refundable_rate
- other
confidence:
type: number
recommendedAction:
type: string
description: "Suggested action: decline, accept, or ask_user"
declineButtonHint:
type: string
description: Text or selector hint for the decline button
required:
- type
- confidence
- recommendedAction
- declineButtonHint
TrustRating:
type: object
properties:
id:
type: integer
domain:
type: string
score:
type: integer
description: Trust score 0-100
tier:
type: string
enum: [gold, clean, neutral, suspicious, high_manipulation]
totalScans:
type: integer
patternsDetectedCount:
type: integer
hiddenFeesCount:
type: integer
lastScannedAt:
type: ["string", "null"]
createdAt:
type: string
updatedAt:
type: string
required:
- id
- domain
- score
- tier
- totalScans
- patternsDetectedCount
- hiddenFeesCount
- createdAt
- updatedAt
UpsertTrustRatingBody:
type: object
properties:
scoreDelta:
type: integer
description: Amount to adjust the score (positive or negative)
patternsFound:
type: integer
hiddenFeesFound:
type: integer
required:
- scoreDelta
- patternsFound
- hiddenFeesFound
DetectionReport:
type: object
properties:
id:
type: integer
domain:
type: string
url:
type: string
trustScore:
type: integer
falseUrgencyDetected:
type: boolean
falseScarcityDetected:
type: boolean
confirmShamingDetected:
type: boolean
hiddenFeesDetected:
type: boolean
preCheckedAddOnsDetected:
type: boolean
misdirectionDetected:
type: boolean
totalPatternsDetected:
type: integer
hiddenFeesTotal:
type: ["number", "null"]
summary:
type: string
createdAt:
type: string
required:
- id
- domain
- url
- trustScore
- falseUrgencyDetected
- falseScarcityDetected
- confirmShamingDetected
- hiddenFeesDetected
- preCheckedAddOnsDetected
- misdirectionDetected
- totalPatternsDetected
- summary
- createdAt
CreateReportBody:
type: object
properties:
domain:
type: string
url:
type: string
trustScore:
type: integer
falseUrgencyDetected:
type: boolean
falseScarcityDetected:
type: boolean
confirmShamingDetected:
type: boolean
hiddenFeesDetected:
type: boolean
preCheckedAddOnsDetected:
type: boolean
misdirectionDetected:
type: boolean
totalPatternsDetected:
type: integer
hiddenFeesTotal:
type: ["number", "null"]
summary:
type: string
required:
- domain
- url
- trustScore
- falseUrgencyDetected
- falseScarcityDetected
- confirmShamingDetected
- hiddenFeesDetected
- preCheckedAddOnsDetected
- misdirectionDetected
- totalPatternsDetected
- summary
StatsSummary:
type: object
properties:
totalScans:
type: integer
totalPatternsDetected:
type: integer
totalHiddenFeesBlocked:
type: number
description: Estimated total money saved in dollars
totalDomainsTracked:
type: integer
totalReportsLast30Days:
type: integer
avgTrustScore:
type: number
goldTierDomains:
type: integer
highManipulationDomains:
type: integer
required:
- totalScans
- totalPatternsDetected
- totalHiddenFeesBlocked
- totalDomainsTracked
- totalReportsLast30Days
- avgTrustScore
- goldTierDomains
- highManipulationDomains
PatternBreakdown:
type: object
properties:
falseUrgency:
type: integer
falseScarcity:
type: integer
confirmShaming:
type: integer
hiddenFees:
type: integer
preCheckedAddOns:
type: integer
misdirection:
type: integer
required:
- falseUrgency
- falseScarcity
- confirmShaming
- hiddenFees
- preCheckedAddOns
- misdirection
DomainOffenderSummary:
type: object
properties:
domain:
type: string
totalPatternsDetected:
type: integer
trustScore:
type: integer
tier:
type: string
totalScans:
type: integer
required:
- domain
- totalPatternsDetected
- trustScore
- tier
- totalScans
DemoScanBody:
type: object
properties:
domain:
type: string
url:
type: string
pageText:
type: string
timerElements:
type: array
items:
type: string
stockAlerts:
type: array
items:
type: string
buttonLabels:
type: array
items:
type: string
priceStrings:
type: array
items:
type: string
scenarioName:
type: ["string", "null"]
description: Name of the preset scenario being run
required:
- domain
- url
- pageText
DemoScanResult:
type: object
properties:
report:
$ref: "#/components/schemas/DetectionReport"
darkPatternReport:
$ref: "#/components/schemas/DarkPatternReport"
trustRating:
$ref: "#/components/schemas/TrustRating"
required:
- report
- darkPatternReport
- trustRating
FeeEstimateBody:
type: object
properties:
domain:
type: string
merchantType:
type: string
description: "Type of merchant: hotel, airline, ecommerce, vacation_rental, car_rental"
listedPrice:
type: number
currency:
type: string
default: USD
itemDescription:
type: ["string", "null"]
required:
- domain
- merchantType
- listedPrice
FeeEstimateResult:
type: object
properties:
listedPrice:
type: number
estimatedTotal:
type: number
savingsOpportunity:
type: number
feeBreakdown:
type: array
items:
$ref: "#/components/schemas/FeeItem"
confidence:
type: string
enum: [high, medium, low]
warningLevel:
type: string
enum: [green, orange, red]
explanation:
type: string
required:
- listedPrice
- estimatedTotal
- savingsOpportunity
- feeBreakdown
- confidence
- warningLevel
- explanation
|