{"openapi":"3.1.0","info":{"title":"ClerkDirect API","version":"1.0.0","description":"Read and manage your organization's meetings, agendas, motions, minutes, tasks and automations. Reference: https://clerkdirect.com/docs/api"},"servers":[{"url":"https://clerkdirect.com/api/v1"}],"security":[{"apiKey":[]}],"tags":[{"name":"Organization","description":"Your workspace, its members and their roles."},{"name":"Meetings","description":"Meetings and everything that hangs off one: agenda, attendees, sessions, minutes, transcript and public portal publication."},{"name":"Agenda items","description":"The items on a meeting's agenda, nested in sections and sub-items."},{"name":"Motions and votes","description":"Decision items on an agenda item: motions, recommendations and their votes."},{"name":"Documents","description":"Files attached to meetings and agenda items: agendas, packets, staff reports, minutes and recordings."},{"name":"Tasks","description":"Action items and resolutions that come out of meetings, with comments."},{"name":"Automations","description":"Rules that run steps when something happens or on a schedule."},{"name":"Boards","description":"Boards, councils and committees, and their members."},{"name":"Meeting types","description":"The kinds of meeting your organization holds and their defaults."},{"name":"Templates","description":"Agenda and document templates."},{"name":"Public portal","description":"Settings for the public portal residents use to follow meetings."},{"name":"Search","description":"Full-text search across meetings, minutes and documents."}],"paths":{"/organization":{"get":{"operationId":"organization.get","tags":["Organization"],"summary":"Get your organization","description":"The organization your API key belongs to.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Organization"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_org_settings"]}},"/members":{"get":{"operationId":"organization.members.list","tags":["Organization"],"summary":"List members","description":"Everyone in the organization. Use userId to assign tasks or add board members.","parameters":[{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Member"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_workspace_members"]}},"/members/{userId}/sign-in-link":{"post":{"operationId":"organization.members.sendSignInLink","tags":["Organization"],"summary":"Email a sign-in link","description":"Emails a member a link that signs them in, for members who can't sign in on their own. Limited to a few links per member per hour.","parameters":[{"name":"userId","in":"path","required":true,"description":"The member's user ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["send_sign_in_link"]}},"/meetings":{"get":{"operationId":"meetings.list","tags":["Meetings"],"summary":"List meetings","description":"Meetings newest first unless you set order. Filter by date, board, type or status.","parameters":[{"name":"search","in":"query","required":false,"description":"Words in the title, description, location or board name.","schema":{"type":"string","maxLength":80}},{"name":"boardId","in":"query","required":false,"description":"Only this board's meetings.","schema":{"type":"integer"}},{"name":"meetingTypeId","in":"query","required":false,"description":"Only meetings of this type.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"Meetings on or after this date (YYYY-MM-DD).","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"description":"Meetings on or before this date (YYYY-MM-DD).","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","required":false,"description":"active: not cancelled. public: published to the portal. internal: not published. cancelled: cancelled.","schema":{"type":"string","enum":["active","public","internal","cancelled"]}},{"name":"order","in":"query","required":false,"description":"By start time. Defaults to desc (newest first).","schema":{"type":"string","enum":["asc","desc"]}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Meeting"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meetings","search_meetings"],"x-ava-note":"Ava also matches meetings by a fuzzy title; the API filters by search words."},"post":{"operationId":"meetings.create","tags":["Meetings"],"summary":"Create a meeting","description":"Creates a meeting with an empty agenda. Members on the meeting's board with an email address get a calendar invitation. Set recurrence to create a series; the response is its first occurrence.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":500,"description":"The meeting's name, such as Regular Council Meeting."},"description":{"type":["string","null"],"maxLength":20000,"description":"Notes about the meeting, shown on its page."},"startsAt":{"type":"string","format":"date-time","description":"Start time, ISO 8601 with an offset (2026-11-18T19:00:00-06:00) or in UTC."},"timeZone":{"type":"string","description":"IANA time zone the meeting is held in, such as America/Chicago."},"durationMinutes":{"type":"integer","minimum":15,"maximum":1440,"description":"How long it's scheduled for, used for calendar invitations."},"location":{"type":["string","null"],"maxLength":500,"description":"Where it's held, such as Council Chambers, City Hall."},"boardId":{"type":["integer","null"],"description":"The board or committee holding the meeting."},"meetingTypeId":{"type":["string","null"],"description":"A meeting type ID."},"tags":{"type":"array","items":{"type":"string","maxLength":80},"maxItems":50,"description":"Labels for finding and filtering meetings in ClerkDirect. Replaces the list."},"guests":{"type":"array","items":{"type":"object","description":"Someone attending who isn't a board member.","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Their full name."},"email":{"type":"string","format":"email","description":"Their email address. When a meeting is created with guests, guests with an email get its calendar invitation."},"title":{"type":"string","maxLength":255,"description":"Their role, such as City Engineer or Applicant."},"isVotingMember":{"type":"boolean","description":"Whether they can vote on motions. Defaults to false."}},"required":["name"],"additionalProperties":false},"maxItems":100,"description":"People attending who aren't on the board, such as staff or presenters."},"recurrence":{"type":"object","description":"Repeat the meeting.","properties":{"frequency":{"type":"string","enum":["daily","weekly","monthly","yearly"],"description":"How often it repeats."},"interval":{"type":"integer","minimum":1,"maximum":99,"description":"Every N periods. Defaults to 1."},"weekdays":{"type":"array","items":{"type":"string","enum":["MO","TU","WE","TH","FR","SA","SU"]},"description":"For weekly meetings, the days it falls on."},"monthlyNthWeekday":{"type":"object","description":"For monthly meetings on, say, the second Tuesday.","properties":{"weekday":{"type":"string","enum":["MO","TU","WE","TH","FR","SA","SU"],"description":"The day of the week."},"nth":{"type":"integer","minimum":-1,"maximum":5,"description":"1-5, or -1 for the last."}},"required":["weekday","nth"],"additionalProperties":false},"until":{"type":"string","format":"date","description":"Last date it can fall on."},"count":{"type":"integer","minimum":1,"maximum":500,"description":"How many occurrences."}},"required":["frequency"],"additionalProperties":false}},"required":["title","startsAt"],"additionalProperties":false},"example":{"title":"Regular Council Meeting","startsAt":"2026-11-18T19:00:00-06:00","timeZone":"America/Chicago","durationMinutes":120,"location":"Council Chambers, City Hall","boardId":12}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Meeting"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_meeting"]}},"/meetings/{meetingId}":{"get":{"operationId":"meetings.get","tags":["Meetings"],"summary":"Get a meeting","description":"One meeting with its sessions and the documents your key's creator can read.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MeetingDetail"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_detail"]},"patch":{"operationId":"meetings.update","tags":["Meetings"],"summary":"Update a meeting","description":"Changes only the fields you send. To publish or unpublish, use the publication endpoint. When a published, upcoming meeting is cancelled or its time or location changes, residents subscribed on the public portal are emailed.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":500,"description":"The meeting's name, such as Regular Council Meeting."},"description":{"type":["string","null"],"maxLength":20000,"description":"Notes about the meeting, shown on its page."},"startsAt":{"type":"string","format":"date-time","description":"Start time, ISO 8601 with an offset (2026-11-18T19:00:00-06:00) or in UTC."},"timeZone":{"type":"string","description":"IANA time zone the meeting is held in, such as America/Chicago."},"durationMinutes":{"type":"integer","minimum":15,"maximum":1440,"description":"How long it's scheduled for, used for calendar invitations."},"location":{"type":["string","null"],"maxLength":500,"description":"Where it's held, such as Council Chambers, City Hall."},"boardId":{"type":["integer","null"],"description":"The board or committee holding the meeting."},"meetingTypeId":{"type":["string","null"],"description":"A meeting type ID."},"tags":{"type":"array","items":{"type":"string","maxLength":80},"maxItems":50,"description":"Labels for finding and filtering meetings in ClerkDirect. Replaces the list."},"isCancelled":{"type":"boolean","description":"Marks the meeting cancelled. It stays in ClerkDirect, and on the portal if published, marked cancelled."},"ownerUserId":{"type":["string","null"],"description":"A meeting manager or administrator."},"recurrenceScope":{"type":"string","enum":["this_occurrence","this_and_following","entire_series"],"description":"For a recurring meeting, which occurrences the change applies to. Defaults to this_occurrence."}},"additionalProperties":false},"example":{"location":"Community Center, Room B","isCancelled":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Meeting"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_meeting"]},"delete":{"operationId":"meetings.delete","tags":["Meetings"],"summary":"Delete a meeting","description":"Deletes the meeting with its agenda and documents. Tasks from it stay, unlinked from the meeting. ClerkDirect keeps deleted records for recovery, as the app does.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"recurrenceScope","in":"query","required":false,"description":"For a recurring meeting, which occurrences the change applies to. Defaults to this_occurrence.","schema":{"type":"string","enum":["this_occurrence","this_and_following","entire_series"]}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_meeting"]}},"/meetings/{meetingId}/sessions":{"get":{"operationId":"meetings.sessions.list","tags":["Meetings"],"summary":"List a meeting's sessions","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Session"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_detail"],"x-ava-note":"Ava reads sessions as part of the meeting."},"post":{"operationId":"meetings.sessions.create","tags":["Meetings"],"summary":"Add a session","description":"Adds an open (public) or closed (private, in-camera) session with its own agenda and minutes.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["open","closed"],"description":"Defaults to closed."},"title":{"type":"string","maxLength":255,"description":"Its name, such as Closed Session. Defaults to one from its type."},"legalAuthority":{"type":"string","maxLength":1000,"description":"For a closed session."},"closedReason":{"type":"string","maxLength":2000,"description":"For a closed session."}},"additionalProperties":false}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Session"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/meetings/{meetingId}/sessions/{sessionId}":{"delete":{"operationId":"meetings.sessions.delete","tags":["Meetings"],"summary":"Delete a session","description":"Deletes a session with its agenda. A meeting always keeps at least one open session.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"sessionId","in":"path","required":true,"description":"Session ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_meeting_session"]}},"/meetings/{meetingId}/attendance":{"get":{"operationId":"meetings.attendance.get","tags":["Meetings"],"summary":"Get attendance","description":"The meeting's board members and voting guests, with roll call where it was taken.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Attendee"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_attendees"]},"put":{"operationId":"meetings.attendance.update","tags":["Meetings"],"summary":"Record roll call","description":"Marks attendees present or absent. Attendees you don't list are left as they are.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"attendance":{"type":"array","minItems":1,"maxItems":100,"description":"Each attendee to mark, by voter key.","items":{"type":"object","properties":{"voterKey":{"type":"string","minLength":1,"maxLength":255,"description":"From Get attendance."},"status":{"type":"string","enum":["present","absent"],"description":"Absent members can't vote."}},"required":["voterKey","status"],"additionalProperties":false}}},"required":["attendance"],"additionalProperties":false},"example":{"attendance":[{"voterKey":"member:31","status":"present"}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Attendee"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["record_attendance"]}},"/meetings/{meetingId}/guests":{"post":{"operationId":"meetings.guests.add","tags":["Meetings"],"summary":"Add a guest","description":"Adds someone who isn't on the board, such as staff or a presenter. Voting guests can vote.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Someone attending who isn't a board member.","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Their full name."},"email":{"type":"string","format":"email","description":"Their email address. When a meeting is created with guests, guests with an email get its calendar invitation."},"title":{"type":"string","maxLength":255,"description":"Their role, such as City Engineer or Applicant."},"isVotingMember":{"type":"boolean","description":"Whether they can vote on motions. Defaults to false."}},"required":["name"],"additionalProperties":false}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Guest"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["add_meeting_participants"]},"get":{"operationId":"meetings.guests.list","tags":["Meetings"],"summary":"List guests","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Guest"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_attendees"]}},"/meetings/{meetingId}/guests/{guestId}":{"delete":{"operationId":"meetings.guests.delete","tags":["Meetings"],"summary":"Remove a guest","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"guestId","in":"path","required":true,"description":"Guest ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/meetings/{meetingId}/documents":{"get":{"operationId":"meetings.documents.list","tags":["Meetings"],"summary":"List a meeting's documents","description":"Every file on the meeting your key's creator can read, newest first.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"type","in":"query","required":false,"description":"Only this document type, such as minutes or agenda_packet.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_detail","search_artifacts"]},"post":{"operationId":"meetings.documents.upload","tags":["Meetings"],"summary":"Upload a document to a meeting","description":"Adds a small file to the meeting's files, as uploading it on the meeting's Files page in the app does; automations that run when a document is added run. The file comes in the request, up to 6 MB; for larger files, start an upload instead. To put it under an agenda item, use Upload a document to an agenda item.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name, with its extension: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added."},"content":{"type":"string","minLength":1,"description":"The file's bytes, base64-encoded (a data: URL works too). At most 6 MB once decoded; start an upload for larger files."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else."},"sessionId":{"type":"integer","minimum":1,"description":"The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting."}},"required":["fileName","content"],"additionalProperties":false},"example":{"fileName":"Public Comment - Main Street Rezoning.pdf","content":"JVBERi0xLjcKJeLjz9MK...","type":"other"}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file, at most 6 MB."},"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name, with its extension: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added. Defaults to the file part's name."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else."},"sessionId":{"type":"integer","minimum":1,"description":"The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting."}},"required":["file"]}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/meetings/{meetingId}/documents/imports":{"post":{"operationId":"meetings.documents.import","tags":["Meetings"],"summary":"Add a document to a meeting from a link","description":"Fetches the file at a public link and adds it to the meeting's files, as uploading it on the meeting's Files page in the app does; automations that run when a document is added run. The server fetches it while the request waits, up to 250 MB within about a minute; for larger files, start an upload instead. To put it under an agenda item, use Add a document to an agenda item from a link.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","minLength":1,"maxLength":2048,"description":"A public http or https link straight to the file, such as a staff report on the city's website (not a page about it, and not one that needs signing in). At most 250 MB."},"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The name to give the file. Defaults to the name the link gives it. It needs one of these extensions: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a; one is added from what the file is when it has none."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else."},"sessionId":{"type":"integer","minimum":1,"description":"The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting."}},"required":["url"],"additionalProperties":false},"example":{"url":"https://www.springfield.gov/files/public-comment-main-street.pdf"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/meetings/{meetingId}/documents/uploads":{"post":{"operationId":"meetings.documents.uploads.create","tags":["Meetings"],"summary":"Start an upload to a meeting","description":"For a file of any size up to 5 GB, such as a recording. Returns uploadUrl: PUT the file's bytes there with the headers given (curl is a ready-made command), within two hours. Then Complete an upload with uploadId adds it to the meeting's files, as uploading it on the meeting's Files page in the app does.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name, with its extension: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added."},"fileSize":{"type":"integer","minimum":1,"description":"The file's exact size in bytes, at most 5 GB. Storage refuses a file of any other size."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else."},"sessionId":{"type":"integer","minimum":1,"description":"The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting."}},"required":["fileName","fileSize"],"additionalProperties":false},"example":{"fileName":"Council - March 3.mp4","fileSize":1873201152}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DocumentUpload"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/meetings/{meetingId}/minutes":{"get":{"operationId":"meetings.minutes.get","tags":["Meetings"],"summary":"Get minutes","description":"A session's minutes as text, with the minutes recorded against each agenda item. Without sessionId, the meeting's first public session.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"sessionId","in":"query","required":false,"description":"Which session.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Minutes"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_minutes"]}},"/meetings/{meetingId}/transcript":{"get":{"operationId":"meetings.transcript.get","tags":["Meetings"],"summary":"Get the transcript","description":"Speaker-labeled transcript segments for a session's recording.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"sessionId","in":"query","required":false,"description":"Which session. Defaults to the live broadcast or first session.","schema":{"type":"integer"}},{"name":"speaker","in":"query","required":false,"description":"Only this speaker's segments.","schema":{"type":"string"}},{"name":"search","in":"query","required":false,"description":"Only segments containing this text.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TranscriptSegment"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_meeting_transcript","get_broadcast_transcript"]}},"/meetings/{meetingId}/transcriptions":{"post":{"operationId":"meetings.transcribe","tags":["Meetings"],"summary":"Transcribe recordings","description":"Starts transcribing the meeting's recordings, or one recording when you name it. Transcription runs in the background; the transcript appears on the meeting when it finishes.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"integer","description":"One recording to transcribe. Defaults to all of them."}},"additionalProperties":false}}}},"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"summary":{"type":"string"}},"required":["summary"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["transcribe_recordings"]}},"/meetings/{meetingId}/publication":{"get":{"operationId":"meetings.publication.get","tags":["Meetings"],"summary":"Get publication status","description":"Whether the meeting is on the public portal, and which files it publishes.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Publication"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]},"put":{"operationId":"meetings.publication.update","tags":["Meetings"],"summary":"Publish or unpublish a meeting","description":"Publishing puts the meeting and the files you choose on the public portal and turns the portal on. Publishing runs in the background: the response has status updating, and Get publication status reports published or error when it finishes. Files you leave out keep the meeting's saved choice. Private sessions never publish.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"isPublic":{"type":"boolean","description":"true publishes; false makes the meeting internal."},"standardFiles":{"type":"array","maxItems":100,"description":"The agenda, agenda packet and minutes to publish for each public session. Replaces the saved choice.","items":{"type":"object","properties":{"role":{"type":"string","enum":["agenda","agenda_packet","minutes"],"description":"Which of the session's documents."},"sessionId":{"type":"integer","description":"A public session, from List a meeting's sessions."},"documentId":{"type":"integer","description":"For agenda_packet, which packet document to publish."}},"required":["role","sessionId"],"additionalProperties":false}},"documentIds":{"type":"array","maxItems":500,"items":{"type":"integer"},"description":"Other meeting documents to publish. Replaces the saved choice."}},"required":["isPublic"],"additionalProperties":false},"example":{"isPublic":true,"standardFiles":[{"role":"agenda","sessionId":88},{"role":"minutes","sessionId":88}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Publication"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_meeting_publication"],"x-ava-note":"Ava keeps the Publishing panel's saved choice of files unless asked otherwise; the API does the same when you leave the files out."}},"/meetings/{meetingId}/agenda":{"get":{"operationId":"agenda.get","tags":["Agenda items"],"summary":"Get a meeting's agenda","description":"Every item in agenda order, with its documents and motions. Without sessionId, the meeting's first open session.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}},{"name":"sessionId","in":"query","required":false,"description":"Which session.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Agenda"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_agenda"]}},"/meetings/{meetingId}/agenda/items":{"post":{"operationId":"agenda.items.create","tags":["Agenda items"],"summary":"Add an agenda item","description":"Adds one item or section. Set parentId to nest it; it goes last among its siblings unless you set position.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":2048,"description":"The item's heading as it appears on the agenda."},"description":{"type":["string","null"],"maxLength":100000,"description":"Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept."},"isSection":{"type":"boolean","description":"A heading that groups the items under it, such as Consent Agenda."},"parentId":{"type":["integer","null"],"description":"The item or section to nest it under."},"position":{"type":"integer","minimum":1,"description":"Its place among its siblings, from 1."},"sessionId":{"type":"integer","description":"Which session's agenda. Defaults to the first open session."}},"required":["title"],"additionalProperties":false},"example":{"title":"Approval of the October 21 minutes","parentId":5012}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AgendaItem"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["add_agenda_item"]}},"/meetings/{meetingId}/agenda/items/batch":{"post":{"operationId":"agenda.items.createBatch","tags":["Agenda items"],"summary":"Add several agenda items","description":"Adds items in order at the end of the agenda (or under parentId). Nest items under a section with children. Items are added one at a time: if one fails, the ones before it stay and the error says which failed.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":2048,"description":"The item's heading as it appears on the agenda."},"description":{"type":["string","null"],"maxLength":100000,"description":"Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept."},"isSection":{"type":"boolean","description":"A heading that groups the items under it, such as Consent Agenda."},"children":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":2048,"description":"The item's heading as it appears on the agenda."},"description":{"type":["string","null"],"maxLength":100000,"description":"Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept."},"isSection":{"type":"boolean","description":"A heading that groups the items under it, such as Consent Agenda."}},"required":["title"],"additionalProperties":false},"description":"Items nested under this one."}},"required":["title"],"additionalProperties":false},"description":"The items to add, in agenda order."},"parentId":{"type":["integer","null"],"description":"Add them all under this item or section."},"sessionId":{"type":"integer","description":"Which session's agenda. Defaults to the first open session."}},"required":["items"],"additionalProperties":false},"example":{"items":[{"title":"Call to Order"},{"title":"Consent Agenda","isSection":true,"children":[{"title":"Approval of Minutes"},{"title":"Payment of Bills"}]}]}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgendaItem"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_agenda_items"]}},"/agenda-items/{itemId}":{"get":{"operationId":"agenda.items.get","tags":["Agenda items"],"summary":"Get an agenda item","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AgendaItem"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_agenda"]},"patch":{"operationId":"agenda.items.update","tags":["Agenda items"],"summary":"Update an agenda item","description":"Changes only the fields you send. Move an item by setting parentId and position.","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":2048,"description":"The item's heading as it appears on the agenda."},"description":{"type":["string","null"],"maxLength":100000,"description":"Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept."},"isSection":{"type":"boolean","description":"A heading that groups the items under it, such as Consent Agenda."},"minutes":{"type":["string","null"],"maxLength":100000,"description":"Minutes recorded against the item."},"parentId":{"type":["integer","null"],"description":"Move it under this item or section; null moves it to the top level."},"position":{"type":"integer","minimum":1,"description":"Its place among its siblings, from 1."}},"additionalProperties":false},"example":{"title":"Approval of the October 21 regular meeting minutes"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AgendaItem"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_agenda_item"]},"delete":{"operationId":"agenda.items.delete","tags":["Agenda items"],"summary":"Delete an agenda item","description":"Deletes the item with its motions and tasks. Items nested under it move up a level.","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_agenda_item"]}},"/agenda-items/{itemId}/documents":{"get":{"operationId":"agenda.items.documents.list","tags":["Agenda items"],"summary":"List an agenda item's documents","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_agenda"]},"post":{"operationId":"agenda.items.documents.upload","tags":["Agenda items"],"summary":"Upload a document to an agenda item","description":"Adds a small file, such as a staff report, to the meeting and attaches it under the item, as uploading it on the item in the app does: it goes in the agenda packet and the meeting's files, and automations that run when a document is added run. The file comes in the request, up to 6 MB; for larger files, start an upload instead.","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name, with its extension: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added."},"content":{"type":"string","minLength":1,"description":"The file's bytes, base64-encoded (a data: URL works too). At most 6 MB once decoded; start an upload for larger files."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app."}},"required":["fileName","content"],"additionalProperties":false},"example":{"fileName":"Staff Report - Zoning Variance 26-04.pdf","content":"JVBERi0xLjcKJeLjz9MK..."}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file, at most 6 MB."},"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name, with its extension: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added. Defaults to the file part's name."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app."}},"required":["file"]}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["attach_document_to_agenda_item"],"x-ava-note":"Ava attaches a file uploaded to the chat or a document already in ClerkDirect; the API uploads a new file."}},"/agenda-items/{itemId}/documents/imports":{"post":{"operationId":"agenda.items.documents.import","tags":["Agenda items"],"summary":"Add a document to an agenda item from a link","description":"Fetches the file at a public link, such as a staff report on the city's website, adds it to the meeting and attaches it under the item, as uploading it on the item in the app does: it goes in the agenda packet and the meeting's files, and automations that run when a document is added run. The server fetches it while the request waits, up to 250 MB within about a minute; for larger files, start an upload instead.","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","minLength":1,"maxLength":2048,"description":"A public http or https link straight to the file, such as a staff report on the city's website (not a page about it, and not one that needs signing in). At most 250 MB."},"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The name to give the file. Defaults to the name the link gives it. It needs one of these extensions: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a; one is added from what the file is when it has none."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app."}},"required":["url"],"additionalProperties":false},"example":{"url":"https://www.springfield.gov/files/staff-report-zoning-26-04.pdf"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/agenda-items/{itemId}/documents/uploads":{"post":{"operationId":"agenda.items.documents.uploads.create","tags":["Agenda items"],"summary":"Start an upload to an agenda item","description":"For a file of any size up to 5 GB. Returns uploadUrl: PUT the file's bytes there with the headers given (curl is a ready-made command), within two hours. Then Complete an upload with uploadId adds it to the meeting and attaches it under the item, as uploading it on the item in the app does.","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The file's name, with its extension: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added."},"fileSize":{"type":"integer","minimum":1,"description":"The file's exact size in bytes, at most 5 GB. Storage refuses a file of any other size."},"type":{"type":"string","enum":["agenda_pdf","agenda_packet","minutes_pdf","minutes_packet","recordings","meeting_recording","other"],"description":"What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app."}},"required":["fileName","fileSize"],"additionalProperties":false},"example":{"fileName":"Agenda Packet - March 3.pdf","fileSize":48213977}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/DocumentUpload"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/meetings/{meetingId}/motions":{"get":{"operationId":"motions.list","tags":["Motions and votes"],"summary":"List a meeting's motions","description":"Every motion on the meeting's agenda items, in agenda order.","parameters":[{"name":"meetingId","in":"path","required":true,"description":"Meeting ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Motion"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_agenda","get_votes"]}},"/agenda-items/{itemId}/motions":{"get":{"operationId":"motions.listForItem","tags":["Motions and votes"],"summary":"List an agenda item's motions","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Motion"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_agenda"]},"post":{"operationId":"motions.create","tags":["Motions and votes"],"summary":"Add a motion","description":"Adds a motion or other decision item to an agenda item, after any already there.","parameters":[{"name":"itemId","in":"path","required":true,"description":"Agenda item ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","description":"Decision item type key, such as motion or recommendation. Defaults to your organization's default."},"title":{"type":"string","minLength":1,"maxLength":2048,"description":"The motion's text."},"description":{"type":["string","null"],"maxLength":20000,"description":"Background or the full text, when title is a short summary."},"mover":{"type":["string","null"],"maxLength":255,"description":"Who moved it, as the minutes name them, such as Councillor Lee."},"seconder":{"type":["string","null"],"maxLength":255,"description":"Who seconded it, as the minutes name them."},"recordedOutcome":{"type":["string","null"],"enum":["passed","failed",null],"description":"Record the outcome by hand. Recording votes sets it from the tally."},"isTabled":{"type":"boolean","description":"Tabled (postponed) rather than decided."},"isWithdrawn":{"type":"boolean","description":"Withdrawn by its mover before a decision."},"officialRecord":{"type":["object","null"],"description":"Give the motion an official record number, such as Resolution 2026-14. null removes it.","properties":{"type":{"type":"string","description":"A record kind key from your record numbering settings, such as resolution."},"numberMode":{"type":"string","enum":["next","manual"],"description":"next takes the next number in sequence; manual uses number."},"number":{"type":"string","maxLength":64,"description":"With numberMode manual."}},"required":["type","numberMode"],"additionalProperties":false}},"required":["title"],"additionalProperties":false},"example":{"title":"Motion to approve the consent agenda as presented","mover":"Council Member Ortiz","seconder":"Council Member Hale"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Motion"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_motion","create_motions"]}},"/motions/{motionId}":{"get":{"operationId":"motions.get","tags":["Motions and votes"],"summary":"Get a motion","parameters":[{"name":"motionId","in":"path","required":true,"description":"Motion ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Motion"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_votes"]},"patch":{"operationId":"motions.update","tags":["Motions and votes"],"summary":"Update a motion","description":"Changes only the fields you send.","parameters":[{"name":"motionId","in":"path","required":true,"description":"Motion ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","description":"Decision item type key, such as motion or recommendation. Defaults to your organization's default."},"title":{"type":"string","minLength":1,"maxLength":2048,"description":"The motion's text."},"description":{"type":["string","null"],"maxLength":20000,"description":"Background or the full text, when title is a short summary."},"mover":{"type":["string","null"],"maxLength":255,"description":"Who moved it, as the minutes name them, such as Councillor Lee."},"seconder":{"type":["string","null"],"maxLength":255,"description":"Who seconded it, as the minutes name them."},"recordedOutcome":{"type":["string","null"],"enum":["passed","failed",null],"description":"Record the outcome by hand. Recording votes sets it from the tally."},"isTabled":{"type":"boolean","description":"Tabled (postponed) rather than decided."},"isWithdrawn":{"type":"boolean","description":"Withdrawn by its mover before a decision."},"officialRecord":{"type":["object","null"],"description":"Give the motion an official record number, such as Resolution 2026-14. null removes it.","properties":{"type":{"type":"string","description":"A record kind key from your record numbering settings, such as resolution."},"numberMode":{"type":"string","enum":["next","manual"],"description":"next takes the next number in sequence; manual uses number."},"number":{"type":"string","maxLength":64,"description":"With numberMode manual."}},"required":["type","numberMode"],"additionalProperties":false}},"additionalProperties":false},"example":{"isTabled":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Motion"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_motion","update_motions"]},"delete":{"operationId":"motions.delete","tags":["Motions and votes"],"summary":"Delete a motion","description":"Deletes the motion and its votes. A motion can't be deleted while voting on it is open.","parameters":[{"name":"motionId","in":"path","required":true,"description":"Motion ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_motion"]}},"/motions/{motionId}/votes":{"get":{"operationId":"motions.votes.list","tags":["Motions and votes"],"summary":"Get votes","description":"Each eligible voter and how they voted. value is null for voters who haven't voted.","parameters":[{"name":"motionId","in":"path","required":true,"description":"Motion ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Vote"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_votes"]},"put":{"operationId":"motions.votes.record","tags":["Motions and votes"],"summary":"Record votes","description":"Sets how each listed voter voted; voters you leave out keep their vote. The motion's outcome is recalculated from the tally. Voter keys come from Get votes or Get attendance.","parameters":[{"name":"motionId","in":"path","required":true,"description":"Motion ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"votes":{"type":"array","minItems":1,"maxItems":100,"description":"Each voter's vote.","items":{"type":"object","properties":{"voterKey":{"type":"string","minLength":1,"maxLength":255,"description":"From Get votes or Get attendance."},"value":{"type":["string","null"],"enum":["yes","no","abstain",null],"description":"null clears the vote."}},"required":["voterKey","value"],"additionalProperties":false}}},"required":["votes"],"additionalProperties":false},"example":{"votes":[{"voterKey":"user_2abc","value":"yes"},{"voterKey":"member:31","value":"no"}]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Vote"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["record_votes"]}},"/decision-item-types":{"get":{"operationId":"motions.kinds.list","tags":["Motions and votes"],"summary":"List decision item types","description":"The kinds of decision item your organization records, such as Motion, Recommendation and Direction, and whether each takes a vote.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DecisionItemType"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_org_settings"]}},"/documents/{documentId}":{"get":{"operationId":"documents.get","tags":["Documents"],"summary":"Get a document","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["search_artifacts","get_meeting_detail"]},"patch":{"operationId":"documents.update","tags":["Documents"],"summary":"Rename or retype a document","description":"Changes its file name (keep the extension) or type. To put a document on the public portal, publish its meeting.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"fileName":{"type":"string","minLength":1,"maxLength":255,"description":"The new file name, keeping its extension."},"type":{"type":"string","description":"What the document is, which decides where it's listed and published.","enum":["agenda","agenda_pdf","agenda_packet","minutes","minutes_pdf","minutes_packet","recordings","meeting_recording","transcripts","other"]}},"additionalProperties":false},"example":{"fileName":"Staff Report - Zoning Variance 26-04.pdf"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]},"delete":{"operationId":"documents.delete","tags":["Documents"],"summary":"Delete a document","description":"ClerkDirect keeps deleted documents for recovery, as the app does.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_document_artifact"]}},"/documents/{documentId}/content":{"get":{"operationId":"documents.download","tags":["Documents"],"summary":"Download a document","description":"The file itself, with its Content-Type and a Content-Disposition naming it. Range requests are supported.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}},{"name":"inline","in":"query","required":false,"description":"Ask for Content-Disposition: inline.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"string","description":"The file's bytes."}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["read_document_source"],"x-ava-note":"Ava reads a document's text rather than downloading the file."}},"/documents/uploads/complete":{"post":{"operationId":"documents.uploads.complete","tags":["Documents"],"summary":"Complete an upload","description":"After the file's bytes are PUT to an upload's uploadUrl: adds the document to the meeting and, for an upload started on an agenda item, attaches it under the item. Automations that run when a document is added run. Completing the same upload again returns the same document with status 200, so retry it if it fails.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"uploadId":{"type":"string","minLength":1,"maxLength":4096,"description":"The uploadId from Start an upload."}},"required":["uploadId"],"additionalProperties":false},"example":{"uploadId":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}}}},"responses":{"200":{"description":"This upload was completed already: the same document.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Document"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[]}},"/documents/{documentId}/review-requests":{"post":{"operationId":"documents.reviews.request","tags":["Documents"],"summary":"Request a review","description":"Asks members to review and approve the document. Reviewers are emailed a link. sequential asks them one after another in the order given.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reviewers":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"},"description":"Members' user IDs or email addresses."},"message":{"type":"string","maxLength":2000,"description":"A note included in the email to reviewers."},"mode":{"type":"string","enum":["parallel","sequential"],"description":"parallel asks every reviewer at once; sequential asks them one at a time, in the order given."}},"required":["reviewers"],"additionalProperties":false},"example":{"reviewers":["clerk@springfield.gov"],"message":"Please review before Tuesday."}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"documentId":{"type":"integer"},"reviewerUserIds":{"type":"array","items":{"type":"string"}},"summary":{"type":"string"}},"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["request_review"]}},"/documents/review-reminders":{"post":{"operationId":"documents.reviews.remind","tags":["Documents"],"summary":"Remind reviewers","description":"Emails everyone with a document review waiting on them your message. Limit it to meetings of some types with meetingTypeIds.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":2000,"description":"The reminder emailed to each reviewer."},"meetingTypeIds":{"type":"array","items":{"type":"string"},"maxItems":24,"description":"Only reviews of documents on meetings of these types (from List meeting types)."}},"required":["message"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"summary":{"type":"string"},"documentIds":{"type":"array","items":{"type":"integer"}}},"required":["summary","documentIds"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["remind_reviewers"]}},"/reviews":{"get":{"operationId":"reviews.list","tags":["Documents"],"summary":"List my reviews","description":"Review rounds you review, requested or own (managers see every round they can read), most recently changed first. stage needs_my_review lists what's waiting on you.","parameters":[{"name":"stage","in":"query","required":false,"description":"Only rounds at this stage for you.","schema":{"type":"string","enum":["needs_my_review","waiting_for_reviewers","waiting_for_author","approved"]}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"type":"object","description":"A review round the member reviews, requested or owns.","properties":{"submissionId":{"type":"integer"},"documentId":{"type":"integer"},"documentName":{"type":"string"},"meetingId":{"type":"integer"},"meetingTitle":{"type":"string"},"meetingStartsAt":{"type":["string","null"],"format":"date-time"},"requestedByUserId":{"type":"string"},"requestedByName":{"type":"string"},"requestedByMe":{"type":"boolean"},"isReviewer":{"type":"boolean","description":"Whether the member is one of its reviewers."},"dueDate":{"type":["string","null"],"format":"date"},"status":{"type":"string","enum":["in_review","changes_requested","approved","canceled","revoked","superseded"]},"stage":{"type":"string","enum":["needs_my_review","waiting_for_reviewers","waiting_for_author","approved"]},"mode":{"type":"string","enum":["parallel","sequential"]},"reviewers":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"name":{"type":"string"},"decision":{"type":"string","enum":["pending","approved","changes_requested"]},"isActive":{"type":"boolean","description":"Whether the review is waiting on this reviewer now."}},"additionalProperties":false}},"updatedAt":{"type":"string","format":"date-time"}},"additionalProperties":false}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[],"x-ava-note":"Members see their reviews on the Reviews page."}},"/documents/{documentId}/review":{"get":{"operationId":"documents.reviews.get","tags":["Documents"],"summary":"Get a document's review","description":"Its current review round: who reviews it, each decision, who it's waiting on, and the discussion.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"A document's current review round and its discussion.","properties":{"documentId":{"type":"integer"},"documentVersion":{"type":"integer"},"status":{"type":["string","null"],"enum":["in_review","changes_requested","approved","canceled","revoked","superseded",null],"description":"null when it has never been sent for review."},"submissionId":{"type":["integer","null"]},"message":{"type":["string","null"],"description":"The requester's note."},"dueDate":{"type":["string","null"],"format":"date"},"requestedByUserId":{"type":["string","null"]},"mode":{"type":["string","null"],"enum":["parallel","sequential",null]},"reviewers":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"name":{"type":"string"},"decision":{"type":"string","enum":["pending","approved","changes_requested"]},"isActive":{"type":"boolean","description":"Whether the review is waiting on this reviewer now."}},"additionalProperties":false}},"myDecision":{"type":["string","null"],"enum":["pending","approved","changes_requested",null],"description":"Your decision, or null when you aren't a reviewer of this round."},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"authorUserId":{"type":"string"},"kind":{"type":"string","description":"comment, or the response or event it records."},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"additionalProperties":false}}},"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[],"x-ava-note":"Members review documents in the app's review view."}},"/documents/{documentId}/review/response":{"post":{"operationId":"documents.reviews.respond","tags":["Documents"],"summary":"Approve or request changes","description":"Records your decision on a document you're reviewing, as the review view does. The requester is notified. In a sequential review it must be your turn. pending withdraws an approval.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"type":"string","enum":["pending","approved","changes_requested"],"description":"approved, changes_requested, or pending to withdraw your decision."},"comment":{"type":"string","maxLength":10000,"description":"Why, shown with your decision, such as what needs to change."}},"required":["decision"],"additionalProperties":false},"example":{"decision":"approved","comment":"Looks good."}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"A document's current review round and its discussion.","properties":{"documentId":{"type":"integer"},"documentVersion":{"type":"integer"},"status":{"type":["string","null"],"enum":["in_review","changes_requested","approved","canceled","revoked","superseded",null],"description":"null when it has never been sent for review."},"submissionId":{"type":["integer","null"]},"message":{"type":["string","null"],"description":"The requester's note."},"dueDate":{"type":["string","null"],"format":"date"},"requestedByUserId":{"type":["string","null"]},"mode":{"type":["string","null"],"enum":["parallel","sequential",null]},"reviewers":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"name":{"type":"string"},"decision":{"type":"string","enum":["pending","approved","changes_requested"]},"isActive":{"type":"boolean","description":"Whether the review is waiting on this reviewer now."}},"additionalProperties":false}},"myDecision":{"type":["string","null"],"enum":["pending","approved","changes_requested",null],"description":"Your decision, or null when you aren't a reviewer of this round."},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"authorUserId":{"type":"string"},"kind":{"type":"string","description":"comment, or the response or event it records."},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"additionalProperties":false}}},"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[],"x-ava-note":"Members respond in the app's review view."}},"/documents/{documentId}/review/comments":{"post":{"operationId":"documents.reviews.comment","tags":["Documents"],"summary":"Comment on a review","description":"Adds a comment to the document's review discussion, as the review view does. Mentioned members are notified.","parameters":[{"name":"documentId","in":"path","required":true,"description":"Document ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000,"description":"The comment text."},"mentionedUserIds":{"type":"array","items":{"type":"string"},"maxItems":50,"description":"Members to notify, by user ID (from List members)."}},"required":["body"],"additionalProperties":false},"example":{"body":"Section 4 should cite the 2025 bylaw."}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","description":"A document's current review round and its discussion.","properties":{"documentId":{"type":"integer"},"documentVersion":{"type":"integer"},"status":{"type":["string","null"],"enum":["in_review","changes_requested","approved","canceled","revoked","superseded",null],"description":"null when it has never been sent for review."},"submissionId":{"type":["integer","null"]},"message":{"type":["string","null"],"description":"The requester's note."},"dueDate":{"type":["string","null"],"format":"date"},"requestedByUserId":{"type":["string","null"]},"mode":{"type":["string","null"],"enum":["parallel","sequential",null]},"reviewers":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string"},"name":{"type":"string"},"decision":{"type":"string","enum":["pending","approved","changes_requested"]},"isActive":{"type":"boolean","description":"Whether the review is waiting on this reviewer now."}},"additionalProperties":false}},"myDecision":{"type":["string","null"],"enum":["pending","approved","changes_requested",null],"description":"Your decision, or null when you aren't a reviewer of this round."},"comments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"authorUserId":{"type":"string"},"kind":{"type":"string","description":"comment, or the response or event it records."},"body":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}},"additionalProperties":false}}},"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":[],"x-ava-note":"Members comment in the app's review view."}},"/tasks":{"get":{"operationId":"tasks.list","tags":["Tasks"],"summary":"List tasks","description":"Tasks your key's creator can read, from the most recent meetings first.","parameters":[{"name":"status","in":"query","required":false,"description":"open (the default) is unstarted or in progress.","schema":{"type":"string","enum":["open","unstarted","in_progress","done","canceled","all"]}},{"name":"meetingId","in":"query","required":false,"description":"Tasks from, or linked to, this meeting.","schema":{"type":"integer"}},{"name":"boardId","in":"query","required":false,"description":"Tasks from this board's meetings.","schema":{"type":"integer"}},{"name":"assigneeUserId","in":"query","required":false,"description":"Tasks assigned to this member.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_action_items","get_resolutions"]},"post":{"operationId":"tasks.create","tags":["Tasks"],"summary":"Create a task","description":"Creates a task. Set agendaItemId to create it from an agenda item, as the meeting page does; otherwise it's a workspace task. The assignee is notified.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":512,"description":"What needs doing, such as Post the adopted budget online."},"description":{"type":["string","null"],"maxLength":20000,"description":"Details and instructions."},"status":{"type":"string","enum":["unstarted","in_progress","done","canceled"],"description":"Defaults to unstarted. done records who completed it and when."},"priority":{"type":["string","null"],"enum":["low","medium","high",null],"description":"null for none."},"assigneeUserId":{"type":["string","null"],"pattern":"^user_","description":"A member's user ID (from List members)."},"dueDate":{"type":["string","null"],"format":"date","description":"When it's due (YYYY-MM-DD)."},"agendaItemId":{"type":"integer","description":"The agenda item it comes out of."}},"required":["title"],"additionalProperties":false},"example":{"title":"Post the adopted budget to the website","assigneeUserId":"user_2abc","dueDate":"2026-12-01","priority":"high"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Task"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_task","create_tasks"]}},"/tasks/{taskId}":{"get":{"operationId":"tasks.get","tags":["Tasks"],"summary":"Get a task","parameters":[{"name":"taskId","in":"path","required":true,"description":"Task ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Task"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_action_items"]},"patch":{"operationId":"tasks.update","tags":["Tasks"],"summary":"Update a task","description":"Changes only the fields you send. Marking a task done records who completed it and when.","parameters":[{"name":"taskId","in":"path","required":true,"description":"Task ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":512,"description":"What needs doing, such as Post the adopted budget online."},"description":{"type":["string","null"],"maxLength":20000,"description":"Details and instructions."},"status":{"type":"string","enum":["unstarted","in_progress","done","canceled"],"description":"Defaults to unstarted. done records who completed it and when."},"priority":{"type":["string","null"],"enum":["low","medium","high",null],"description":"null for none."},"assigneeUserId":{"type":["string","null"],"pattern":"^user_","description":"A member's user ID (from List members)."},"dueDate":{"type":["string","null"],"format":"date","description":"When it's due (YYYY-MM-DD)."},"cancellationReason":{"type":"string","maxLength":255,"description":"With status canceled."}},"additionalProperties":false},"example":{"status":"done"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Task"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_action_item"]},"delete":{"operationId":"tasks.delete","tags":["Tasks"],"summary":"Delete a task","parameters":[{"name":"taskId","in":"path","required":true,"description":"Task ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_action_item"]}},"/tasks/{taskId}/comments":{"get":{"operationId":"tasks.comments.list","tags":["Tasks"],"summary":"List a task's comments","description":"Oldest first.","parameters":[{"name":"taskId","in":"path","required":true,"description":"Task ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskComment"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_task_comments"]},"post":{"operationId":"tasks.comments.create","tags":["Tasks"],"summary":"Comment on a task","description":"Adds a comment as your key's creator. Mentioned members are notified.","parameters":[{"name":"taskId","in":"path","required":true,"description":"Task ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":10000,"description":"The comment text."},"mentionedUserIds":{"type":"array","items":{"type":"string"},"maxItems":50,"description":"Members to notify, by user ID (from List members)."}},"required":["body"],"additionalProperties":false},"example":{"body":"Posted to the website on Nov 20."}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/TaskComment"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["comment_on_task"]}},"/tasks/{taskId}/motions":{"post":{"operationId":"tasks.motions.link","tags":["Tasks"],"summary":"Link motions to a task","description":"Links the motions a task carries out, such as the resolution that directed it.","parameters":[{"name":"taskId","in":"path","required":true,"description":"Task ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"motionIds":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"integer"},"description":"Motions to link, from List a meeting's motions."}},"required":["motionIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Task"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["link_task_motions"]}},"/tasks/reminders":{"post":{"operationId":"tasks.reminders.send","tags":["Tasks"],"summary":"Remind assignees","description":"Emails the assignees of the listed open tasks your message. Each task's assignee is reminded at most once a day with the same message.","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"taskIds":{"type":"array","minItems":1,"maxItems":200,"items":{"type":"integer"},"description":"The tasks whose assignees to remind."},"message":{"type":"string","minLength":1,"maxLength":2000,"description":"The reminder emailed to each assignee."}},"required":["taskIds","message"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"summary":{"type":"string"},"remindedCount":{"type":"integer"}},"required":["summary","remindedCount"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["remind_open_tasks"]}},"/automations":{"get":{"operationId":"automations.list","tags":["Automations"],"summary":"List automations","parameters":[{"name":"status","in":"query","required":false,"description":"Only active automations run on their own.","schema":{"type":"string","enum":["draft","active","paused"]}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_automations"]},"post":{"operationId":"automations.create","tags":["Automations"],"summary":"Create an automation","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Such as Draft minutes after council meetings."},"description":{"type":["string","null"],"maxLength":2000,"description":"What it's for, shown in the automation list."},"status":{"type":"string","enum":["draft","active","paused"],"description":"Only active automations run on their own."},"ownerUserId":{"type":"string","description":"Defaults to your key's creator. Steps run as the owner."},"trigger":{"type":"object","additionalProperties":true,"description":"When it runs. type is one of meeting_ended, meeting_upcoming, schedule, document_generated, document_added or document_approved; the other fields depend on it (see Automation triggers).","properties":{"type":{"type":"string","description":"What starts a run.","enum":["meeting_ended","meeting_upcoming","schedule","document_generated","document_added","document_approved"]}},"required":["type"]},"steps":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","description":"One step. Steps run in order.","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"Unique within the automation."},"name":{"type":["string","null"],"maxLength":255,"description":"A label for the step in run history."},"action":{"type":"object","additionalProperties":true,"description":"What the step does. type is one of transcribe_recordings, generate_document, ask_ava, create_tasks, remind_open_tasks, remind_reviewers, request_review or export_to_sharepoint (see Automation steps).","properties":{"type":{"type":"string","description":"The kind of step. Its other settings go alongside it in action.","enum":["transcribe_recordings","generate_document","ask_ava","create_tasks","remind_open_tasks","remind_reviewers","request_review","export_to_sharepoint"]}},"required":["type"]}},"required":["id","action"],"additionalProperties":false},"description":"What it does, in order. A step that fails ends the run."}},"required":["name","trigger","steps"],"additionalProperties":false},"example":{"name":"Draft minutes after council meetings","status":"active","trigger":{"type":"meeting_ended","meetingTypeIds":["council"]},"steps":[{"id":"transcribe","action":{"type":"transcribe_recordings"}},{"id":"minutes","action":{"type":"generate_document","prompt":"Draft the minutes.","templateId":null,"fileName":null,"sessionMinutes":true}}]}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_automation"]}},"/automations/{automationId}":{"get":{"operationId":"automations.get","tags":["Automations"],"summary":"Get an automation","parameters":[{"name":"automationId","in":"path","required":true,"description":"Automation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_automations"]},"patch":{"operationId":"automations.update","tags":["Automations"],"summary":"Update an automation","description":"Changes only the fields you send. trigger and steps replace the automation's whole trigger or step list. Pause or resume by setting status.","parameters":[{"name":"automationId","in":"path","required":true,"description":"Automation ID.","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Such as Draft minutes after council meetings."},"description":{"type":["string","null"],"maxLength":2000,"description":"What it's for, shown in the automation list."},"status":{"type":"string","enum":["draft","active","paused"],"description":"Only active automations run on their own."},"ownerUserId":{"type":"string","description":"Defaults to your key's creator. Steps run as the owner."},"trigger":{"type":"object","additionalProperties":true,"description":"When it runs. type is one of meeting_ended, meeting_upcoming, schedule, document_generated, document_added or document_approved; the other fields depend on it (see Automation triggers).","properties":{"type":{"type":"string","description":"What starts a run.","enum":["meeting_ended","meeting_upcoming","schedule","document_generated","document_added","document_approved"]}},"required":["type"]},"steps":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"object","description":"One step. Steps run in order.","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"Unique within the automation."},"name":{"type":["string","null"],"maxLength":255,"description":"A label for the step in run history."},"action":{"type":"object","additionalProperties":true,"description":"What the step does. type is one of transcribe_recordings, generate_document, ask_ava, create_tasks, remind_open_tasks, remind_reviewers, request_review or export_to_sharepoint (see Automation steps).","properties":{"type":{"type":"string","description":"The kind of step. Its other settings go alongside it in action.","enum":["transcribe_recordings","generate_document","ask_ava","create_tasks","remind_open_tasks","remind_reviewers","request_review","export_to_sharepoint"]}},"required":["type"]}},"required":["id","action"],"additionalProperties":false},"description":"What it does, in order. A step that fails ends the run."}},"additionalProperties":false},"example":{"status":"paused"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_automation"]},"delete":{"operationId":"automations.delete","tags":["Automations"],"summary":"Delete an automation","description":"ClerkDirect's default minutes automation can't be deleted; pause it instead.","parameters":[{"name":"automationId","in":"path","required":true,"description":"Automation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_automation"]}},"/automations/{automationId}/runs":{"post":{"operationId":"automations.run","tags":["Automations"],"summary":"Run an automation now","description":"Starts a run right away, even if the automation is paused. Meeting-based automations need meetingId; document-based ones need documentId.","parameters":[{"name":"automationId","in":"path","required":true,"description":"Automation ID.","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"meetingId":{"type":"integer","description":"The meeting to run it for."},"documentId":{"type":"integer","description":"The document to run it for."}},"additionalProperties":false}}}},"responses":{"202":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AutomationRun"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["run_automation"]},"get":{"operationId":"automations.runs.list","tags":["Automations"],"summary":"List an automation's runs","description":"Most recent first, with each step's outcome.","parameters":[{"name":"automationId","in":"path","required":true,"description":"Automation ID.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"How many results to return (1-200, default 50).","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"cursor","in":"query","required":false,"description":"The nextCursor from the previous page. Omit it for the first page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data","hasMore","nextCursor"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AutomationRun"}},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_automation_runs"]}},"/boards":{"get":{"operationId":"boards.list","tags":["Boards"],"summary":"List boards","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Board"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_boards"]},"post":{"operationId":"boards.create","tags":["Boards"],"summary":"Create a board","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Such as City Council or Planning Commission."},"members":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"userId":{"type":["string","null"],"description":"The member's user ID, when they have a ClerkDirect account."},"name":{"type":["string","null"],"maxLength":255,"description":"Their name, for someone without an account."},"title":{"type":["string","null"],"maxLength":255,"description":"Such as Mayor or Ward 2 Council Member."},"startDate":{"type":["string","null"],"format":"date","description":"Term start."},"endDate":{"type":["string","null"],"format":"date","description":"Term end."}},"additionalProperties":false},"description":"Its members: by userId for someone with an account, otherwise by name."}},"required":["name"],"additionalProperties":false},"example":{"name":"Planning Commission","members":[{"name":"Dana Whitfield","title":"Chair","startDate":"2026-01-01"}]}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Board"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_board"]}},"/boards/{boardId}":{"get":{"operationId":"boards.get","tags":["Boards"],"summary":"Get a board","parameters":[{"name":"boardId","in":"path","required":true,"description":"Board ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Board"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_boards"]},"patch":{"operationId":"boards.update","tags":["Boards"],"summary":"Rename a board","description":"Renames the board. Its members keep their IDs.","parameters":[{"name":"boardId","in":"path","required":true,"description":"Board ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The new name."}},"required":["name"],"additionalProperties":false}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Board"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_board"]},"delete":{"operationId":"boards.delete","tags":["Boards"],"summary":"Delete a board","description":"Deletes the board and its roster. Its meetings stay, with no board.","parameters":[{"name":"boardId","in":"path","required":true,"description":"Board ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_board"]}},"/boards/{boardId}/members":{"post":{"operationId":"boards.members.add","tags":["Boards"],"summary":"Add a board member","description":"Set userId for a member with an account, or name for someone without one.","parameters":[{"name":"boardId","in":"path","required":true,"description":"Board ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":["string","null"],"description":"The member's user ID, when they have a ClerkDirect account."},"name":{"type":["string","null"],"maxLength":255,"description":"Their name, for someone without an account."},"title":{"type":["string","null"],"maxLength":255,"description":"Such as Mayor or Ward 2 Council Member."},"startDate":{"type":["string","null"],"format":"date","description":"Term start."},"endDate":{"type":["string","null"],"format":"date","description":"Term end."}},"additionalProperties":false},"example":{"userId":"user_2abc","title":"Ward 3 Council Member","startDate":"2026-01-06"}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BoardMember"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["add_board_member"]}},"/boards/{boardId}/members/{memberId}":{"patch":{"operationId":"boards.members.update","tags":["Boards"],"summary":"Update a board member","description":"Change a member's title, term dates, or (for someone without an account) name.","parameters":[{"name":"boardId","in":"path","required":true,"description":"Board ID.","schema":{"type":"integer","minimum":1}},{"name":"memberId","in":"path","required":true,"description":"Board member ID.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":["string","null"],"maxLength":255,"description":"Their name, for someone without an account."},"title":{"type":["string","null"],"maxLength":255,"description":"Such as Mayor or Ward 2 Council Member."},"startDate":{"type":["string","null"],"format":"date","description":"Term start."},"endDate":{"type":["string","null"],"format":"date","description":"Term end."}},"additionalProperties":false},"example":{"endDate":"2026-12-31"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/BoardMember"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_board_member"]},"delete":{"operationId":"boards.members.remove","tags":["Boards"],"summary":"Remove a board member","parameters":[{"name":"boardId","in":"path","required":true,"description":"Board ID.","schema":{"type":"integer","minimum":1}},{"name":"memberId","in":"path","required":true,"description":"Board member ID.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","properties":{"id":{"type":"integer"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"additionalProperties":false}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["delete_board_member"]}},"/meeting-types":{"get":{"operationId":"meetingTypes.list","tags":["Meeting types"],"summary":"List meeting types","parameters":[{"name":"includeArchived","in":"query","required":false,"description":"Include archived types.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MeetingType"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_org_settings"]},"post":{"operationId":"meetingTypes.create","tags":["Meeting types"],"summary":"Create a meeting type","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"description":"Such as Regular Council or Planning Commission."},"decisionKindIds":{"type":"array","minItems":1,"items":{"type":"string"},"description":"The decision item types its meetings can use (from List decision item types)."},"defaultDecisionKindId":{"type":"string","description":"One of decisionKindIds."},"agendaTemplateId":{"type":["string","null"],"description":"Agenda template new meetings of this type start from."},"showDecisionItemsOnAgenda":{"type":"boolean","description":"Whether motions appear in agenda documents and the public agenda page."}},"required":["name"],"additionalProperties":false},"example":{"name":"Special Meeting","decisionKindIds":["motion"]}}}},"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MeetingType"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["create_meeting_type"]}},"/meeting-types/{meetingTypeId}":{"patch":{"operationId":"meetingTypes.update","tags":["Meeting types"],"summary":"Update a meeting type","description":"Changes only the fields you send. Archive a type with isArchived; its meetings keep it.","parameters":[{"name":"meetingTypeId","in":"path","required":true,"description":"Meeting type ID.","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"description":"Such as Regular Council or Planning Commission."},"decisionKindIds":{"type":"array","minItems":1,"items":{"type":"string"},"description":"The decision item types its meetings can use (from List decision item types)."},"defaultDecisionKindId":{"type":"string","description":"One of decisionKindIds."},"agendaTemplateId":{"type":["string","null"],"description":"Agenda template new meetings of this type start from."},"showDecisionItemsOnAgenda":{"type":"boolean","description":"Whether motions appear in agenda documents and the public agenda page."},"isArchived":{"type":"boolean","description":"true hides it from new meetings; false restores it. Its meetings keep the type."}},"additionalProperties":false},"example":{"isArchived":true}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MeetingType"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_meeting_type","archive_meeting_type","restore_meeting_type"]}},"/templates":{"get":{"operationId":"templates.list","tags":["Templates"],"summary":"List document templates","description":"Your organization's minutes and document templates.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_document_templates","get_template_workspace"]}},"/agenda-templates":{"get":{"operationId":"templates.agenda.list","tags":["Templates"],"summary":"List agenda templates","description":"Saved agenda outlines new meetings can start from.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgendaTemplate"}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_agenda_templates"]}},"/portal":{"get":{"operationId":"portal.settings.get","tags":["Public portal"],"summary":"Get portal settings","description":"null when the organization hasn't set up its public portal.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PortalSettings"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["get_portal_settings"]},"patch":{"operationId":"portal.settings.update","tags":["Public portal"],"summary":"Update portal settings","description":"Changes only the fields you send. Turning the portal off takes every meeting off it.","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Whether the public portal is on. Turning it off takes every meeting off it."},"pageTitle":{"type":"string","maxLength":255,"description":"The heading at the top of the portal."},"pageDescription":{"type":["string","null"],"maxLength":2000,"description":"Introductory text under the heading."},"headerBgColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"Header background, as a hex color such as #1F4E79."},"headerTextColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"Header text, as a hex color."},"accentColor":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"Links and buttons, as a hex color."},"navLinks":{"type":"array","maxItems":20,"description":"Links in the portal's header, such as your website. Replaces the list.","items":{"type":"object","properties":{"label":{"type":"string","maxLength":80,"description":"The link's text."},"url":{"type":"string","format":"uri","description":"Where it goes."}},"required":["label","url"],"additionalProperties":false}},"socialLinks":{"type":"array","maxItems":20,"description":"Social media profiles shown on the portal. Replaces the list.","items":{"type":"object","properties":{"platform":{"type":"string","description":"Which network, for its icon.","enum":["facebook","instagram","x","youtube","linkedin","nextdoor","tiktok","threads"]},"url":{"type":"string","format":"uri","description":"The profile's address."}},"required":["platform","url"],"additionalProperties":false}},"displayConfig":{"type":"object","additionalProperties":true,"properties":{},"description":"Display options: resultsPerPage (6, 10, 12 or 20), defaultSort (newest or oldest), documentOpenMode (newTab or download), allowSubscriptions, and show* flags for each part of the portal."}},"additionalProperties":false},"example":{"pageTitle":"Springfield Public Meetings","accentColor":"#1F4E79"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/PortalSettings"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["update_portal_settings"]}},"/search":{"get":{"operationId":"search.workspace","tags":["Search"],"summary":"Search everything","description":"Searches meeting titles, agenda items, documents (by name and content) and minutes. Results are limited to what your key's creator can read.","parameters":[{"name":"q","in":"query","required":true,"description":"What to search for.","schema":{"type":"string","minLength":2,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SearchResults"}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["search_meetings","search_artifacts","search_across_minutes"]}},"/search/minutes":{"get":{"operationId":"search.minutes","tags":["Search"],"summary":"Search minutes","description":"Full-text search of every meeting's minutes, newest first (up to 30 matches).","parameters":[{"name":"q","in":"query","required":true,"description":"A word or exact phrase to find in the minutes' text.","schema":{"type":"string","minLength":1,"maxLength":200}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"type":"object","properties":{"meetingId":{"type":"integer"},"meetingTitle":{"type":"string"},"meetingStartsAt":{"type":"string","format":"date-time"},"sessionId":{"type":["integer","null"]},"documentId":{"type":["integer","null"]},"excerpt":{"type":"string"}},"additionalProperties":false}}}}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-ava-tools":["search_across_minutes"]}}},"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Your API key, from Settings → Developers. It acts as you, with your role. Send it as Authorization: Bearer cdk_..."}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","examples":["not_found"]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":true},"requestId":{"type":"string","examples":["req_4f1c2a9b0e7d3c5a61"]}}}}},"Meeting":{"type":"object","description":"A meeting.","properties":{"id":{"type":"integer","description":"Meeting ID."},"title":{"type":"string","description":"Meeting title.","examples":["Regular Council Meeting"]},"description":{"type":["string","null"],"description":"Description."},"startsAt":{"type":"string","format":"date-time","description":"Start, in UTC. Date-only meetings start at midnight in timeZone."},"timeZone":{"type":["string","null"],"description":"IANA time zone the meeting is held in, such as America/Chicago."},"durationMinutes":{"type":"integer"},"location":{"type":["string","null"],"description":"Where it's held."},"boardId":{"type":["integer","null"],"description":"The board or committee holding it."},"meetingTypeId":{"type":["string","null"],"description":"Its meeting type."},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean","description":"Whether it's published to the public portal. Change it with the publication endpoint."},"isCancelled":{"type":"boolean"},"ownerUserId":{"type":["string","null"],"description":"The member who owns it, when known."},"recurrenceSeriesId":{"type":["integer","null"],"description":"Set when the meeting is one occurrence of a recurring series."},"createdAt":{"type":"string","format":"date-time","description":"When it was created."},"updatedAt":{"type":"string","format":"date-time","description":"When it last changed."}},"required":["id","title","description","startsAt","timeZone","durationMinutes","location","boardId","meetingTypeId","tags","isPublic","isCancelled","ownerUserId","recurrenceSeriesId","createdAt","updatedAt"],"additionalProperties":false},"MeetingDetail":{"type":"object","description":"A meeting with its sessions and documents.","properties":{"id":{"type":"integer","description":"Meeting ID."},"title":{"type":"string","description":"Meeting title.","examples":["Regular Council Meeting"]},"description":{"type":["string","null"],"description":"Description."},"startsAt":{"type":"string","format":"date-time","description":"Start, in UTC. Date-only meetings start at midnight in timeZone."},"timeZone":{"type":["string","null"],"description":"IANA time zone the meeting is held in, such as America/Chicago."},"durationMinutes":{"type":"integer"},"location":{"type":["string","null"],"description":"Where it's held."},"boardId":{"type":["integer","null"],"description":"The board or committee holding it."},"meetingTypeId":{"type":["string","null"],"description":"Its meeting type."},"tags":{"type":"array","items":{"type":"string"}},"isPublic":{"type":"boolean","description":"Whether it's published to the public portal. Change it with the publication endpoint."},"isCancelled":{"type":"boolean"},"ownerUserId":{"type":["string","null"],"description":"The member who owns it, when known."},"recurrenceSeriesId":{"type":["integer","null"],"description":"Set when the meeting is one occurrence of a recurring series."},"createdAt":{"type":"string","format":"date-time","description":"When it was created."},"updatedAt":{"type":"string","format":"date-time","description":"When it last changed."},"agendaItemCount":{"type":"integer"},"sessions":{"type":"array","items":{"$ref":"#/components/schemas/Session"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}},"required":["id","title","description","startsAt","timeZone","durationMinutes","location","boardId","meetingTypeId","tags","isPublic","isCancelled","ownerUserId","recurrenceSeriesId","createdAt","updatedAt","agendaItemCount","sessions","documents"],"additionalProperties":false},"Session":{"type":"object","description":"A part of a meeting with its own agenda and minutes. Every meeting has an open session; closed (in-camera) sessions are private.","properties":{"id":{"type":"integer","description":"Session ID."},"title":{"type":"string","description":"Session title."},"type":{"type":"string","enum":["open","closed"]},"visibility":{"type":"string","enum":["public","private"]},"position":{"type":"integer","description":"Order within the meeting, from 1."},"legalAuthority":{"type":["string","null"],"description":"For a closed session, the authority it was closed under."},"closedReason":{"type":["string","null"],"description":"For a closed session, the reason it was closed."},"hasTranscript":{"type":"boolean"},"minutesDocumentId":{"type":["integer","null"],"description":"The document holding this session's minutes, if there is one."},"canRead":{"type":"boolean","description":"False when the session is restricted to members your key's creator isn't one of."}},"required":["id","title","type","visibility","position","legalAuthority","closedReason","hasTranscript","minutesDocumentId","canRead"],"additionalProperties":false},"Attendee":{"type":"object","description":"Someone expected at a meeting: a board member or a guest.","properties":{"voterKey":{"type":"string","description":"Identifies them in roll call and votes."},"name":{"type":["string","null"],"description":"Their name."},"title":{"type":["string","null"],"description":"Their title, such as Mayor."},"userId":{"type":["string","null"],"description":"Their user ID, when they have an account."},"boardMemberId":{"type":["integer","null"]},"isGuest":{"type":"boolean"},"isVotingMember":{"type":"boolean"},"attendance":{"type":["string","null"],"enum":["present","absent",null],"description":"From roll call; null when it wasn't taken."}},"required":["voterKey","name","title","userId","boardMemberId","isGuest","isVotingMember","attendance"],"additionalProperties":false},"Guest":{"type":"object","description":"A meeting guest who isn't on the board.","properties":{"id":{"type":"integer","description":"Guest ID."},"name":{"type":"string","description":"Name."},"email":{"type":["string","null"],"description":"Email."},"title":{"type":["string","null"],"description":"Title."},"isVotingMember":{"type":"boolean"}},"required":["id","name","email","title","isVotingMember"],"additionalProperties":false},"Minutes":{"type":"object","description":"A session's minutes.","properties":{"meetingId":{"type":"integer","description":"Meeting ID."},"sessionId":{"type":["integer","null"]},"documentId":{"type":["integer","null"],"description":"The minutes document."},"fileName":{"type":["string","null"],"description":"The minutes document's name."},"text":{"type":["string","null"],"description":"The minutes as plain text. null for an uploaded file ClerkDirect can't read."},"agendaItems":{"type":"array","description":"Minutes recorded against each agenda item.","items":{"type":"object","description":"","properties":{"title":{"type":"string"},"minutes":{"type":["string","null"]},"isSection":{"type":"boolean"}},"required":["title","minutes","isSection"],"additionalProperties":false}}},"required":["meetingId","sessionId","documentId","fileName","text","agendaItems"],"additionalProperties":false},"TranscriptSegment":{"type":"object","description":"A stretch of speech by one speaker.","properties":{"speaker":{"type":["string","null"],"description":"Speaker name or label."},"text":{"type":"string","description":"What they said."},"startMs":{"type":"integer","description":"Offset into the recording, in milliseconds."},"endMs":{"type":"integer"}},"required":["speaker","text","startMs","endMs"],"additionalProperties":false},"Publication":{"type":"object","description":"Whether a meeting is on the public portal.","properties":{"status":{"type":"string","enum":["unpublished","updating","published","error"],"description":"updating while the portal copy is being built."},"isPublic":{"type":"boolean"},"publishedAt":{"type":["string","null"],"format":"date-time"},"error":{"type":["string","null"],"description":"Why the last publish failed."},"revision":{"type":"integer"},"standardFiles":{"type":"array","items":{"type":"object","description":"","properties":{"role":{"type":"string","enum":["agenda","agenda_packet","minutes"]},"sessionId":{"type":"integer"},"documentId":{"type":["integer","null"]}},"required":["role","sessionId","documentId"],"additionalProperties":false}},"documentIds":{"type":"array","items":{"type":"integer"}}},"required":["status","isPublic","publishedAt","error","revision","standardFiles","documentIds"],"additionalProperties":false},"Document":{"type":"object","description":"A file attached to a meeting or agenda item.","properties":{"id":{"type":"integer","description":"Document ID."},"meetingId":{"type":["integer","null"]},"sessionId":{"type":["integer","null"]},"type":{"type":"string","description":"What the file is: agenda, agenda_pdf, agenda_packet, minutes, minutes_pdf, minutes_packet, recordings (an uploaded audio or video file), meeting_recording (a live meeting's recording), transcripts or other."},"fileName":{"type":"string","description":"File name, with extension."},"fileSize":{"type":"integer","description":"Size in bytes."},"contentType":{"type":["string","null"],"description":"MIME type."},"isPublic":{"type":"boolean","description":"Whether the public portal shows it."},"version":{"type":"integer"},"agendaItems":{"type":"array","description":"Agenda items the file is attached to.","items":{"type":"object","description":"","properties":{"id":{"type":"integer"},"title":{"type":"string"}},"required":["id","title"],"additionalProperties":false}},"createdAt":{"type":"string","format":"date-time","description":"When it was added."},"updatedAt":{"type":"string","format":"date-time","description":"When it last changed."}},"required":["id","meetingId","sessionId","type","fileName","fileSize","contentType","isPublic","version","agendaItems","createdAt","updatedAt"],"additionalProperties":false},"DocumentUpload":{"type":"object","description":"An upload waiting for its file. PUT the file's bytes to uploadUrl with headers, then Complete an upload with uploadId.","properties":{"uploadId":{"type":"string","description":"Pass this to Complete an upload once the file is stored."},"uploadUrl":{"type":"string","description":"Where to PUT the file's bytes, straight to storage. It's signed for this file's exact size; send the Content-Type in headers, which completing the upload checks."},"method":{"type":"string","description":"Always PUT.","enum":["PUT"]},"headers":{"type":"object","additionalProperties":true,"properties":{},"description":"Headers to send with the PUT, exactly as given. If-None-Match makes storage refuse a second PUT (412), so running the command again can't replace a stored file."},"expiresAt":{"type":"string","format":"date-time","description":"When uploadUrl stops working. Complete the upload within a day."},"curl":{"type":"string","description":"A ready-to-run curl command that PUTs the file, run from the folder it's in."}},"required":["uploadId","uploadUrl","method","headers","expiresAt","curl"],"additionalProperties":false},"Agenda":{"type":"object","description":"A session's agenda.","properties":{"meetingId":{"type":"integer","description":"Meeting ID."},"sessionId":{"type":["integer","null"]},"items":{"type":"array","description":"Every item, in agenda order (each parent before its children).","items":{"$ref":"#/components/schemas/AgendaItem"}}},"required":["meetingId","sessionId","items"],"additionalProperties":false},"AgendaItem":{"type":"object","description":"An agenda item or section.","properties":{"id":{"type":"integer","description":"Agenda item ID."},"meetingId":{"type":"integer","description":"Its meeting."},"sessionId":{"type":["integer","null"]},"parentId":{"type":["integer","null"],"description":"The item or section it's nested under."},"depth":{"type":"integer","description":"Nesting depth; top-level items are 0."},"position":{"type":"integer","description":"Order among its siblings, from 1."},"title":{"type":"string","description":"Title."},"description":{"type":["string","null"],"description":"Body text."},"minutes":{"type":["string","null"],"description":"Minutes recorded against the item."},"isSection":{"type":"boolean","description":"A heading that groups the items under it."},"restricted":{"type":"boolean","description":"True when the item is limited to selected members and your key's creator isn't one of them. Its title is then the public title and its contents are left out."},"documents":{"type":"array","items":{"type":"object","description":"","properties":{"id":{"type":"integer"},"fileName":{"type":"string"}},"required":["id","fileName"],"additionalProperties":false}},"motions":{"type":"array","items":{"$ref":"#/components/schemas/Motion"}}},"required":["id","meetingId","sessionId","parentId","depth","position","title","description","minutes","isSection","restricted","documents","motions"],"additionalProperties":false},"Motion":{"type":"object","description":"A decision item on an agenda item: a motion, recommendation, resolution or another kind your organization defines.","properties":{"id":{"type":"integer","description":"Motion ID."},"agendaItemId":{"type":"integer","description":"The agenda item it belongs to."},"kind":{"type":"string","description":"Decision item type key, such as motion."},"kindLabel":{"type":"string","description":"Decision item type name, such as Motion."},"votingMode":{"type":"string","enum":["required","optional","none"]},"title":{"type":"string","description":"The motion's text."},"description":{"type":["string","null"],"description":"Further detail."},"mover":{"type":["string","null"],"description":"Who moved it."},"seconder":{"type":["string","null"],"description":"Who seconded it."},"status":{"type":"string","enum":["pending","passed","failed","tabled","withdrawn"],"description":"Where the motion stands."},"recordedOutcome":{"type":["string","null"],"enum":["passed","failed",null],"description":"The outcome recorded for it, by vote or by hand."},"officialRecord":{"type":["object","null"],"description":"Its official record number, such as Resolution 2026-14.","properties":{"type":{"type":"string"},"number":{"type":["string","null"]}},"required":["type","number"],"additionalProperties":false},"voteCounts":{"$ref":"#/components/schemas/VoteCounts"},"position":{"type":"integer","description":"Order on the agenda item."},"createdAt":{"type":"string","format":"date-time","description":"When it was created."},"updatedAt":{"type":"string","format":"date-time","description":"When it last changed."}},"required":["id","agendaItemId","kind","kindLabel","votingMode","title","description","mover","seconder","status","recordedOutcome","officialRecord","voteCounts","position","createdAt","updatedAt"],"additionalProperties":false},"VoteCounts":{"type":"object","description":"Vote tallies.","properties":{"yes":{"type":"integer"},"no":{"type":"integer"},"abstain":{"type":"integer"},"absent":{"type":"integer"},"recorded":{"type":"integer"},"eligible":{"type":["integer","null"]}},"required":["yes","no","abstain","absent","recorded","eligible"],"additionalProperties":false},"Vote":{"type":"object","description":"One voter's vote on a motion.","properties":{"voterKey":{"type":"string","description":"Who voted: a member's user ID, member:<boardMemberId> for a board member without an account, or guest:<guestId>."},"boardMemberId":{"type":["integer","null"]},"name":{"type":["string","null"],"description":"The voter's name, when known."},"value":{"type":["string","null"],"enum":["yes","no","abstain","absent",null]}},"required":["voterKey","boardMemberId","name","value"],"additionalProperties":false},"Task":{"type":"object","description":"An action item, often directed by a motion at a meeting.","properties":{"id":{"type":"integer"},"number":{"type":["string","null"],"description":"Its task number, such as T-2026-031."},"title":{"type":"string"},"description":{"type":["string","null"]},"status":{"type":"string","enum":["unstarted","in_progress","done","canceled"],"description":"Defaults to unstarted. done records who completed it and when."},"priority":{"type":["string","null"],"enum":["low","medium","high",null]},"assigneeUserId":{"type":["string","null"]},"dueDate":{"type":["string","null"],"format":"date"},"meetingId":{"type":["integer","null"],"description":"The meeting it came from."},"agendaItemId":{"type":["integer","null"],"description":"The agenda item it came from."},"linkedAgendaItemIds":{"type":"array","items":{"type":"integer"}},"linkedMotionIds":{"type":"array","items":{"type":"integer"}},"commentCount":{"type":["integer","null"]},"completedAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"additionalProperties":false},"TaskComment":{"type":"object","properties":{"id":{"type":"integer"},"authorUserId":{"type":["string","null"]},"body":{"type":"string"},"mentionedUserIds":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"additionalProperties":false},"Automation":{"type":"object","description":"A rule that runs steps when something happens or on a schedule.","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"status":{"type":"string","enum":["draft","active","paused"],"description":"Only active automations run on their own."},"isDefault":{"type":"boolean","description":"ClerkDirect's default minutes automation."},"ownerUserId":{"type":["string","null"]},"trigger":{"type":"object","additionalProperties":true,"description":"When it runs. type is one of meeting_ended, meeting_upcoming, schedule, document_generated, document_added or document_approved; the other fields depend on it (see Automation triggers).","properties":{"type":{"type":"string","description":"What starts a run.","enum":["meeting_ended","meeting_upcoming","schedule","document_generated","document_added","document_approved"]}}},"steps":{"type":"array","items":{"type":"object","description":"One step. Steps run in order.","properties":{"id":{"type":"string","minLength":1,"maxLength":64,"description":"Unique within the automation."},"name":{"type":["string","null"],"maxLength":255,"description":"A label for the step in run history."},"action":{"type":"object","additionalProperties":true,"description":"What the step does. type is one of transcribe_recordings, generate_document, ask_ava, create_tasks, remind_open_tasks, remind_reviewers, request_review or export_to_sharepoint (see Automation steps).","properties":{"type":{"type":"string","description":"The kind of step. Its other settings go alongside it in action.","enum":["transcribe_recordings","generate_document","ask_ava","create_tasks","remind_open_tasks","remind_reviewers","request_review","export_to_sharepoint"]}},"required":["type"]}},"required":["id","action"],"additionalProperties":false}},"nextRuns":{"type":"array","items":{"type":"string","format":"date-time"},"description":"For scheduled automations, the next times it runs."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"additionalProperties":false},"AutomationRun":{"type":"object","properties":{"id":{"type":"integer"},"automationId":{"type":"string"},"status":{"type":"string","enum":["running","waiting","succeeded","failed","skipped","canceled"]},"triggeredBy":{"type":["string","null"],"enum":["event","schedule","manual",null]},"triggerType":{"type":["string","null"]},"meetingId":{"type":["integer","null"]},"error":{"type":["string","null"]},"steps":{"type":"array","items":{"type":"object","properties":{"stepId":{"type":"string"},"type":{"type":["string","null"]},"status":{"type":["string","null"]},"summary":{"type":["string","null"]},"error":{"type":["string","null"]},"startedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false}},"startedAt":{"type":["string","null"],"format":"date-time"},"completedAt":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"Organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"slug":{"type":["string","null"]},"dataRegion":{"type":"string","enum":["us","ca","eu"],"description":"Where its data is stored."}},"additionalProperties":false},"Member":{"type":"object","properties":{"userId":{"type":"string"},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"canManageMeetings":{"type":"boolean","description":"An administrator or meeting manager."}},"additionalProperties":false},"Board":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"members":{"type":"array","items":{"$ref":"#/components/schemas/BoardMember"}},"meetingCount":{"type":"integer"}},"additionalProperties":false},"BoardMember":{"type":"object","properties":{"id":{"type":"integer"},"boardId":{"type":"integer"},"userId":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"title":{"type":["string","null"]},"startDate":{"type":["string","null"],"format":"date"},"endDate":{"type":["string","null"],"format":"date"}},"additionalProperties":false},"MeetingType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"isArchived":{"type":"boolean"},"decisionKindIds":{"type":"array","items":{"type":"string"}},"defaultDecisionKindId":{"type":["string","null"]},"agendaTemplateId":{"type":["string","null"]},"showDecisionItemsOnAgenda":{"type":"boolean"}},"additionalProperties":false},"DecisionItemType":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"votingMode":{"type":"string","enum":["required","optional","none"]},"isDefault":{"type":"boolean"}},"additionalProperties":false},"Template":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"category":{"type":["string","null"]},"kind":{"type":"string","enum":["document","agenda"]},"status":{"type":"string","description":"ready, or the state of a template still being built."}},"additionalProperties":false},"AgendaTemplate":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"itemCount":{"type":"integer"},"isDefault":{"type":"boolean"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"PortalSettings":{"type":["object","null"],"properties":{"id":{"type":"integer"},"slug":{"type":["string","null"]},"url":{"type":["string","null"]},"isEnabled":{"type":"boolean"},"pageTitle":{"type":["string","null"]},"pageDescription":{"type":["string","null"]},"logoUrl":{"type":["string","null"]},"headerBgColor":{"type":["string","null"]},"headerTextColor":{"type":["string","null"]},"accentColor":{"type":["string","null"]},"navLinks":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"socialLinks":{"type":"array","items":{"type":"object","properties":{"platform":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false}},"displayConfig":{"type":["object","null"],"additionalProperties":true,"properties":{}},"updatedAt":{"type":["string","null"],"format":"date-time"}},"additionalProperties":false},"SearchResults":{"type":"object","properties":{"meetings":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{}}},"agendaItems":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{}}},"documents":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{}}},"minutes":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{}}}},"additionalProperties":false}}}}