Skip to content

Wabee Agent Core API (v1)

Wabee Agent Core API

Wabee Agent Core API enables developers to interact with an AI agent in a custom, secure and flexible manner through REST API calls.

One can build applications to interact with the agent API to complete a task using any of the Agents endpoints which allow for both text streaming and direct JSON response. The Memory endpoints are useful for managing the agent memory programatically. Moreover, the Metrics endpoints provide an interface for monitoring the underlying Agent in terms of latency, health, token consumption and much more.

Download OpenAPI description
Overview
License

Wabee License

Languages
Servers
Mock server

https://api.docs.wabee.ai/_mock/openapi/

Production server

https://<your_agent_uri>.wabee.ai/

Agent

Endpoints for interacting with the AI agent

Operations

Memory

Endpoints for managing agent memory

Observability

Endpoints for monitoring agent performance and logs

Operations

Sessions

Endpoints for managing agent sessions

Operations

Sub-Agents

Endpoints for managing sub-agents

Operations

Request

Lists all sub-agents that have been created by the parent agent.

Security
APIKeyHeader
curl -i -X GET \
  https://api.docs.wabee.ai/_mock/openapi/core/v1/chain/sub_agents \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
sub_agentsArray of objects(Sub Agents)required

List of sub-agents

sub_agents[].​idstring(Id)required

Unique identifier for the sub-agent

Example: "sa-1234abcd"
sub_agents[].​namestring(Name)required

Name of the sub-agent

Example: "Market Research Agent"
sub_agents[].​descriptionstring(Description)required

Description of the sub-agent's purpose

Example: "Specialized agent for conducting market research and competitive analysis"
sub_agents[].​statusstring(Status)required

Current status of the sub-agent

Example: "ready"
sub_agents[].​created_atstring(date-time)(Created At)required

Creation timestamp

Example: "2025-04-10T14:30:00Z"
sub_agents[].​last_activeLast Active (string) or Last Active (null)(Last Active)
Example: "2025-04-10T15:45:00Z"
Any of:

Last activity timestamp

string(date-time)(Last Active)
Response
application/json
{ "sub_agents": [ { … } ] }

Request

Creates a new specialized sub-agent that can handle specific tasks. The sub-agent will have access to the specified tools and can be assigned tasks.

Security
APIKeyHeader
Bodyapplication/jsonrequired
namestring(Name)required

A descriptive name for the sub-agent

Example: "Market Research Agent"
descriptionstring(Description)required

A detailed description of the sub-agent's purpose and capabilities

Example: "Specialized agent for conducting market research and competitive analysis"
objectivestring(Objective)required

The primary goal or objective for the sub-agent

Example: "Gather and analyze market information to provide competitive insights"
toolsArray of strings(Tools)

List of tool names to include for the sub-agent

Example: ["web_search","csv_analysis"]
workflow_typestring(Workflow Type)

The workflow type for the sub-agent

Default "react"
Enum"react""hierarchical"
Example: "react"
curl -i -X POST \
  https://api.docs.wabee.ai/_mock/openapi/core/v1/chain/sub_agents \
  -H 'Content-Type: application/json' \
  -H 'x-wabee-access: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Market Research Agent",
    "description": "Specialized agent for conducting market research and competitive analysis",
    "objective": "Gather and analyze market information to provide competitive insights",
    "tools": [
      "web_search",
      "csv_analysis"
    ],
    "workflow_type": "react"
  }'

Responses

Successful Response

Bodyapplication/json
sub_agent_idstring(Sub Agent Id)required

Unique identifier for the new sub-agent

Example: "sa-1234abcd"
sub_agent_infoobject(SubAgentInfoResponse)required
sub_agent_info.​idstring(Id)required

Unique identifier for the sub-agent

Example: "sa-1234abcd"
sub_agent_info.​namestring(Name)required

Name of the sub-agent

Example: "Market Research Agent"
sub_agent_info.​descriptionstring(Description)required

Description of the sub-agent's purpose

Example: "Specialized agent for conducting market research and competitive analysis"
sub_agent_info.​statusstring(Status)required

Current status of the sub-agent

Example: "ready"
sub_agent_info.​created_atstring(date-time)(Created At)required

Creation timestamp

Example: "2025-04-10T14:30:00Z"
sub_agent_info.​last_activeLast Active (string) or Last Active (null)(Last Active)
Example: "2025-04-10T15:45:00Z"
Any of:

Last activity timestamp

string(date-time)(Last Active)
Response
application/json
{ "sub_agent_id": "sa-1234abcd", "sub_agent_info": { "id": "sa-1234abcd", "name": "Market Research Agent", "description": "Specialized agent for conducting market research and competitive analysis", "status": "ready", "created_at": "2025-04-10T14:30:00Z", "last_active": "2025-04-10T15:45:00Z" } }

Request

Retrieves information about a specific sub-agent, including its status and basic information.

Security
APIKeyHeader
Path
sub_agent_idstring(Sub Agent Id)required

ID of the sub-agent to retrieve

curl -i -X GET \
  'https://api.docs.wabee.ai/_mock/openapi/core/v1/chain/sub_agents/{sub_agent_id}' \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
idstring(Id)required

Unique identifier for the sub-agent

Example: "sa-1234abcd"
namestring(Name)required

Name of the sub-agent

Example: "Market Research Agent"
descriptionstring(Description)required

Description of the sub-agent's purpose

Example: "Specialized agent for conducting market research and competitive analysis"
statusstring(Status)required

Current status of the sub-agent

Example: "ready"
created_atstring(date-time)(Created At)required

Creation timestamp

Example: "2025-04-10T14:30:00Z"
last_activeLast Active (string) or Last Active (null)(Last Active)
Example: "2025-04-10T15:45:00Z"
Any of:

Last activity timestamp

string(date-time)(Last Active)
Response
application/json
{ "id": "sa-1234abcd", "name": "Market Research Agent", "description": "Specialized agent for conducting market research and competitive analysis", "status": "ready", "created_at": "2025-04-10T14:30:00Z", "last_active": "2025-04-10T15:45:00Z" }

Request

Terminates a specific sub-agent and cleans up its resources.

Security
APIKeyHeader
Path
sub_agent_idstring(Sub Agent Id)required

ID of the sub-agent to terminate

curl -i -X DELETE \
  'https://api.docs.wabee.ai/_mock/openapi/core/v1/chain/sub_agents/{sub_agent_id}' \
  -H 'x-wabee-access: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
any
Response
application/json
{ "success": true }
Operations