OpenAI API

Hosted OpenAI model endpoints for text, vision, audio and embeddings.

Provider: default
Kind: AI service
Category: Compute
Official docs: https://developers.openai.com/api/docs/guides/your-data

Properties · 6 set by this component

property	type	values	required	kind default	this component
audio · component property	boolean	—	no	false	inherited
auth	enum	api-key \| oauth \| iam \| none	no	—	▸ api-key
batchApi · component property	boolean	—	no	false	inherited
contentFiltering	boolean	—	no	—	▸ false
customerManagedKeys	boolean	—	no	—	inherited
dataResidency · advanced	enum	us \| eu \| asia \| global	no	—	inherited
dataRetentionDays	integer	—	no	—	▸ 30
keyStore	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
modality	enum	text \| vision \| speech \| multimodal \| structured \| image \| video \| audio \| embedding \| rerank	no	—	▸ multimodal
moderation · component property	boolean	—	no	false	inherited
publicEndpoint	boolean	—	no	—	▸ true
quotaUnitsPerMinute	integer	—	no	—	inherited
rateLimitRpm · advanced	integer	—	no	—	inherited
rateLimitTpm · advanced	integer	—	no	—	inherited
realtime · component property	boolean	—	no	false	inherited
trainingOptIn · component property	boolean	—	no	false	inherited
usageTier · component property	enum	free \| tier-1 \| tier-2 \| tier-3 \| tier-4 \| tier-5	no	tier-1	inherited
viaGateway	boolean	—	no	false	inherited
zeroDataRetention · component property	boolean	—	no	false	inherited

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

AI API key not managedwarning

ai-api-key-unmanaged

This AI vendor is reached with an API key, and nothing in the design holds or rotates that key. It ends up in environment files or code, every caller shares it, and a single leak runs up the vendor bill until someone notices. Put the key in a key-management component, or say it is held there with keyStore.

— all of these hold:
— the node's `auth` is "api-key"
— the node's `keyStore` is false
— the node has at least one incoming edge from an app-server, worker or client
— this does not hold:
— the design contains a node of kind key-management

Stateful node without zone redundancyerror

stateful-node-without-zone-redundancy

A stateful compute node pinned to exactly one availability zone disappears with that zone, and its state goes with it. Nodes inside a cell are exempt, because there the cell is deliberately single-zone and redundancy comes from the other cells.

— all of these hold:
— the node's `stateless` is false
— the node sits inside exactly 1 availability-zone group
— this does not hold:
— the node sits inside at least one cell group

Use it in a design

nodes:
  - { id: "openai-api", component: "openai-api" }

Other AI service products · 125

and 85 more → AI service page

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# OpenAI API: hosted multimodal model endpoints (text, image, audio, embeddings) over a public HTTPS endpoint.
3# Per "Data controls in the OpenAI platform", API inputs and outputs are retained 30 days for abuse monitoring
4# and are not used to train models unless the organization opts in; Zero Data Retention needs prior approval.
5# Per "Rate limits", limits are per model in RPM/TPM and a new paying organization starts on Tier 1.
6# realtime (Realtime API over WebRTC or WebSocket), audio (speech to text and text to speech, Whisper) and
7# moderation (the separate moderation endpoint) are each a call the app has to make, so all start off.
8schemaVersion: "1"
9type: "component"
10id: "openai-api"
11kind: "ai-service"
12provider: "default"
13docs: "https://developers.openai.com/api/docs/guides/your-data"
14defaults:
15  auth: "api-key"
16  managed: true
17  modality: "multimodal"
18  publicEndpoint: true
19  dataRetentionDays: 30
20  contentFiltering: false
21properties:
22  usageTier:
23    type: "enum"
24    values: ["free", "tier-1", "tier-2", "tier-3", "tier-4", "tier-5"]
25    default: "tier-1"
26  zeroDataRetention:
27    type: "boolean"
28    default: false
29  trainingOptIn:
30    type: "boolean"
31    default: false
32  batchApi:
33    type: "boolean"
34    default: false
35  realtime:
36    type: "boolean"
37    default: false
38  audio:
39    type: "boolean"
40    default: false
41  moderation:
42    type: "boolean"
43    default: false

The same page as markdown, for an agent: /catalogue/components/openai-api.md