# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Relevance AI Endpoints Organizations API
  version: 1.0.0
extends: openapi/relevance-ai-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: 62
- target: $.paths['/organizations/{organization_id}/integrations/overrides/bulk/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk set integration permission overrides
      effect: write
      questions:
      - Can I allow or block several integrations for my organization in one call?
      - How do I override the default permission for specific integration providers?
      instructions:
      - text: Apply integration permission overrides {overrides} to organization {org}.
        slots:
          org: path.organization_id
          overrides: requestBody.overrides
      - text: Bulk upsert integration overrides for org {org} using {overrides}.
        slots:
          org: path.organization_id
          overrides: requestBody.overrides
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/integrations/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default integration permission
      effect: read
      questions:
      - Are integrations allowed by default in my organization?
      - What's the default integration permission status for an org?
      instructions:
      - text: Get the default integration permission for organization {org}.
        slots:
          org: path.organization_id
      - text: Tell me whether new integrations are allowed by default in org {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/integrations/default'].post
  update:
    x-apievangelist-phrasing:
      intent: Change the default integration permission
      effect: write
      questions:
      - How do I block all integrations by default for my organization?
      - Can I change the org-wide default status for integrations?
      instructions:
      - text: Set the default integration permission of org {org} to {integrations_permission_status}.
        slots:
          org: path.organization_id
          integrations_permission_status: requestBody.integrations_permission_status
      - text: Change org {org}'s default integration status to {integrations_permission_status}.
        slots:
          org: path.organization_id
          integrations_permission_status: requestBody.integrations_permission_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/integrations/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List integration providers for an organization
      effect: read
      questions:
      - Which API key and OAuth integration providers are available to my organization?
      - Can I see each integration's permission override and credentials when listing them?
      instructions:
      - text: List integration providers for organization {org}.
        slots:
          org: path.organization_id
      - text: Search integration providers in org {org} for {query}.
        slots:
          org: path.organization_id
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/keys/set'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an organization-wide native API key
      effect: write
      questions:
      - How do I set a fallback API key for every project in my organization?
      - Which key gets used when a project has no API key of its own?
      instructions:
      - text: Set native key {key} to {value} for organization {org}.
        slots:
          org: path.organization_id
          key: requestBody.key
          value: requestBody.value
      - text: Store {value} as the org-level {key} key for {org}, shared {is_shared}.
        slots:
          org: path.organization_id
          value: requestBody.value
          key: requestBody.key
          is_shared: requestBody.is_shared
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/keys/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization native API key
      effect: destructive
      questions:
      - How do I remove an org-level native API key?
      - What happens to projects when I delete the organization's fallback key?
      instructions:
      - text: Delete native key {key} from organization {org}.
        slots:
          org: path.organization_id
          key: requestBody.key
      - text: Remove the org-wide {key} API key for {org}.
        slots:
          org: path.organization_id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/keys/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List organization native API keys
      effect: read
      questions:
      - Which native API keys are set at the organization level?
      - Where can I see the org's fallback API keys?
      instructions:
      - text: List native API keys for organization {org}.
        slots:
          org: path.organization_id
      - text: Show the org-level fallback keys for {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization
      effect: write
      questions:
      - How do I create a new organization in Relevance AI?
      - Can I name an organization when I create it?
      instructions:
      - text: Create an organization named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new org called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an organization
      effect: write
      questions:
      - Can I change my organization's name?
      - How do I update an existing organization's details?
      instructions:
      - text: Rename organization {org} to {name}.
        slots:
          org: path.organization_id
          name: requestBody.name
      - text: Update org {org} with the name {name}.
        slots:
          org: path.organization_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organizations
      effect: read
      questions:
      - Which organizations do I belong to?
      - What metadata comes back for each of my organizations?
      instructions:
      - text: List all my organizations.
      - text: Show every org I'm a member of with its metadata.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization
      effect: destructive
      questions:
      - How do I delete an entire organization?
      - Is deleting an organization something I can undo?
      instructions:
      - text: Delete organization {org}.
        slots:
          org: path.organization_id
      - text: Permanently remove org {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - How do I look up one organization's details?
      - What information is stored about my organization?
      instructions:
      - text: Get organization {org}.
        slots:
          org: path.organization_id
      - text: Show the details of org {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/usage/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's usage
      effect: read
      questions:
      - How much has my organization used this period?
      - Where can I see usage for my whole organization?
      instructions:
      - text: Get usage for organization {org}.
        slots:
          org: path.organization_id
      - text: Show how much org {org} has consumed.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List available subscription plans
      effect: read
      questions:
      - What subscription plans can an organization choose from?
      - Which plans are offered and how do they differ?
      instructions:
      - text: List the available organization plans.
      - text: Show me every subscription plan on offer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/users/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in an organization
      effect: read
      questions:
      - Who are the members of my organization?
      - Can I filter organization users by email?
      instructions:
      - text: List users in organization {org}.
        slots:
          org: path.organization_id
      - text: Find users in org {org} with email {filter_by_email}.
        slots:
          org: path.organization_id
          filter_by_email: query.filter_by_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/projects/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects in an organization
      effect: read
      questions:
      - What projects belong to my organization?
      - How many projects does an organization have?
      instructions:
      - text: List projects in organization {org}.
        slots:
          org: path.organization_id
      - text: Show every project under org {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invites/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending organization invites
      effect: read
      questions:
      - Who has been invited to my organization but not joined yet?
      - Can I see outstanding invites for an org?
      instructions:
      - text: List invites for organization {org}.
        slots:
          org: path.organization_id
      - text: Show the outstanding invitations in org {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/billing/events/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List an organization's billing events
      effect: read
      questions:
      - Can I see each individual billing event for my organization?
      - How do I filter and page through billing events?
      instructions:
      - text: List billing events for organization {org}.
        slots:
          org: path.organization_id
      - text: List billing events in org {org} matching {filters}.
        slots:
          org: path.organization_id
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/billing/totals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total spend over a date range
      effect: read
      questions:
      - What did my organization spend over a given date range?
      - Can I total up billing costs for last month?
      instructions:
      - text: Get billing totals for organization {org} over {date_range}.
        slots:
          org: path.organization_id
          date_range: query.date_range
      - text: Total org {org}'s cost for {date_range}.
        slots:
          org: path.organization_id
          date_range: query.date_range
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/billing/get_billing_frontend_link'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a link to the billing portal
      effect: read
      questions:
      - Where do I manage my organization's billing and payment method?
      - Can I get a link that opens the billing portal?
      instructions:
      - text: Get the billing portal link for organization {org}.
        slots:
          org: path.organization_id
      - text: Open the billing page for org {org} with flow {flow}.
        slots:
          org: path.organization_id
          flow: query.flow
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/billing/checkout'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a billing checkout session
      effect: read
      questions:
      - How do I get a checkout session to add a payment method or subscribe?
      - Can I request a checkout session of a specific type?
      instructions:
      - text: Get a {type} checkout session for organization {org}.
        slots:
          org: path.organization_id
          type: query.type
      - text: Fetch a billing checkout session for org {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/billing/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an organization's plan and cycle
      effect: write
      questions:
      - How do I move my organization to a different plan?
      - Can I switch between monthly and annual billing?
      instructions:
      - text: Update org {org} billing to plan {plan} on a {billing_cycle} cycle.
        slots:
          org: path.organization_id
          plan: requestBody.plan
          billing_cycle: requestBody.billing_cycle
      - text: Set billing for {org} to {plan}, billed {billing_cycle}.
        slots:
          org: path.organization_id
          plan: requestBody.plan
          billing_cycle: requestBody.billing_cycle
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/subscription/sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Resync an organization's subscription
      effect: write
      questions:
      - My subscription looks out of date, can I force it to resync?
      - How do I refresh the subscription state for an organization?
      instructions:
      - text: Sync the subscription for organization {org}.
        slots:
          org: path.organization_id
      - text: Refresh org {org}'s subscription status.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/get_credit_cost'].post
  update:
    x-apievangelist-phrasing:
      intent: Price a quantity of credits or actions
      effect: read
      questions:
      - How much would a given number of credits cost on a plan?
      - Can I price out units before buying them?
      instructions:
      - text: Get the cost of {units} {type} units.
        slots:
          units: requestBody.units
          type: requestBody.type
      - text: Price {units} units of {type} on plan {plan}.
        slots:
          units: requestBody.units
          type: requestBody.type
          plan: requestBody.plan
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/subscription/downgrade'].post
  update:
    x-apievangelist-phrasing:
      intent: Downgrade an organization's subscription
      effect: write
      questions:
      - How do I downgrade my organization to a cheaper plan?
      - Can I leave feedback when downgrading my subscription?
      instructions:
      - text: Downgrade org {org} to plan {plan} with idempotency key {idempotency_key}.
        slots:
          org: path.organization_id
          plan: requestBody.plan
          idempotency_key: requestBody.idempotency_key
      - text: Downgrade {org} to {plan}, noting feedback {feedback}, key {idempotency_key}.
        slots:
          org: path.organization_id
          plan: requestBody.plan
          feedback: requestBody.feedback
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/billing/subscription/change'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch subscription plan
      effect: write
      questions:
      - How do I change my subscription to a new plan with a coupon?
      - Can I switch plans and billing cycle in one step?
      instructions:
      - text: Change org {org}'s subscription to {new_plan_name} billed {billing_cycle}, key {idempotency_key}.
        slots:
          org: path.organization_id
          new_plan_name: requestBody.new_plan_name
          billing_cycle: requestBody.billing_cycle
          idempotency_key: requestBody.idempotency_key
      - text: Switch {org} to {new_plan_name} {billing_cycle} using coupon {coupon_code}, key {idempotency_key}.
        slots:
          org: path.organization_id
          new_plan_name: requestBody.new_plan_name
          billing_cycle: requestBody.billing_cycle
          coupon_code: requestBody.coupon_code
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/downgrade/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a scheduled downgrade
      effect: write
      questions:
      - I scheduled a downgrade by mistake, can I cancel it?
      - How do I keep my current plan after requesting a downgrade?
      instructions:
      - text: Cancel the pending downgrade for org {org} with key {idempotency_key}.
        slots:
          org: path.organization_id
          idempotency_key: requestBody.idempotency_key
      - text: Undo the scheduled downgrade on {org}, idempotency key {idempotency_key}.
        slots:
          org: path.organization_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/subscription/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an organization's subscription
      effect: destructive
      questions:
      - How do I cancel my organization's subscription?
      - What stops when I cancel the paid plan?
      instructions:
      - text: Cancel the subscription for organization {org}.
        slots:
          org: path.organization_id
      - text: End org {org}'s paid subscription.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/credits/buy'].post
  update:
    x-apievangelist-phrasing:
      intent: Buy extra credits
      effect: write
      questions:
      - How do I top up credits for my organization?
      - Can I buy a specific number of credits right away?
      instructions:
      - text: Buy {quantity} credits for org {org} with key {idempotency_key}.
        slots:
          org: path.organization_id
          quantity: requestBody.quantity
          idempotency_key: requestBody.idempotency_key
      - text: Purchase {quantity} extra credits for {org}, idempotency key {idempotency_key}.
        slots:
          org: path.organization_id
          quantity: requestBody.quantity
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/credits/checkout'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a checkout to buy credits and actions
      effect: write
      questions:
      - Can I get a checkout page to pay for credits and actions together?
      - Is there a hosted checkout flow for buying credits?
      instructions:
      - text: Start a checkout for {credits_quantity} credits and {actions_quantity} actions for org {org}.
        slots:
          org: path.organization_id
          credits_quantity: requestBody.credits_quantity
          actions_quantity: requestBody.actions_quantity
      - text: 'Create a credit purchase checkout for {org}: {credits_quantity} credits, {actions_quantity} actions.'
        slots:
          org: path.organization_id
          credits_quantity: requestBody.credits_quantity
          actions_quantity: requestBody.actions_quantity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/checkout/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a checkout completed
      effect: read
      questions:
      - Did my checkout payment go through?
      - How can I tell if a checkout session finished?
      instructions:
      - text: Check the status of checkout {checkout_session_id} for org {org}.
        slots:
          org: path.organization_id
          checkout_session_id: query.checkout_session_id
      - text: Tell me if org {org}'s last checkout completed.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/trial/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a plan trial
      effect: write
      questions:
      - Can my organization start a free trial of a plan?
      - How do I trigger a plan trial for an org?
      instructions:
      - text: Start a plan trial for organization {org}.
        slots:
          org: path.organization_id
      - text: Trigger the trial for {org} with idempotency key {idempotency_key}.
        slots:
          org: path.organization_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/roles/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List assignable roles for an entity type
      effect: read
      questions:
      - What roles can I assign on projects or other entity types?
      - Which role definitions does my organization support?
      instructions:
      - text: List the roles available for {entity_type} in org {org}.
        slots:
          org: path.organization_id
          entity_type: requestBody.entity_type
      - text: Show assignable {entity_type} roles for organization {org}.
        slots:
          org: path.organization_id
          entity_type: requestBody.entity_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/usage-alarms/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage alarms
      effect: read
      questions:
      - What usage alarms are set up for my organization?
      - Where can I see my configured spend thresholds?
      instructions:
      - text: List usage alarms for organization {org}.
        slots:
          org: path.organization_id
      - text: Show the usage alerts configured on {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/usage-alarms/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a usage alarm
      effect: write
      questions:
      - How do I get alerted when usage passes a threshold?
      - Can I change the threshold on an existing usage alarm?
      instructions:
      - text: Set a {usage_type} alarm on org {org} at {usage_threshold} with action {alarm_action}.
        slots:
          org: path.organization_id
          usage_type: requestBody.usage_type
          usage_threshold: requestBody.usage_threshold
          alarm_action: requestBody.alarm_action
      - text: Alert me via {alarm_action} when {org}'s {usage_type} usage reaches {usage_threshold}.
        slots:
          org: path.organization_id
          alarm_action: requestBody.alarm_action
          usage_type: requestBody.usage_type
          usage_threshold: requestBody.usage_threshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/usage-alarms/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a usage alarm
      effect: destructive
      questions:
      - How do I turn off a usage alarm?
      - Can I remove just one alarm action for a usage type?
      instructions:
      - text: Delete the {usage_type} {alarm_action} alarm on org {org}.
        slots:
          org: path.organization_id
          usage_type: requestBody.usage_type
          alarm_action: requestBody.alarm_action
      - text: Remove {org}'s {alarm_action} alert for {usage_type} usage.
        slots:
          org: path.organization_id
          alarm_action: requestBody.alarm_action
          usage_type: requestBody.usage_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/update_features'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization's enabled features
      effect: write
      questions:
      - How do I turn features on or off for an organization?
      - Can I change which features are enabled for my org?
      instructions:
      - text: Set enabled features of org {org} to {features}.
        slots:
          org: path.organization_id
          features: requestBody.features
      - text: Enable features {features} for organization {org}.
        slots:
          org: path.organization_id
          features: requestBody.features
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/features'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's enabled features
      effect: read
      questions:
      - Which features are enabled for my organization?
      - Is a particular feature switched on for my org?
      instructions:
      - text: Get enabled features for organization {org}.
        slots:
          org: path.organization_id
      - text: List the features turned on for {org}.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/domain-enterprise-check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if my email domain is enterprise
      effect: read
      questions:
      - Does my email domain belong to an enterprise organization?
      - Can I tell from a sign-in token whether I should join an enterprise org?
      instructions:
      - text: Check enterprise status for the domain of ID token {id_token}.
        slots:
          id_token: requestBody.id_token
      - text: Tell me if the user behind {id_token} is on an enterprise domain.
        slots:
          id_token: requestBody.id_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/check-sso-enforcement'].post
  update:
    x-apievangelist-phrasing:
      intent: Check if an email domain requires SSO
      effect: read
      questions:
      - Does this email address have to sign in with SSO?
      - How do I know if a domain enforces single sign-on?
      instructions:
      - text: Check whether {email} must use SSO.
        slots:
          email: requestBody.email
      - text: Tell me if SSO is enforced for the domain of {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/usage-based-billing-enabled'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if usage-based billing is on
      effect: read
      questions:
      - Is my organization on usage-based billing?
      - Am I billed by usage or on a fixed plan?
      instructions:
      - text: Check whether usage-based billing is enabled for my org.
      - text: Tell me if my organization pays by usage.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/entitlements/limits/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check entitlement limits
      effect: read
      questions:
      - Has my organization hit its plan limits for certain entitlements?
      - Can I check several entitlements against their limits at once?
      instructions:
      - text: Check whether entitlements {entitlements} have reached their limits.
        slots:
          entitlements: requestBody.entitlements
      - text: Tell me if my org is over the limit for {entitlements}.
        slots:
          entitlements: requestBody.entitlements
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/configuration/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization configuration value
      effect: read
      questions:
      - How do I read a single configuration setting for my organization?
      - What is the value of a given config key on my org?
      instructions:
      - text: Get configuration key {key} for organization {org}.
        slots:
          org: path.organization_id
          key: path.key
      - text: Read org {org}'s {key} setting.
        slots:
          org: path.organization_id
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/data_retention'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the data retention policy
      effect: read
      questions:
      - How long does my organization keep data?
      - What data retention settings are configured for my org?
      instructions:
      - text: Get the data retention config for organization {org}.
        slots:
          org: path.organization_id
      - text: Show {org}'s data retention period.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/data_retention'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the data retention policy
      effect: write
      questions:
      - How do I have my organization's data deleted after a number of days?
      - Can I change the retention period for my org's data?
      instructions:
      - text: Set org {org} data retention to {retention_period_days} days with settings {settings}.
        slots:
          org: path.organization_id
          retention_period_days: requestBody.retention_period_days
          settings: requestBody.settings
      - text: Keep data for {retention_period_days} days in {org} using {settings}.
        slots:
          org: path.organization_id
          retention_period_days: requestBody.retention_period_days
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/data_retention'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the data retention policy
      effect: destructive
      questions:
      - How do I remove the custom data retention policy on my org?
      - What happens when I delete a retention configuration?
      instructions:
      - text: Delete the data retention config for organization {org}.
        slots:
          org: path.organization_id
      - text: Remove {org}'s custom retention policy.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/retention-offer/eligibility'].get
  update:
    x-apievangelist-phrasing:
      intent: Check eligibility for a retention discount
      effect: read
      questions:
      - Is my organization eligible for a discount if I'm thinking of cancelling?
      - Can I check for a retention offer before I cancel?
      instructions:
      - text: Check retention offer eligibility for org {org}.
        slots:
          org: path.organization_id
      - text: Tell me if {org} qualifies for a retention discount.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/retention-offer/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a retention discount
      effect: write
      questions:
      - How do I take the 30% or 50% discount offered instead of cancelling?
      - Can I give a cancellation reason when accepting the retention offer?
      instructions:
      - text: Accept the retention offer for organization {org}.
        slots:
          org: path.organization_id
      - text: Apply the retention discount to {org}, reason {cancellation_reason}.
        slots:
          org: path.organization_id
          cancellation_reason: requestBody.cancellation_reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in an organization
      effect: read
      questions:
      - What user groups exist in my organization?
      - How many users are in each group and what projects can they access?
      instructions:
      - text: List groups in organization {org}.
        slots:
          org: path.organization_id
      - text: Show every group in {org} with user counts.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/groups/{group_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a group
      effect: read
      questions:
      - Who is in a particular group?
      - Can I filter a group's members by email?
      instructions:
      - text: List members of group {group_id} in org {org}.
        slots:
          org: path.organization_id
          group_id: path.group_id
      - text: Find {filter_by_email} among members of group {group_id} in {org}.
        slots:
          org: path.organization_id
          filter_by_email: query.filter_by_email
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/groups/{group_id}/members/pending'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending members of a group
      effect: read
      questions:
      - Which invited users haven't joined a group yet?
      - Can I see pending group members separately from active ones?
      instructions:
      - text: List invited users who have not yet joined group {group_id} in org {org}.
        slots:
          org: path.organization_id
          group_id: path.group_id
      - text: Show users still pending in group {group_id} of {org}.
        slots:
          org: path.organization_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/groups/{group_id}/assign_to_project'].post
  update:
    x-apievangelist-phrasing:
      intent: Give a group access to a project
      effect: write
      questions:
      - How do I give a whole group access to a project?
      - Can I change a group's permission level on a project it already has?
      instructions:
      - text: Assign group {group_id} to project {project_display_id} with {permission} in org {org}.
        slots:
          org: path.organization_id
          group_id: path.group_id
          project_display_id: requestBody.project_display_id
          permission: requestBody.permission
      - text: Give group {group_id} of {org} {permission} access to project {project_display_id}.
        slots:
          org: path.organization_id
          group_id: path.group_id
          permission: requestBody.permission
          project_display_id: requestBody.project_display_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_display_id}/group_permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups with access to a project
      effect: read
      questions:
      - Which groups have permissions on a project?
      - Who can access this project through group membership?
      instructions:
      - text: List group permissions on project {project_display_id}.
        slots:
          project_display_id: path.project_display_id
      - text: Show which groups can access project {project_display_id}.
        slots:
          project_display_id: path.project_display_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/groups/{group_id}/projects/{project_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group's access to a project
      effect: destructive
      questions:
      - How do I revoke a group's access to a project?
      - Does removing a group from a project take away all its permissions there?
      instructions:
      - text: Remove group {group_id} from project {project_id} in org {org}.
        slots:
          org: path.organization_id
          group_id: path.group_id
          project_id: path.project_id
      - text: Revoke group {group_id}'s access to project {project_id} in {org}.
        slots:
          org: path.organization_id
          group_id: path.group_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{asset_type}/{asset_id}/group_permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups with access to an asset
      effect: read
      questions:
      - Which groups can access a specific agent or tool?
      - Can I see group permissions on a table or workforce?
      instructions:
      - text: List group permissions on {asset_type} {asset_id}.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      - text: Show which groups can use agent {asset_id} of type {asset_type}.
        slots:
          asset_id: path.asset_id
          asset_type: path.asset_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{asset_type}/{asset_id}/group_permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a group access to an asset
      effect: write
      questions:
      - How do I share an agent or tool with a whole group?
      - Can I give a group a specific permission level on a table?
      instructions:
      - text: Give group {group_id} {permission} on {asset_type} {asset_id}.
        slots:
          group_id: requestBody.group_id
          permission: requestBody.permission
          asset_type: path.asset_type
          asset_id: path.asset_id
      - text: Share {asset_type} {asset_id} with group {group_id} as {permission}.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
          group_id: requestBody.group_id
          permission: requestBody.permission
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{asset_type}/{asset_id}/group_permissions/{group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a group's access to an asset
      effect: destructive
      questions:
      - How do I stop a group from accessing an agent or tool?
      - Does revoking a group's asset permission work for legacy permissions?
      instructions:
      - text: Remove group {group_id} from {asset_type} {asset_id}.
        slots:
          group_id: path.group_id
          asset_type: path.asset_type
          asset_id: path.asset_id
      - text: Revoke group {group_id}'s access to agent {asset_id} of type {asset_type}.
        slots:
          group_id: path.group_id
          asset_id: path.asset_id
          asset_type: path.asset_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/{organization_id}/overage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overage settings
      effect: read
      questions:
      - Is my organization allowed to go over its credit or action limits?
      - What are the overage settings for concurrency?
      instructions:
      - text: Get the overage configuration for org {org}.
        slots:
          org: path.organization_id
      - text: Show {org}'s overage settings for credits, actions and concurrency.
        slots:
          org: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/{organization_id}/overage'].put
  update:
    x-apievangelist-phrasing:
      intent: Change overage settings
      effect: write
      questions:
      - How do I allow my organization to exceed its credit limit?
      - Can I change just the concurrency overage without touching the rest?
      instructions:
      - text: Set credit overage for org {org} to {credits}.
        slots:
          org: path.organization_id
          credits: requestBody.credits
      - text: Update {org}'s concurrency overage to {concurrency}.
        slots:
          org: path.organization_id
          concurrency: requestBody.concurrency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/{organization_id}/auto-recharge/{currency}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get auto-recharge settings
      effect: read
      questions:
      - Is auto-recharge turned on for my organization?
      - At what balance does my account top itself up?
      instructions:
      - text: Get the {currency} auto-recharge config for org {org}.
        slots:
          org: path.organization_id
          currency: path.currency
      - text: Show {org}'s auto top-up settings for {currency}.
        slots:
          org: path.organization_id
          currency: path.currency
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/{organization_id}/auto-recharge/{currency}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set up auto-recharge
      effect: write
      questions:
      - How do I automatically top up when my balance runs low?
      - Can I change the recharge amount and threshold?
      instructions:
      - text: Auto-recharge {amount} {currency} for org {org} when the balance drops below {threshold}.
        slots:
          org: path.organization_id
          amount: requestBody.amount
          currency: path.currency
          threshold: requestBody.threshold
      - text: Set {org}'s {currency} top-up to {amount} at threshold {threshold}.
        slots:
          org: path.organization_id
          currency: path.currency
          amount: requestBody.amount
          threshold: requestBody.threshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/{organization_id}/auto-recharge/{currency}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Turn off auto-recharge
      effect: destructive
      questions:
      - How do I stop automatic top-ups?
      - Can I remove auto-recharge for just one currency?
      instructions:
      - text: Delete the {currency} auto-recharge config for org {org}.
        slots:
          org: path.organization_id
          currency: path.currency
      - text: Turn off {currency} auto top-up for {org}.
        slots:
          org: path.organization_id
          currency: path.currency
      method: generated
      generated: '2026-09-26'