Esta página se tradujo automáticamente. Leer el original en inglés.

Component

core/ai-agent/agenta-api

The control-plane API of an agent workspace: the service that holds the agents a team builds, each agent's instructions, tools, skills, permissions and version history, and the record of every run. It serves the REST API the console renders from and an external client calls, and it is the tier that reads and writes the platform's relational model. It holds no state of its own: a relational backend, a cache, a queue and an object store do, each wired through a socket of its own, and it reaches the authentication core wired through auth_core for every sign-in and every session check. Wire here for the platform's own data plane. It is the counterpart of core/ai-agent/agenta-services, which owns completions, chat and the dispatch of an agent run to the runner, so a caller that wants to invoke a model reaches that service rather than this one. Realized on Kubernetes via its Helm Recipe, which synthesizes the service as a stateless Deployment behind a ClusterIP Service on its HTTP port. It exports its host, port, endpoint and protocol to consumers.

Procedencia

OficialFirmado por una identidad de firma que este catálogo reconoce como editor oficial.
Digest del contenido
sha256:4f4386baa75d06eb78086e19737b007745d76247b3b684ebf92fbe57caa1bcc0
Publicado
2026-11-10T10:07:14Z
Identidad de firma
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Firma

  • Oficialapplication/vnd.dev.sigstore.bundle.v0.3+json

    https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

    sha256:5a82941a9c4c4a7aeb81161941eb7745567c5b120de9c7c56541c172f989fbf8

Referencia en esta versión

oci://hub.aggrega.ai/component/core/ai-agent/agenta-api:1.0.0

Parámetros del desarrollador

Valores que el desarrollador establece en el Aggregate.

NombreTipoPredeterminadoObligatorioDescripción
email_sign_in_enabledbooleantruenoAllow an account to sign in with an email address and a password. Turned off, only the sign-in methods configured elsewhere remain.
allowed_email_domainsstring—noComma-separated list of email domains an account may be created under. Left unset, any domain is accepted.
password_min_lengthinteger (min 1)8noFewest characters a password may have. The authentication core enforces it at sign-up and at password change.

Dimensionamiento del operador

Dimensionamiento de la infraestructura que el operador ajusta para cada entorno.

NombreTipoPredeterminadoObligatorioDescripción
portinteger (min 1024, max 65535)8000noPort the service serves its HTTP API on; consumers connect here. Most operators should omit this and let the Recipe assign the default (8000).
external_base_urlstring—noExternally reachable base URL of the whole platform, as a browser reaches it through the ingress tier — for example https://agenta.example.com. The service composes the addresses it hands out in links and mail from it. The compiler cannot know a cluster's external hostname, so this carries no default and the Kubernetes realization halts at build until it is set.
engine_versionstringv0.114.1noPlatform API container image tag. The API service, the model-facing service, the two worker tiers, the scheduler and the schema-migration task run the same image, so a Release moves them together.
web_workersinteger (min 1)2noNumber of request-serving worker processes in one container. Raising it raises throughput and the container's memory ceiling together, so it is sized with compute.memory.
log_levelstring (DEBUG | INFO | WARNING | ERROR | CRITICAL)INFOnoLog verbosity the service emits.
computeobject—no—
overridesobject (open)—noProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contrato de salida

Valores que este componente publica para los consumidores a través de la topología uses.

NombreTipoPredeterminadoObligatorioDescripción
hoststring—síIn-cluster DNS name of the Service fronting the control-plane API. The other tiers of the workspace, and any external client routed inward, dial this name.
portinteger—síTCP port that Service accepts API requests on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
endpointstring—síFull in-cluster base URL of the control-plane API, with the host and the port already composed. It is the address a peer tier calls, not the address a browser reaches, which the ingress tier publishes separately.
protocolstring—noURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.

Sockets uses

Los sockets de dependencia a través de los cuales se conecta este componente. El destino de cada conexión cableada a través de un socket debe satisfacer su selector de etiquetas, y cada conexión puede llevar un acoplamiento en los slots que declara el socket. Cada conexión que el Aggregate o la Release cablea a través del socket debe llenar los slots obligatorios.

backend

