# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for authentik Agents API
  version: 1.0.0
extends: openapi/authentik-agents-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: 6
- target: $.paths['/agents/agents/'].get
  update:
    x-apievangelist-phrasing:
      intent: List agent identities
      effect: read
      questions:
      - Which delegate agent identities have been provisioned in authentik?
      - Can I see only the agents created on behalf of one parent user?
      instructions:
      - text: List all agent identities.
      - text: Show the agents that belong to parent user {parent}.
        slots:
          parent: query.parent
      - text: Search agent identities for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/agents/'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision an agent identity for a user
      effect: write
      questions:
      - How do I create a delegate identity that acts for a user, like an AI agent?
      - Can a new agent identity be set to expire at a certain time?
      instructions:
      - text: Create an agent for parent user {parent} labeled {label}.
        slots:
          parent: requestBody.parent
          label: requestBody.label
      - text: Provision an agent under {parent} that expires at {expires}.
        slots:
          parent: requestBody.parent
          expires: requestBody.expires
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/agents/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent identity
      effect: read
      questions:
      - What are the details of one agent identity, including its parent user?
      - When does a particular delegate agent expire?
      instructions:
      - text: Show agent {id}.
        slots:
          id: path.id
      - text: Look up the expiry and parent of agent identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/agents/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an agent identity's profile
      effect: write
      questions:
      - How do I overwrite an agent's username, display name and email all at once?
      - Which fields are required when fully replacing an agent identity?
      instructions:
      - text: Replace agent {id} with username {username} and display name {name}.
        slots:
          id: path.id
          username: requestBody.username
          name: requestBody.name
      - text: 'Fully update agent {id}: username {username}, name {name}, email {email}.'
        slots:
          id: path.id
          username: requestBody.username
          name: requestBody.name
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/agents/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent identity
      effect: destructive
      questions:
      - How do I permanently remove a delegate agent identity?
      - Can I delete an agent that is no longer needed by its parent user?
      instructions:
      - text: Delete agent {id}.
        slots:
          id: path.id
      - text: Permanently remove the agent identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/agents/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change settings on an agent identity
      effect: write
      questions:
      - Can I deactivate an agent without deleting it?
      - How do I push back the expiry date on an existing agent?
      instructions:
      - text: Set agent {id} active status to {is_active}.
        slots:
          id: path.id
          is_active: requestBody.is_active
      - text: Extend agent {id} so it expires at {expires}.
        slots:
          id: path.id
          expires: requestBody.expires
      method: generated
      generated: '2026-09-26'