OpenAgents
BETA
OpenAgents
BETA
Get Started

Agents

Agents are AI-powered entities that can perform tasks on behalf of users. You can create, list, and manage agents through these endpoints.

post /api/v1/agents
Store a newly created agent in storage.

Request Body

Agent creation payload

Schema: AgentCreateRequest
Property Type Required Description
name string Yes The user-friendly name of the agent
configuration object No The agent configuration (LLM settings, prompts, etc.)

Responses

Schema: Agent
Property Type Description
id string The unique identifier for the Agent instance
user_id string The ID of the user who owns this agent
name string The user-friendly name of the agent
status string The agent status (e.g., idle, running, stopped)
configuration object The agent configuration (LLM settings, prompts, etc.)
spark_address string The public Spark address for receiving payments (if wallet exists)
identity_public_key string The identity public key associated with the Spark wallet (if wallet exists)
wallet_status string The status of the agent's wallet
created_at string When the agent was created
updated_at string When the agent was last updated
object
Properties
Property Type Description
message string
object
Properties
Property Type Description
message string
errors object
object
Properties
Property Type Description
message string
get /api/v1/agents
Display a listing of the user's agents.

Responses

array
object
Properties
Property Type Description
message string
object
Properties
Property Type Description
message string
get /api/v1/agents/{agent_id}
Display the specified agent.

Parameters

Name In Required Type Description
agent_id path Yes string The agent ID

Responses

Schema: Agent
Property Type Description
id string The unique identifier for the Agent instance
user_id string The ID of the user who owns this agent
name string The user-friendly name of the agent
status string The agent status (e.g., idle, running, stopped)
configuration object The agent configuration (LLM settings, prompts, etc.)
spark_address string The public Spark address for receiving payments (if wallet exists)
identity_public_key string The identity public key associated with the Spark wallet (if wallet exists)
wallet_status string The status of the agent's wallet
created_at string When the agent was created
updated_at string When the agent was last updated
object
Properties
Property Type Description
message string
object
Properties
Property Type Description
message string
object
Properties
Property Type Description
message string