Managing Agents

Agents are the core building block of the Meibel platform. Each agent encapsulates a system prompt, model configuration, and optional datasources. This guide walks through the full lifecycle: creating, inspecting, updating, publishing, versioning, and deleting agents.

Create an agent

Create a new agent definition by providing a name, description, and system prompt.

import os
from meibel import MeibelClient
from meibel.models import CreateAgentDefinitionRequest

client = MeibelClient(api_key=os.environ["MEIBEL_API_KEY"])

agent = client.agents.create(body=CreateAgentDefinitionRequest(
    display_name="Research Assistant",
    description="Answers questions using uploaded knowledge bases",
    instructions="You are a helpful research assistant. Answer questions accurately and cite your sources.",
))

print(agent.id, agent.display_name)

import { MeibelClient } from 'meibel';

const client = new MeibelClient({ apiKey: process.env.MEIBEL_API_KEY });

const agent = await client.agents.create({
  displayName: 'Research Assistant',
  description: 'Answers questions using uploaded knowledge bases',
  instructions: 'You are a helpful research assistant. Answer questions accurately and cite your sources.',
});

console.log(agent.id, agent.displayName);

import (
    "context"
    "fmt"
    "os"

    meibel "github.com/meibel-ai/meibel-go"
)

client := meibel.NewClient(meibel.WithAPIKey(os.Getenv("MEIBEL_API_KEY")))
ctx := context.Background()

agent, err := client.Agents.CreateAgent(ctx, meibel.CreateAgentDefinitionRequest{
    DisplayName:  "Research Assistant",
    Description:  "Answers questions using uploaded knowledge bases",
    Instructions: "You are a helpful research assistant. Answer questions accurately and cite your sources.",
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(agent.ID, agent.DisplayName)

meibel agents create --data '{
  "display_name": "Research Assistant",
  "description": "Answers questions using uploaded knowledge bases",
  "instructions": "You are a helpful research assistant. Answer questions accurately and cite your sources."
}'

The response includes the agent’s id, display_name, description, instructions, and timestamps. Use the id for all subsequent operations.

Get agent details

Retrieve the full configuration and metadata for an existing agent.

agent = client.agents.get(agent_id="agent_123")

print(agent.display_name)
print(agent.instructions)
print(agent.created_at)

const agent = await client.agents.get('agent_123');

console.log(agent.displayName);
console.log(agent.instructions);
console.log(agent.createdAt);

agent, err := client.Agents.GetAgent(ctx, "agent_123")
if err != nil {
    log.Fatal(err)
}

fmt.Println(agent.DisplayName)
fmt.Println(agent.Instructions)
fmt.Println(agent.CreatedAt)

meibel agents get agent_123

Update an agent

Modify an agent’s name, description, system prompt, or other configuration fields. Only the fields you include in the request body are changed.

from meibel.models import UpdateAgentDefinitionRequest

updated = client.agents.update(
    agent_id="agent_123",
    body=UpdateAgentDefinitionRequest(
        display_name="Research Assistant v2",
        instructions="You are an expert research assistant. Always cite sources with page numbers.",
    ),
)

print(updated.version)

const updated = await client.agents.update('agent_123', {
  displayName: 'Research Assistant v2',
  instructions: 'You are an expert research assistant. Always cite sources with page numbers.',
});

console.log(updated.version);

updated, err := client.Agents.UpdateAgent(ctx, "agent_123", meibel.UpdateAgentDefinitionRequest{
    DisplayName:  "Research Assistant v2",
    Instructions: "You are an expert research assistant. Always cite sources with page numbers.",
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(updated.DisplayName)

meibel agents update agent_123 --data '{
  "display_name": "Research Assistant v2",
  "instructions": "You are an expert research assistant. Always cite sources with page numbers."
}'

Publish an agent

Publishing creates an immutable snapshot of the agent’s current configuration. Include a commit message to document what changed.

from meibel.models import PublishAgentDefinitionRequest

published = client.agents.publish(
    agent_id="agent_123",
    body=PublishAgentDefinitionRequest(
        commit_message="Improved citation formatting and added page-number references",
    ),
)

print(published.version)
print(published.commit_message)

const published = await client.agents.publish('agent_123', {
  commitMessage: 'Improved citation formatting and added page-number references',
});

console.log(published.version);
console.log(published.commitMessage);

published, err := client.Agents.PublishAgent(ctx, "agent_123", meibel.PublishAgentDefinitionRequest{
    CommitMessage: "Improved citation formatting and added page-number references",
})
if err != nil {
    log.Fatal(err)
}

fmt.Println(published.Version)
fmt.Println(published.CommitMessage)

meibel agents publish agent_123 --data '{
  "commit_message": "Improved citation formatting and added page-number references"
}'

Publishing does not affect the draft agent. You can continue editing the draft and publish again when ready.

List agent versions

Retrieve all published versions for an agent. Versions are returned in reverse chronological order.

for version in client.agents.list_versions(agent_id="agent_123"):
    print(f"v{version.version}: {version.commit_message} ({version.published_at})")

for await (const version of client.agents.listVersions('agent_123')) {
  console.log(`v${version.version}: ${version.commitMessage} (${version.publishedAt})`);
}

iter := client.Agents.ListAgentVersions(ctx, "agent_123")
for iter.Next(ctx) {
    version := iter.Item()
    fmt.Printf("v%d: %s (%s)\n", version.Version, version.CommitMessage, version.PublishedAt)
}
if err := iter.Err(); err != nil {
    log.Fatal(err)
}

meibel agents list-agent-versions agent_123

Delete an agent

Permanently remove an agent and all its published versions. This action cannot be undone.

client.agents.delete(agent_id="agent_123")

await client.agents.delete('agent_123');

err := client.Agents.DeleteAgent(ctx, "agent_123")
if err != nil {
    log.Fatal(err)
}

meibel agents delete agent_123

Deleting an agent removes all published versions and terminates any active sessions associated with it.

Get started

Tutorials

Core concepts

Agents and sessions

Data and documents

Operations

Support

Managing Agents

Managing Agents

Create an agent

Get agent details

Update an agent

Publish an agent

List agent versions

Delete an agent

​Managing Agents

​Create an agent

​Get agent details

​Update an agent

​Publish an agent

​List agent versions

​Delete an agent

Managing Agents

Create an agent

Get agent details

Update an agent

Publish an agent

List agent versions

Delete an agent