@clerk/testing/dist/types/common/agent-task.d.ts

Utilities to help you create E2E test suites for apps using Clerk

import type { AgentTask, ClerkClient } from '@clerk/backend';
export type CreateAgentTaskParams = Parameters<ClerkClient['agentTasks']['create']>[0] & ({
    /**
     * The API URL for your Clerk instance.
     * If not provided, falls back to the `CLERK_API_URL` environment variable.
     */
    apiUrl?: string;
    /**
     * The secret key for your Clerk instance.
     * If not provided, falls back to the `CLERK_SECRET_KEY` environment variable.
     */
    secretKey?: string;
    clerkClient?: never;
} | {
    /**
     * The Clerk client to use to create the agent task.
     * If not provided, a new Clerk client will be created.
     */
    clerkClient?: ClerkClient;
    apiUrl?: string;
    secretKey?: string;
});
export declare const ERROR_MISSING_SECRET_KEY: string;
export declare const ERROR_MISSING_API_URL: string;
export declare const ERROR_AGENT_TASK_FAILED = "Failed to create agent task: ";
/**
 * Creates an agent task using the Clerk Backend API and returns its URL.
 *
 * @internal Framework-specific wrappers should call this after resolving the secret key.
 *
 * @experimental This is an experimental API for the Agent Tasks feature that is available under a private beta,
 * and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version
 * and the clerk-js version to avoid breaking changes.
 */
export declare function createAgentTestingTask(params: CreateAgentTaskParams): Promise<AgentTask>;
//# sourceMappingURL=agent-task.d.ts.map