Edita un agente
curl --request PATCH \
--url https://api.wondeya.com/v1/agents/{agentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"identity": {
"businessName": "<string>",
"description": "<string>",
"tone": "<string>",
"actions": [
{
"id": "talk_to_team",
"description": "<string>"
}
],
"links": [
{
"id": "menu",
"url": "<string>",
"path": {},
"description": "<string>",
"userDescription": "<string>"
}
]
},
"content": {
"useWorkspaceKnowledge": true,
"useWorkspaceAssets": true
},
"answerPolicy": {
"contactLinkId": {},
"forbiddenTopics": [
"<string>"
]
}
}
'import requests
url = "https://api.wondeya.com/v1/agents/{agentId}"
payload = {
"name": "<string>",
"identity": {
"businessName": "<string>",
"description": "<string>",
"tone": "<string>",
"actions": [
{
"id": "talk_to_team",
"description": "<string>"
}
],
"links": [
{
"id": "menu",
"url": "<string>",
"path": {},
"description": "<string>",
"userDescription": "<string>"
}
]
},
"content": {
"useWorkspaceKnowledge": True,
"useWorkspaceAssets": True
},
"answerPolicy": {
"contactLinkId": {},
"forbiddenTopics": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
identity: {
businessName: '<string>',
description: '<string>',
tone: '<string>',
actions: [{id: 'talk_to_team', description: '<string>'}],
links: [
{
id: 'menu',
url: '<string>',
path: {},
description: '<string>',
userDescription: '<string>'
}
]
},
content: {useWorkspaceKnowledge: true, useWorkspaceAssets: true},
answerPolicy: {contactLinkId: {}, forbiddenTopics: ['<string>']}
})
};
fetch('https://api.wondeya.com/v1/agents/{agentId}', 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.wondeya.com/v1/agents/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'identity' => [
'businessName' => '<string>',
'description' => '<string>',
'tone' => '<string>',
'actions' => [
[
'id' => 'talk_to_team',
'description' => '<string>'
]
],
'links' => [
[
'id' => 'menu',
'url' => '<string>',
'path' => [
],
'description' => '<string>',
'userDescription' => '<string>'
]
]
],
'content' => [
'useWorkspaceKnowledge' => true,
'useWorkspaceAssets' => true
],
'answerPolicy' => [
'contactLinkId' => [
],
'forbiddenTopics' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.wondeya.com/v1/agents/{agentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"identity\": {\n \"businessName\": \"<string>\",\n \"description\": \"<string>\",\n \"tone\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"talk_to_team\",\n \"description\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"id\": \"menu\",\n \"url\": \"<string>\",\n \"path\": {},\n \"description\": \"<string>\",\n \"userDescription\": \"<string>\"\n }\n ]\n },\n \"content\": {\n \"useWorkspaceKnowledge\": true,\n \"useWorkspaceAssets\": true\n },\n \"answerPolicy\": {\n \"contactLinkId\": {},\n \"forbiddenTopics\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.wondeya.com/v1/agents/{agentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"identity\": {\n \"businessName\": \"<string>\",\n \"description\": \"<string>\",\n \"tone\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"talk_to_team\",\n \"description\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"id\": \"menu\",\n \"url\": \"<string>\",\n \"path\": {},\n \"description\": \"<string>\",\n \"userDescription\": \"<string>\"\n }\n ]\n },\n \"content\": {\n \"useWorkspaceKnowledge\": true,\n \"useWorkspaceAssets\": true\n },\n \"answerPolicy\": {\n \"contactLinkId\": {},\n \"forbiddenTopics\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wondeya.com/v1/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"identity\": {\n \"businessName\": \"<string>\",\n \"description\": \"<string>\",\n \"tone\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"talk_to_team\",\n \"description\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"id\": \"menu\",\n \"url\": \"<string>\",\n \"path\": {},\n \"description\": \"<string>\",\n \"userDescription\": \"<string>\"\n }\n ]\n },\n \"content\": {\n \"useWorkspaceKnowledge\": true,\n \"useWorkspaceAssets\": true\n },\n \"answerPolicy\": {\n \"contactLinkId\": {},\n \"forbiddenTopics\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"identity": {
"businessName": "<string>",
"description": "<string>",
"tone": "<string>",
"actions": [
{
"id": "talk_to_team",
"description": "<string>"
}
],
"links": [
{
"id": "menu",
"label": {
"es": "<string>",
"en": "<string>"
},
"description": "<string>",
"url": "<string>",
"kind": "<string>",
"path": {}
}
]
},
"content": {
"useWorkspaceKnowledge": true,
"useWorkspaceAssets": true
},
"answerPolicy": {
"contactLinkId": {},
"forbiddenTopics": [
"<string>"
]
},
"defaultLocale": "es",
"locales": [
"es"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Agents
Edita un agente
Todo campo es opcional y un campo ausente se deja sin cambios. Define identity para indicarle al agente en nombre de quién habla; aplica a toda página que use este agente.
PATCH
/
v1
/
agents
/
{agentId}
Edita un agente
curl --request PATCH \
--url https://api.wondeya.com/v1/agents/{agentId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"identity": {
"businessName": "<string>",
"description": "<string>",
"tone": "<string>",
"actions": [
{
"id": "talk_to_team",
"description": "<string>"
}
],
"links": [
{
"id": "menu",
"url": "<string>",
"path": {},
"description": "<string>",
"userDescription": "<string>"
}
]
},
"content": {
"useWorkspaceKnowledge": true,
"useWorkspaceAssets": true
},
"answerPolicy": {
"contactLinkId": {},
"forbiddenTopics": [
"<string>"
]
}
}
'import requests
url = "https://api.wondeya.com/v1/agents/{agentId}"
payload = {
"name": "<string>",
"identity": {
"businessName": "<string>",
"description": "<string>",
"tone": "<string>",
"actions": [
{
"id": "talk_to_team",
"description": "<string>"
}
],
"links": [
{
"id": "menu",
"url": "<string>",
"path": {},
"description": "<string>",
"userDescription": "<string>"
}
]
},
"content": {
"useWorkspaceKnowledge": True,
"useWorkspaceAssets": True
},
"answerPolicy": {
"contactLinkId": {},
"forbiddenTopics": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
identity: {
businessName: '<string>',
description: '<string>',
tone: '<string>',
actions: [{id: 'talk_to_team', description: '<string>'}],
links: [
{
id: 'menu',
url: '<string>',
path: {},
description: '<string>',
userDescription: '<string>'
}
]
},
content: {useWorkspaceKnowledge: true, useWorkspaceAssets: true},
answerPolicy: {contactLinkId: {}, forbiddenTopics: ['<string>']}
})
};
fetch('https://api.wondeya.com/v1/agents/{agentId}', 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.wondeya.com/v1/agents/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'identity' => [
'businessName' => '<string>',
'description' => '<string>',
'tone' => '<string>',
'actions' => [
[
'id' => 'talk_to_team',
'description' => '<string>'
]
],
'links' => [
[
'id' => 'menu',
'url' => '<string>',
'path' => [
],
'description' => '<string>',
'userDescription' => '<string>'
]
]
],
'content' => [
'useWorkspaceKnowledge' => true,
'useWorkspaceAssets' => true
],
'answerPolicy' => [
'contactLinkId' => [
],
'forbiddenTopics' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.wondeya.com/v1/agents/{agentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"identity\": {\n \"businessName\": \"<string>\",\n \"description\": \"<string>\",\n \"tone\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"talk_to_team\",\n \"description\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"id\": \"menu\",\n \"url\": \"<string>\",\n \"path\": {},\n \"description\": \"<string>\",\n \"userDescription\": \"<string>\"\n }\n ]\n },\n \"content\": {\n \"useWorkspaceKnowledge\": true,\n \"useWorkspaceAssets\": true\n },\n \"answerPolicy\": {\n \"contactLinkId\": {},\n \"forbiddenTopics\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.wondeya.com/v1/agents/{agentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"identity\": {\n \"businessName\": \"<string>\",\n \"description\": \"<string>\",\n \"tone\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"talk_to_team\",\n \"description\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"id\": \"menu\",\n \"url\": \"<string>\",\n \"path\": {},\n \"description\": \"<string>\",\n \"userDescription\": \"<string>\"\n }\n ]\n },\n \"content\": {\n \"useWorkspaceKnowledge\": true,\n \"useWorkspaceAssets\": true\n },\n \"answerPolicy\": {\n \"contactLinkId\": {},\n \"forbiddenTopics\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wondeya.com/v1/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"identity\": {\n \"businessName\": \"<string>\",\n \"description\": \"<string>\",\n \"tone\": \"<string>\",\n \"actions\": [\n {\n \"id\": \"talk_to_team\",\n \"description\": \"<string>\"\n }\n ],\n \"links\": [\n {\n \"id\": \"menu\",\n \"url\": \"<string>\",\n \"path\": {},\n \"description\": \"<string>\",\n \"userDescription\": \"<string>\"\n }\n ]\n },\n \"content\": {\n \"useWorkspaceKnowledge\": true,\n \"useWorkspaceAssets\": true\n },\n \"answerPolicy\": {\n \"contactLinkId\": {},\n \"forbiddenTopics\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"identity": {
"businessName": "<string>",
"description": "<string>",
"tone": "<string>",
"actions": [
{
"id": "talk_to_team",
"description": "<string>"
}
],
"links": [
{
"id": "menu",
"label": {
"es": "<string>",
"en": "<string>"
},
"description": "<string>",
"url": "<string>",
"kind": "<string>",
"path": {}
}
]
},
"content": {
"useWorkspaceKnowledge": true,
"useWorkspaceAssets": true
},
"answerPolicy": {
"contactLinkId": {},
"forbiddenTopics": [
"<string>"
]
},
"defaultLocale": "es",
"locales": [
"es"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}Autorizaciones
Una clave de API del espacio de trabajo: wdy_live_… / wdy_test_…. Se crea en POST /workspaces/{tenantId}/keys y se muestra exactamente una vez.
Parámetros de ruta
Cuerpo
application/json
Respuesta
El id del agente. El único asidero que tiene.
Etiqueta interna. Nunca una dirección (sin slug).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
El idioma en que está redactado el texto del agente (D-44).
Opciones disponibles:
es, en Todos los idiomas que habla el agente.
Opciones disponibles:
es, en