Yahad

Lists the occasions this group-card service supports, with the value to pass to create_board.

{
  "type": "object",
  "properties": {}
}

Suggests ready questions the organiser can show participants, for an occasion. Optional recipientName fills the name in.

{
  "type": "object",
  "properties": {
    "occasion": {
      "description": "Occasion value from list_occasions, or a word like 'retirement'.",
      "type": "string"
    },
    "recipientName": {
      "description": "Recipient's first name, to fill into the questions.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "occasion"
  ]
}

Next date and the one after for a professional day (Russian service) or a Jewish holiday (Hebrew service), computed from the calendar rule, never stale. For fasts and memorial days the answer says greetings are not customary.

{
  "type": "object",
  "properties": {
    "occasion": {
      "description": "Holiday id like 'avtomobilista' or 'yom-kippur', or its name.",
      "type": "string"
    }
  },
  "required": [
    "occasion"
  ]
}

Shows how collection is going for a card: how many have signed, when collection closes and when it opens. Takes the participants' invite link.

{
  "type": "object",
  "properties": {
    "invite": {
      "description": "The invite link (https://.../m/...) or its token.",
      "type": "string"
    }
  },
  "required": [
    "invite"
  ]
}

Creates a group greeting card that several people sign before it opens on a set date, and returns the link to send to participants. Requires the organiser's email: the full management links are sent there, and a one-time 'take control' link is returned. Ask the person for anything missing; never invent an email. For Дарим (darim.ai) names are Russian; for Yahad (yahad.ai) Hebrew.

{
  "type": "object",
  "properties": {
    "recipientName": {
      "description": "Who the card is for, as participants will see it.",
      "type": "string"
    },
    "occasion": {
      "description": "Occasion value from list_occasions, or a word like 'retirement'.",
      "type": "string"
    },
    "revealDate": {
      "description": "Date the card opens, YYYY-MM-DD, in the future.",
      "type": "string"
    },
    "organizerEmail": {
      "description": "Organiser's email. Required; ask the person, never guess.",
      "type": "string"
    },
    "revealTime": {
      "description": "Time the card opens, HH:MM, 24-hour. Default 18:00.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "timezone": {
      "description": "IANA timezone, e.g. Europe/Moscow. Default: the service's own.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "promptQuestion": {
      "description": "Optional question shown to participants; see suggest_prompts.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },
    "recipientGender": {
      "description": "Optional: 'female' or 'male', used for Hebrew grammar.",
      "type": [
        "string",
        "null"
      ],
      "default": null
    }
  },
  "required": [
    "recipientName",
    "occasion",
    "revealDate",
    "organizerEmail"
  ]
}

How much each person gives toward a group gift: divide the cost by those who will actually pay, round down; the organiser adds the rest. Or, from a per-person amount, the total budget. Pass exactly one of giftCost or perPerson. Amounts are in the service's currency.

{
  "type": "object",
  "properties": {
    "giftCost": {
      "description": "Total gift cost, in the service's currency.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "perPerson": {
      "description": "Amount each person gives.",
      "type": [
        "number",
        "null"
      ],
      "default": null
    },
    "payers": {
      "description": "How many people will actually pay, 2 to 500.",
      "type": "integer",
      "default": 0
    }
  }
}