Forest Admin - API reference
    Preparing search index...

    Variable createForestAgentClientConst

    createForestAgentClient: (
        options: {
            agentForestAuthSecret: string;
            agentForestEnvSecret: string;
            agentSchemaPath: string;
            agentUrl: string;
            serverUrl: string;
        },
    ) => Promise<AgentTestClient> = createAgentTestClient

    Type Declaration

      • (
            options: {
                agentForestAuthSecret: string;
                agentForestEnvSecret: string;
                agentSchemaPath: string;
                agentUrl: string;
                serverUrl: string;
            },
        ): Promise<AgentTestClient>
      • Create a test client to test your agent customizations by sending requests to the agent like the frontend does. With this client, you should start your agent by yourself. You can test any agent with this client (python, ruby, nodeJs, etc.)

        Parameters

        • options: {
              agentForestAuthSecret: string;
              agentForestEnvSecret: string;
              agentSchemaPath: string;
              agentUrl: string;
              serverUrl: string;
          }

        Returns Promise<AgentTestClient>

    Use createAgentTestClient instead