API Reference

Admin

Organization

External Storage

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create an external storage configuration

admin.organization.external_storage.create(**kwargs) -> OrganizationExternalStorage { id, created_at, geography, 4 more }

POST/organization/external_storage

Register one customer-managed external storage configuration.

ParametersExpand Collapse

project_id: String

provider: Aws{ bucket, role_arn, type} | Azure{ account_name, container, resource_group, 3 more}

ReturnsExpand Collapse

class OrganizationExternalStorage { id, created_at, geography, 4 more }

id: String

created_at: Integer

formatunixtime

geography: String

object: :"organization.external_storage"

project_id: String

provider: Aws{ account_id, bucket, external_id, 3 more} | Azure{ account_name, container, region, 4 more}

status: :pending | :validated | :unhealthy

Create an external storage configuration

Ruby

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

require "openai"

openai = OpenAI::Client.new(admin_api_key: "My Admin API Key")

organization_external_storage = openai.admin.organization.external_storage.create(
  project_id: "proj_123",
  provider: {bucket: "bucket", role_arn: "role_arn", type: :aws}
)

puts(organization_external_storage)

200 example

{
  "id": "id",
  "created_at": 0,
  "geography": "geography",
  "object": "organization.external_storage",
  "project_id": "project_id",
  "provider": {
    "account_id": "account_id",
    "bucket": "bucket",
    "external_id": "external_id",
    "region": "region",
    "role_arn": "role_arn",
    "type": "aws"
  },
  "status": "pending"
}

Returns Examples

200 example

{
  "id": "id",
  "created_at": 0,
  "geography": "geography",
  "object": "organization.external_storage",
  "project_id": "project_id",
  "provider": {
    "account_id": "account_id",
    "bucket": "bucket",
    "external_id": "external_id",
    "region": "region",
    "role_arn": "role_arn",
    "type": "aws"
  },
  "status": "pending"
}