Import Agent

client.agents.importFile(, ?): AgentImportFileResponse { agent_ids }

POST/v1/agents/import

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

ParametersExpand Collapse

params: AgentImportFileParams { file, append_copy_suffix, embedding, 11 more }

file: Uploadable

Body param

Deprecatedappend_copy_suffix?: boolean

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

embedding?: string | null

Body param: Embedding handle to override with.

Deprecatedenv_vars_json?: string | null

Body param: Environment variables as a JSON string to pass to the agent for tool execution. Use ‘secrets’ instead.

model?: string | null

Body param: Model handle to override the agent’s default model. This allows the imported agent to use a different model while keeping other defaults (e.g., context size) from the original configuration.

name?: string | null

Body param: If provided, overrides the agent name with this value.

Deprecatedoverride_embedding_handle?: string | null

Body param: Override import with specific embedding handle. Use ‘embedding’ instead.

override_existing_tools?: boolean

Body param: 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.

Deprecatedoverride_model_handle?: string | null

Body param: Model handle to override the agent’s default model. Use ‘model’ instead.

Deprecatedoverride_name?: string | null

Body param: If provided, overrides the agent name with this value. Use ‘name’ instead.

Deprecatedproject_id?: string | null

Body param: The project ID to associate the uploaded agent with. This is now passed via headers.

secrets?: string | null

Body param: Secrets as a JSON string to pass to the agent for tool execution.

strip_messages?: boolean

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

xOverrideEmbeddingModel?: string

Header param

ReturnsExpand Collapse

AgentImportFileResponse { agent_ids }

Response model for imported agents

agent_ids: Array<string>

List of IDs of the imported agents

Import Agent

import fs from 'fs';
import Letta from '@letta-ai/letta-client';

const client = new Letta({
  apiKey: process.env['LETTA_API_KEY'], // This is the default and can be omitted
});

const response = await client.agents.importFile({ file: fs.createReadStream('path/to/file') });

console.log(response.agent_ids);

{
  "agent_ids": [
    "string"
  ]
}

Returns Examples

{
  "agent_ids": [
    "string"
  ]
}