Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Agent Tasks API

3 actions 3 updates phrasing extends openapi/clerk-com-agent-tasks-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/agents/tasks'].post

$.paths['/agents/tasks/{agent_task_id}/revoke'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Backend Agent Tasks API
  version: 1.0.0
extends: openapi/clerk-com-agent-tasks-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: 2
- target: $.paths['/agents/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent task acting for a user
      effect: write
      questions:
      - How do I let an AI agent act on behalf of a user with a session link?
      - Can I cap how long the agent's session lasts?
      instructions:
      - text: Create agent task for {agent_name} on behalf of {on_behalf_of} with permissions {permissions}, task {task_description}, redirect {redirect_url}.
        slots:
          agent_name: requestBody.agent_name
          on_behalf_of: requestBody.on_behalf_of
          permissions: requestBody.permissions
          task_description: requestBody.task_description
          redirect_url: requestBody.redirect_url
      - text: Let agent {agent_name} act for {on_behalf_of} on {task_description} with {permissions}, redirect {redirect_url}, max {session_max_duration_in_seconds}s.
        slots:
          agent_name: requestBody.agent_name
          on_behalf_of: requestBody.on_behalf_of
          task_description: requestBody.task_description
          permissions: requestBody.permissions
          redirect_url: requestBody.redirect_url
          session_max_duration_in_seconds: requestBody.session_max_duration_in_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agents/tasks/{agent_task_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a pending agent task
      effect: destructive
      questions:
      - How do I cancel an agent task before the agent uses its link?
      - Can a pending agent task be revoked?
      instructions:
      - text: Revoke agent task {agent_task_id}.
        slots:
          agent_task_id: path.agent_task_id
      - text: Cancel pending agent task {agent_task_id}.
        slots:
          agent_task_id: path.agent_task_id
      method: generated
      generated: '2026-09-26'