Agents

Yumeru API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api-docs.yumeru.ai/_mock/openapi/

Index

Operations

Health

Operations

Usage

Operations

Agents

Operations

Create a new agent

Request

Create a new agent for a specific organization

Path
organizationIdstringrequired
Bodyapplication/json
namestringrequired
voiceIdstringrequired
languagestringrequired
Enum"en""es"
metadataobject
contextstring
templateTypestringrequired
Enum"book_meeting""warm_up""qualify""blank"
valuePropositionsArray of objects
callToActionsArray of objects
questionsArray of objects
objectionsArray of objects
caseStudiesArray of objects
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/agents' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "voiceId": "string",
    "language": "en",
    "metadata": {
      "firstMessage": "string",
      "llmModel": "gpt-4o-mini",
      "modelTemperature": 0,
      "voiceSpeed": 0,
      "voiceTemperature": 0,
      "interruptionSensitivity": 0,
      "maxCallDurationMs": 0,
      "endCallAfterSilenceMs": 0,
      "enableTranscriptionFormatting": true,
      "enableVoicemailDetection": true,
      "voicemailMessage": "string",
      "ambientSound": "none",
      "pronunciationDictionary": [
        {
          "word": "string",
          "pronunciation": "string",
          "alphabet": "ipa",
          "phoneme": "string"
        }
      ],
      "calendarConfig": {
        "apiKey": "string",
        "eventTypeId": 0
      },
      "transferNumber": "string",
      "enableIvr": true,
      "enableEndCall": true,
      "postCallAnalysisData": [
        {
          "type": "boolean",
          "name": "string",
          "description": "string"
        }
      ],
      "enableBackchanneling": true,
      "backchannelMessages": [
        {
          "message": "string",
          "minSilenceMs": 0
        }
      ]
    },
    "context": "string",
    "templateType": "book_meeting",
    "valuePropositions": [
      {
        "value": "string"
      }
    ],
    "callToActions": [
      {
        "callToAction": "string"
      }
    ],
    "questions": [
      {
        "question": "string",
        "purpose": "string"
      }
    ],
    "objections": [
      {
        "objection": "string",
        "response": "string"
      }
    ],
    "caseStudies": [
      {
        "description": "string",
        "results": "string"
      }
    ]
  }'

Responses

Agent created successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​agentobjectrequired
data.​agent.​idnumberrequired
data.​agent.​namestringrequired
data.​agent.​voiceIdstringrequired
data.​agent.​languagestringrequired
Enum"en""es"
data.​agent.​metadataobject
data.​agent.​contextstring
data.​agent.​templateTypestringrequired
Enum"book_meeting""warm_up""qualify""blank"
data.​agent.​statusstringrequired
Enum"draft""active""inactive""archived"
data.​agent.​createdAtstringrequired
data.​agent.​updatedAtstringrequired
data.​valuePropositionsArray of objectsrequired
data.​valuePropositions[].​idnumberrequired
data.​valuePropositions[].​valuestringrequired
data.​valuePropositions[].​createdAtstringrequired
data.​valuePropositions[].​updatedAtstringrequired
data.​callToActionsArray of objectsrequired
data.​callToActions[].​idnumberrequired
data.​callToActions[].​callToActionstringrequired
data.​callToActions[].​createdAtstringrequired
data.​callToActions[].​updatedAtstringrequired
data.​questionsArray of objectsrequired
data.​questions[].​idnumberrequired
data.​questions[].​questionstringrequired
data.​questions[].​purposestring
data.​questions[].​createdAtstringrequired
data.​questions[].​updatedAtstringrequired
data.​objectionsArray of objectsrequired
data.​objections[].​idnumberrequired
data.​objections[].​objectionstringrequired
data.​objections[].​responsestringrequired
data.​objections[].​createdAtstringrequired
data.​objections[].​updatedAtstringrequired
data.​caseStudiesArray of objectsrequired
data.​caseStudies[].​idnumberrequired
data.​caseStudies[].​descriptionstringrequired
data.​caseStudies[].​resultsstringrequired
data.​caseStudies[].​createdAtstringrequired
data.​caseStudies[].​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "agent": { … },
    "valuePropositions": [ … ],
    "callToActions": [ … ],
    "questions": [ … ],
    "objections": [ … ],
    "caseStudies": [ … ]
  }
}

Get agent details

Request

Get details for a specific agent

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

Responses

