Proyectos
GET
https://api.smelter.ai/v2/projects
Devuelve la lista de proyectos junto con sus configuraciones. El ejemplo de respuesta:
{
"data":[
{
"title":"Mi nombre de marca",
"channel_name":"abcdef",
"query_params":{
"channel_keywords_include":["palabra clave uno", "palabra clave dos"],
"channel_keywords_exclude":["algo a excluir"],
"channel_languages": ["eng"],
"channel_source_names": ["myhost.com"]
}
},
{
"title":"Mi segundo nombre de marca",
"channel_name":"bcdfg",
"query_params":{
"channel_keywords_include":["segunda marca",
"channel_keywords_exclude":[],
"channel_languages": ["esp"],
"channel_source_names": ["myhost2.com"]
}
}, ...
]
}
GET
https://api.smelter.ai/v2/projects/<project_name>
Devuelve la configuración de un único proyecto. El ejemplo de respuesta:
{
"data":
{
"title":"Mi nombre de marca",
"channel_name":"abcdef",
"query_params":{
"channel_keywords_include":["palabra clave uno", "palabra clave dos"],
"channel_keywords_exclude":["algo a excluir"],
"channel_languages": ["eng"],
"channel_source_names": ["myhost.com"]
}
}
}
Los datos son los mismos que en el "endpoint" (punto final) anterior, que enumera todos los proyectos junto con su configuración.
PUT
https://api.smelter.ai/v2/projects/<project_name>
El contenido debe tener el siguiente formato. Deben especificarse todos los campos, de lo contrario se pueden perder.
El escenario recomendado para actualizar la configuración del proyecto es obtener la configuración actual utilizando GET
, hacer los cambios y PUT
toda la configuración. El ejemplo de respuesta:
"title":"Mi nombre de marca",
"channel_name":"abcdef",
"query_params":{
"channel_keywords_include":["palabra clave uno", "palabra clave dos"],
"channel_keywords_exclude":["algo a excluir"],
"channel_languages": ["eng"],
"channel_source_names": ["myhost.com"]
}
Si todo está correcto, devuelve el código 200
que contiene la nueva configuración del proyecto.
DELETE
https://api.smelter.ai/v2/projects/<project_name>
Devuelve el código 204
sin contenido.
POST
https://api.smelter.ai/v2/create_project
Acepta el contenido en el formato:
{
"title":"El título de tu canal",
"query_params": {
"channel_keywords_include":["primera palabra clave","segunda palabra clave"]
}
}
Cuando se crea el proyecto, responde con el código 200
que contiene la configuración del proyecto.