Relevance AI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Relevance AI Endpoints Auth API

53 actions 53 updates phrasing extends openapi/relevance-ai-auth-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Relevance AI's API. It is a proposal applied on top of the contract, not a document Relevance AI publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 53 · first 16 shown; the file carries all of them

$.info
$.paths['/auth/users/create'].post
$.paths['/auth/users/list'].post
$.paths['/auth/asset-users/list'].post
$.paths['/auth/{asset_type}/{asset_id}/capability'].get
$.paths['/auth/is_authorized'].post
$.paths['/auth/info'].get
$.paths['/auth/invite/create'].post
$.paths['/auth/invite/list'].post
$.paths['/auth/invite/accept'].post
$.paths['/auth/invite/delete'].post
$.paths['/auth/invite/resend'].post
$.paths['/auth/users/{user_id}'].get
$.paths['/auth/users/{user_id}/update'].post
$.paths['/auth/users/user'].post
$.paths['/auth/users/{user_id}/delete'].post

OpenAPI Overlay

Raw ↑
# 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 Auth API
  version: 1.0.0
extends: openapi/relevance-ai-auth-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: 52
- target: $.paths['/auth/users/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign up a new user with an organization and project
      effect: write
      questions:
      - How do I create a new user account along with its first organization and project?
      - Can I sign up a user with an invite code so they join an existing project?
      instructions:
      - text: Create a user {first_name} {last_name} with organization {organization_name}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          organization_name: requestBody.organization_name
      - text: Sign up a new user using invite code {invite_code}.
        slots:
          invite_code: requestBody.invite_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List users in the project
      effect: read
      questions:
      - Who are the users in my project?
      - Can I filter and sort the project's user list?
      instructions:
      - text: List the users in this project.
      - text: Show project users matching {user_filters}, {page_size} per page.
        slots:
          user_filters: requestBody.user_filters
          page_size: requestBody.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/asset-users/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List who has access to an asset
      effect: read
      questions:
      - Which users have access to a particular agent or tool, and with what role?
      - Can I see everyone's permissions on one shared asset?
      instructions:
      - text: List user permissions for asset {asset_context}.
        slots:
          asset_context: requestBody.asset_context
      - text: Show who can access {asset_context} and their roles.
        slots:
          asset_context: requestBody.asset_context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/{asset_type}/{asset_id}/capability'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my capabilities on an asset
      effect: read
      questions:
      - What am I allowed to do on a specific asset?
      - Can I check my own capabilities for an agent before editing it?
      instructions:
      - text: Get my capabilities on {asset_type} {asset_id}.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      - text: Check what the current user can do with {asset_type} {asset_id}.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/is_authorized'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether the caller holds given permissions
      effect: read
      questions:
      - Does my current key have a given set of permissions?
      - Can I test authorization for a relationship on an object before calling it?
      instructions:
      - text: Check whether I am authorized for {permissions}.
        slots:
          permissions: requestBody.permissions
      - text: Verify I have relationship {relationship} on object {object}.
        slots:
          relationship: requestBody.relationship
          object: requestBody.object
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify the user and key behind my credentials
      effect: read
      questions:
      - Which user and key id does my auth header belong to?
      - What permissions does the API key I'm using carry?
      instructions:
      - text: Show the user id, key id and permissions for my auth header.
      - text: Tell me who I'm authenticated as.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/invite/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to a project
      effect: write
      questions:
      - How do I invite a teammate to my project by email?
      - Can I invite an existing user by id with a specific role?
      instructions:
      - text: Invite {email} to this project.
        slots:
          email: requestBody.email
      - text: Invite user {user_id} to the project with role {role}.
        slots:
          user_id: requestBody.user_id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/invite/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List outstanding project invites
      effect: read
      questions:
      - Which project invites are still outstanding?
      - Who have we invited to the project who hasn't joined?
      instructions:
      - text: List pending project invites.
      - text: Show all invites sent for this project.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/invite/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a project invite
      effect: write
      questions:
      - I got an invite code - how do I join the project with it?
      - What permissions do I get after accepting a project invite?
      instructions:
      - text: Accept project invite {invite_code}.
        slots:
          invite_code: requestBody.invite_code
      - text: Join the project using invite code {invite_code}.
        slots:
          invite_code: requestBody.invite_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/invite/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a project invite
      effect: destructive
      questions:
      - Can I revoke a project invite before it's accepted?
      - How do I delete an invite I sent by mistake?
      instructions:
      - text: Delete project invite {invite_code}.
        slots:
          invite_code: requestBody.invite_code
      - text: Revoke the invite with code {invite_code}.
        slots:
          invite_code: requestBody.invite_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/invite/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a project invite
      effect: write
      questions:
      - Can I resend an invite that someone didn't receive?
      - Is there a way to nudge an invitee by sending the project invite again?
      instructions:
      - text: Resend project invite {invite_code}.
        slots:
          invite_code: requestBody.invite_code
      - text: Send the invite {invite_code} again.
        slots:
          invite_code: requestBody.invite_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/{user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's profile
      effect: read
      questions:
      - Can I look up a specific user's profile by id?
      - What details are stored for a given user?
      instructions:
      - text: Get user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show the profile of user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/{user_id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a user by id, incl. tags and permissions
      effect: write
      questions:
      - Can I add notes, tags or a label to a user by their id?
      - How do I change another user's permissions in the project?
      instructions:
      - text: Update user {user_id} with label {label}.
        slots:
          user_id: path.user_id
          label: requestBody.label
      - text: Set permissions {permissions} on user {user_id}.
        slots:
          permissions: requestBody.permissions
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Update my own profile details
      effect: write
      questions:
      - How do I change my own name or profile picture?
      - Can I update the email on my own account?
      instructions:
      - text: Change my name to {first_name} {last_name}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
      - text: Update my own email to {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/{user_id}/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from this project
      effect: destructive
      questions:
      - Can I remove someone from my project without affecting their other projects?
      - What happens to a user's access elsewhere when I remove them from the project?
      instructions:
      - text: Remove user {user_id} from this project.
        slots:
          user_id: path.user_id
      - text: Delete user {user_id} from the project only.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/request_account_deletion'].post
  update:
    x-apievangelist-phrasing:
      intent: Request deletion of my account
      effect: destructive
      questions:
      - How do I request that my whole account be deleted?
      - Is there a way to close my own user account?
      instructions:
      - text: Request deletion of my account.
      - text: Submit a request to delete my user account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/{user_id}/keys/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API key for a user
      effect: write
      questions:
      - How do I generate a new API key for a user?
      - Can I create a key that expires after a number of hours?
      instructions:
      - text: Create an API key for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Create a key labelled {label} for user {user_id} that expires in {ttl_hours} hours.
        slots:
          label: requestBody.label
          user_id: path.user_id
          ttl_hours: requestBody.ttl_hours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/{user_id}/keys/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a user's API keys
      effect: read
      questions:
      - Which API keys does a user have?
      - What keys have been issued to this user id?
      instructions:
      - text: List API keys for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show every key issued to user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/users/{user_id}/keys/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's API key
      effect: destructive
      questions:
      - Can I revoke one of a user's API keys?
      - What happens to integrations using a key once I delete it?
      instructions:
      - text: Delete key {id} for user {user_id}.
        slots:
          id: requestBody.id
          user_id: path.user_id
      - text: Revoke API key {id} belonging to {user_id}.
        slots:
          id: requestBody.id
          user_id: path.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/options/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List available OAuth providers
      effect: read
      questions:
      - Which OAuth providers can I connect accounts from?
      - What third-party sign-in options are supported for integrations?
      instructions:
      - text: List the available OAuth options.
      - text: Show which OAuth providers I can connect.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/get_url'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an OAuth connection for a provider
      effect: write
      questions:
      - How do I start connecting a third-party account via OAuth?
      - Can I reconnect an existing OAuth account to request more scopes?
      instructions:
      - text: Get an OAuth URL for {provider} with {types} scopes, redirecting to {redirect_url}.
        slots:
          provider: requestBody.provider
          types: requestBody.types
          redirect_url: requestBody.redirect_url
      - text: Reauthorize account {existing_oauth_account_id} on {provider} for {types}, returning to {redirect_url}.
        slots:
          existing_oauth_account_id: requestBody.existing_oauth_account_id
          provider: requestBody.provider
          types: requestBody.types
          redirect_url: requestBody.redirect_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mcp/oauth/get_url'].post
  update:
    x-apievangelist-phrasing:
      intent: Start OAuth for a remote MCP server
      effect: write
      questions:
      - How do I authorize a remote MCP server that requires OAuth?
      - Can I supply my own client id and secret when connecting an MCP server?
      instructions:
      - text: Start OAuth for MCP server {mcp_name} at {url} in project {project}, redirecting to {redirect_url}.
        slots:
          mcp_name: requestBody.mcp_name
          url: requestBody.url
          project: requestBody.project
          redirect_url: requestBody.redirect_url
      - text: Authorize MCP {mcp_name} at {url} for project {project} with client {client_id}, returning to {redirect_url}.
        slots:
          mcp_name: requestBody.mcp_name
          url: requestBody.url
          project: requestBody.project
          client_id: requestBody.client_id
          redirect_url: requestBody.redirect_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/callback'].get
  update:
    x-apievangelist-phrasing:
      intent: Complete an OAuth redirect callback
      effect: read
      questions:
      - Where does the OAuth provider send the user back after they authorize?
      - What happens when an OAuth redirect returns an error?
      instructions:
      - text: Handle the OAuth callback with code {code} and state {state}.
        slots:
          code: query.code
          state: query.state
      - text: Process the OAuth callback error {error}.
        slots:
          error: query.error
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/access_token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a short-lived access token for a connected account
      effect: read
      questions:
      - Can I get a short-lived OAuth token for client-side use, like a file picker?
      - Which providers allow fetching an access token for a connected account?
      instructions:
      - text: Get a short-lived access token for {provider} account {account_id}.
        slots:
          provider: requestBody.provider
          account_id: requestBody.account_id
      - text: Fetch a client-side token for connected account {account_id} on {provider}.
        slots:
          account_id: requestBody.account_id
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/accounts/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List my connected OAuth accounts
      effect: read
      questions:
      - Which OAuth accounts have I connected?
      - Can I filter connected OAuth accounts by asset?
      instructions:
      - text: List my connected OAuth accounts.
      - text: Show OAuth accounts matching {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Search connected provider accounts
      effect: read
      questions:
      - Can I search my connected accounts by name and status?
      - Which provider accounts are connected versus disconnected?
      instructions:
      - text: List provider accounts sorted by {sort_by}, page {page} of {page_size}.
        slots:
          sort_by: requestBody.sort_by
          page: requestBody.page
          page_size: requestBody.page_size
      - text: Search accounts for {query} sorted by {sort_by}, page {page}, {page_size} per page.
        slots:
          query: requestBody.query
          sort_by: requestBody.sort_by
          page: requestBody.page
          page_size: requestBody.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/accounts/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect an OAuth account
      effect: destructive
      questions:
      - How do I disconnect an OAuth account I linked?
      - Can I delete a stored OAuth token?
      instructions:
      - text: Delete OAuth account {account_id}.
        slots:
          account_id: requestBody.account_id
      - text: Disconnect and remove the token for account {account_id}.
        slots:
          account_id: requestBody.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/{account_id}/link/tool'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an OAuth account to a tool
      effect: write
      questions:
      - Can I make a tool always use a specific connected account?
      - What kinds of links can I set between an OAuth account and a tool?
      instructions:
      - text: Link OAuth account {account_id} to tool {tool_id} as {link_type}.
        slots:
          account_id: path.account_id
          tool_id: requestBody.tool_id
          link_type: requestBody.link_type
      - text: Set tool {tool_id} to use account {account_id} with link type {link_type}.
        slots:
          tool_id: requestBody.tool_id
          account_id: path.account_id
          link_type: requestBody.link_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/oauth/{account_id}/link/tool/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlink an OAuth account from a tool
      effect: destructive
      questions:
      - How do I stop a tool from using a particular connected account?
      - Can I remove the link between an OAuth account and a tool?
      instructions:
      - text: Unlink OAuth account {account_id} from tool {tool_id}.
        slots:
          account_id: path.account_id
          tool_id: requestBody.tool_id
      - text: Remove the tool link between {tool_id} and account {account_id}.
        slots:
          tool_id: requestBody.tool_id
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/pipedream/connect_token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a Pipedream Connect token
      effect: write
      questions:
      - How do I get a token to start connecting an account through Pipedream?
      - What is a Pipedream Connect token used for here?
      instructions:
      - text: Get a Pipedream Connect token.
      - text: Issue a new Pipedream Connect token for account linking.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/pipedream/apps/{slug_name}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an app is a Pipedream-backed integration
      effect: read
      questions:
      - Is a given app integration backed by Pipedream?
      - Can I look up a Pipedream app by its slug?
      instructions:
      - text: Check whether app {slug_name} is Pipedream backed.
        slots:
          slug_name: path.slug_name
      - text: Get the Pipedream app {slug_name}.
        slots:
          slug_name: path.slug_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/pipedream/connect/callback/success'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a successful Pipedream account connection
      effect: write
      questions:
      - What gets called after a user successfully connects an account through Pipedream?
      - Can I set sharing when saving a newly connected Pipedream account?
      instructions:
      - text: Record Pipedream account {account_id} for external user {external_user_id} as connected.
        slots:
          account_id: requestBody.account_id
          external_user_id: requestBody.external_user_id
      - text: Save connected Pipedream account {account_id} for {external_user_id} with sharing {sharing_permission}.
        slots:
          account_id: requestBody.account_id
          external_user_id: requestBody.external_user_id
          sharing_permission: requestBody.sharing_permission
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/pipedream/connect/callback/failed'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a failed Pipedream account connection
      effect: write
      questions:
      - What happens when connecting an account through Pipedream fails?
      - Can I report the error message from a failed Pipedream connection?
      instructions:
      - text: 'Report failed Pipedream connection {name} for {provider}: {message}.'
        slots:
          name: requestBody.name
          provider: requestBody.provider
          message: requestBody.message
      - text: Log the Pipedream failure {name} with message {message} on provider {provider}.
        slots:
          name: requestBody.name
          message: requestBody.message
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/arcade/twitter/url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the OAuth URL for connecting X (Twitter)
      effect: read
      questions:
      - How do I connect an X (Twitter) account through Arcade?
      - Where do I get the authorization link for Twitter?
      instructions:
      - text: Get the Arcade OAuth URL for X (Twitter).
      - text: Give me the link to authorize my Twitter account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/arcade/twitter/callback'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete the X (Twitter) OAuth connection
      effect: write
      questions:
      - What finalizes an X (Twitter) connection after the Arcade OAuth window?
      - Can I choose sharing permission when completing the Twitter connection?
      instructions:
      - text: Complete the Twitter connection with Arcade key {arcade_id_key}.
        slots:
          arcade_id_key: requestBody.arcade_id_key
      - text: Finish X OAuth for {arcade_id_key} with sharing {sharing_permission}.
        slots:
          arcade_id_key: requestBody.arcade_id_key
          sharing_permission: requestBody.sharing_permission
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/organization/{organization_id}/user/{user_id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a user's role in an organization
      effect: write
      questions:
      - How do I make a user an admin of my organization?
      - Can I change someone's organization role?
      instructions:
      - text: Set user {user_id} in organization {organization_id} admin to {admin}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
          admin: requestBody.admin
      - text: Give user {user_id} role {role} in {organization_id} with admin {admin}.
        slots:
          user_id: path.user_id
          role: requestBody.role
          organization_id: path.organization_id
          admin: requestBody.admin
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/asset/user/{user_id}/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a user's role on an asset
      effect: write
      questions:
      - Can I give a user editor access to one specific agent?
      - Is it possible to change a user's role on a single shared asset?
      instructions:
      - text: Give user {user_id} role {role} on asset {asset_context}.
        slots:
          user_id: path.user_id
          role: requestBody.role
          asset_context: requestBody.asset_context
      - text: Change {user_id}'s access on {asset_context} to {role}.
        slots:
          user_id: path.user_id
          asset_context: requestBody.asset_context
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/rename'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a connected account
      effect: write
      questions:
      - Can I give a connected account a friendlier name?
      - How do I change the label on a linked account?
      instructions:
      - text: Rename account {account_id} to {label}.
        slots:
          account_id: path.account_id
          label: requestBody.label
      - text: Change the label of connected account {account_id} to {label}.
        slots:
          account_id: path.account_id
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/namespace'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the namespace of an OAuth account
      effect: write
      questions:
      - Can I set a namespace on an OAuth account?
      - What does changing a connected account's namespace do?
      instructions:
      - text: Set namespace {namespace} on OAuth account {account_id}.
        slots:
          namespace: requestBody.namespace
          account_id: path.account_id
      - text: Move account {account_id} to namespace {namespace}.
        slots:
          account_id: path.account_id
          namespace: requestBody.namespace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/slack/users/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List Slack users for a connected account
      effect: read
      questions:
      - Who are the Slack users visible to my connected Slack account?
      - Can I see the members of the Slack workspace I linked?
      instructions:
      - text: List Slack users for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show the Slack workspace members on {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/slack/channels/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List Slack channels for a connected account
      effect: read
      questions:
      - Which Slack channels can my connected account see?
      - Can I search Slack channels by name or filter by channel type?
      instructions:
      - text: List Slack channels for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Search Slack channels on {account_id} for {search_query}.
        slots:
          account_id: path.account_id
          search_query: query.search_query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/slack/dms/open'].post
  update:
    x-apievangelist-phrasing:
      intent: Open Slack DMs with users by email
      effect: write
      questions:
      - How can I make a Slack DM show up as a trigger channel option?
      - Can I open direct message channels with several people by email?
      instructions:
      - text: Open Slack DMs on account {account_id} with {emails}.
        slots:
          account_id: path.account_id
          emails: requestBody.emails
      - text: Start direct messages with {emails} via Slack account {account_id}.
        slots:
          emails: requestBody.emails
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/teams/users/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List Microsoft Teams users for an account
      effect: read
      questions:
      - Which Teams users can my connected Microsoft account see?
      - Can I search Teams users by name and page with a cursor?
      instructions:
      - text: List Teams users for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Search Teams users on {account_id} for {search_query}.
        slots:
          account_id: path.account_id
          search_query: query.search_query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/teams/channels/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List Microsoft Teams channels for an account
      effect: read
      questions:
      - Which Teams channels are available to my connected account?
      - What channels could an agent post to in Microsoft Teams?
      instructions:
      - text: List Teams channels for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show the Microsoft Teams channels on {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/teams/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List Teams group chats (all at once)
      effect: read
      questions:
      - Which Teams group chats is my connected account part of?
      - Can I get all group chats in one response without paging?
      instructions:
      - text: List Teams group chats for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show every group chat {account_id} participates in, unpaged.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/teams/groups/v2'].get
  update:
    x-apievangelist-phrasing:
      intent: List Teams group chats with cursor paging
      effect: read
      questions:
      - Is there a paginated way to list Teams group chats when there are many?
      - How do I get the next page of Teams group chats using a cursor?
      instructions:
      - text: List Teams group chats for {account_id} using cursor pagination.
        slots:
          account_id: path.account_id
      - text: Get the next {page_size} Teams group chats for {account_id} after cursor {cursor}.
        slots:
          page_size: query.page_size
          account_id: path.account_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/auth/accounts/{account_id}/missing-scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: Find missing scopes on an OAuth account
      effect: read
      questions:
      - Why is a tool failing - is my connected account missing scopes?
      - Which permissions still need to be granted on an OAuth account?
      instructions:
      - text: Show missing scopes for OAuth account {account_id}.
        slots:
          account_id: path.account_id
      - text: Check which scopes account {account_id} still lacks.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/overlays/relevance-ai-auth-api-phrasing-overlay.yaml