Agent details retrieved successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​agentobjectrequired
data.​agent.​idnumberrequired
data.​agent.​namestringrequired
data.​agent.​voiceIdstringrequired
data.​agent.​languagestringrequired
Enum"en""es"
data.​agent.​metadataobject
data.​agent.​contextstring
data.​agent.​templateTypestringrequired
Enum"book_meeting""warm_up""qualify""blank"
data.​agent.​statusstringrequired
Enum"draft""active""inactive""archived"
data.​agent.​createdAtstringrequired
data.​agent.​updatedAtstringrequired
data.​valuePropositionsArray of objectsrequired
data.​valuePropositions[].​idnumberrequired
data.​valuePropositions[].​valuestringrequired
data.​valuePropositions[].​createdAtstringrequired
data.​valuePropositions[].​updatedAtstringrequired
data.​callToActionsArray of objectsrequired
data.​callToActions[].​idnumberrequired
data.​callToActions[].​callToActionstringrequired
data.​callToActions[].​createdAtstringrequired
data.​callToActions[].​updatedAtstringrequired
data.​questionsArray of objectsrequired
data.​questions[].​idnumberrequired
data.​questions[].​questionstringrequired
data.​questions[].​purposestring
data.​questions[].​createdAtstringrequired
data.​questions[].​updatedAtstringrequired
data.​objectionsArray of objectsrequired
data.​objections[].​idnumberrequired
data.​objections[].​objectionstringrequired
data.​objections[].​responsestringrequired
data.​objections[].​createdAtstringrequired
data.​objections[].​updatedAtstringrequired
data.​caseStudiesArray of objectsrequired
data.​caseStudies[].​idnumberrequired
data.​caseStudies[].​descriptionstringrequired
data.​caseStudies[].​resultsstringrequired
data.​caseStudies[].​createdAtstringrequired
data.​caseStudies[].​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "agent": { … },
    "valuePropositions": [ … ],
    "callToActions": [ … ],
    "questions": [ … ],
    "objections": [ … ],
    "caseStudies": [ … ]
  }
}

Update agent details

Request

Update the details of a specific agent

Path
agentIdstringrequired
Bodyapplication/json
namestring
voiceIdstring
languagestring
Enum"en""es"
metadataobject
contextstring
templateTypestring
Enum"book_meeting""warm_up""qualify""blank"
valuePropositionsArray of objects
callToActionsArray of objects
questionsArray of objects
objectionsArray of objects
caseStudiesArray of objects
curl -i -X PUT \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "voiceId": "string",
    "language": "en",
    "metadata": {
      "firstMessage": "string",
      "llmModel": "gpt-4o-mini",
      "modelTemperature": 0,
      "voiceSpeed": 0,
      "voiceTemperature": 0,
      "interruptionSensitivity": 0,
      "maxCallDurationMs": 0,
      "endCallAfterSilenceMs": 0,
      "enableTranscriptionFormatting": true,
      "enableVoicemailDetection": true,
      "voicemailMessage": "string",
      "ambientSound": "none",
      "pronunciationDictionary": [
        {
          "word": "string",
          "pronunciation": "string",
          "alphabet": "ipa",
          "phoneme": "string"
        }
      ],
      "calendarConfig": {
        "apiKey": "string",
        "eventTypeId": 0
      },
      "transferNumber": "string",
      "enableIvr": true,
      "enableEndCall": true,
      "postCallAnalysisData": [
        {
          "type": "boolean",
          "name": "string",
          "description": "string"
        }
      ],
      "enableBackchanneling": true,
      "backchannelMessages": [
        {
          "message": "string",
          "minSilenceMs": 0
        }
      ]
    },
    "context": "string",
    "templateType": "book_meeting",
    "valuePropositions": [
      {
        "value": "string"
      }
    ],
    "callToActions": [
      {
        "callToAction": "string"
      }
    ],
    "questions": [
      {
        "question": "string",
        "purpose": "string"
      }
    ],
    "objections": [
      {
        "objection": "string",
        "response": "string"
      }
    ],
    "caseStudies": [
      {
        "description": "string",
        "results": "string"
      }
    ]
  }'

Responses

