{"openapi":"3.1.0","info":{"title":"BigMarker (BYOK) API","version":"0.1.0","description":"BigMarker (BYOK) lets an AI assistant read your own BigMarker data through the BigMarker API with a key you supply (BigMarker API key). Read-only: 10 tools (list_conferences, get_conference, list_channels, get_channel, list_channel_conferences, get_channel_conference_stats, list_registrations, list_attendees, get_event_summary, list_conference_presenters). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bigmarker.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bigmarker/docs"},"termsOfService":"https://connectorbay.com/byok-bigmarker/terms"},"servers":[{"url":"https://byok-bigmarker.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bigmarker/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_conferences":{"post":{"operationId":"list_conferences","summary":"List conferences (webinars) across your channels, upcoming by default, with title, start time, duration, privacy and pub","description":"List conferences (webinars) across your channels, upcoming by default, with title, start time, duration, privacy and public address. Can filter by role, type, title text and a Unix time window. Use for \"Which BigMarker webinars do I have coming up\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["future","past","all","multiple_times","future_do_not_include_happening","future_with_24_hour_room","past_with_recording","always_open","happening_now"],"type":"string"},{"type":"null"}],"default":"future","description":"Which conferences: future (default), past, all, always_open, happening_now, past_with_recording and others.","title":"Type"},"role":{"anyOf":[{"enum":["all","hosting","attending"],"type":"string"},{"type":"null"}],"default":"all","description":"Your role: all (default), hosting or attending.","title":"Role"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only conferences whose title contains this text.","title":"Query"},"start_time":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only conferences starting after this Unix timestamp in seconds.","title":"Start Time"},"end_time":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Only conferences ending before this Unix timestamp in seconds.","title":"End Time"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results per page (1 to 100).","title":"Per Page"}},"title":"list_conferencesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_conference":{"post":{"operationId":"get_conference","summary":"Get one conference with title, type, schedule, public address, capacity, privacy and whether it is recorded. Use for \"Gi","description":"Get one conference with title, type, schedule, public address, capacity, privacy and whether it is recorded. Use for \"Give me the details of BigMarker conference 5e2a9c1f3b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"conference_id":{"description":"BigMarker conference (webinar) id, as returned by list_conferences.","maxLength":64,"title":"Conference Id","type":"string"}},"required":["conference_id"],"title":"get_conferenceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_channels":{"post":{"operationId":"list_channels","summary":"List the BigMarker channels (branded webinar hubs) your key can access, with id, URL name and overview. Use for \"Which B","description":"List the BigMarker channels (branded webinar hubs) your key can access, with id, URL name and overview. Use for \"Which BigMarker channels do I manage\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_channelsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_channel":{"post":{"operationId":"get_channel","summary":"Get one channel by its id: URL, name, overview and description. Use for \"Show BigMarker channel c1\".","description":"Get one channel by its id: URL, name, overview and description. Use for \"Show BigMarker channel c1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"channel_id":{"description":"BigMarker channel id, as returned by list_channels.","maxLength":64,"title":"Channel Id","type":"string"}},"required":["channel_id"],"title":"get_channelArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_channel_conferences":{"post":{"operationId":"list_channel_conferences","summary":"List the conferences of one channel, upcoming by default, with title, schedule and address. Use for \"What webinars has t","description":"List the conferences of one channel, upcoming by default, with title, schedule and address. Use for \"What webinars has the acme BigMarker channel hosted in the past\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"channel_url":{"description":"The channel's URL name, for example 'acme' (the last part of the channel address).","maxLength":80,"title":"Channel Url","type":"string"},"timing":{"anyOf":[{"enum":["future","past","all"],"type":"string"},{"type":"null"}],"default":"future","description":"Time frame: future (default), past or all.","title":"Timing"},"sort_start_date":{"anyOf":[{"enum":["ascending","descending"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by start date: ascending or descending.","title":"Sort Start Date"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 to 100).","title":"Per Page"}},"required":["channel_url"],"title":"list_channel_conferencesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_channel_conference_stats":{"post":{"operationId":"get_channel_conference_stats","summary":"Page through a channel's conferences with summary numbers: total registrations, live attendees and on-demand attendees. ","description":"Page through a channel's conferences with summary numbers: total registrations, live attendees and on-demand attendees. Use for \"How many people registered and attended each webinar on the acme BigMarker channel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"channel_url":{"description":"The channel's URL name, for example 'acme'.","maxLength":80,"title":"Channel Url","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many results per page (1 to 100).","title":"Per Page"}},"required":["channel_url"],"title":"get_channel_conference_statsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_registrations":{"post":{"operationId":"list_registrations","summary":"List people registered for a conference with name, email, source and certificate status. Canceled and pending registrati","description":"List people registered for a conference with name, email, source and certificate status. Canceled and pending registrations are left out unless asked for. Use for \"Who registered for BigMarker conference 5e2a9c1f3b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"conference_id":{"description":"BigMarker conference (webinar) id, as returned by list_conferences.","maxLength":64,"title":"Conference Id","type":"string"},"include_all_status":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to include canceled, pending and other non-active registrations.","title":"Include All Status"},"email":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the registration with this email address.","title":"Email"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many results per page (1 to 100).","title":"Per Page"}},"required":["conference_id"],"title":"list_registrationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_attendees":{"post":{"operationId":"list_attendees","summary":"List who attended a finished conference with entry and exit times, time in the room and counts of chats, questions and p","description":"List who attended a finished conference with entry and exit times, time in the room and counts of chats, questions and polls answered. Use for \"Who attended BigMarker conference 5e2a9c1f3b and for how long\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"conference_id":{"description":"BigMarker conference (webinar) id, as returned by list_conferences.","maxLength":64,"title":"Conference Id","type":"string"},"current_page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Current Page"},"per_page":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Attendees per page (1 to 500).","title":"Per Page"}},"required":["conference_id"],"title":"list_attendeesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_event_summary":{"post":{"operationId":"get_event_summary","summary":"Get a conference's total live minutes watched and who created it, with the creation time. Use for \"How many live minutes","description":"Get a conference's total live minutes watched and who created it, with the creation time. Use for \"How many live minutes were watched in BigMarker conference 5e2a9c1f3b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"conference_id":{"description":"BigMarker conference (webinar) id, as returned by list_conferences.","maxLength":64,"title":"Conference Id","type":"string"}},"required":["conference_id"],"title":"get_event_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_conference_presenters":{"post":{"operationId":"list_conference_presenters","summary":"List the presenters of a conference with their member id and name. Use for \"Who presents at BigMarker conference 5e2a9c1","description":"List the presenters of a conference with their member id and name. Use for \"Who presents at BigMarker conference 5e2a9c1f3b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"conference_id":{"description":"BigMarker conference (webinar) id, as returned by list_conferences.","maxLength":64,"title":"Conference Id","type":"string"}},"required":["conference_id"],"title":"list_conference_presentersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}