POST
/
api
/
v1
/
agents
Create a new agent
curl --request POST \
  --url https://prod.featherhq.com/api/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "voicemailMessage": "<string>",
  "useKnowledgeBase": true,
  "mode": "FLOW",
  "flows": {
    "blocks": [
      {
        "blockId": "<string>",
        "blockType": "prompt",
        "systemPrompt": "<string>",
        "variables": [
          {
            "name": "<string>",
            "required": true,
            "defaultValue": "<string>"
          }
        ],
        "loop": false,
        "tools": [],
        "nextBlocks": [],
        "metadata": {},
        "inputCaptureType": "phone",
        "transferNumber": "<string>"
      }
    ],
    "startBlockId": "<string>",
    "systemPrompt": "<string>",
    "variables": [
      {
        "name": "<string>",
        "required": true,
        "defaultValue": "<string>"
      }
    ],
    "allVariables": [
      {
        "name": "<string>",
        "required": true,
        "defaultValue": "<string>"
      }
    ]
  },
  "prompt": {
    "system": "<string>",
    "systemUIFormatting": "<any>",
    "variables": [
      {
        "name": "<string>",
        "required": true,
        "defaultValue": "<string>"
      }
    ],
    "tools": [
      "<string>"
    ],
    "preBuiltTools": [
      "<string>"
    ]
  },
  "sttConfigId": "<string>",
  "ttsConfigId": "<string>",
  "llmConfigId": "<string>",
  "overrideSTTConfig": {},
  "overrideTTSConfig": {},
  "overrideLLMConfig": {},
  "voiceId": "<string>",
  "channels": [
    "INBOUND_CALL"
  ],
  "enableBackgroundAudio": false,
  "backgroundAudio": 50,
  "postCallPrompt": "<string>"
}'
{
  "agent": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "inboundPhoneNumbers": [
      {
        "id": "<string>"
      }
    ],
    "outboundPhoneNumbers": [
      {
        "id": "<string>"
      }
    ],
    "cekuraAgentId": 123,
    "cekuraPhoneNumberId": "<string>",
    "version": {
      "id": "<string>",
      "version": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "mode": "FLOW",
      "flows": {
        "blocks": [
          {
            "blockId": "<string>",
            "blockType": "prompt",
            "systemPrompt": "<string>",
            "variables": [
              {
                "name": "<string>",
                "required": true,
                "defaultValue": "<string>"
              }
            ],
            "loop": false,
            "tools": [],
            "nextBlocks": [],
            "metadata": {},
            "inputCaptureType": "phone",
            "transferNumber": "<string>"
          }
        ],
        "startBlockId": "<string>",
        "systemPrompt": "<string>",
        "variables": [
          {
            "name": "<string>",
            "required": true,
            "defaultValue": "<string>"
          }
        ],
        "allVariables": [
          {
            "name": "<string>",
            "required": true,
            "defaultValue": "<string>"
          }
        ]
      },
      "prompt": {
        "system": "<string>",
        "systemUIFormatting": "<any>",
        "variables": [
          {
            "name": "<string>",
            "required": true,
            "defaultValue": "<string>"
          }
        ],
        "tools": [
          "<string>"
        ],
        "preBuiltTools": [
          "<string>"
        ]
      },
      "sttConfigId": "<string>",
      "ttsConfigId": "<string>",
      "llmConfigId": "<string>",
      "overrideSTTConfig": {},
      "overrideTTSConfig": {},
      "overrideLLMConfig": {},
      "voiceId": "<string>",
      "channels": [
        "INBOUND_CALL"
      ],
      "postCallPrompt": "<string>",
      "postCallVariables": [
        {
          "variableName": "<string>",
          "type": "STRING",
          "description": "<string>",
          "required": false
        }
      ],
      "knowledgeBaseCollectionIds": [
        "<string>"
      ],
      "voicemailMessage": "<string>",
      "useKnowledgeBase": true,
      "enableBackgroundAudio": false,
      "backgroundAudio": 50,
      "rotationStrategy": "ROUND_ROBIN",
      "forwardingPhoneNumber": "<string>"
    }
  }
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Response

201
application/json

New agent version created successfully

The response is of type object.