Cereal docs
TypeScript SDKTypeScript signatures

client.agents

TypeScript client.agents signature, generated from CerealClient.

This is the TypeScript interface. See client setup and behavior.

interface ClientSurface {
readonly agents: {
    experimentResults(input: {
        readonly id: string;
        readonly experiment: string;
        readonly revision: string;
    }): Promise<import("./types.js").ExperimentResults>;
    list(input?: {
        readonly includeDerived?: boolean;
    }): Promise<ReadonlyArray<Agent>>;
    get(input: {
        readonly id: string;
    }): Promise<Agent>;
    getBySlug(input: {
        readonly slug: string;
    }): Promise<Agent>;
    create(input: {
        readonly definition: AgentDefinition;
    }): Promise<AgentVersion>;
    update(input: {
        readonly id: string;
        readonly definition: AgentDefinition;
        readonly expectedVersion?: number;
    }): Promise<AgentVersion>;
    upsert(input: {
        readonly slug: string;
        readonly definition: AgentDefinition;
    }): Promise<AgentVersion>;
    versions(input: {
        readonly id: string;
    }): Promise<ReadonlyArray<AgentVersion>>;
    imageStatus(input: {
        readonly id: string;
        readonly version?: number;
    }): Promise<ImageStatusReport>;
    rebake(input: {
        readonly id: string;
    }): Promise<ImageStatusReport>;
    copyToEnvironment(input: {
        readonly agentId: string;
        readonly version?: number;
        readonly to: string;
        readonly mapping?: {
            readonly connections?: Readonly<Record<string, string>>;
            readonly providers?: Readonly<Record<string, string>>;
            readonly secrets?: Readonly<Record<string, string>>;
        };
        readonly dryRun?: boolean;
    }): Promise<AgentVersion>;
};
}

For the wire contract, use HTTP reference. Composite helpers are explained in the API/SDK map.