Gooshi Developer Docs
Triggers

Trigger proposal v1 reference

Understand the public, intent-level format an AI can use to prepare a trigger proposal.

The Gooshi trigger draft proposal v1 JSON Schema describes a planning document for human review. It does not provide publication authority and is not a currently callable import or validation API.

Unknown fields are rejected by the schema. Use references supplied by the current Gooshi workspace; a syntactically valid reference is not proof that it exists or is authorized.

The current self-serve UI shows discovered tool names but does not yet export a stable field-and-meter reference bundle. Do not invent those references. Use the business-rule brief workflow until Gooshi provides the scoped export/import flow.

Proposal fields

  • proposalVersion: the proposal format version. Use 1.
  • draft.contractVersion: the draft contract version. Use 1.
  • draft.toolRefs: one or more exact, server-provided tool references.
  • draft.condition: the rule that must match.
  • draft.payment: a one-time or subscription offer in minor currency units.
  • draft.usage: when and where quota usage counts.
  • draft.resumable: whether the user-visible request is expected to continue after its requirement is satisfied.
  • draft.blockedCopy: clear text shown when the rule blocks a request.
  • explanation, assumptions, and questions: the AI's reasoning record for human review.

amountMinor uses minor currency units. For example, 250 represents 2.50 in a two-decimal currency. A three-letter currency code still must be available in the current payment setup.

Conditions

  • always: match every call to the selected tools.
  • quota_exceeded: match after freeUnits for a supplied meter reference.
  • comparison: compare a supplied field reference with a string, number, or boolean using >, >=, <, <=, ==, or !=.
  • all: require every nested condition.
  • any: require at least one nested condition.

An all or any group contains between 1 and 20 conditions. Keep nesting as small as the business rule permits.

A quota proposal must include usage. Choose on_success when only completed tool calls should count, or on_attempt when attempted calls should count.

Safe example

The references below demonstrate the contract shape only. They are not usable workspace references. Do not submit or publish this example.

{
  "proposalVersion": 1,
  "draft": {
    "contractVersion": 1,
    "toolRefs": ["tool_ref_from_gooshi"],
    "condition": {
      "type": "quota_exceeded",
      "meterRef": "meter_ref_from_gooshi",
      "freeUnits": 10,
      "reason": "Require payment after the included calls are used."
    },
    "payment": {
      "type": "one_time",
      "amountMinor": 250,
      "currency": "USD",
      "label": "Additional tool access"
    },
    "usage": {
      "meterRef": "meter_ref_from_gooshi",
      "increment": "on_success"
    },
    "resumable": true,
    "blockedCopy": "Your included calls are used. Complete payment to continue this request."
  },
  "explanation": "Allow ten completed calls, then present a one-time offer.",
  "assumptions": [
    "The references were copied from the current Gooshi workspace."
  ],
  "questions": [
    "Should failed attempts count toward the included allowance?"
  ]
}

Next: Proposal validation errors.

On this page