API Evangelist conversational phrasing for Relevance AI Endpoints Projects API

# 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 Projects API
  version: 1.0.0
extends: openapi/relevance-ai-projects-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: 33
- target: $.paths['/projects/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project in an organization
      effect: write
      questions:
      - How do I create a new project inside my organization?
      - Can I give a new project a description and language when creating it?
      instructions:
      - text: Create a project named {name} in organization {organization_id}.
        slots:
          name: requestBody.name
          organization_id: requestBody.organization_id
      - text: Make a new project {name} in {organization_id} described as {description}.
        slots:
          name: requestBody.name
          organization_id: requestBody.organization_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update the current project's details
      effect: write
      questions:
      - Can I rename my current project or change its description?
      - How do I change the default language of an existing project?
      instructions:
      - text: Rename the current project to {name}.
        slots:
          name: requestBody.name
      - text: Set this project's language to {language}.
        slots:
          language: requestBody.language
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List my projects
      effect: read
      questions:
      - Which projects do I have access to?
      - Can I page through all my projects and their metadata?
      instructions:
      - text: List all my projects.
      - text: Show page {page} of my projects, {page_size} per page.
        slots:
          page: query.page
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/organization_info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization a project belongs to
      effect: read
      questions:
      - Which organization does my current project belong to?
      - What organization details are attached to this project?
      instructions:
      - text: Get organization info for the current project.
      - text: Show which organization owns this project.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/keys/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List keys configured on a project
      effect: read
      questions:
      - Which third-party keys have been set on my project?
      - What project keys exist right now?
      instructions:
      - text: List the keys set on this project.
      - text: Show which project keys are configured.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/keys/availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Check API key availability incl. org fallbacks
      effect: read
      questions:
      - Are API keys available to this project from the organization level if not set on the project?
      - Which native API keys can my project actually use?
      instructions:
      - text: Show API key availability for this project including organization fallbacks.
      - text: Check which native API keys this project can fall back to from its organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/keys/types/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List valid project key types
      effect: read
      questions:
      - What kinds of keys can I store on a project?
      - Can I filter the supported project key types by tag?
      instructions:
      - text: List all valid project key types.
      - text: Show project key types tagged {tags}.
        slots:
          tags: query.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/keys/set'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a key on a project
      effect: write
      questions:
      - How do I store a third-party API key on my project?
      - Can I overwrite a project key with a new value?
      instructions:
      - text: Set project key {key} to {value}.
        slots:
          key: requestBody.key
          value: requestBody.value
      - text: Store {value} as the project's {key} key.
        slots:
          value: requestBody.value
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/keys/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a key from a project
      effect: destructive
      questions:
      - Can I remove a stored key from my project?
      - What happens when I delete a project key my tools depend on?
      instructions:
      - text: Delete project key {key}.
        slots:
          key: requestBody.key
      - text: Remove the {key} key from this project.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/snippets/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a project snippet
      effect: write
      questions:
      - Can I save reusable text snippets at the project level?
      - How do I edit the content of an existing project snippet?
      instructions:
      - text: Create snippet {name} with content {content} at order {order}.
        slots:
          name: requestBody.name
          content: requestBody.content
          order: requestBody.order
      - text: Update snippet {_id} named {name} to {content} at position {order}.
        slots:
          _id: requestBody._id
          name: requestBody.name
          content: requestBody.content
          order: requestBody.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/snippets/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's snippets
      effect: read
      questions:
      - Which snippets are saved in my project?
      - Can I see where each project snippet is referenced?
      instructions:
      - text: List this project's snippets.
      - text: Show project snippets with their references, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/snippets/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a project snippet
      effect: destructive
      questions:
      - Is it possible to delete a snippet from my project?
      - What happens to agents that use a snippet I delete?
      instructions:
      - text: Delete project snippet {id}.
        slots:
          id: requestBody.id
      - text: Remove snippet {id} from the project.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/delete_job'].get
  update:
    x-apievangelist-phrasing:
      intent: See the latest delete job and resource counts
      effect: read
      questions:
      - Before deleting a project, how many resources does it still contain?
      - Is there already a delete job running for my project?
      instructions:
      - text: Show the latest delete job and resource counts for project {project_id}.
        slots:
          project_id: path.project_id
      - text: Check whether project {project_id} has a delete job and what it contains.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/delete_job'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a project and all its resources
      effect: destructive
      questions:
      - How do I permanently delete a project and everything in it?
      - Does deleting a project remove all its agents and tools too?
      instructions:
      - text: Delete project {project_id} and all its resources.
        slots:
          project_id: path.project_id
      - text: Start a job to wipe and delete project {project_id}.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/delete_job/{project_deletion_job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check progress of a project delete job
      effect: read
      questions:
      - How far along is my project deletion?
      - How many resources are left while a project delete job runs?
      instructions:
      - text: Get project delete job {project_deletion_job_id}.
        slots:
          project_deletion_job_id: path.project_deletion_job_id
      - text: Show remaining resources for deletion job {project_deletion_job_id}.
        slots:
          project_deletion_job_id: path.project_deletion_job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/usage-alarms/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's usage alarms
      effect: read
      questions:
      - What usage alarms are set on my project?
      - Which spending thresholds will alert or block this project?
      instructions:
      - text: List usage alarms for project {project_id}.
        slots:
          project_id: path.project_id
      - text: Show every usage threshold alarm on {project_id}.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/usage-alarms/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a usage alarm
      effect: write
      questions:
      - Can I get alerted when my project's usage passes a threshold?
      - How do I make a project stop running once usage hits a limit?
      instructions:
      - text: Set a {usage_type} alarm on project {project_id} at {usage_threshold} with action {alarm_action}.
        slots:
          usage_type: requestBody.usage_type
          project_id: path.project_id
          usage_threshold: requestBody.usage_threshold
          alarm_action: requestBody.alarm_action
      - text: Change the {alarm_action} alarm for {usage_type} on {project_id} to trigger at {usage_threshold}.
        slots:
          alarm_action: requestBody.alarm_action
          usage_type: requestBody.usage_type
          project_id: path.project_id
          usage_threshold: requestBody.usage_threshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/usage-alarms/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a usage alarm
      effect: destructive
      questions:
      - How do I remove a usage alarm from my project?
      - Can I drop just one alarm action for a usage type?
      instructions:
      - text: Delete the {alarm_action} alarm for {usage_type} on project {project_id}.
        slots:
          alarm_action: requestBody.alarm_action
          usage_type: requestBody.usage_type
          project_id: path.project_id
      - text: Remove project {project_id}'s {usage_type} usage alarm with action {alarm_action}.
        slots:
          project_id: path.project_id
          usage_type: requestBody.usage_type
          alarm_action: requestBody.alarm_action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/usage-alarms/is-blocking'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if usage alarms are blocking a project
      effect: read
      questions:
      - Why are my agents being blocked - has a usage alarm tripped?
      - Is my project or its organization currently blocked by usage limits?
      instructions:
      - text: Check whether project {project_id} is blocked by usage alarms.
        slots:
          project_id: path.project_id
      - text: Tell me if usage alarms are blocking actions on {project_id}.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/feature_gates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get features available to a project
      effect: read
      questions:
      - Which features are enabled for my project?
      - Does this project have access to a particular gated feature?
      instructions:
      - text: Get feature gates for project {project_id}.
        slots:
          project_id: path.project_id
      - text: Show the features available on {project_id}.
        slots:
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/streaming-token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project-wide streaming token
      effect: read
      questions:
      - How can a client subscribe to refresh events across all conversations in a project?
      - Can I get one streaming token for the whole project rather than per conversation?
      instructions:
      - text: Get a project-wide streaming token.
      - text: Issue a streaming token for cross-conversation refresh events in this project.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/settings/{setting_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a single project setting
      effect: read
      questions:
      - What is the current value of a specific project setting?
      - Can I read one setting on a project by its id?
      instructions:
      - text: Get setting {setting_id} on project {project_id}.
        slots:
          setting_id: path.setting_id
          project_id: path.project_id
      - text: Show the value of {setting_id} for {project_id}.
        slots:
          setting_id: path.setting_id
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/settings/{setting_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a project setting
      effect: write
      questions:
      - How do I change one of my project's settings?
      - Can an admin overwrite a project setting value?
      instructions:
      - text: Set {setting_id} on project {project_id} to {payload}.
        slots:
          setting_id: path.setting_id
          project_id: path.project_id
          payload: requestBody.payload
      - text: Update project {project_id}'s setting {setting_id} with {payload}.
        slots:
          project_id: path.project_id
          setting_id: path.setting_id
          payload: requestBody.payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Read several project settings at once
      effect: read
      questions:
      - Can I fetch several named project settings in one request?
      - What values do a set of project settings currently hold?
      instructions:
      - text: Get settings {setting_names} for project {project_id}.
        slots:
          setting_names: requestBody.setting_names
          project_id: path.project_id
      - text: Show the values of {setting_names} on {project_id}.
        slots:
          setting_names: requestBody.setting_names
          project_id: path.project_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/mcp/upsert'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update a project MCP server
      effect: write
      questions:
      - How do I connect an MCP server to my whole project?
      - Will adding an MCP server with a URL that already exists update it instead?
      instructions:
      - text: Add MCP server {url} to the project as {label}.
        slots:
          url: requestBody.url
          label: requestBody.label
      - text: Update project MCP server {display_id} to point to {url}.
        slots:
          display_id: requestBody.display_id
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/mcp/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List a project's MCP servers
      effect: read
      questions:
      - Which MCP servers are configured for my project?
      - What authentication type does each project MCP server use?
      instructions:
      - text: List the project's MCP servers.
      - text: Show all MCP server configurations with their auth details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/mcp/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a project MCP server
      effect: destructive
      questions:
      - Can I disconnect an MCP server from my project?
      - What if the MCP server I try to delete doesn't exist?
      instructions:
      - text: Delete project MCP server {display_id}.
        slots:
          display_id: requestBody.display_id
      - text: Remove MCP server {display_id} from this project.
        slots:
          display_id: requestBody.display_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/mcp/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one project MCP server's config
      effect: read
      questions:
      - What URL and label does a specific project MCP server have?
      - Can I inspect the auth details of one MCP server by its display id?
      instructions:
      - text: Get project MCP server {display_id}.
        slots:
          display_id: requestBody.display_id
      - text: Show URL and auth details of MCP server {display_id}.
        slots:
          display_id: requestBody.display_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{asset_type}/{asset_id}/access_configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get general access settings for an asset
      effect: read
      questions:
      - Is this agent visible to everyone in the project or only invited people?
      - What role do project members get on a shared asset?
      instructions:
      - text: Get access configuration for {asset_type} {asset_id}.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      - text: Show who can access {asset_type} {asset_id} by default.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{asset_type}/{asset_id}/access_configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Set general access for an asset
      effect: write
      questions:
      - Can I share an asset with everyone in my project at once?
      - How do I restrict an asset to only people I've invited?
      instructions:
      - text: Set general access for {asset_type} {asset_id}.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      - text: Restrict {asset_type} {asset_id} to invited users only.
        slots:
          asset_type: path.asset_type
          asset_id: path.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job-priorities/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List job priority tiers in a project
      effect: read
      questions:
      - Which agents, tools or workforces have a custom job priority?
      - What priority tiers are set in this project?
      instructions:
      - text: List job priority tiers for this project.
      - text: Show every entity with a non-default job priority.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job-priorities/set'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the job priority for an agent, tool or workforce
      effect: write
      questions:
      - Can I make one agent's jobs run at a higher priority?
      - How do I change the priority tier of a workforce?
      instructions:
      - text: Set {priority_entity} {entity_id} to priority tier {priority_tier}.
        slots:
          priority_entity: requestBody.priority_entity
          entity_id: requestBody.entity_id
          priority_tier: requestBody.priority_tier
      - text: Give {priority_entity} {entity_id} the {priority_tier} job priority.
        slots:
          priority_entity: requestBody.priority_entity
          entity_id: requestBody.entity_id
          priority_tier: requestBody.priority_tier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/job-priorities/unset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset job priority to the Medium default
      effect: destructive
      questions:
      - How do I put an agent back to the default Medium priority?
      - Can I clear a custom priority tier I set on a tool?
      instructions:
      - text: Unset job priority for {priority_entity} {entity_id}.
        slots:
          priority_entity: requestBody.priority_entity
          entity_id: requestBody.entity_id
      - text: Revert {priority_entity} {entity_id} to Medium priority.
        slots:
          priority_entity: requestBody.priority_entity
          entity_id: requestBody.entity_id
      method: generated
      generated: '2026-09-26'