Selector
component.aggrega.ai/category=datastore
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credentialfeature.aggrega.ai/kind=secretnoenvsíPassword the service authenticates to the relational backend this connection reaches with. Delivered as an env secret reference and substituted into the connection URL at run time, so the value never appears in the rendered manifest. Unattached, the Recipe emits the development literal `apppass`, the default the standard-library relational Recipes leave in place; this catalog publishes it, so every Release that leaves the slot unattached shares that password.

cache

Selector
component.aggrega.ai/category=datastore
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
server_cafeature.aggrega.ai/kind=secretnofilesíOptional authority the platform's Redis client checks the cache's certificate against while the cache publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and names the file in the connection's URL. The build halts on a server_ca publishing no Secret name, and on one wired to a cache served without TLS. Fill it with core/referenced-secret.

queue

Selector
component.aggrega.ai/category=datastore
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
server_cafeature.aggrega.ai/kind=secretnofilesíOptional authority the platform's Redis client checks the queue's certificate against while the queue publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and names the file in the connection's URL. The build halts on a server_ca publishing no Secret name, and on one wired to a queue served without TLS. Fill it with core/referenced-secret.

auth_core

Selector
component.aggrega.ai/category=security
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credentialfeature.aggrega.ai/kind=secretnoenvsíAPI key presented to the authentication core this connection reaches. The core issues none by default and accepts every caller that can reach its address, so where a key is attached to the core, the same one is attached here. Unattached, no key is sent.

store

Selector
component.aggrega.ai/type=resource,component.aggrega.ai/category=storage
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credential_idfeature.aggrega.ai/kind=secretnoenvsíAccess-key identifier the S3 client authenticates to the object store this connection reaches with, the identifier half of the pair whose secret half is this connection's credential. It names an account on that store, so it matches whatever the store itself was given. Unattached, the Recipe presents the identifier admin.
credentialfeature.aggrega.ai/kind=secretnoenvsíSecret key paired with this connection's credential_id. There is no default: the build halts when nothing fills this slot, unless the connection's values set unauthenticated: true.

runner

Selector
component.aggrega.ai/category=ai-agent
Inyección
env

Slots que cada conexión a través de este socket puede llenar

SlotSelectorObligatorioInyecciónSensibleDescripción
credentialfeature.aggrega.ai/kind=secretnoenvsíToken presented on every call to the runner this connection reaches, which rejects an untokened request. The same credential is attached to the runner's own slot so both ends agree. Unattached, the Recipe emits the pinned development literal `dev-agenta-runner-change-me`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

Slots de acoplamiento

Puntos de enlace con nombre en los que una Feature se acopla a este componente. El selector de un slot restringe qué Feature puede llenarlo y su lista inject indica cómo puede entregarse el material de la Feature. Un slot obligatorio debe estar enlazado en cada instancia, mediante un acoplamiento en la instancia o en un ámbito superior, y un slot sensible se declara para manejar material secreto. Una Feature también puede acoplarse con un nombre que ningún slot declara.

SlotSelectorObligatorioInyecciónSensibleDescripción
auth_keyfeature.aggrega.ai/kind=secretsíenvsíRequired key the platform signs its own internal tokens with. Every workload of the platform that issues or verifies one carries the same value, so attaching a credential here attaches it to each of them. There is no default: the build halts when nothing fills this slot.
crypt_keyfeature.aggrega.ai/kind=secretsíenvsíRequired key the stored model-provider credentials and connected-application tokens are encrypted under. It must be the same value on every workload of the platform that reads them, and changing it makes what is already stored unreadable. There is no default: the build halts when nothing fills this slot.
services_internal_keyfeature.aggrega.ai/kind=secretnoenvsíKey this service and the model-facing service present to each other on internal calls. Both ends carry the same value. Unattached, the Recipe emits the pinned development literal `dev-agenta-internal-change-me`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

Lista de permitidos de autoinyección

env

Relaciones

Aristas tipadas hacia y desde otras entidades publicadas. Una referencia sin un destino publicado se muestra como una arista rota en lugar de como un enlace.

Usa

Usado por

Referencia del concepto Component →

El catálogo de Aggrega — un índice abierto de componentes, funcionalidades, recetas y los plugins que los renderizan.

Creado con el sistema de diseño compartido de Aggrega.

Privacidad