Component
core/ai-agent/openai-agents-sdk
An agent built on the OpenAI Agents SDK, run in-cluster as an application image the Release supplies. The SDK is published as a library an application is built around rather than as a server, so there is no upstream image to pin: the catalog supplies none, and until a Release sets `infra.image` the build halts naming the container image and renders nothing. Deploying it gives that application as a worker wired to a model serving the OpenAI API. The Recipe delivers the model's endpoint, its model name and the connection's credential as the variables the SDK reads, so one image runs against any such model in the catalog without an endpoint in its code. By default the SDK uploads a trace of each run to OpenAI, authenticated with the key it reads as OPENAI_API_KEY, which here is the model connection's credential whatever model it reaches. While `values.upload_traces_to_openai` is false, its default, the Recipe delivers OPENAI_AGENTS_DISABLE_TRACING=1, and that upload is off unless the application turns tracing on in its own code. Set true, the variable is not delivered and each run's traces go to OpenAI. Each tool wired into the optional `tools` socket, such as a Model Context Protocol server reached over HTTP, reaches the application under variables named for the connection's alias, its address as AGGREGA_TOOL_<ALIAS>_URL, which the application hands to the SDK in its own code. An `inject:` block on a connection delivers the names the application reads, as variables or files: on a tools connection in place of the tool's address and header, and on the model connection beside the variables the SDK reads. The component's own `inject:` block takes `env` and `file` entries.
Provenance
- Content digest
- sha256:5232196409373c4428858df9231c3a4b20bc092234c779f25d696ff90e0399e2
- Published
- 2026-11-10T10:08:34Z
- Signing identity
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Signature
- Officialapplication/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:f470f4fc8ed75dc089afdd392d463470e34b09bb93c0095325cbd081f22ef8d1
Reference at this version
oci://hub.aggrega.ai/component/core/ai-agent/openai-agents-sdk:1.0.0Developer parameters
Values the developer sets in the Aggregate.
Extends BaseComponents#/schemas/BaseAgentParameter
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| upload_traces_to_openai | boolean | false | no | Whether the SDK uploads a trace of each run to OpenAI. While false, its default, the Recipe delivers OPENAI_AGENTS_DISABLE_TRACING=1, and the SDK's trace upload to OpenAI is off unless the application turns tracing on in its own code. Set true, no such variable is delivered, and the SDK sends each run's traces to OpenAI, authenticated with the model connection's key, delivered as OPENAI_API_KEY. |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| image | string | — | no | Container image running the application built on the OpenAI Agents SDK. |
Output contract
Values this component publishes to consumers over the uses topology.
No output values declared.
Uses sockets
The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.
model
- Selector
- component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
- Inject
- env, file
Slots each connection through this socket may fill
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | no | env | yes | Optional credential the agent presents to the model this connection reaches. When attached, the Recipe delivers it to the application as OPENAI_API_KEY (a Kubernetes secretKeyRef on helm, the inject pipe on compose); unattached, the application runs without an injected key. |
tools
- Selector
- component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
- Inject
- env, file
Slots each connection through this socket may fill
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | no | env | yes | Optional credential the agent presents to the tool this connection reaches, under the request header the tool publishes as credential_header: as Bearer <credential> under Authorization, and as the whole value of any other header. When attached, the Recipe delivers it as AGGREGA_TOOL_<ALIAS>_CREDENTIAL (a Kubernetes secretKeyRef on helm, the inject pipe on compose), on a connection writing an inject block too, and, on one writing none, the header as AGGREGA_TOOL_<ALIAS>_CREDENTIAL_HEADER where the tool publishes one. |
| endpoint | feature.aggrega.ai/kind=secret | no | env | yes | Optional whole address of the tool this connection reaches, the part carrying its key included, for a server that reads its key from its own address. When attached, the Recipe delivers it as AGGREGA_TOOL_<ALIAS>_URL in place of the endpoint the tool publishes: a Kubernetes secretKeyRef on helm, so the key reaches no rendered file, and the inject pipe on compose, written as delivered. |
Attachment slots
Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.
No attachment slots declared.
Self-inject allowlist
env, file
Relationships
Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.
Uses
- usesuses socket «model»
component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
Attachment slots: credential
core/ai-model/docker-model-runner v1.0.0 →core/ai-model/litellm v1.0.0 →core/ai-model/nvidia-api v1.0.0 →core/ai-model/nvidia-nim v1.0.0 →core/ai-model/ollama v1.0.0 →core/ai-model/openai v1.0.0 →core/ai-model/openai-compatible v1.0.0 →core/ai-model/openai-embedding v1.0.0 →core/ai-model/tei v1.0.0 →core/ai-model/tgi v1.0.0 →core/ai-model/vllm v1.0.0 →core/gateway/agentgateway v1.0.0 →core/gateway/apisix v1.0.0 →core/gateway/envoy-gateway v1.0.0 →core/gateway/higress v1.0.0 →core/gateway/kong v1.0.0 →core/gateway/kong-enterprise v1.0.0 →core/gateway/litellm v1.0.0 →core/gateway/traefik-hub v1.0.0 → - usesuses socket «tools»
component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
Attachment slots: credential, endpoint
- $refextends schema (values)
BaseComponents#/schemas/BaseAgentParameter
Used by
uses socket «runner»
uses socket «api»
uses socket «runner»
uses socket «api»
uses socket «services»
uses socket «api»
uses socket «services»
uses socket «services»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «api»
uses socket «ssrf_proxy»
uses socket «api»
uses socket «api»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «sandbox»
uses socket «plugin_daemon»
uses socket «ssrf_proxy»
uses socket «target_agent»
uses socket «scrape_target»
applies to
applies to
applies to
implements
implements