Agent updated successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​agentobjectrequired
data.​agent.​idnumberrequired
data.​agent.​namestringrequired
data.​agent.​voiceIdstringrequired
data.​agent.​languagestringrequired
Enum"en""es"
data.​agent.​metadataobject
data.​agent.​contextstring
data.​agent.​templateTypestringrequired
Enum"book_meeting""warm_up""qualify""blank"
data.​agent.​statusstringrequired
Enum"draft""active""inactive""archived"
data.​agent.​createdAtstringrequired
data.​agent.​updatedAtstringrequired
data.​valuePropositionsArray of objectsrequired
data.​valuePropositions[].​idnumberrequired
data.​valuePropositions[].​valuestringrequired
data.​valuePropositions[].​createdAtstringrequired
data.​valuePropositions[].​updatedAtstringrequired
data.​callToActionsArray of objectsrequired
data.​callToActions[].​idnumberrequired
data.​callToActions[].​callToActionstringrequired
data.​callToActions[].​createdAtstringrequired
data.​callToActions[].​updatedAtstringrequired
data.​questionsArray of objectsrequired
data.​questions[].​idnumberrequired
data.​questions[].​questionstringrequired
data.​questions[].​purposestring
data.​questions[].​createdAtstringrequired
data.​questions[].​updatedAtstringrequired
data.​objectionsArray of objectsrequired
data.​objections[].​idnumberrequired
data.​objections[].​objectionstringrequired
data.​objections[].​responsestringrequired
data.​objections[].​createdAtstringrequired
data.​objections[].​updatedAtstringrequired
data.​caseStudiesArray of objectsrequired
data.​caseStudies[].​idnumberrequired
data.​caseStudies[].​descriptionstringrequired
data.​caseStudies[].​resultsstringrequired
data.​caseStudies[].​createdAtstringrequired
data.​caseStudies[].​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "agent": { … },
    "valuePropositions": [ … ],
    "callToActions": [ … ],
    "questions": [ … ],
    "objections": [ … ],
    "caseStudies": [ … ]
  }
}

Delete an agent

Request

Delete a specific agent

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

Responses

Agent deleted successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
Response
application/json
{
  "success": true
}

List agents

Request

List all agents for a specific organization

Query
organizationIdstringrequired
statusstring
Enum"draft""active""inactive""archived"
pagenumber>= 1
limitnumber[ 1 .. 100 ]
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/agents?limit=1&organizationId=string&page=1&status=draft' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Agents retrieved successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataArray of objectsrequired
data[].​idnumberrequired
data[].​namestringrequired
data[].​voiceIdstringrequired
data[].​languagestringrequired
Enum"en""es"
data[].​metadataobject
data[].​contextstring
data[].​templateTypestringrequired
Enum"book_meeting""warm_up""qualify""blank"
data[].​statusstringrequired
Enum"draft""active""inactive""archived"
data[].​createdAtstringrequired
data[].​updatedAtstringrequired
totalnumberrequired
pagenumberrequired
totalPagesnumberrequired
Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "total": 0,
  "page": 0,
  "totalPages": 0
}

Web simulate an agent

Request

Web simulate a specific agent

Path
agentIdstringrequired
Bodyapplication/json
dynamicVariablesobject
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/agents/{agentId}/web-simulate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "dynamicVariables": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Web simulation connection details

Bodyapplication/json
accessTokenstringrequired
callIdstringrequired
promptstringrequired
Response
application/json
{
  "accessToken": "string",
  "callId": "string",
  "prompt": "string"
}

Create a new demo link

Request

Create a new demo link for a specific agent

Path
organizationIdstringrequired
agentIdstringrequired
Bodyapplication/json
expiresAtstring(date-time)
maxUsesnumber>= 1
curl -i -X POST \
  'https://api-docs.yumeru.ai/_mock/openapi/organizations/{organizationId}/agents/{agentId}/demo' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "expiresAt": "2019-08-24T14:15:22Z",
    "maxUses": 1
  }'

Responses

Demo link created successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idstringrequired
data.​pathstringrequired
data.​expiresAtstring(date-time)
data.​maxUsesnumber
data.​usageCountnumberrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": "string",
    "path": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "maxUses": 0,
    "usageCount": 0
  }
}

Archive an agent

Request

Archive a specific agent

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

Responses

Agent archived successfully

Bodyapplication/json
successbooleanrequired
Valuetrue
dataobjectrequired
data.​idnumberrequired
data.​organizationIdstringrequired
data.​namestringrequired
data.​voiceIdstringrequired
data.​languagestringrequired
Enum"en""es"
data.​metadataobject
data.​contextstring
data.​templateTypestringrequired
Enum"book_meeting""warm_up""qualify""blank"
data.​statusstringrequired
Enum"draft""active""inactive""archived"
data.​createdAtstringrequired
data.​updatedAtstringrequired
Response
application/json
{
  "success": true,
  "data": {
    "id": 0,
    "organizationId": "string",
    "name": "string",
    "voiceId": "string",
    "language": "en",
    "metadata": { … },
    "context": "string",
    "templateType": "book_meeting",
    "status": "draft",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Campaigns

Operations

Meetings

Operations

Webhooks

Operations