OpenAI API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "openai",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "data_checks": true,
  "config": {
    "api_key": "your_openai_platform_admin_api_key",
    "api_key_2": "your_openai_platform_project_api_key",
    "api_key_3": "your_chatgpt_admin_key",
    "organization_id": "your_openai_platform_organization_id",
    "workspace_id": "your_workspace_id",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`api_key`	Your OpenAI Platform Admin API key.
`api_key_2`	The API key for the OpenAI Platform project whose data you want to sync.
`api_key_3`	Your ChatGPT Admin key for syncing Codex Enterprise Analytics API and Compliance Platform data.
`organization_id`	The ID of the OpenAI API Platform organization whose organization-level Compliance Platform data you want to sync.
`workspace_id`	The ID of the ChatGPT Enterprise or Edu workspace whose data you want to sync.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the api_key, api_key_2, api_key_3, workspace_id and organization_id parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "openai",
  "group_id": "group_id",
  "config": {
    "api_key": "your_openai_platform_admin_api_key",
    "api_key_2": "your_openai_platform_project_api_key",
    "api_key_3": "your_chatgpt_admin_key",
    "workspace_id": "your_workspace_id",
    "organization_id": "your_openai_platform_organization_id"
  }
}

By using the Connect Card or the Fivetran dashboard.