Skip to content

Yumeru API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://api-docs.yumeru.ai/_mock/openapi/

Usage

Operations

Agents

Operations

Campaigns

Operations

Meetings

Operations

Webhooks

Operations

Create a new webhook for an agent

Request

Create a new webhook for an agent

Security
BearerAuth
Path
agentIdstringrequired
Bodyapplication/json
urlstring(uri)required
enabledboolean
Default true
eventsArray of strings
Default ["call_started","call_ended","call_analyzed"]
Items Enum"call_started""call_ended""call_analyzed"
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}/webhooks' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "http://example.com",
    "enabled": true,
    "events": [
      "call_started",
      "call_ended",
      "call_analyzed"
    ]
  }'

Responses

Webhook created successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​agentIdnumberrequired
data.​urlstring(uri)required
data.​secretstringrequired
data.​enabledbooleanrequired
data.​eventsArray of stringsrequired
Items Enum"call_started""call_ended""call_analyzed"
data.​createdAtstringrequired
data.​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "agentId": 0,
    "url": "http://example.com",
    "secret": "string",
    "enabled": true,
    "events": [ … ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

List all webhooks for an agent

Request

List all webhooks for an agent

Security
BearerAuth
Path
agentIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}/webhooks' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhooks retrieved successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataArray of objectsrequired
data[].​idnumberrequired
data[].​agentIdnumberrequired
data[].​urlstring(uri)required
data[].​secretstringrequired
data[].​enabledbooleanrequired
data[].​eventsArray of stringsrequired
Items Enum"call_started""call_ended""call_analyzed"
data[].​createdAtstringrequired
data[].​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

Get a webhook by ID for an agent

Request

Get a webhook by ID for an agent

Security
BearerAuth
Path
agentIdstringrequired
webhookIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook retrieved successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​agentIdnumberrequired
data.​urlstring(uri)required
data.​secretstringrequired
data.​enabledbooleanrequired
data.​eventsArray of stringsrequired
Items Enum"call_started""call_ended""call_analyzed"
data.​createdAtstringrequired
data.​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "agentId": 0,
    "url": "http://example.com",
    "secret": "string",
    "enabled": true,
    "events": [ … ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Update a webhook by ID for an agent

Request

Update a webhook by ID for an agent

Security
BearerAuth
Path
agentIdstringrequired
webhookIdstringrequired
Bodyapplication/json
urlstring(uri)
enabledboolean
Default true
eventsArray of strings
Default ["call_started","call_ended","call_analyzed"]
Items Enum"call_started""call_ended""call_analyzed"
curl -i -X PUT \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "http://example.com",
    "enabled": true,
    "events": [
      "call_started",
      "call_ended",
      "call_analyzed"
    ]
  }'

Responses

Webhook updated successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​agentIdnumberrequired
data.​urlstring(uri)required
data.​secretstringrequired
data.​enabledbooleanrequired
data.​eventsArray of stringsrequired
Items Enum"call_started""call_ended""call_analyzed"
data.​createdAtstringrequired
data.​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "agentId": 0,
    "url": "http://example.com",
    "secret": "string",
    "enabled": true,
    "events": [ … ],
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Delete a webhook by ID for an agent

Request

Delete a webhook by ID for an agent

Security
BearerAuth
Path
agentIdstringrequired
webhookIdstringrequired
curl -i -X DELETE \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}/webhooks/{webhookId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Webhook deleted successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataany or nullrequired
Response
application/json
{
  "success": true,
  "data": null
}