# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Bugsnag Organizations API version: 1.0.0 extends: openapi/bugsnag-organizations-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 41 - target: $.paths['/user/organizations'].get update: x-apievangelist-phrasing: intent: List my organizations effect: read questions: - Which BugSnag organizations do I belong to? - Can I page through the organizations my account is a member of? instructions: - text: List the organizations I belong to. - text: Show my organizations, {per_page} per page. slots: per_page: query.per_page method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}'].get update: x-apievangelist-phrasing: intent: Get an organization's billing email and slug effect: read questions: - What billing email and slug are set on my organization? - When was my organization created? instructions: - text: Get the name, slug and billing email of organization {organization_id}. slots: organization_id: path.organization_id - text: Show when organization {organization_id} was created. slots: organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations'].post update: x-apievangelist-phrasing: intent: Create an organization effect: write questions: - How do I start a brand-new BugSnag organization? - Does creating an organization make me its admin? instructions: - text: Create an organization named {name}. slots: name: requestBody.name - text: Set up a new organization called {name} with me as admin. slots: name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/organizations/{id}'].get update: x-apievangelist-phrasing: intent: View an organization record by ID effect: read questions: - How do I pull up an organization's complete record by its ID? - Can I check an organization's auto-upgrade and invoice settings? instructions: - text: View the organization record {id}. slots: id: path.id - text: Show invoice and auto-upgrade settings for organization {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{id}'].delete update: x-apievangelist-phrasing: intent: Delete an organization effect: destructive questions: - Can I shut down and delete an entire BugSnag organization? - How do I remove an organization I no longer use? instructions: - text: Delete organization {id}. slots: id: path.id - text: Permanently close organization {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{id}'].patch update: x-apievangelist-phrasing: intent: Update organization name and billing effect: write questions: - How do I change my organization's billing emails or invoice address? - Can I turn automatic plan upgrades off for my organization? instructions: - text: Rename organization {id} to {name} with auto-upgrade {auto_upgrade}. slots: id: path.id name: requestBody.name auto_upgrade: requestBody.auto_upgrade - text: Set billing emails for organization {id} to {billing_emails}, keeping name {name} and auto-upgrade {auto_upgrade}. slots: id: path.id billing_emails: requestBody.billing_emails name: requestBody.name auto_upgrade: requestBody.auto_upgrade method: generated generated: '2026-09-26' - target: $.paths['/organizations/{id}/api_key'].delete update: x-apievangelist-phrasing: intent: Regenerate an organization's API key effect: destructive questions: - How do I rotate my organization's API key if it leaked? - Does regenerating the organization API key invalidate the old one? instructions: - text: Regenerate the API key for organization {id}. slots: id: path.id - text: Rotate organization {id}'s API key. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{id}/auth_token'].delete update: x-apievangelist-phrasing: intent: Regenerate the deprecated organization auth token effect: destructive questions: - Can I still regenerate the old organization-level data access auth token? - Is the organization auth token deprecated in favor of user tokens? instructions: - text: Regenerate the organization auth token for {id}. slots: id: path.id - text: Issue a new data access auth token for organization {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}'].get update: x-apievangelist-phrasing: intent: Show an organization collaborator effect: read questions: - What does a collaborator's organization membership record contain? - How do I look up one member of my organization? instructions: - text: Show collaborator {id} on organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Look up member {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}'].delete update: x-apievangelist-phrasing: intent: Remove a member from an organization effect: destructive questions: - How do I take someone out of my organization? - Can I delete a collaborator who has left the company? instructions: - text: Delete collaborator {id} from organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Remove member {id} from organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}'].patch update: x-apievangelist-phrasing: intent: Change a member's project roles or admin rights effect: write questions: - Can I set per-project roles for an existing member? - How do I grant or revoke admin rights for a member? instructions: - text: Set member {id} in organization {organization_id} to project roles {project_roles}. slots: id: path.id organization_id: path.organization_id project_roles: requestBody.project_roles - text: Set admin to {admin} for member {id} of organization {organization_id}. slots: admin: requestBody.admin id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/bulk_invite'].post update: x-apievangelist-phrasing: intent: Invite several people at once effect: write questions: - Can I invite a whole list of email addresses to my organization in one request? - How do I bulk invite teammates with the same project roles? instructions: - text: Invite {emails} to organization {organization_id}. slots: emails: requestBody.emails organization_id: path.organization_id - text: Bulk invite {emails} to organization {organization_id} with access to projects {project_ids}. slots: emails: requestBody.emails organization_id: path.organization_id project_ids: requestBody.project_ids method: generated generated: '2026-09-26' - target: $.paths['/projects/{project_id}/collaborators'].get update: x-apievangelist-phrasing: intent: List who can access a project effect: read questions: - Who has access to a particular project? - Can I list the collaborators on one project rather than the whole organization? instructions: - text: List collaborators on project {project_id}. slots: project_id: path.project_id - text: Show everyone with access to project {project_id}. slots: project_id: path.project_id method: generated generated: '2026-09-26' - target: $.paths['/projects/{project_id}/collaborators/{id}'].get update: x-apievangelist-phrasing: intent: Show a collaborator within a project effect: read questions: - What does one collaborator's record look like inside a specific project? - Do I need access to a project to view its collaborators? instructions: - text: Show collaborator {id} in project {project_id}. slots: id: path.id project_id: path.project_id - text: Get project {project_id}'s record for collaborator {id}. slots: project_id: path.project_id id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/project_access_counts'].get update: x-apievangelist-phrasing: intent: Count projects each collaborator can access effect: read questions: - How many projects does each of these collaborators have access to? - Can I get project access counts for several collaborators at once? instructions: - text: Count project access for collaborators {collaborator_ids} in organization {organization_id}. slots: collaborator_ids: query.collaborator_ids organization_id: path.organization_id - text: Show how many projects collaborators {collaborator_ids} can reach in organization {organization_id}. slots: collaborator_ids: query.collaborator_ids organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{collaborator_id}/projects'].get update: x-apievangelist-phrasing: intent: View projects a collaborator can access effect: read questions: - Which projects can a given collaborator open? - Can I search a collaborator's accessible projects by name? instructions: - text: List the projects collaborator {collaborator_id} can access in organization {organization_id}. slots: collaborator_id: path.collaborator_id organization_id: path.organization_id - text: Search collaborator {collaborator_id}'s projects in organization {organization_id} for {q}. slots: collaborator_id: path.collaborator_id organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{collaborator_id}/project_accesses'].get update: x-apievangelist-phrasing: intent: List a collaborator's project access records effect: read questions: - What project access grants does a collaborator hold in the organization? - Can I page through a collaborator's project access entries? instructions: - text: List project access records for collaborator {collaborator_id} in organization {organization_id}. slots: collaborator_id: path.collaborator_id organization_id: path.organization_id - text: Show {per_page} project access grants per page for collaborator {collaborator_id} in organization {organization_id}. slots: per_page: query.per_page collaborator_id: path.collaborator_id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{collaborator_id}/project_accesses/{project_id}'].get update: x-apievangelist-phrasing: intent: Get a collaborator's access to one project effect: read questions: - What role does a collaborator have on one specific project? - How was a collaborator given access to a particular project? instructions: - text: Show collaborator {collaborator_id}'s access to project {project_id} in organization {organization_id}. slots: collaborator_id: path.collaborator_id project_id: path.project_id organization_id: path.organization_id - text: Get the access details for {collaborator_id} on project {project_id} in organization {organization_id}. slots: collaborator_id: path.collaborator_id project_id: path.project_id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}/team_memberships'].post update: x-apievangelist-phrasing: intent: Add a collaborator to teams effect: write questions: - How do I put one collaborator on several teams at once? - Can I add a collaborator to every team in the organization? instructions: - text: Add collaborator {id} to teams {team_ids} in organization {organization_id}. slots: id: path.id team_ids: requestBody.team_ids organization_id: path.organization_id - text: Put collaborator {id} on every team in organization {organization_id} (add_all_teams {add_all_teams}). slots: id: path.id organization_id: path.organization_id add_all_teams: requestBody.add_all_teams method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}/team_memberships'].delete update: x-apievangelist-phrasing: intent: Remove a collaborator from teams effect: destructive questions: - How do I take one collaborator off a group of teams? - Can I remove a person from teams without removing them from the organization? instructions: - text: Remove collaborator {id} from teams in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Take collaborator {id} off their teams in organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams'].get update: x-apievangelist-phrasing: intent: List or search an organization's teams effect: read questions: - What teams exist in my organization? - Can I search my organization's teams by name? instructions: - text: List teams in organization {organization_id}. slots: organization_id: path.organization_id - text: Find teams in organization {organization_id} matching {q}. slots: organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams'].post update: x-apievangelist-phrasing: intent: Create a team effect: write questions: - How do I create a new team in my organization? - Can I group collaborators into a named team? instructions: - text: Create a team called {name} in organization {organization_id}. slots: name: requestBody.name organization_id: path.organization_id - text: Add a new team {name} to organization {organization_id}. slots: name: requestBody.name organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}'].get update: x-apievangelist-phrasing: intent: Show a team's details effect: read questions: - What are the details of a particular team? - How do I look up one team by its ID? instructions: - text: Show team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Get details of team {id} from organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a team effect: destructive questions: - Can I delete a team we no longer need? - How do I get rid of a team in my organization? instructions: - text: Delete team {id} from organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Remove the team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}'].patch update: x-apievangelist-phrasing: intent: Rename a team effect: write questions: - How do I rename an existing team? - Can I change a team's name after creating it? instructions: - text: Rename team {id} in organization {organization_id} to {name}. slots: id: path.id organization_id: path.organization_id name: requestBody.name - text: Change the name of team {id} in organization {organization_id} to {name}. slots: id: path.id organization_id: path.organization_id name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/suggested_collaborators'].get update: x-apievangelist-phrasing: intent: Suggest collaborators to add to a team effect: read questions: - Which collaborators could I add to this team? - Can team member suggestions include people who already have access? instructions: - text: Suggest collaborators to add to team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Find suggested collaborators for team {id} in organization {organization_id} matching {q}. slots: id: path.id organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}/teams'].get update: x-apievangelist-phrasing: intent: List the teams a collaborator is on effect: read questions: - Which teams is a given collaborator a member of? - Can I search a collaborator's teams by name? instructions: - text: List teams for collaborator {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Search collaborator {id}'s teams in organization {organization_id} for {q}. slots: id: path.id organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/collaborators/{id}/suggested_teams'].get update: x-apievangelist-phrasing: intent: Suggest teams for a collaborator to join effect: read questions: - Which teams could a collaborator be added to? - Can team suggestions for a person also flag teams they are already in? instructions: - text: Suggest teams for collaborator {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: List suggested teams for collaborator {id} in organization {organization_id}, including membership {include_is_member}. slots: id: path.id organization_id: path.organization_id include_is_member: query.include_is_member method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/collaborators'].get update: x-apievangelist-phrasing: intent: List members of a team effect: read questions: - Who is on a particular team? - Can I search a team's members by name? instructions: - text: List members of team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Search team {id}'s members in organization {organization_id} for {q}. slots: id: path.id organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/team_memberships'].post update: x-apievangelist-phrasing: intent: Add collaborators to a team effect: write questions: - How do I add several people to a team at once? - Can I add every collaborator in the organization to one team? instructions: - text: Put users {collaborator_ids} onto team {id} in organization {organization_id}. slots: collaborator_ids: requestBody.collaborator_ids id: path.id organization_id: path.organization_id - text: Fill team {id} in organization {organization_id} with everyone in the organization (add_all_collaborators {add_all_collaborators}). slots: id: path.id organization_id: path.organization_id add_all_collaborators: requestBody.add_all_collaborators method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/team_memberships'].delete update: x-apievangelist-phrasing: intent: Remove collaborators from a team effect: destructive questions: - How do I remove several people from a team? - Can I take members off a team without deleting the team? instructions: - text: Remove members from team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Take the listed users off team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/project_accesses'].get update: x-apievangelist-phrasing: intent: List projects a team can access effect: read questions: - Which projects does a team have access to? - Can I search a team's project access by project name? instructions: - text: List project access for team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Search team {id}'s accessible projects in organization {organization_id} for {q}. slots: id: path.id organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/project_accesses'].delete update: x-apievangelist-phrasing: intent: Remove a team's access to projects effect: destructive questions: - How do I revoke a team's access to certain projects? - Can I take projects away from a team without deleting it? instructions: - text: Remove project access from team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Revoke team {id}'s access to the given projects in organization {organization_id}. slots: id: path.id organization_id: path.organization_id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/project_accesses'].patch update: x-apievangelist-phrasing: intent: Grant a team access to projects effect: write questions: - How do I give a team access to every project? - Can I set the role a team gets on the projects it can access? instructions: - text: 'Give team {id} in organization {organization_id} access to all projects: {add_all_projects}.' slots: id: path.id organization_id: path.organization_id add_all_projects: requestBody.add_all_projects - text: Grant team {id} in organization {organization_id} project roles {project_roles}. slots: id: path.id organization_id: path.organization_id project_roles: requestBody.project_roles method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/teams/{id}/suggested_projects'].get update: x-apievangelist-phrasing: intent: Suggest projects to give a team effect: read questions: - Which projects could I give this team access to? - Can project suggestions for a team exclude ones it already has? instructions: - text: Suggest projects for team {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: List suggested projects for team {id} in organization {organization_id} matching {q}. slots: id: path.id organization_id: path.organization_id q: query.q method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/event_data_requests'].post update: x-apievangelist-phrasing: intent: Request an organization-wide event export effect: write questions: - How do I export all event data across my organization? - Can I request an organization data export for a GDPR subject access request? instructions: - text: Start an event data export for organization {organization_id} with filters {filters}. slots: organization_id: path.organization_id filters: requestBody.filters - text: Request a {report_type} event export for organization {organization_id} filtered by {filters}. slots: report_type: requestBody.report_type organization_id: path.organization_id filters: requestBody.filters method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/event_data_requests/{id}'].get update: x-apievangelist-phrasing: intent: Check an organization export's status effect: read questions: - Is my organization-wide event data export ready to download? - How do I check progress on an organization data request? instructions: - text: Check the status of event data request {id} for organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Get the download status of organization {organization_id} export {id}. slots: organization_id: path.organization_id id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/event_data_deletions'].post update: x-apievangelist-phrasing: intent: Request an organization-wide event deletion effect: destructive questions: - How do I delete a user's events across every project in my organization? - Do email filters in an organization deletion request match substrings? instructions: - text: Request deletion of events matching {filters} across organization {organization_id}. slots: filters: requestBody.filters organization_id: path.organization_id - text: Delete organization {organization_id} events matching {filters} with skip confirmation {skip_confirmation}. slots: organization_id: path.organization_id filters: requestBody.filters skip_confirmation: requestBody.skip_confirmation method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/event_data_deletions/{id}/confirm'].post update: x-apievangelist-phrasing: intent: Confirm an organization event deletion effect: destructive questions: - How do I confirm a pending organization-wide event deletion? - Does an organization deletion request wait for confirmation before running? instructions: - text: Confirm event deletion request {id} for organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Go ahead with organization {organization_id} deletion {id}. slots: organization_id: path.organization_id id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/event_data_deletions/{id}'].get update: x-apievangelist-phrasing: intent: Check an organization deletion's status effect: read questions: - Has my organization-wide event deletion finished? - How do I track an organization deletion request? instructions: - text: Check the status of deletion request {id} in organization {organization_id}. slots: id: path.id organization_id: path.organization_id - text: Show progress of organization {organization_id} event deletion {id}. slots: organization_id: path.organization_id id: path.id method: generated generated: '2026-09-26' - target: $.paths['/organizations/{organization_id}/traces/{trace_id}/spans'].get update: x-apievangelist-phrasing: intent: List an organization-level trace's spans effect: read questions: - How do I see all spans in a distributed trace across my organization? - What permission do I need to view organization-level trace spans? instructions: - text: List spans for trace {trace_id} in organization {organization_id} from {from} to {to}. slots: trace_id: path.trace_id organization_id: path.organization_id from: query.from to: query.to - text: Show organization {organization_id} trace {trace_id} around span {target_span_id} between {from} and {to}. slots: organization_id: path.organization_id trace_id: path.trace_id target_span_id: query.target_span_id from: query.from to: query.to method: generated generated: '2026-09-26'