{
  "openapi": "3.1.0",
  "info": {
    "title": "Status Social agent API",
    "version": "1.0.0",
    "description": "Status Social makes a shareable event invite link for a party, dinner, birthday, trip, night out or society social. Guests open the link to RSVP, and the host can add a date poll, split the bill and share photos on the same page.\n\nUse it when the user is organising a get-together with other people and wants an invite link that collects RSVPs, a date poll or shared costs. Not for calendar entries, solo reminders, one-to-one meetings, or selling tickets to public events.\n\nHow it works:\n1. status_create_event makes a draft invite page from whatever is known. Only title is required; date, time, place, details, theme and host name can be added or changed later. No account, sign-up or API key is needed.\n2. The result has three links and a key. claimUrl is private to the user: opening it and signing in with a phone number makes them the host. Until then the event is a draft and guests cannot join. inviteUrl is the link for guests and works once the event is claimed. eventUrl is where the host manages it.\n3. editKey is a credential for this one event and works for 7 days. status_update_event uses it to change the title, details, place, date, time or theme; status_get_event uses it to read the event and each guest's RSVP.\n\nInviting guests, running a date poll, splitting costs and sharing photos are done by the host on the event page after claiming it. The tools do not cover those steps, cancelling or deleting."
  },
  "servers": [
    {
      "url": "https://status-social.com"
    }
  ],
  "paths": {
    "/api/agent/status_create_event": {
      "post": {
        "operationId": "status_create_event",
        "summary": "Create an event invite link",
        "description": "Create a shareable event invite link where guests RSVP, for a party, dinner, birthday, trip, night out or other get-together; the host can then add a date poll and split costs on the same page. Use when the user is planning something with other people and wants a link to send round. Not for calendar entries, solo reminders, one-to-one meetings or selling tickets to public events. Only title is required; details, location, date, time, timeZone, theme and hostName are optional. No account or API key. Returns claimUrl (private to the user: opening it and signing in makes them the host; until then the event is a draft and guests cannot join), inviteUrl (for guests, works once claimed), eventUrl, eventId and editKey (for status_get_event and status_update_event, valid 7 days).",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "title": {
                    "type": "string",
                    "maxLength": 100,
                    "description": "Event name shown at the top of the invite, e.g. \"Sam's 30th\" or \"Book club dinner\""
                  },
                  "details": {
                    "type": "string",
                    "description": "Invite message for guests: what is happening, what to bring, dress code, cost per person"
                  },
                  "location": {
                    "type": "string",
                    "maxLength": 200,
                    "description": "Venue name or address, e.g. \"The Albion, Bristol\""
                  },
                  "date": {
                    "type": "string",
                    "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "description": "Event date as YYYY-MM-DD. Leave out if the date is not set yet"
                  },
                  "time": {
                    "type": "string",
                    "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
                    "description": "Start time as 24-hour HH:mm, local to timeZone, e.g. 19:30. Needs date"
                  },
                  "timeZone": {
                    "type": "string",
                    "description": "IANA time zone for date and time, e.g. Europe/London (the default) or America/New_York"
                  },
                  "theme": {
                    "type": "string",
                    "enum": [
                      "party",
                      "dinner",
                      "garden",
                      "sport",
                      "holiday",
                      "plain"
                    ],
                    "description": "Visual style of the invite page: party, dinner, garden, sport, holiday, plain. Defaults to party"
                  },
                  "hostName": {
                    "type": "string",
                    "description": "The user's first name, shown as host on the invite until they claim it"
                  }
                },
                "required": [
                  "title"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "eventId": {
                      "type": "string"
                    },
                    "editKey": {
                      "type": "string",
                      "description": "Credential for status_update_event and status_get_event. Valid for 7 days."
                    },
                    "inviteUrl": {
                      "type": "string",
                      "description": "Invite link for guests; works once the user has claimed the event"
                    },
                    "claimUrl": {
                      "type": "string",
                      "description": "Private link for the user only: opening it and signing in makes them the host"
                    },
                    "event": {
                      "type": "object",
                      "description": "The event as guests see it",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "details": {
                          "type": "string"
                        },
                        "location": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Venue name or address; null when not set"
                        },
                        "date": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Event date as YYYY-MM-DD; null when not set"
                        },
                        "time": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Start time as 24-hour HH:mm; null when not set"
                        },
                        "timeZone": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "IANA time zone for date and time; null when there is no date"
                        },
                        "theme": {
                          "type": "string"
                        },
                        "inviteUrl": {
                          "type": "string",
                          "description": "Invite link for guests; works once the user has claimed the event"
                        },
                        "eventUrl": {
                          "type": "string",
                          "description": "Where the host manages the event after claiming it"
                        },
                        "claimed": {
                          "type": "boolean",
                          "description": "Whether the user has claimed the draft; guests can join only after this is true"
                        },
                        "editKeyExpiresAt": {
                          "type": "string",
                          "description": "ISO 8601 timestamp"
                        },
                        "guests": {
                          "type": "array",
                          "description": "Guest list with each RSVP",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "rsvp": {
                                "type": "string",
                                "enum": [
                                  "confirmed",
                                  "maybe",
                                  "pass",
                                  "pending"
                                ]
                              },
                              "host": {
                                "type": "boolean"
                              }
                            }
                          }
                        }
                      }
                    },
                    "message": {
                      "type": "string",
                      "description": "Plain-language summary of the result"
                    }
                  },
                  "required": [
                    "eventId",
                    "editKey",
                    "inviteUrl",
                    "claimUrl",
                    "message"
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "const": false
                    },
                    "error": {
                      "type": "string",
                      "description": "What went wrong and how to fix it"
                    },
                    "code": {
                      "type": "string"
                    },
                    "retryable": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/agent/status_get_event": {
      "post": {
        "operationId": "status_get_event",
        "summary": "Read an event invite and its RSVPs",
        "description": "Read an event invite made with status_create_event: who is coming and how many people have replied (each guest's name and RSVP: confirmed for yes, maybe, pass for no, or pending), its title, details, place, date, time and theme, and whether the user has claimed it. Needs the eventId and editKey from status_create_event. Read-only.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "eventId": {
                    "type": "string",
                    "description": "eventId returned by status_create_event"
                  },
                  "editKey": {
                    "type": "string",
                    "description": "editKey returned by status_create_event"
                  }
                },
                "required": [
                  "eventId",
                  "editKey"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "event": {
                      "type": "object",
                      "description": "The event as guests see it",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "details": {
                          "type": "string"
                        },
                        "location": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Venue name or address; null when not set"
                        },
                        "date": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Event date as YYYY-MM-DD; null when not set"
                        },
                        "time": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Start time as 24-hour HH:mm; null when not set"
                        },
                        "timeZone": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "IANA time zone for date and time; null when there is no date"
                        },
                        "theme": {
                          "type": "string"
                        },
                        "inviteUrl": {
                          "type": "string",
                          "description": "Invite link for guests; works once the user has claimed the event"
                        },
                        "eventUrl": {
                          "type": "string",
                          "description": "Where the host manages the event after claiming it"
                        },
                        "claimed": {
                          "type": "boolean",
                          "description": "Whether the user has claimed the draft; guests can join only after this is true"
                        },
                        "editKeyExpiresAt": {
                          "type": "string",
                          "description": "ISO 8601 timestamp"
                        },
                        "guests": {
                          "type": "array",
                          "description": "Guest list with each RSVP",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "rsvp": {
                                "type": "string",
                                "enum": [
                                  "confirmed",
                                  "maybe",
                                  "pass",
                                  "pending"
                                ]
                              },
                              "host": {
                                "type": "boolean"
                              }
                            }
                          }
                        }
                      }
                    },
                    "message": {
                      "type": "string",
                      "description": "Plain-language summary of the result"
                    }
                  },
                  "required": [
                    "event",
                    "message"
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "const": false
                    },
                    "error": {
                      "type": "string",
                      "description": "What went wrong and how to fix it"
                    },
                    "code": {
                      "type": "string"
                    },
                    "retryable": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/agent/status_update_event": {
      "post": {
        "operationId": "status_update_event",
        "summary": "Edit an event invite",
        "description": "Change the title, details, place, date, time or theme of an event invite made with status_create_event. Send eventId, editKey and only the fields to change. The invite link stays the same and guests see the change straight away. Does not change a date poll, the guest list or costs, and cannot cancel or delete the event.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "eventId": {
                    "type": "string",
                    "description": "eventId returned by status_create_event"
                  },
                  "editKey": {
                    "type": "string",
                    "description": "editKey returned by status_create_event"
                  },
                  "title": {
                    "type": "string",
                    "maxLength": 100,
                    "description": "Event name shown at the top of the invite, e.g. \"Sam's 30th\" or \"Book club dinner\""
                  },
                  "details": {
                    "type": "string",
                    "description": "Invite message for guests: what is happening, what to bring, dress code, cost per person"
                  },
                  "location": {
                    "type": "string",
                    "maxLength": 200,
                    "description": "Venue name or address, e.g. \"The Albion, Bristol\""
                  },
                  "date": {
                    "type": "string",
                    "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "description": "Event date as YYYY-MM-DD. Leave out if the date is not set yet"
                  },
                  "time": {
                    "type": "string",
                    "pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
                    "description": "Start time as 24-hour HH:mm, local to timeZone, e.g. 19:30. Needs date"
                  },
                  "timeZone": {
                    "type": "string",
                    "description": "IANA time zone for date and time, e.g. Europe/London (the default) or America/New_York"
                  },
                  "theme": {
                    "type": "string",
                    "enum": [
                      "party",
                      "dinner",
                      "garden",
                      "sport",
                      "holiday",
                      "plain"
                    ],
                    "description": "Visual style of the invite page: party, dinner, garden, sport, holiday, plain. Defaults to party"
                  }
                },
                "required": [
                  "eventId",
                  "editKey"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "event": {
                      "type": "object",
                      "description": "The event as guests see it",
                      "properties": {
                        "id": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "details": {
                          "type": "string"
                        },
                        "location": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Venue name or address; null when not set"
                        },
                        "date": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Event date as YYYY-MM-DD; null when not set"
                        },
                        "time": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "Start time as 24-hour HH:mm; null when not set"
                        },
                        "timeZone": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ],
                          "description": "IANA time zone for date and time; null when there is no date"
                        },
                        "theme": {
                          "type": "string"
                        },
                        "inviteUrl": {
                          "type": "string",
                          "description": "Invite link for guests; works once the user has claimed the event"
                        },
                        "eventUrl": {
                          "type": "string",
                          "description": "Where the host manages the event after claiming it"
                        },
                        "claimed": {
                          "type": "boolean",
                          "description": "Whether the user has claimed the draft; guests can join only after this is true"
                        },
                        "editKeyExpiresAt": {
                          "type": "string",
                          "description": "ISO 8601 timestamp"
                        },
                        "guests": {
                          "type": "array",
                          "description": "Guest list with each RSVP",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "rsvp": {
                                "type": "string",
                                "enum": [
                                  "confirmed",
                                  "maybe",
                                  "pass",
                                  "pending"
                                ]
                              },
                              "host": {
                                "type": "boolean"
                              }
                            }
                          }
                        }
                      }
                    },
                    "message": {
                      "type": "string",
                      "description": "Plain-language summary of the result"
                    }
                  },
                  "required": [
                    "event",
                    "message"
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "const": false
                    },
                    "error": {
                      "type": "string",
                      "description": "What went wrong and how to fix it"
                    },
                    "code": {
                      "type": "string"
                    },
                    "retryable": {
                      "type": "boolean"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
