{"openapi":"3.1.0","info":{"title":"AOL Mail API (Bowmark)","version":"e833508f87ff","description":"Reads and changes mail in the CALLER's own AOL Mail account — folders, the inbox, search, full messages, mark read, move, delete — over IMAP with the caller's address and an AOL app password. AOL Mail runs on Yahoo Mail's backend and shares its engine.\n\nEvery function Bowmark has for AOL Mail (mail.aol.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/aol_mail/listContacts":{"post":{"operationId":"listContacts","summary":"Looks up contacts in the CALLER's own AOL address book over CardDAV — name, email addresses, phone numbers and company — optionally filtered by a name or address fragment in query, so an address can b","description":"Looks up contacts in the CALLER's own AOL address book over CardDAV — name, email addresses, phone numbers and company — optionally filtered by a name or address fragment in query, so an address can be found before sendMessage. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.listContacts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailContact[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListContactsArgs","description":"TypeScript: `ListContactsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/listFolders":{"post":{"operationId":"listFolders","summary":"Lists the CALLER's own AOL Mail folders — Inbox, Sent, Drafts, Spam, Trash and custom folders — with message and unread counts.","description":"Lists the CALLER's own AOL Mail folders — Inbox, Sent, Drafts, Spam, Trash and custom folders — with message and unread counts. Takes the caller's AOL address and an AOL app password (made at help.aol.com/articles/Create-and-manage-app-password), passed as secrets. Each folder's `id` is what the other functions take as `folderId`.\n\nCalls `bowmark.providers.aol_mail.listFolders`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailFolder[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListFoldersArgs","description":"TypeScript: `ListFoldersArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/listMessages":{"post":{"operationId":"listMessages","summary":"Lists the newest messages in one of the CALLER's AOL Mail folders (Inbox by default), newest first — sender, subject, snippet, received time, read and flagged state.","description":"Lists the newest messages in one of the CALLER's AOL Mail folders (Inbox by default), newest first — sender, subject, snippet, received time, read and flagged state. Each row's `id` goes straight into getMessage, markAsRead, moveMessage or deleteMessage. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.listMessages`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailMessageRow[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListMessagesArgs","description":"TypeScript: `ListMessagesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/searchMessages":{"post":{"operationId":"searchMessages","summary":"Searches the CALLER's own AOL Mail — `from:`, `to:`, `subject:`, `is:unread`, `is:flagged` and plain words — in one folder, or in every folder except Trash and Spam.","description":"Searches the CALLER's own AOL Mail — `from:`, `to:`, `subject:`, `is:unread`, `is:flagged` and plain words — in one folder, or in every folder except Trash and Spam. Returns the same rows as listMessages, newest first. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.searchMessages`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailMessageRow[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SearchMessagesArgs","description":"TypeScript: `SearchMessagesArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/getMessage":{"post":{"operationId":"getMessage","summary":"Reads one of the CALLER's own AOL Mail messages in full — sender, recipients, subject, dates, plain-text and HTML body, and the list of attachments — given a row `id` from listMessages or searchMessag","description":"Reads one of the CALLER's own AOL Mail messages in full — sender, recipients, subject, dates, plain-text and HTML body, and the list of attachments — given a row `id` from listMessages or searchMessages. Does not mark it read. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.getMessage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailMessage>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetMessageArgs","description":"TypeScript: `GetMessageArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/markAsRead":{"post":{"operationId":"markAsRead","summary":"Marks one of the CALLER's own AOL Mail messages read (or unread with `read: false`), given a row `id` from listMessages or searchMessages.","description":"Marks one of the CALLER's own AOL Mail messages read (or unread with `read: false`), given a row `id` from listMessages or searchMessages. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.markAsRead`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailReadResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MarkAsReadArgs","description":"TypeScript: `MarkAsReadArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/getAttachment":{"post":{"operationId":"getAttachment","summary":"Saves one attachment of the CALLER's own AOL Mail message — a PDF statement, a photo — to the run's files, given the message's row `id` and the attachment's position in getMessage's `attachments` list","description":"Saves one attachment of the CALLER's own AOL Mail message — a PDF statement, a photo — to the run's files, given the message's row `id` and the attachment's position in getMessage's `attachments` list. Returns the saved `file` (name, type, size, a signed url), not inline bytes. Does not mark the message read. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.getAttachment`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailAttachment>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetAttachmentArgs","description":"TypeScript: `GetAttachmentArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/flagMessage":{"post":{"operationId":"flagMessage","summary":"Stars (flags) one of the CALLER's own AOL Mail messages, or unstars it with `flagged: false`, given a row `id` from listMessages or searchMessages.","description":"Stars (flags) one of the CALLER's own AOL Mail messages, or unstars it with `flagged: false`, given a row `id` from listMessages or searchMessages. Rows report the result as `flagged`, and searchMessages finds them with `is:flagged`. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.flagMessage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailFlagResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/FlagMessageArgs","description":"TypeScript: `FlagMessageArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/moveMessage":{"post":{"operationId":"moveMessage","summary":"Moves one of the CALLER's own AOL Mail messages to another folder — a folder `id` from listFolders, or \"archive\", \"spam\", \"trash\" — and returns its new id there.","description":"Moves one of the CALLER's own AOL Mail messages to another folder — a folder `id` from listFolders, or \"archive\", \"spam\", \"trash\" — and returns its new id there. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.moveMessage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailMoveResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/MoveMessageArgs","description":"TypeScript: `MoveMessageArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/deleteMessage":{"post":{"operationId":"deleteMessage","summary":"Deletes one of the CALLER's own AOL Mail messages the way the site's own delete button does: moves it to Trash, or removes it for good when it is already in Trash.","description":"Deletes one of the CALLER's own AOL Mail messages the way the site's own delete button does: moves it to Trash, or removes it for good when it is already in Trash. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.deleteMessage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailDeleteResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/DeleteMessageArgs","description":"TypeScript: `DeleteMessageArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/sendMessage":{"post":{"operationId":"sendMessage","summary":"Sends an email from the CALLER's own AOL Mail account, through the signed-in relay session (not IMAP/SMTP — outbound mail ports are blocked from every Bowmark exit).","description":"Sends an email from the CALLER's own AOL Mail account, through the signed-in relay session (not IMAP/SMTP — outbound mail ports are blocked from every Bowmark exit). Whether this truly sends or only saves a draft is UNMEASURED; check listMessages on Drafts/Sent to confirm.\n\nCalls `bowmark.providers.aol_mail.sendMessage`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailSendResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/SendMessageArgs","description":"TypeScript: `SendMessageArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/getAccountProfile":{"post":{"operationId":"getAccountProfile","summary":"Reads the CALLER's own AOL account page (login.aol.com/myaccount/personalinfo) through their signed-in session and returns the page's own server-rendered props verbatim — name, photo and recovery deta","description":"Reads the CALLER's own AOL account page (login.aol.com/myaccount/personalinfo) through their signed-in session and returns the page's own server-rendered props verbatim — name, photo and recovery details as AOL ships them — plus its crumbs. The exact field names are unmeasured signed in.\n\nCalls `bowmark.providers.aol_mail.getAccountProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolAccountProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/updateAccountProfile":{"post":{"operationId":"updateAccountProfile","summary":"Changes the first and/or last name on the CALLER's own AOL account (login.aol.com/myaccount/personalinfo) by filling the page's name fields and pressing Save in a browser, through their signed-in sess","description":"Changes the first and/or last name on the CALLER's own AOL account (login.aol.com/myaccount/personalinfo) by filling the page's name fields and pressing Save in a browser, through their signed-in session. Returns whether the page's save request succeeded, its status and URL.\n\nCalls `bowmark.providers.aol_mail.updateAccountProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolProfileUpdateResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/UpdateAccountProfileArgs","description":"TypeScript: `UpdateAccountProfileArgs`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/aol_mail/createFolder":{"post":{"operationId":"createFolder","summary":"Creates a new folder in the CALLER's own AOL Mail account and returns it in listFolders' shape, so moveMessage can file mail there with its `id`.","description":"Creates a new folder in the CALLER's own AOL Mail account and returns it in listFolders' shape, so moveMessage can file mail there with its `id`. Refuses a name that already exists. Takes the caller's address and app password, as secrets.\n\nCalls `bowmark.providers.aol_mail.createFolder`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<AolMailFolder>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CreateFolderArgs","description":"TypeScript: `CreateFolderArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"CreateFolderArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"name":{"type":"string"}},"required":["credentials","name"],"additionalProperties":true},"DeleteMessageArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"messageId":{"type":"string"}},"required":["credentials","messageId"],"additionalProperties":true},"FlagMessageArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"messageId":{"type":"string"},"flagged":{"type":"boolean"}},"required":["credentials","messageId"],"additionalProperties":true},"GetAttachmentArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"id":{"type":"string"},"index":{"type":"number"}},"required":["credentials","id","index"],"additionalProperties":true},"GetMessageArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"id":{"type":"string"}},"required":["credentials","id"],"additionalProperties":true},"ListContactsArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"query":{"type":"string"},"limit":{"type":"number"}},"required":["credentials"],"additionalProperties":true},"ListFoldersArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"}},"required":["credentials"],"additionalProperties":true},"ListMessagesArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"folderId":{"type":"string"},"limit":{"type":"number"}},"required":["credentials"],"additionalProperties":true},"MailboxCredentials":{"type":"object","properties":{"username":{"type":"string"},"appPassword":{"type":"string"}},"required":["username","appPassword"],"additionalProperties":true},"MarkAsReadArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"messageId":{"type":"string"},"read":{"type":"boolean"}},"required":["credentials","messageId"],"additionalProperties":true},"MoveMessageArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"messageId":{"type":"string"},"folderId":{"type":"string"}},"required":["credentials","messageId","folderId"],"additionalProperties":true},"SearchMessagesArgs":{"type":"object","properties":{"credentials":{"$ref":"#/components/schemas/MailboxCredentials"},"query":{"type":"string"},"folderId":{"type":"string"},"limit":{"type":"number"}},"required":["credentials","query"],"additionalProperties":true},"SendMessageArgs":{"type":"object","properties":{"to":{"type":"string"},"subject":{"type":"string"},"body":{"type":"string"},"from":{"type":"string"}},"required":["to","subject","body"],"additionalProperties":true},"UpdateAccountProfileArgs":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"}},"additionalProperties":true}}}}