Skip to content

docs: clarify Safari API visibility #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ysyneu merged 1 commit into from
Jul 9, 2026
Merged

docs: clarify Safari API visibility #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions api-reference/openapi.en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22825,7 +22825,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Pagination uses `p`/`limit` (max 100); `scope` defaults to `all` (own + member-of-team rows).\n- `is_running` reflects the live run-set; `has_unread` is computed per calling user.\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Pagination uses `p`/`limit` (max 100); `scope` defaults to `all`.\n- `all` returns your personal sessions plus team sessions you can access; account admins see all team sessions, but not other users' personal sessions.\n- `team_ids` narrows the visible set and never expands access.\n- `is_running` reflects the live run-set; `has_unread` is computed per calling user.\n",
"href": "/en/api-reference/ai-sre/sessions/session-read-list",
"metadata": {
"sidebarTitle": "List sessions"
Expand Down Expand Up @@ -22934,7 +22934,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Page older history with `search_after_ctx` from the previous response.\n- `limit` (or legacy `num_recent_events`) caps the event page; default 100, max 1000.\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Personal sessions are readable only by their creator; team sessions can be read by same-account callers with the `session_id`.\n- Page older history with `search_after_ctx` from the previous response.\n- `limit` (or legacy `num_recent_events`) caps the event page; default 100, max 1000.\n",
"href": "/en/api-reference/ai-sre/sessions/session-read-info",
"metadata": {
"sidebarTitle": "Get session detail"
Expand Down Expand Up @@ -23067,7 +23067,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- The response is `application/x-ndjson` — parse line-by-line and write to a file; do not buffer the whole body in memory.\n- The first line is always a `session_meta` envelope; `include_subagents=true` inlines each child session's stream after its dispatch line.\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Personal sessions are exportable only by their creator; team sessions can be exported by same-account callers with the `session_id`.\n- The response is `application/x-ndjson` — parse line-by-line and write to a file; do not buffer the whole body in memory.\n- The first line is always a `session_meta` envelope; `include_subagents=true` inlines each child session's stream after its dispatch line.\n",
"href": "/en/api-reference/ai-sre/sessions/session-read-export",
"metadata": {
"sidebarTitle": "Export session transcript"
Expand Down Expand Up @@ -23128,7 +23128,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Requires manage rights on the session (creator, account admin, or owning-team member).\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | None — any valid `app_key` can call this operation |\n\n## Usage\n\n- Personal sessions can be deleted only by their creator; team sessions can be deleted by the creator, an account admin, or a member of the owning team.\n",
"href": "/en/api-reference/ai-sre/sessions/session-write-delete",
"metadata": {
"sidebarTitle": "Delete session"
Expand Down Expand Up @@ -24963,7 +24963,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- List visibility follows session-list visibility: owners/admins see all rules; ordinary members see rules they created and rules for their teams.\n- `http_post_token` is returned only when creating or rotating the token. Save it immediately.\n- To trigger from On-call incidents, send `oncall_incident_trigger_enabled`, `oncall_incident_channel_ids`, and `oncall_incident_severities`; matching events run with `trigger_kind=oncall_incident`.\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- Rule lists include your personal rules plus accessible team rules; account admins see all team rules, but not other users' personal rules.\n- Get, update, delete, and run history access require manage rights: the personal rule owner; for team rules, an account admin or a member of the rule's team.\n- `http_post_token` is returned only when creating or rotating the token. Save it immediately.\n- To trigger from On-call incidents, send `oncall_incident_trigger_enabled`, `oncall_incident_channel_ids`, and `oncall_incident_severities`; matching events run with `trigger_kind=oncall_incident`.\n",
"href": "/en/api-reference/ai-sre/automations/automation-rule-write-create",
"metadata": {
"sidebarTitle": "Create Automation rule"
Expand Down Expand Up @@ -25086,7 +25086,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; results are filtered to the caller's visible scope |\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; results are filtered to the caller's visible scope |\n\n## Usage\n\n- `all` returns your personal rules plus team rules you can access.\n- Account admins see all team rules in list results, but not other users' personal rules.\n- `team_ids` narrows the visible set and never expands access.\n",
"href": "/en/api-reference/ai-sre/automations/automation-rule-read-list",
"metadata": {
"sidebarTitle": "List Automation rules"
Expand Down Expand Up @@ -25200,7 +25200,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; results are filtered to the caller's visible scope |\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; caller must manage the target rule |\n\n## Usage\n\n- Manage rights mean the personal rule owner; for team rules, an account admin or a member of the rule's team.\n",
"href": "/en/api-reference/ai-sre/automations/automation-rule-read-get",
"metadata": {
"sidebarTitle": "Get Automation rule"
Expand Down Expand Up @@ -25308,7 +25308,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- List visibility follows session-list visibility: owners/admins see all rules; ordinary members see rules they created and rules for their teams.\n- `http_post_token` is returned only when creating or rotating the token. Save it immediately.\n- To trigger from On-call incidents, send `oncall_incident_trigger_enabled`, `oncall_incident_channel_ids`, and `oncall_incident_severities`; matching events run with `trigger_kind=oncall_incident`.\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- Rule lists include your personal rules plus accessible team rules; account admins see all team rules, but not other users' personal rules.\n- Get, update, delete, and run history access require manage rights: the personal rule owner; for team rules, an account admin or a member of the rule's team.\n- `http_post_token` is returned only when creating or rotating the token. Save it immediately.\n- To trigger from On-call incidents, send `oncall_incident_trigger_enabled`, `oncall_incident_channel_ids`, and `oncall_incident_severities`; matching events run with `trigger_kind=oncall_incident`.\n",
"href": "/en/api-reference/ai-sre/automations/automation-rule-write-update",
"metadata": {
"sidebarTitle": "Update Automation rule"
Expand Down Expand Up @@ -25428,7 +25428,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- A caller may create personal rules and rules for any team in the current account; `team_id` is immutable after creation.\n- List visibility follows session-list visibility: owners/admins see all rules; ordinary members see rules they created and rules for their teams.\n- `http_post_token` is returned only when creating or rotating the token. Save it immediately.\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; management operations require the caller to manage the target rule |\n\n## Usage\n\n- Get, update, delete, and run history access require manage rights: the personal rule owner; for team rules, an account admin or a member of the rule's team.\n- Rule lists include your personal rules plus accessible team rules; account admins see all team rules, but not other users' personal rules.\n- `http_post_token` is returned only when creating or rotating the token. Save it immediately.\n",
"href": "/en/api-reference/ai-sre/automations/automation-rule-write-delete",
"metadata": {
"sidebarTitle": "Delete Automation rule"
Expand Down Expand Up @@ -25595,7 +25595,7 @@
}
],
"x-mint": {
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; results are filtered to the caller's visible scope |\n",
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | Valid `app_key`; caller must manage the target rule |\n\n## Usage\n\n- Run history is visible only when the caller can manage the rule: the personal rule owner; for team rules, an account admin or a member of the rule's team.\n",
"href": "/en/api-reference/ai-sre/automations/automation-run-read-list",
"metadata": {
"sidebarTitle": "List Automation runs"
Expand Down Expand Up @@ -44174,7 +44174,7 @@
},
"SessionListRequest": {
"type": "object",
"description": "Filters for listing agent sessions. Reads are scoped to the resolved account and the caller's visible teams.",
"description": "Filters for listing agent sessions. `all` visibility means the caller's own personal sessions plus accessible team sessions; account admins do not see other users' personal sessions.",
"properties": {
"app_name": {
"type": "string",
Expand Down Expand Up @@ -44225,7 +44225,7 @@
},
"scope": {
"type": "string",
"description": "Visibility scope: all (own + member-of-team rows, default), personal, or team.",
"description": "Visibility scope: `all` (own personal + accessible team sessions), `personal`, or `team`; default `all`.",
"enum": [
"all",
"personal",
Expand All @@ -44238,7 +44238,7 @@
"type": "integer",
"format": "int64"
},
"description": "Optional explicit team filter; intersects with `scope`."
"description": "Optional explicit team filter; intersects with `scope` and never expands access."
},
"entry_kinds": {
"type": "array",
Expand Down Expand Up @@ -44395,7 +44395,7 @@
},
"can_manage": {
"type": "boolean",
"description": "True when the caller may rename/archive/delete the session."
"description": "True when the caller may rename/archive/delete the session; personal sessions are creator-only, team sessions allow the creator, account admin, or team member."
},
"status": {
"type": "string",
Expand Down Expand Up @@ -45560,7 +45560,7 @@
},
"AutomationRuleListRequest": {
"type": "object",
"description": "List Automation rules visible to the caller.",
"description": "List Automation rules visible to the caller. `all` includes the caller's personal rules plus accessible team rules; account admins do not see other users' personal rules in list results.",
"properties": {
"p": {
"type": "integer",
Expand All @@ -45580,15 +45580,15 @@
"personal",
"team"
],
"description": "Scope filter. Defaults to all."
"description": "Scope filter: `all` (own personal + accessible team rules), `personal`, or `team`; default `all`."
},
"team_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Filter to these team IDs; this filters results and does not expand access."
"description": "Filter to these team IDs; this narrows results and does not expand access."
},
"include_person": {
"type": [
Expand Down Expand Up @@ -45746,7 +45746,7 @@
},
"can_edit": {
"type": "boolean",
"description": "Whether the caller can manage this rule."
"description": "True when the caller can manage this rule: the personal rule owner; for team rules, an account admin or a member of the rule's team."
},
"created_at": {
"type": "integer",
Expand Down
Loading