Create a new agent

curl --request POST \
  --url https://api-trial.cognigy.ai/v1/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "localeReferenceId": "<string>",
  "name": "<string>",
  "projectId": "<string>",
  "agentType": "voice",
  "description": "<string>",
  "guardrails": {
    "dataPrivacy": {
      "contactProfilesOption": "completeProfile",
      "selectedProfileFields": [
        "<string>"
      ]
    },
    "safetySettings": {
      "avoidCopyrightInfringements": true,
      "avoidHarmfulContent": true,
      "avoidUngroundedContent": true,
      "preventJailbreakAndManipulation": true
    }
  },
  "hooks": {
    "preTurn": [
      {
        "handler": {
          "flowReferenceId": "<string>",
          "kind": "<string>"
        }
      }
    ]
  },
  "image": "<string>",
  "imageOptimizedFormat": true,
  "instructions": "<string>",
  "knowledge": {
    "cognigyParameters": {
      "language": "<string>",
      "stores": [
        "<string>"
      ],
      "topK": 123
    },
    "context": "<string>",
    "onSearchFailure": "<string>",
    "ragMode": "<string>",
    "ragType": "<string>"
  },
  "largeLanguageModelReferenceId": "<string>",
  "llmConfig": {
    "maxOutputTokens": 123,
    "reasoningEffort": "<string>",
    "temperature": 123
  },
  "personaReferenceId": "<string>",
  "realtimeVoice": "<string>",
  "role": "<string>",
  "skillReferenceIds": [
    "<string>"
  ],
  "toolReferenceIds": [
    "<string>"
  ],
  "voiceLargeLanguageModelReferenceId": "<string>"
}
'

import requests

url = "https://api-trial.cognigy.ai/v1/agents"

payload = {
    "localeReferenceId": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "agentType": "voice",
    "description": "<string>",
    "guardrails": {
        "dataPrivacy": {
            "contactProfilesOption": "completeProfile",
            "selectedProfileFields": ["<string>"]
        },
        "safetySettings": {
            "avoidCopyrightInfringements": True,
            "avoidHarmfulContent": True,
            "avoidUngroundedContent": True,
            "preventJailbreakAndManipulation": True
        }
    },
    "hooks": { "preTurn": [{ "handler": {
                    "flowReferenceId": "<string>",
                    "kind": "<string>"
                } }] },
    "image": "<string>",
    "imageOptimizedFormat": True,
    "instructions": "<string>",
    "knowledge": {
        "cognigyParameters": {
            "language": "<string>",
            "stores": ["<string>"],
            "topK": 123
        },
        "context": "<string>",
        "onSearchFailure": "<string>",
        "ragMode": "<string>",
        "ragType": "<string>"
    },
    "largeLanguageModelReferenceId": "<string>",
    "llmConfig": {
        "maxOutputTokens": 123,
        "reasoningEffort": "<string>",
        "temperature": 123
    },
    "personaReferenceId": "<string>",
    "realtimeVoice": "<string>",
    "role": "<string>",
    "skillReferenceIds": ["<string>"],
    "toolReferenceIds": ["<string>"],
    "voiceLargeLanguageModelReferenceId": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    localeReferenceId: '<string>',
    name: '<string>',
    projectId: '<string>',
    agentType: 'voice',
    description: '<string>',
    guardrails: {
      dataPrivacy: {contactProfilesOption: 'completeProfile', selectedProfileFields: ['<string>']},
      safetySettings: {
        avoidCopyrightInfringements: true,
        avoidHarmfulContent: true,
        avoidUngroundedContent: true,
        preventJailbreakAndManipulation: true
      }
    },
    hooks: {preTurn: [{handler: {flowReferenceId: '<string>', kind: '<string>'}}]},
    image: '<string>',
    imageOptimizedFormat: true,
    instructions: '<string>',
    knowledge: {
      cognigyParameters: {language: '<string>', stores: ['<string>'], topK: 123},
      context: '<string>',
      onSearchFailure: '<string>',
      ragMode: '<string>',
      ragType: '<string>'
    },
    largeLanguageModelReferenceId: '<string>',
    llmConfig: {maxOutputTokens: 123, reasoningEffort: '<string>', temperature: 123},
    personaReferenceId: '<string>',
    realtimeVoice: '<string>',
    role: '<string>',
    skillReferenceIds: ['<string>'],
    toolReferenceIds: ['<string>'],
    voiceLargeLanguageModelReferenceId: '<string>'
  })
};

