DocumentationNeuronAgent Documentation
Documentation Branch: You are viewing documentation for the main branch (3.0.0-devel). Select a branch to view its documentation:

NeuronAgent Quick Start

Prerequisites

  • NeuronAgent running on http://localhost:8080
  • NeuronDB extension installed and configured
  • API key for authentication

Create Your First Agent

Create an agent with tools and memory capabilities:

Create agent

curl -X POST http://localhost:8080/api/v1/agents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my_agent",
    "profile": "general-assistant",
    "tools": ["sql", "http", "browser"]
  }'

Send a Message

Create a session and send a message to your agent:

Create session and send message

# Create session
curl -X POST http://localhost:8080/api/v1/sessions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "your-agent-id",
    "user_id": "user123"
  }'

# Send message
curl -X POST http://localhost:8080/api/v1/sessions/{session_id}/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Hello, can you help me search for information?",
    "role": "user"
  }'

Using Tools

Agents can use tools to perform actions. Tools are automatically selected based on the agent's configuration and the task at hand.

See the Agent Tools Example for complete working examples.

Next Steps