{"openapi":"3.1.0","info":{"title":"Arketa API (Bowmark)","version":"e833508f87ff","description":"Arketa studio booking pages (yoga, pilates, barre): find a studio, read its class schedule, pricing, private sessions and on-demand library, and (signed in) book, waitlist and cancel classes.\n\nEvery function Bowmark has for Arketa (arketa.co) 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/arketa/findStudio":{"post":{"operationId":"findStudio","summary":"Finds an Arketa studio by its booking-page name (\"thesilhouettemethod\"), its app.arketa.co URL, or the studio's own website that embeds the Arketa schedule.","description":"Finds an Arketa studio by its booking-page name (\"thesilhouettemethod\"), its app.arketa.co URL, or the studio's own website that embeds the Arketa schedule. Returns the studio `id` — pass that, not the booking-page name, to every other function's `studio` argument.\n\nCalls `bowmark.providers.arketa.findStudio`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaStudio>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"}},"required":["studio"],"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/arketa/listLocations":{"post":{"operationId":"listLocations","summary":"Lists a studio's physical locations: id, name, full address and coordinates.","description":"Lists a studio's physical locations: id, name, full address and coordinates.\n\nCalls `bowmark.providers.arketa.listLocations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaLocation[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"}},"required":["studio"],"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/arketa/listScheduleFilters":{"post":{"operationId":"listScheduleFilters","summary":"Lists what a studio's schedule can be filtered by — its locations, class types and instructors, each with an id — for `listClasses`.","description":"Lists what a studio's schedule can be filtered by — its locations, class types and instructors, each with an id — for `listClasses`.\n\nCalls `bowmark.providers.arketa.listScheduleFilters`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaScheduleFilters>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"}},"required":["studio"],"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/arketa/listClasses":{"post":{"operationId":"listClasses","summary":"Lists a studio's class schedule for a date range, optionally narrowed to a location, class type or instructor.","description":"Lists a studio's class schedule for a date range, optionally narrowed to a location, class type or instructor.\n\nCalls `bowmark.providers.arketa.listClasses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaClass[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListClassesArgs","description":"TypeScript: `ListClassesArgs`"}},"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/arketa/getClass":{"post":{"operationId":"getClass","summary":"Returns one scheduled class by id (from listClasses): description, start and end time, instructor, location and room, capacity, number booked, waitlist length, drop-in price, credits it costs, and pre","description":"Returns one scheduled class by id (from listClasses): description, start and end time, instructor, location and room, capacity, number booked, waitlist length, drop-in price, credits it costs, and preparation directions.\n\nCalls `bowmark.providers.arketa.getClass`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaClassDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetClassArgs","description":"TypeScript: `GetClassArgs`"}},"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/arketa/listPricing":{"post":{"operationId":"listPricing","summary":"Lists what a studio sells — drop-ins, class packs, memberships, on-demand subscriptions — with price, credits, expiry and new-students-only flags.","description":"Lists what a studio sells — drop-ins, class packs, memberships, on-demand subscriptions — with price, credits, expiry and new-students-only flags. Takes findStudio().widgetName, not the id.\n\nCalls `bowmark.providers.arketa.listPricing`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaPricingOption[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"widgetName":{"type":"string","description":"TypeScript: `string`"}},"required":["widgetName"],"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/arketa/listInstructors":{"post":{"operationId":"listInstructors","summary":"Lists a studio's instructors with id and name, plus bio and photo for those teaching in the next two weeks.","description":"Lists a studio's instructors with id and name, plus bio and photo for those teaching in the next two weeks.\n\nCalls `bowmark.providers.arketa.listInstructors`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaInstructor[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"}},"required":["studio"],"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/arketa/listPrivateSessions":{"post":{"operationId":"listPrivateSessions","summary":"Lists the private (one-to-one) sessions a studio offers, with title, length, price and description.","description":"Lists the private (one-to-one) sessions a studio offers, with title, length, price and description.\n\nCalls `bowmark.providers.arketa.listPrivateSessions`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaPrivateSession[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"}},"required":["studio"],"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/arketa/getPrivateSession":{"post":{"operationId":"getPrivateSession","summary":"Returns one private session by id (from listPrivateSessions): length, price, credits, description, and the instructors, locations and rooms it runs with — the ids getPrivateSessionAvailability takes.","description":"Returns one private session by id (from listPrivateSessions): length, price, credits, description, and the instructors, locations and rooms it runs with — the ids getPrivateSessionAvailability takes.\n\nCalls `bowmark.providers.arketa.getPrivateSession`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaPrivateSessionDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetPrivateSessionArgs","description":"TypeScript: `GetPrivateSessionArgs`"}},"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/arketa/getPrivateSessionAvailability":{"post":{"operationId":"getPrivateSessionAvailability","summary":"Returns which days from `date` to the end of its month a private session can be booked with one instructor at one location, and the open start times on `date` itself.","description":"Returns which days from `date` to the end of its month a private session can be booked with one instructor at one location, and the open start times on `date` itself.\n\nCalls `bowmark.providers.arketa.getPrivateSessionAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaPrivateSessionAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/GetPrivateSessionAvailabilityArgs","description":"TypeScript: `GetPrivateSessionAvailabilityArgs`"}},"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/arketa/listReviews":{"post":{"operationId":"listReviews","summary":"Lists a studio's public reviews, newest first — first name, star rating, text and date — with the total count and average rating.","description":"Lists a studio's public reviews, newest first — first name, star rating, text and date — with the total count and average rating.\n\nCalls `bowmark.providers.arketa.listReviews`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaReviews>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListReviewsArgs","description":"TypeScript: `ListReviewsArgs`"}},"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/arketa/listProducts":{"post":{"operationId":"listProducts","summary":"Lists the retail products a studio sells (apparel, add-ons): name, price, photos, and each size or variant with its price and stock.","description":"Lists the retail products a studio sells (apparel, add-ons): name, price, photos, and each size or variant with its price and stock.\n\nCalls `bowmark.providers.arketa.listProducts`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaProduct[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"}},"required":["studio"],"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/arketa/listOnDemandVideos":{"post":{"operationId":"listOnDemandVideos","summary":"Lists a studio's on-demand video library: its categories, or — given a category id from a prior call — each video in it with title, length, equipment, intensity and instructor ids (resolve a name with","description":"Lists a studio's on-demand video library: its categories, or — given a category id from a prior call — each video in it with title, length, equipment, intensity and instructor ids (resolve a name with listInstructors). Arketa's own API carries no price or subscription-tier field on a video, so that cannot be reported.\n\nCalls `bowmark.providers.arketa.listOnDemandVideos`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaOnDemandLibrary>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/ListOnDemandVideosArgs","description":"TypeScript: `ListOnDemandVideosArgs`"}},"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/arketa/getMyProfile":{"post":{"operationId":"getMyProfile","summary":"Returns the signed-in caller's own client profile at one studio (the id findStudio returns): name, email, phone, birthday, address, home location and ID-verification status.","description":"Returns the signed-in caller's own client profile at one studio (the id findStudio returns): name, email, phone, birthday, address, home location and ID-verification status. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.getMyProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaMyProfile>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["studio"],"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/arketa/listMyBookings":{"post":{"operationId":"listMyBookings","summary":"Lists the signed-in caller's class reservations at one studio — takes findStudio().widgetName, not the id.","description":"Lists the signed-in caller's class reservations at one studio — takes findStudio().widgetName, not the id. Each row has the reservation id, whether it was canceled, and the class it is for as Arketa returns it. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.listMyBookings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaBooking[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"widgetName":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["widgetName"],"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/arketa/listMyPasses":{"post":{"operationId":"listMyPasses","summary":"Lists the signed-in caller's purchased packs and memberships at one studio (the id findStudio returns): expiry, activation date, and the offering (credits, type) each one was bought as.","description":"Lists the signed-in caller's purchased packs and memberships at one studio (the id findStudio returns): expiry, activation date, and the offering (credits, type) each one was bought as. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.listMyPasses`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaPass[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"studio":{"type":"string","description":"TypeScript: `string`"},"opts":{"type":"object","properties":{"connection":{"type":"string"}},"required":["connection"],"additionalProperties":true,"description":"TypeScript: `ConnectionOption`"}},"required":["studio"],"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/arketa/updateMyProfile":{"post":{"operationId":"updateMyProfile","summary":"Updates the signed-in caller's studio-specific client fields and their marketing email / SMS opt-ins at one studio (studio = findStudio().id) — the two edits Arketa's booking page makes.","description":"Updates the signed-in caller's studio-specific client fields and their marketing email / SMS opt-ins at one studio (studio = findStudio().id) — the two edits Arketa's booking page makes. Name and phone cannot be edited through Arketa's booking page, so they are not offered. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.updateMyProfile`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaProfileUpdateResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/UpdateMyProfileArgs","description":"TypeScript: `UpdateMyProfileArgs`"},"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/arketa/joinWaitlist":{"post":{"operationId":"joinWaitlist","summary":"Puts the signed-in caller on the waitlist for a full class (classId from listClasses), optionally with named guests.","description":"Puts the signed-in caller on the waitlist for a full class (classId from listClasses), optionally with named guests. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.joinWaitlist`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaActionResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/JoinWaitlistArgs","description":"TypeScript: `JoinWaitlistArgs`"},"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/arketa/bookClass":{"post":{"operationId":"bookClass","summary":"Books the signed-in caller into a class (classId from listClasses) with a pass they already own (offeringId from listMyPasses).","description":"Books the signed-in caller into a class (classId from listClasses) with a pass they already own (offeringId from listMyPasses). Only finishes when Arketa prices it at 0; otherwise returns booked:false with the price and never pays. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.bookClass`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaBookingResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/BookClassArgs","description":"TypeScript: `BookClassArgs`"},"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/arketa/bookPrivateSession":{"post":{"operationId":"bookPrivateSession","summary":"Books the signed-in caller into a private session at a time getPrivateSessionAvailability returned, with a pass they already own.","description":"Books the signed-in caller into a private session at a time getPrivateSessionAvailability returned, with a pass they already own. Only finishes when Arketa prices it at 0; otherwise returns booked:false with the price and never pays. Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.bookPrivateSession`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaBookingResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/BookPrivateSessionArgs","description":"TypeScript: `BookPrivateSessionArgs`"},"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/arketa/cancelBooking":{"post":{"operationId":"cancelBooking","summary":"Cancels one of the signed-in caller's class reservations or waitlist spots (reservationId from listMyBookings).","description":"Cancels one of the signed-in caller's class reservations or waitlist spots (reservationId from listMyBookings). Needs the caller signed in to Arketa.\n\nCalls `bowmark.providers.arketa.cancelBooking`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<ArketaActionResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CancelBookingArgs","description":"TypeScript: `CancelBookingArgs`"},"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/arketa/signup":{"post":{"operationId":"signup","summary":"Makes a NEW Arketa account with the person's own email and password, in a session.","description":"Makes a NEW Arketa account with the person's own email and password, in a session. Pauses with `needs_code` / `needs_phone` whenever the site wants something only the person has; continue with `confirmSignup` in the same session. Ends `signed_up` with the login saved and the credentials in the person's secrets.\n\nCalls `bowmark.providers.arketa.signup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ status: \"needs_code\"; channel: \"email\" | \"sms\"; sentTo?: string } | { status: \"needs_phone\" } | { status: \"in_progress\"; retryAfterSeconds: number } | { status: \"signed_up\"; username: string; email: string; connection: string | null; twoFactor: \"enrolled\" | \"none\"; secrets: string[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"description":"TypeScript: `SignupInput`"}},"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/arketa/confirmSignup":{"post":{"operationId":"confirmSignup","summary":"Continues the sign-up `signup` started in this session with the emailed or texted `code`, the email's verification `link`, or the person's `phone`.","description":"Continues the sign-up `signup` started in this session with the emailed or texted `code`, the email's verification `link`, or the person's `phone`.\n\nCalls `bowmark.providers.arketa.confirmSignup`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<{ status: \"needs_code\"; channel: \"email\" | \"sms\"; sentTo?: string } | { status: \"needs_phone\" } | { status: \"in_progress\"; retryAfterSeconds: number } | { status: \"signed_up\"; username: string; email: string; connection: string | null; twoFactor: \"enrolled\" | \"none\"; secrets: string[] }>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"description":"TypeScript: `SignupConfirmInput`"}},"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}}},"BookClassArgs":{"type":"object","properties":{"studio":{"type":"string"},"classId":{"type":"string"},"offeringId":{"type":"string"}},"required":["studio","classId"],"additionalProperties":true},"BookPrivateSessionArgs":{"type":"object","properties":{"studio":{"type":"string"},"serviceId":{"type":"string"},"isoTime":{"type":"string"},"instructorId":{"type":"string"},"locationId":{"type":"string"},"roomId":{"type":"string"},"offeringId":{"type":"string"}},"required":["studio","serviceId","isoTime"],"additionalProperties":true},"CancelBookingArgs":{"type":"object","properties":{"reservationId":{"type":"string"}},"required":["reservationId"],"additionalProperties":true},"GetClassArgs":{"type":"object","properties":{"studio":{"type":"string"},"classId":{"type":"string"}},"required":["studio","classId"],"additionalProperties":true},"GetPrivateSessionArgs":{"type":"object","properties":{"studio":{"type":"string"},"serviceId":{"type":"string"}},"required":["studio","serviceId"],"additionalProperties":true},"GetPrivateSessionAvailabilityArgs":{"type":"object","properties":{"studio":{"type":"string"},"serviceId":{"type":"string"},"instructorId":{"type":"string"},"locationId":{"type":"string"},"date":{"type":"string"},"timezone":{"type":"string"}},"required":["studio","serviceId","instructorId","locationId","date"],"additionalProperties":true},"JoinWaitlistArgs":{"type":"object","properties":{"classId":{"type":"string"},"guestNames":{"type":"array","items":{"type":"string"}}},"required":["classId"],"additionalProperties":true},"ListClassesArgs":{"type":"object","properties":{"studio":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"locationId":{"type":"string"},"classTypeId":{"type":"string"},"instructorId":{"type":"string"},"timezone":{"type":"string"}},"required":["studio","startDate","endDate"],"additionalProperties":true},"ListOnDemandVideosArgs":{"type":"object","properties":{"studio":{"type":"string"},"category":{"type":"string"}},"required":["studio"],"additionalProperties":true},"ListReviewsArgs":{"type":"object","properties":{"studio":{"type":"string"},"limit":{"type":"number"},"offset":{"type":"number"}},"required":["studio"],"additionalProperties":true},"UpdateMyProfileArgs":{"type":"object","properties":{"studio":{"type":"string"},"customFields":{"type":"object","additionalProperties":{}},"marketingOptIn":{"type":"boolean"},"smsOptIn":{"type":"boolean"}},"required":["studio"],"additionalProperties":true}}}}