Saltar al contenido principal

Inicio rápido

Instale Rikoo, conecte un proveedor de modelos, construya y publique un agente en el Studio y expóngalo en su sitio o mediante la API pública.

Lo que necesita

Una máquina o un clúster de Kubernetes para alojar Rikoo, y acceso a un modelo: una clave de API de un proveedor alojado o un servidor compatible con OpenAI, como Ollama o vLLM.

Preparar el Studio​

1. Instalar Rikoo​

La instalación se describe en las guías de autoalojamiento: Docker Compose ejecuta todo en una sola máquina y Kubernetes (Helm) despliega en un clúster. Vuelva aquí cuando el Studio responda en PUBLIC_URL, la dirección pública de su instancia (http://localhost:3000 con los valores por defecto de Compose).

2. Crear la primera cuenta​

Abra PUBLIC_URL y regístrese. Mientras la instancia no tenga ninguna organización, la primera cuenta puede registrarse y crear una, de la que pasa a ser propietaria (Owner). Después, por defecto, las personas se unen por invitación (consulte Roles y permisos). La edición Community contiene una sola organización, y el servidor se niega a crear una segunda.

3. Usar el primer proyecto​

Al crear la organización se crea también un primer proyecto, del que usted es propietario. Un proyecto es el espacio de trabajo de un equipo, con sus propios agentes, colecciones de conocimiento, servidores MCP, habilidades, claves de API y miembros. Para añadir otro, use New project en la pantalla Organization.

4. Conectar un proveedor de modelos​

Abra LLM APIs, haga clic en Add a provider, elija el proveedor, pegue su clave de API y haga clic en Connect the provider. La clave queda sellada en la bóveda de secretos y el Studio no vuelve a mostrarla. A continuación, el worker prueba la conexión y descubre los modelos que sirve el proveedor, que quedan disponibles para sus agentes. Conectar un proveedor requiere el rol Admin u Owner.

5. Construir el agente y guardar una versión​

Abra Agents y haga clic en New agent. En Config, escriba las instrucciones y elija el modelo principal y, si lo desea, modelos de respaldo de otros proveedores. Adjunte una colección de conocimiento en Knowledge y conceda herramientas en Tools si el agente las necesita. Save a version congela la configuración en una versión numerada e inmutable. Pruébela en Playground, que ejecuta cualquier versión guardada y deja esas ejecuciones fuera de las métricas de producción.

6. Publicar​

En la pestaña Deploy del agente, elija el entorno en el selector de la parte superior de la página (Test o Production) y active al menos una superficie: el widget desde Configure the widget → o el interruptor Headless API. Slack solo responde en Production. Después haga clic en Publish…, seleccione la versión, elija el entorno en Deploy this version to y haga clic en Deploy. La versión queda fijada en todas las superficies activas de ese entorno, y las ejecuciones ya iniciadas conservan la versión con la que empezaron. Consulte Entornos.

Exponer el agente​

El widget y la API pública alcanzan cada uno la versión publicada en un entorno.

<!-- one script tag; the allowed origins are enforced server-side -->
<script src="$PUBLIC_URL/widget/widget.js"
        data-rikoo-token="rk_wgt_..." defer></script>

En la pestaña Deploy, Configure the widget → reúne el diseño, los orígenes permitidos, el token y este fragmento para el entorno seleccionado. El token rk_wgt_ designa un despliegue: el agente, la superficie y el entorno. Más detalles en Widget y SDK de JavaScript.

# a key with the full scope; its prefix (rk_test_ or rk_live_) selects the environment
curl -X POST "$PUBLIC_URL/api/v1/agents/$AGENT_ID/conversations" \
  -H "Authorization: Bearer $RIKOO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"My invoice is wrong","sync":true}'

Configure the API →, en la misma pestaña, muestra el punto de acceso, donde $AGENT_ID es el UUID del agente, y crea una clave limitada a este agente y al entorno seleccionado. Su valor se muestra una sola vez. Con sync, la llamada espera a la ejecución y devuelve la respuesta. Sin él, la llamada devuelve de inmediato los identificadores de la conversación y de la ejecución, y la respuesta llega en streaming por SSE desde /api/v1/agents/{agentId}/conversations/{conversationId}/runs/{runId}/stream. La página API pública cubre el resto.

La ejecución aparece después en Monitor → Traces con su versión, sus llamadas al modelo y a herramientas, sus tokens y su coste. Si el operador ha configurado un colector OpenTelemetry, la traza también se exporta allí.

  • Conceptos básicos: organización, proyecto, agente, versión y ejecución, las cinco palabras que el resto de la documentación da por sabidas.
  • Autoalojamiento: qué se ejecuta, qué edición elegir y cómo desplegarla.