Skip to main content
POST

Authorizations

apikey
string
header
required

Body

application/json

Body of Test Compliance Connection. Nothing here is stored, including the key.

compliance_api_key
string<password>
required
write-only

The provider's compliance API key to probe.

workspace_id
string<uuid>
required

The ChatGPT workspace UUID, not an OpenAI organization id.

event_types
enum<string>[]

Which services to probe. Omit to let the service choose what to check.

Available options:
CONVERSATION_MESSAGE,
CODEX_LOG,
APP_LOG,
CUSTOM_AGENTS_LOG,
CHATGPT_PLUGIN_SPREADSHEET
proposed_cursor
string<date-time>

A start time you are considering. Supplying it makes the response carry a backfill estimate for the history since then.

max_pages
integer
default:10

How many pages of the provider's file listing to walk while estimating. Higher is slower but less likely to come back truncated.

Required range: 1 <= x <= 50

Response

The probe ran. key_valid and workspace_found say whether the credentials worked — a rejected key is reported here, not as a 4xx.

Result of the probe. A rejected key is reported here with key_valid: false and HTTP 200, not as a 4xx.

key_valid
boolean

Whether the provider accepted the key.

workspace_found
boolean

Whether that workspace was found. A false here with a valid key usually means an organization id was sent instead of a workspace id.

event_types
ComplianceEventTypeProbe · object[]

One entry per probed service.

backfill
ComplianceBackfillEstimate · object | null

Present only when proposed_cursor was sent.

error
string | null

Why the probe failed, when it did.