Skip to main content

revoke()

Warning

Agent Tasks are currently in beta. If you run into any issues, please reach out to our support team.

Revokes the given Agent Task.

Returns the revoked AgentTask object.

function revoke(agentTaskId: string): Promise<Omit<AgentTask, "url">>

Parameters

  • Name
    agentTaskId
    Type
    string
    Description

    The ID of the Agent Task to revoke.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

await clerkClient.agentTasks.revoke('agttsk_123')

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/agents/tasks/{agent_task_id}/revoke. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub