Import Agent

Import a serialized agent file and recreate the agent(s) in the system. Returns the IDs of all imported agents.

Request

This endpoint expects a multipart form containing a file.

filefileRequired

append_copy_suffixbooleanOptionalDefaults to trueDeprecated

If set to True, appends “_copy” to the end of the agent name.

override_namestring or nullOptional

If provided, overrides the agent name with this value.

override_existing_toolsbooleanOptionalDefaults to true

If set to True, existing tools can get their source code overwritten by the uploaded tool definitions. Note that Letta core tools can never be updated externally.

override_embedding_handlestring or nullOptional

Override import with specific embedding handle.

project_idstring or nullOptional

The project ID to associate the uploaded agent with.

strip_messagesbooleanOptionalDefaults to false

If set to True, strips all messages from the agent before importing.

env_vars_jsonstring or nullOptional

Environment variables as a JSON string to pass to the agent for tool execution.

Response

Successful Response

agent_idslist of strings

List of IDs of the imported agents

1	import { LettaClient } from "@letta-ai/letta-client";
2	import * as fs from "fs";
3
4	const client = new LettaClient({ token: "YOUR_TOKEN", project: "YOUR_PROJECT" });
5	await client.agents.importFile(fs.createReadStream("/path/to/your/file"), {
6	overrideEmbeddingModel: "x-override-embedding-model"
7	});

Import Agent

Headers

Request

Response

Errors