fetch('https://api-trial.cognigy.ai/v1/agents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/v1/agents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'localeReferenceId' => '<string>',
    'name' => '<string>',
    'projectId' => '<string>',
    'agentType' => 'voice',
    'description' => '<string>',
    'guardrails' => [
        'dataPrivacy' => [
                'contactProfilesOption' => 'completeProfile',
                'selectedProfileFields' => [
                                '<string>'
                ]
        ],
        'safetySettings' => [
                'avoidCopyrightInfringements' => true,
                'avoidHarmfulContent' => true,
                'avoidUngroundedContent' => true,
                'preventJailbreakAndManipulation' => true
        ]
    ],
    'hooks' => [
        'preTurn' => [
                [
                                'handler' => [
                                                                'flowReferenceId' => '<string>',
                                                                'kind' => '<string>'
                                ]
                ]
        ]
    ],
    'image' => '<string>',
    'imageOptimizedFormat' => true,
    'instructions' => '<string>',
    'knowledge' => [
        'cognigyParameters' => [
                'language' => '<string>',
                'stores' => [
                                '<string>'
                ],
                'topK' => 123
        ],
        'context' => '<string>',
        'onSearchFailure' => '<string>',
        'ragMode' => '<string>',
        'ragType' => '<string>'
    ],
    'largeLanguageModelReferenceId' => '<string>',
    'llmConfig' => [
        'maxOutputTokens' => 123,
        'reasoningEffort' => '<string>',
        'temperature' => 123
    ],
    'personaReferenceId' => '<string>',
    'realtimeVoice' => '<string>',
    'role' => '<string>',
    'skillReferenceIds' => [
        '<string>'
    ],
    'toolReferenceIds' => [
        '<string>'
    ],
    'voiceLargeLanguageModelReferenceId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-trial.cognigy.ai/v1/agents"

	payload := strings.NewReader("{\n  \"localeReferenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"agentType\": \"voice\",\n  \"description\": \"<string>\",\n  \"guardrails\": {\n    \"dataPrivacy\": {\n      \"contactProfilesOption\": \"completeProfile\",\n      \"selectedProfileFields\": [\n        \"<string>\"\n      ]\n    },\n    \"safetySettings\": {\n      \"avoidCopyrightInfringements\": true,\n      \"avoidHarmfulContent\": true,\n      \"avoidUngroundedContent\": true,\n      \"preventJailbreakAndManipulation\": true\n    }\n  },\n  \"hooks\": {\n    \"preTurn\": [\n      {\n        \"handler\": {\n          \"flowReferenceId\": \"<string>\",\n          \"kind\": \"<string>\"\n        }\n      }\n    ]\n  },\n  \"image\": \"<string>\",\n  \"imageOptimizedFormat\": true,\n  \"instructions\": \"<string>\",\n  \"knowledge\": {\n    \"cognigyParameters\": {\n      \"language\": \"<string>\",\n      \"stores\": [\n        \"<string>\"\n      ],\n      \"topK\": 123\n    },\n    \"context\": \"<string>\",\n    \"onSearchFailure\": \"<string>\",\n    \"ragMode\": \"<string>\",\n    \"ragType\": \"<string>\"\n  },\n  \"largeLanguageModelReferenceId\": \"<string>\",\n  \"llmConfig\": {\n    \"maxOutputTokens\": 123,\n    \"reasoningEffort\": \"<string>\",\n    \"temperature\": 123\n  },\n  \"personaReferenceId\": \"<string>\",\n  \"realtimeVoice\": \"<string>\",\n  \"role\": \"<string>\",\n  \"skillReferenceIds\": [\n    \"<string>\"\n  ],\n  \"toolReferenceIds\": [\n    \"<string>\"\n  ],\n  \"voiceLargeLanguageModelReferenceId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/v1/agents")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"localeReferenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"agentType\": \"voice\",\n  \"description\": \"<string>\",\n  \"guardrails\": {\n    \"dataPrivacy\": {\n      \"contactProfilesOption\": \"completeProfile\",\n      \"selectedProfileFields\": [\n        \"<string>\"\n      ]\n    },\n    \"safetySettings\": {\n      \"avoidCopyrightInfringements\": true,\n      \"avoidHarmfulContent\": true,\n      \"avoidUngroundedContent\": true,\n      \"preventJailbreakAndManipulation\": true\n    }\n  },\n  \"hooks\": {\n    \"preTurn\": [\n      {\n        \"handler\": {\n          \"flowReferenceId\": \"<string>\",\n          \"kind\": \"<string>\"\n        }\n      }\n    ]\n  },\n  \"image\": \"<string>\",\n  \"imageOptimizedFormat\": true,\n  \"instructions\": \"<string>\",\n  \"knowledge\": {\n    \"cognigyParameters\": {\n      \"language\": \"<string>\",\n      \"stores\": [\n        \"<string>\"\n      ],\n      \"topK\": 123\n    },\n    \"context\": \"<string>\",\n    \"onSearchFailure\": \"<string>\",\n    \"ragMode\": \"<string>\",\n    \"ragType\": \"<string>\"\n  },\n  \"largeLanguageModelReferenceId\": \"<string>\",\n  \"llmConfig\": {\n    \"maxOutputTokens\": 123,\n    \"reasoningEffort\": \"<string>\",\n    \"temperature\": 123\n  },\n  \"personaReferenceId\": \"<string>\",\n  \"realtimeVoice\": \"<string>\",\n  \"role\": \"<string>\",\n  \"skillReferenceIds\": [\n    \"<string>\"\n  ],\n  \"toolReferenceIds\": [\n    \"<string>\"\n  ],\n  \"voiceLargeLanguageModelReferenceId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/v1/agents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"localeReferenceId\": \"<string>\",\n  \"name\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"agentType\": \"voice\",\n  \"description\": \"<string>\",\n  \"guardrails\": {\n    \"dataPrivacy\": {\n      \"contactProfilesOption\": \"completeProfile\",\n      \"selectedProfileFields\": [\n        \"<string>\"\n      ]\n    },\n    \"safetySettings\": {\n      \"avoidCopyrightInfringements\": true,\n      \"avoidHarmfulContent\": true,\n      \"avoidUngroundedContent\": true,\n      \"preventJailbreakAndManipulation\": true\n    }\n  },\n  \"hooks\": {\n    \"preTurn\": [\n      {\n        \"handler\": {\n          \"flowReferenceId\": \"<string>\",\n          \"kind\": \"<string>\"\n        }\n      }\n    ]\n  },\n  \"image\": \"<string>\",\n  \"imageOptimizedFormat\": true,\n  \"instructions\": \"<string>\",\n  \"knowledge\": {\n    \"cognigyParameters\": {\n      \"language\": \"<string>\",\n      \"stores\": [\n        \"<string>\"\n      ],\n      \"topK\": 123\n    },\n    \"context\": \"<string>\",\n    \"onSearchFailure\": \"<string>\",\n    \"ragMode\": \"<string>\",\n    \"ragType\": \"<string>\"\n  },\n  \"largeLanguageModelReferenceId\": \"<string>\",\n  \"llmConfig\": {\n    \"maxOutputTokens\": 123,\n    \"reasoningEffort\": \"<string>\",\n    \"temperature\": 123\n  },\n  \"personaReferenceId\": \"<string>\",\n  \"realtimeVoice\": \"<string>\",\n  \"role\": \"<string>\",\n  \"skillReferenceIds\": [\n    \"<string>\"\n  ],\n  \"toolReferenceIds\": [\n    \"<string>\"\n  ],\n  \"voiceLargeLanguageModelReferenceId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "agentType": "voice",
  "createdAt": 123,
  "createdBy": "507f1f77bcf86cd799439011",
  "description": "<string>",
  "disabledToolReferenceIds": [
    "<string>"
  ],
  "guardrails": {
    "dataPrivacy": {
      "contactProfilesOption": "completeProfile",
      "selectedProfileFields": [
        "<string>"
      ]
    },
    "safetySettings": {
      "avoidCopyrightInfringements": true,
      "avoidHarmfulContent": true,
      "avoidUngroundedContent": true,
      "preventJailbreakAndManipulation": true
    }
  },
  "hooks": {
    "preTurn": [
      {
        "handler": {
          "flowReferenceId": "<string>",
          "kind": "<string>"
        }
      }
    ]
  },
  "id": "507f1f77bcf86cd799439011",
  "image": "<string>",
  "imageOptimizedFormat": true,
  "instructions": "<string>",
  "knowledge": {
    "cognigyParameters": {
      "language": "<string>",
      "stores": [
        "<string>"
      ],
      "topK": 123
    },
    "context": "<string>",
    "onSearchFailure": "<string>",
    "ragMode": "<string>",
    "ragType": "<string>"
  },
  "largeLanguageModelReferenceId": "<string>",
  "lastChangedAt": 123,
  "lastChangedBy": "507f1f77bcf86cd799439011",
  "llmConfig": {
    "maxOutputTokens": 123,
    "reasoningEffort": "<string>",
    "temperature": 123
  },
  "localeReferenceId": "<string>",
  "name": "<string>",
  "organisationId": "507f1f77bcf86cd799439011",
  "personaReferenceId": "<string>",
  "projectId": "507f1f77bcf86cd799439011",
  "realtimeVoice": "<string>",
  "referenceId": "<string>",
  "role": "<string>",
  "skillReferenceIds": [
    "<string>"
  ],
  "toolReferenceIds": [
    "<string>"
  ],
  "voiceLargeLanguageModelReferenceId": "<string>",
  "voicePromptTemplate": "<string>"
}

{
  "detail": "request body validation failed",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "instance": "/v1/{resource}",
  "status": 400,
  "title": "Bad Request",
  "traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
  "type": "about:blank"
}

{
  "detail": "access denied: insufficient permissions",
  "instance": "/v1/{resource}/{id}",
  "status": 403,
  "title": "Forbidden",
  "traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
  "type": "about:blank"
}

{
  "detail": "a resource with this identifier already exists",
  "instance": "/v1/{resource}",
  "status": 409,
  "title": "Conflict",
  "traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
  "type": "about:blank"
}

{
  "detail": "internal server error",
  "instance": "/v1/{resource}",
  "status": 500,
  "title": "Internal Server Error",
  "traceId": "api--a4d2f126-bec4-4544-a049-7c0cf08524ed",
  "type": "about:blank"
}