Documentation Index
Fetch the complete documentation index at: https://docs.openpipe.ai/llms.txt
Use this file to discover all available pages before exploring further.
Use the OpenPipe SDK as a drop-in replacement for the generic OpenAI package. Calls sent through the OpenPipe SDK will be recorded by default for later training. You’ll use this same SDK to call your own fine-tuned models once they’re deployed.
Python
NodeJS (ESM)
NodeJS (CJS)
Find the SDK at https://pypi.org/project/openpipe/Installation
Simple Integration
Add OPENPIPE_API_KEY to your environment variables.export OPENPIPE_API_KEY=opk-<your-api-key>
# Or you can set it in your code, see "Complete Example" below
from openai import OpenAI
from openpipe import OpenAI
Complete Example
from openpipe import OpenAI
import os
client = OpenAI(
# defaults to os.environ.get("OPENAI_API_KEY")
api_key="My API Key",
openpipe={
# defaults to os.environ.get("OPENPIPE_API_KEY")
"api_key": "My OpenPipe API Key",
# optional, defaults to process.env["OPENPIPE_BASE_URL"] or https://api.openpipe.ai/api/v1 if not set
"base_url": "My URL",
}
)
completion = client.chat.completions.create(
model="gpt-4o",
messages=[{"role": "system", "content": "count to 10"}],
metadata={"prompt_id": "counting", "any_key": "any_value"},
)
Find the SDK at https://www.npmjs.com/package/openpipeInstallation
npm install --save openpipe
# or
yarn add openpipe
Simple Integration
Add OPENPIPE_API_KEY to your environment variables.export OPENPIPE_API_KEY=opk-<your-api-key>
# Or you can set it in your code, see "Complete Example" below
import OpenAI from "openai";
import OpenAI from "openpipe/openai";
Complete Example
import OpenAI from "openpipe/openai";
// Fully compatible with original OpenAI initialization
const openai = new OpenAI({
apiKey: "my api key", // defaults to process.env["OPENAI_API_KEY"]
// openpipe key is optional
openpipe: {
apiKey: "my api key", // defaults to process.env["OPENPIPE_API_KEY"]
baseUrl: "my url", // defaults to process.env["OPENPIPE_BASE_URL"] or https://api.openpipe.ai/api/v1 if not set
},
});
const completion = await openai.chat.completions.create({
messages: [{ role: "user", content: "Count to 10" }],
model: "gpt-4o",
// optional
metadata: {
prompt_id: "counting",
any_key: "any_value",
},
store: true, // Enable/disable data collection. Defaults to true.
});
Find the SDK at https://www.npmjs.com/package/openpipeInstallation
npm install --save openpipe
# or
yarn add openpipe
Simple Integration
Add OPENPIPE_API_KEY to your environment variables.export OPENPIPE_API_KEY=opk-<your-api-key>
# Or you can set it in your code, see "Complete Example" below
const OpenAI = require("openai");
const OpenAI = require("openpipe/openai").default;
Complete Example
import OpenAI from "openpipe/openai";
// Fully compatible with original OpenAI initialization
const openai = new OpenAI({
apiKey: "my api key", // defaults to process.env["OPENAI_API_KEY"]
// openpipe key is optional
openpipe: {
apiKey: "my api key", // defaults to process.env["OPENPIPE_API_KEY"]
baseUrl: "my url", // defaults to process.env["OPENPIPE_BASE_URL"] or https://api.openpipe.ai/api/v1 if not set
},
});
const completion = await openai.chat.completions.create({
messages: [{ role: "user", content: "Count to 10" }],
model: "gpt-4o",
// optional
metadata: {
prompt_id: "counting",
any_key: "any_value",
},
store: true, // Enable/disable data collection. Defaults to true.
});
Should I Wait to Enable Logging?
We recommend keeping request logging turned on from the beginning. If you change your prompt you can just set a new prompt_id metadata tag so you can select just the latest version when you’re ready to create a dataset.
