aiagentscity-com Setup Event API

openapi: 3.2.0
info:
  title: AgentLedger Setup Event API
  version: 0.4.7
  x-guidance: 'AgentLedger is per-agent AI spend tracking with ENFORCED budget caps. Two ways in, both machine-only. (1) FREE, no wallet: POST /start mints a workspace_key (shown once) with no signup and no card — GET /start only renders the form and does NOT mint. Claim an agent with the key in the body of POST /v1/track, set a cap with POST /v1/budget, then route traffic through /proxy/{provider}/... so an over-budget call is refused with 402 BEFORE the provider is contacted. (2) PAID, no human: POST /v1/billing/x402 with a wallet-signed x402 payment mints a workspace bound to the paying wallet. NOTE: a workspace_key claims NEW agents; an agent_secret writes to an existing one. Plain POST /v1/track can reject the ledger write that would cross a cap but cannot un-spend a charge that already happened — only the proxy/wrapper path stops money.'
tags:
- name: Setup Event
paths:
  /v1/setup-event:
    post:
      summary: Setup Event
      description: 'Record one connect-funnel event. Returns {"ok": true} — the CLI treats

        reporting as best-effort, and a 200 here is an ack of receipt, not a claim

        about the install.


        Header note: the CLI may send `x-al-key-lookup` (a SHA-256) for products

        that carry a key. Nothing on this service reads it, so it is deliberately

        NOT persisted — storing an identifier no one consumes is data collection

        without a purpose.'
      operationId: setup_event_v1_setup_event_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetupEventRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Setup Event
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SetupEventRequest:
      properties:
        product:
          type: string
          enum:
          - agent-ledger
          - workbench
          title: Product
        outcome:
          type: string
          enum:
          - started
          - registered
          - already_registered
          - manual
          - failed
          - dry_run
          - skill_installed
          - completed
          title: Outcome
        harness:
          anyOf:
          - type: string
            enum:
            - claude-code
            - codex
            - cursor
            - opencode
            - hermes
            - openclaw
          - type: 'null'
          title: Harness
        is_human_initiated:
          type: boolean
          title: Is Human Initiated
        connect_attempt_id:
          anyOf:
          - type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          - type: 'null'
          title: Connect Attempt Id
        failure_reason:
          anyOf:
          - type: string
            enum:
            - harness_not_supported
            - command_not_found
            - spawn_failed
            - config_corrupt
            - write_failed
            - declined
          - type: 'null'
          title: Failure Reason
        cli_version:
          anyOf:
          - type: string
            maxLength: 32
            pattern: ^[A-Za-z0-9._+-]{1,32}$
          - type: 'null'
          title: Cli Version
        runtime_platform:
          anyOf:
          - type: string
            maxLength: 16
            pattern: ^[a-z0-9]{1,16}$
          - type: 'null'
          title: Runtime Platform
      additionalProperties: false
      type: object
      required:
      - product
      - outcome
      - is_human_initiated
      title: SetupEventRequest
      description: 'Closed schema — extra fields are a 422 so a drifting client is told,

        not silently absorbed.'
x-service-info:
  docs:
    llms: /llms.txt
x-products:
- id: trustscan
  x-slot: trust
  x-direction: outward
  x-connect:
    mcp: https://aiagentscity.com/mcp/trustscan
    paid_call: POST https://aiagentscity.com/api/x402/trustscan/npm
    human: https://aiagentscity.com/trust-scan
  tagline: Scan before you trust
  free_proof: POST /api/trustscan/npm returns registry facts + a typosquat screen for any package, unauthenticated — the same check is payable per call over x402 without the rate limit; remote deep scans are path-scoped to the host
- id: agent-watch
  x-slot: trust
  x-direction: outward
  x-connect:
    mcp: https://aiagentscity.com/mcp/agent-watch
    paid_call: POST https://aiagentscity.com/api/x402/agent-watch/probe
    human: https://aiagentscity.com/agent-watch
  tagline: Is this agent or MCP server real and still behaving?
  free_proof: aw_health + aw_census MCP tools are open reads — live census data, no auth
- id: perimeter-watch
  x-slot: trust
  x-direction: outward
  x-connect:
    mcp: https://aiagentscity.com/mcp/perimeter-watch
    human: https://aiagentscity.com/perimeter-watch
  tagline: Is your endpoint still what it claims — checked from the outside?
  free_proof: free browser snapshot — https://entradox.github.io/perimeter-watch-site/
- id: benefits-city
  x-slot: outcome
  x-direction: outward
  x-connect:
    mcp: https://aiagentscity.com/benefits/mcp
    human: https://aiagentscity.com/benefits
  tagline: Verified offer records — will this action actually pay?
  free_proof: search_bonuses / get_bonus MCP tools return hand-verified records with source URLs — no auth
- id: cited
  x-slot: outcome
  x-direction: outward
  x-connect:
    mcp: https://aiagentscity.com/mcp/cited
    human: https://aiagentscity.com/cited
  tagline: Prove the claim that AI recommends you — verbatim evidence
  free_proof: free browser scan — https://entradox.github.io/cited-site/
- id: agent-ledger
  x-slot: outcome
  x-direction: spine
  x-connect:
    mcp: https://aiagentscity.com/mcp/
    rest: https://aiagentscity.com/v1/
    install: npx @aiagentscity/setup ledger
    human: https://aiagentscity.com/agent-ledger
  tagline: Metered, capped, receipted agent spend — proof of what every cent bought
  free_proof: POST /start mints a free workspace (3 agents, every rail) — no signup, no card
- id: workbench-kit
  x-slot: trust+outcome
  x-direction: inward
  x-connect:
    install: npx @aiagentscity/setup workbench
    human: https://aiagentscity.com/workbench
  tagline: Frame, gate, and close-receipt every agent task — proof of what your agents did
  free_proof: the whole kit is free and runs fully offline — `wb verify <receipt_id>` recomputes a close receipt against the local ledger
x-frame:
  frame: trust-and-outcome
  tagline: 'The trust-and-outcome clearing layer for the agent economy: before an agent acts, it verifies the counterparty; after it acts, it proves the result.'
  questions:
    trust: Before an agent acts — can it trust the counterparty?
    outcome: After an agent acts — did it work?
  directions:
    outward: verifies counterparties outside your fleet
    spine: the receipts rail every instrument writes through
    inward: verifies your own fleet's work
  parked: []