Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Users API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/users'].post
$.paths['/users/verify'].post
$.paths['/users/login'].post
$.paths['/users/verify/resend'].post
$.paths['/users/login/token'].post
$.paths['/users/reset/request'].post
$.paths['/users/reset/confirm'].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 Getemboss Ai Users API
  version: 1.0.0
extends: openapi/getemboss-ai-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign up for a new account
      effect: write
      questions:
      - How do I create an account with email and password?
      - Is a bot-check token required to sign up?
      instructions:
      - text: Sign up {email} with password {password} and Turnstile token {turnstile_token}.
        slots:
          email: requestBody.email
          password: requestBody.password
          turnstile_token: requestBody.turnstile_token
      - text: Register a new account for {email} using {password}, verified by {turnstile_token}.
        slots:
          email: requestBody.email
          password: requestBody.password
          turnstile_token: requestBody.turnstile_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a new account's email
      effect: write
      questions:
      - How do I confirm my email after signing up?
      - Can I verify with the emailed code instead of clicking the link?
      instructions:
      - text: Verify my account with link token {token}.
        slots:
          token: requestBody.token
      - text: Verify {email} using code {code}.
        slots:
          email: requestBody.email
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/login'].post
  update:
    x-apievangelist-phrasing:
      intent: Log in to the website with a password
      effect: write
      questions:
      - How do I sign in to my web account with my password?
      - What happens when I log in with an email that isn't verified yet?
      instructions:
      - text: Log in as {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Sign {email} into the website using {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/verify/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend the email verification code
      effect: write
      questions:
      - I never got my verification email; can it be resent?
      - Does resending verification reveal whether an email is registered?
      instructions:
      - text: Resend the verification code to {email} with Turnstile token {turnstile_token}.
        slots:
          email: requestBody.email
          turnstile_token: requestBody.turnstile_token
      - text: Send {email} a fresh verification link, bot check {turnstile_token}.
        slots:
          email: requestBody.email
          turnstile_token: requestBody.turnstile_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/login/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign in with a one-time login token
      effect: write
      questions:
      - How does clicking the verification link sign me in without a password?
      - Can a one-time login token be redeemed for a session?
      instructions:
      - text: Sign in {email} with one-time login token {login_token}.
        slots:
          email: requestBody.email
          login_token: requestBody.login_token
      - text: Redeem login token {login_token} for {email}.
        slots:
          login_token: requestBody.login_token
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/reset/request'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a password reset email
      effect: write
      questions:
      - I forgot my password; how do I get a reset link?
      - Is a bot-check needed to request a password reset?
      instructions:
      - text: Send a password reset to {email} with Turnstile token {turnstile_token}.
        slots:
          email: requestBody.email
          turnstile_token: requestBody.turnstile_token
      - text: Request a reset link for {email}, bot check {turnstile_token}.
        slots:
          email: requestBody.email
          turnstile_token: requestBody.turnstile_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/reset/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a new password with a reset token
      effect: write
      questions:
      - How do I set a new password after getting the reset email?
      - Can a reset token be used to choose a new password?
      instructions:
      - text: Set my password to {new_password} using reset token {token}.
        slots:
          new_password: requestBody.new_password
          token: requestBody.token
      - text: Confirm password reset {token} with new password {new_password}.
        slots:
          token: requestBody.token
          new_password: requestBody.new_password
      method: generated
      generated: '2026-10-01'