---
title: "OpenAI"
description: "Adds instrumentation for the OpenAI SDK. (default)"
url: https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations/openai/
---

# OpenAI | Sentry for Effect

Requires SDK version `11.0.0` or higher. On earlier versions, see the [Agent Tracing](https://docs.sentry.io/platforms/javascript/agent-tracing.md) setup for your SDK.

*Import name: `Sentry.openAIIntegration`*

This integration is enabled by default when tracing is enabled. If you'd like to modify your default integrations, read [this](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations.md#modifying-default-integrations).

The `openAIIntegration` adds instrumentation for the [`openai`](https://www.npmjs.com/package/openai) SDK to capture [agent tracing](https://docs.sentry.io/platforms/javascript/guides/effect/agent-tracing.md) `gen_ai` spans, recording model, token usage, latency, and (when enabled) inputs and outputs.

```javascript
Sentry.init({
  dsn: "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
  // Tracing must be enabled for agent tracing to work
  tracesSampleRate: 1.0,
  integrations: [Sentry.openAIIntegration()],
});
```

## [Supported Operations](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations/openai.md#supported-operations)

By default, tracing support is added to the following OpenAI SDK calls:

* `chat.completions.create()` - Chat completion requests
* `responses.create()` - Response SDK requests
* `embeddings.create()` - Generate embeddings
* `conversations.create()` - Create conversations

Streaming and non-streaming requests are automatically detected and handled appropriately. `chat.completions.create()` and `responses.create()` produce the same span type: op `gen_ai.chat`, name like `chat <model>`.

## [Supported Versions](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations/openai.md#supported-versions)

* `openai`: `>=4.0.0 <8`

## [Options](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations/openai.md#options)

### [`recordInputs`](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations/openai.md#recordinputs)

*Type: `boolean` (optional)*

Records inputs to OpenAI SDK calls (such as prompts and messages).

Defaults to `true` if `dataCollection.genAI.inputs` is `true` (which is the default when using `dataCollection`), or if the deprecated `sendDefaultPii` is `true`.

### [`recordOutputs`](https://docs.sentry.io/platforms/javascript/guides/effect/configuration/integrations/openai.md#recordoutputs)

*Type: `boolean` (optional)*

Records outputs from OpenAI SDK calls (such as generated text and responses).

Defaults to `true` if `dataCollection.genAI.outputs` is `true` (which is the default when using `dataCollection`), or if the deprecated `sendDefaultPii` is `true`.

```javascript
Sentry.init({
  dsn: "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
  tracesSampleRate: 1.0,
  integrations: [
    Sentry.openAIIntegration({
      recordInputs: true,
      recordOutputs: true,
    }),
  ],
});
```