---
title: "Get an OpenAI integration"
method: GET
path: "/v1/integrations/openai/{id}"
tags: ["OpenAI Integration"]
---

# Get an OpenAI integration

`GET /v1/integrations/openai/{id}`

## Request

- Base URL: `https://docs.grepr.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.grepr.ai/v1/integrations/openai/{id}`
- Auth: one of:
  - API key in header `GREPR-API-KEY`
  - OpenID Connect (`https://grepr-prod.us.auth0.com/.well-known/openid-configuration`)

Get an OpenAI integration by ID.

## Path parameters

- `id` string, required

## Response `200`

Integration retrieved successfully

- ReadOpenAi
  - `createdAt` string, date-time, required: Timestamp when the integration was created.
  - `id` string, required: The integration id
  - `jobIds` string[], required: List of job IDs associated with the integration.
  - `name` string, required: Name of the integration.
  - `organizationId` string, required: Organization ID of the integration.
  - `payload` OpenAi, required: The payload containing integration data.
    - `apiKey` string: Masked API key for OpenAI
    - `integrationMaxTokens` integer: Total tokens all agents using this integration may consume per max-tokens window. Null uses the default of 200,000,000.
    - `maxTokensWindowHours` integer: Length in hours of the UTC-aligned max tokens window; must be a divisor of 24. Null uses the default of 1.
    - `supportsEmbedding` boolean: Whether this provider offers an embeddings API and can back agent investigation memory.
    - `validateKeysOnSave` boolean: Indicates whether to validate the API key when saving.
  - `teamIds` string[]: The team IDs that this integration is associated with.
  - `type` 'openai', required: The type of the integration. This is used to determine the payload type.
  - `updatedAt` string, date-time, required: Timestamp when the integration was last updated.
  - `version` integer, required: Version of the integration. Should be increased by one for every new update in order for the write to succeed. Otherwise, a '409 Conflict' will be returned.

## Other responses

- `401`: Unauthorized
- `404`: Integration not found.

---

[API](https://skmtc.dev/grepr/apis/grepr-api.md) - [All operations](https://skmtc.dev/grepr/apis/grepr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grepr/apis/grepr-api/revisions/2a5ce03a0bf0?raw)