{"openapi":"3.1.0","info":{"title":"OpenReplay (BYOK) API","version":"0.1.0","description":"OpenReplay (BYOK) lets an AI assistant read your own OpenReplay data through the OpenReplay API with a key you supply (Organization API key (Preferences > Account)). Read-only: 6 tools (list_projects, get_project, list_user_sessions, list_session_events, list_deletion_jobs, get_deletion_job). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-openreplay.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-openreplay/docs"},"termsOfService":"https://connectorbay.com/byok-openreplay/terms"},"servers":[{"url":"https://byok-openreplay.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-openreplay/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_projects":{"post":{"operationId":"list_projects","summary":"List the projects of the organization with id, name, project key and platform (web or ios). Use for \"Which OpenReplay pr","description":"List the projects of the organization with id, name, project key and platform (web or ios). Use for \"Which OpenReplay projects do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_projectsArguments","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_project":{"post":{"operationId":"get_project","summary":"Get one project by project key: id, name, platform. Use for \"What is the OpenReplay project with key 3sWXSsqHgSKnE87YkNJ","description":"Get one project by project key: id, name, platform. Use for \"What is the OpenReplay project with key 3sWXSsqHgSKnE87YkNJK\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_key":{"description":"Project key of the OpenReplay project (list_projects returns it), for example '3sWXSsqHgSKnE87YkNJK'.","maxLength":64,"title":"Project Key","type":"string"}},"required":["project_key"],"title":"get_projectArguments","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_user_sessions":{"post":{"operationId":"list_user_sessions","summary":"List the recorded sessions of one user (the id the tracker set with setUserID) in a time window, with event count and st","description":"List the recorded sessions of one user (the id the tracker set with setUserID) in a time window, with event count and start and end time. Paginated. Use for \"Which sessions did user jane@example.com have last week\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_key":{"description":"Project key of the OpenReplay project (list_projects returns it), for example '3sWXSsqHgSKnE87YkNJK'.","maxLength":64,"title":"Project Key","type":"string"},"user_id":{"description":"The user id set in the tracker with setUserID (up to 256 characters).","maxLength":256,"title":"User Id","type":"string"},"start_ms":{"description":"Start of the time window as Unix time in milliseconds (at least 946684800000).","maximum":4102444800000,"minimum":946684800000,"title":"Start Ms","type":"integer"},"end_ms":{"description":"End of the time window as Unix time in milliseconds; must be later than start_ms.","maximum":4102444800000,"minimum":946684800000,"title":"End Ms","type":"integer"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Page size (1 to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order: asc or desc.","title":"Sort Order"}},"required":["project_key","user_id","start_ms","end_ms"],"title":"list_user_sessionsArguments","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_session_events":{"post":{"operationId":"list_session_events","summary":"List the events (page views, clicks, inputs, custom events) captured in one recorded session in a time window. Paginated","description":"List the events (page views, clicks, inputs, custom events) captured in one recorded session in a time window. Paginated; event properties are returned as stored. Use for \"What did the user click in session 4813023023591169\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_key":{"description":"Project key of the OpenReplay project (list_projects returns it), for example '3sWXSsqHgSKnE87YkNJK'.","maxLength":64,"title":"Project Key","type":"string"},"session_id":{"description":"The session id (from list_user_sessions), for example '4813023023591169'.","maxLength":256,"title":"Session Id","type":"string"},"start_ms":{"description":"Start of the time window as Unix time in milliseconds (at least 946684800000).","maximum":4102444800000,"minimum":946684800000,"title":"Start Ms","type":"integer"},"end_ms":{"description":"End of the time window as Unix time in milliseconds; must be later than start_ms.","maximum":4102444800000,"minimum":946684800000,"title":"End Ms","type":"integer"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Page size (1 to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order: asc or desc.","title":"Sort Order"}},"required":["project_key","session_id","start_ms","end_ms"],"title":"list_session_eventsArguments","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_deletion_jobs":{"post":{"operationId":"list_deletion_jobs","summary":"List the user-data deletion jobs of a project with action, status (scheduled, running, completed, failed, cancelled), ti","description":"List the user-data deletion jobs of a project with action, status (scheduled, running, completed, failed, cancelled), times and errors. User ids inside are left out. Use for \"Are there any OpenReplay data deletion jobs still running\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_key":{"description":"Project key of the OpenReplay project (list_projects returns it), for example '3sWXSsqHgSKnE87YkNJK'.","maxLength":64,"title":"Project Key","type":"string"},"limit":{"anyOf":[{"maximum":200,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Page size (1 to 200).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["project_key"],"title":"list_deletion_jobsArguments","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_deletion_job":{"post":{"operationId":"get_deletion_job","summary":"Get one user-data deletion job: action, status, times and errors. Use for \"What is the status of OpenReplay deletion job","description":"Get one user-data deletion job: action, status, times and errors. Use for \"What is the status of OpenReplay deletion job 3451\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_key":{"description":"Project key of the OpenReplay project (list_projects returns it), for example '3sWXSsqHgSKnE87YkNJK'.","maxLength":64,"title":"Project Key","type":"string"},"job_id":{"description":"Numeric job id (from list_deletion_jobs).","minimum":1,"title":"Job Id","type":"integer"}},"required":["project_key","job_id"],"title":"get_deletion_jobArguments","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}}}}