SpyBara
Go Premium

Reference 2026-07-12 06:58 UTC to 2026-07-13 15:59 UTC

49 files changed +1,211 −709. View all changes and history on the product overview
2026
Thu 16 20:57 Wed 15 02:58 Tue 14 06:58 Mon 13 15:59 Sun 12 06:58 Fri 10 23:02 Thu 9 20:58 Tue 7 08:02
Details

13131 13131 

13132 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.13132 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

13133 13133 

13134- `--owner-project-access: optional "active" or "inactive" or "any"`

13135 

13136 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

13137 

13134### Returns13138### Returns

13135 13139 

13136- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`13140- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`


13211 13215 

13212 The user's project role.13216 The user's project role.

13213 13217 

13218 - `owner_project_access: "active" or "inactive"`

13219 

13220 Whether the API key's owner currently has effective access to the project.

13221 

13222 - `"active"`

13223 

13224 - `"inactive"`

13225 

13214 - `redacted_value: string`13226 - `redacted_value: string`

13215 13227 

13216 The redacted value of the API key13228 The redacted value of the API key


13258 "role": "role"13270 "role": "role"

13259 }13271 }

13260 },13272 },

13273 "owner_project_access": "active",

13261 "redacted_value": "redacted_value"13274 "redacted_value": "redacted_value"

13262 }13275 }

13263 ],13276 ],


13288 13301 

13289### Returns13302### Returns

13290 13303 

13291- `project_api_key: object { id, created_at, last_used_at, 4 more }`13304- `project_api_key: object { id, created_at, last_used_at, 5 more }`

13292 13305 

13293 Represents an individual API key in a project.13306 Represents an individual API key in a project.

13294 13307 


13366 13379 

13367 The user's project role.13380 The user's project role.

13368 13381 

13382 - `owner_project_access: "active" or "inactive"`

13383 

13384 Whether the API key's owner currently has effective access to the project.

13385 

13386 - `"active"`

13387 

13388 - `"inactive"`

13389 

13369 - `redacted_value: string`13390 - `redacted_value: string`

13370 13391 

13371 The redacted value of the API key13392 The redacted value of the API key


13404 "role": "role"13425 "role": "role"

13405 }13426 }

13406 },13427 },

13428 "owner_project_access": "active",

13407 "redacted_value": "redacted_value"13429 "redacted_value": "redacted_value"

13408}13430}

13409```13431```


13462 13484 

13463### Project API Key13485### Project API Key

13464 13486 

13465- `project_api_key: object { id, created_at, last_used_at, 4 more }`13487- `project_api_key: object { id, created_at, last_used_at, 5 more }`

13466 13488 

13467 Represents an individual API key in a project.13489 Represents an individual API key in a project.

13468 13490 


13540 13562 

13541 The user's project role.13563 The user's project role.

13542 13564 

13565 - `owner_project_access: "active" or "inactive"`

13566 

13567 Whether the API key's owner currently has effective access to the project.

13568 

13569 - `"active"`

13570 

13571 - `"inactive"`

13572 

13543 - `redacted_value: string`13573 - `redacted_value: string`

13544 13574 

13545 The redacted value of the API key13575 The redacted value of the API key

Details

13129 13129 

13130 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.13130 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

13131 13131 

13132- `--owner-project-access: optional "active" or "inactive" or "any"`

13133 

13134 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

13135 

13132### Returns13136### Returns

13133 13137 

13134- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`13138- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`


13209 13213 

13210 The user's project role.13214 The user's project role.

13211 13215 

13216 - `owner_project_access: "active" or "inactive"`

13217 

13218 Whether the API key's owner currently has effective access to the project.

13219 

13220 - `"active"`

13221 

13222 - `"inactive"`

13223 

13212 - `redacted_value: string`13224 - `redacted_value: string`

13213 13225 

13214 The redacted value of the API key13226 The redacted value of the API key


13256 "role": "role"13268 "role": "role"

13257 }13269 }

13258 },13270 },

13271 "owner_project_access": "active",

13259 "redacted_value": "redacted_value"13272 "redacted_value": "redacted_value"

13260 }13273 }

13261 ],13274 ],


13286 13299 

13287### Returns13300### Returns

13288 13301 

13289- `project_api_key: object { id, created_at, last_used_at, 4 more }`13302- `project_api_key: object { id, created_at, last_used_at, 5 more }`

13290 13303 

13291 Represents an individual API key in a project.13304 Represents an individual API key in a project.

13292 13305 


13364 13377 

13365 The user's project role.13378 The user's project role.

13366 13379 

13380 - `owner_project_access: "active" or "inactive"`

13381 

13382 Whether the API key's owner currently has effective access to the project.

13383 

13384 - `"active"`

13385 

13386 - `"inactive"`

13387 

13367 - `redacted_value: string`13388 - `redacted_value: string`

13368 13389 

13369 The redacted value of the API key13390 The redacted value of the API key


13402 "role": "role"13423 "role": "role"

13403 }13424 }

13404 },13425 },

13426 "owner_project_access": "active",

13405 "redacted_value": "redacted_value"13427 "redacted_value": "redacted_value"

13406}13428}

13407```13429```


13460 13482 

13461### Project API Key13483### Project API Key

13462 13484 

13463- `project_api_key: object { id, created_at, last_used_at, 4 more }`13485- `project_api_key: object { id, created_at, last_used_at, 5 more }`

13464 13486 

13465 Represents an individual API key in a project.13487 Represents an individual API key in a project.

13466 13488 


13538 13560 

13539 The user's project role.13561 The user's project role.

13540 13562 

13563 - `owner_project_access: "active" or "inactive"`

13564 

13565 Whether the API key's owner currently has effective access to the project.

13566 

13567 - `"active"`

13568 

13569 - `"inactive"`

13570 

13541 - `redacted_value: string`13571 - `redacted_value: string`

13542 13572 

13543 The redacted value of the API key13573 The redacted value of the API key

Details

1792 1792 

1793 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.1793 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

1794 1794 

1795- `--owner-project-access: optional "active" or "inactive" or "any"`

1796 

1797 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

1798 

1795### Returns1799### Returns

1796 1800 

1797- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`1801- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`


1872 1876 

1873 The user's project role.1877 The user's project role.

1874 1878 

1879 - `owner_project_access: "active" or "inactive"`

1880 

1881 Whether the API key's owner currently has effective access to the project.

1882 

1883 - `"active"`

1884 

1885 - `"inactive"`

1886 

1875 - `redacted_value: string`1887 - `redacted_value: string`

1876 1888 

1877 The redacted value of the API key1889 The redacted value of the API key


1919 "role": "role"1931 "role": "role"

1920 }1932 }

1921 },1933 },

1934 "owner_project_access": "active",

1922 "redacted_value": "redacted_value"1935 "redacted_value": "redacted_value"

1923 }1936 }

1924 ],1937 ],


1949 1962 

1950### Returns1963### Returns

1951 1964 

1952- `project_api_key: object { id, created_at, last_used_at, 4 more }`1965- `project_api_key: object { id, created_at, last_used_at, 5 more }`

1953 1966 

1954 Represents an individual API key in a project.1967 Represents an individual API key in a project.

1955 1968 


2027 2040 

2028 The user's project role.2041 The user's project role.

2029 2042 

2043 - `owner_project_access: "active" or "inactive"`

2044 

2045 Whether the API key's owner currently has effective access to the project.

2046 

2047 - `"active"`

2048 

2049 - `"inactive"`

2050 

2030 - `redacted_value: string`2051 - `redacted_value: string`

2031 2052 

2032 The redacted value of the API key2053 The redacted value of the API key


2065 "role": "role"2086 "role": "role"

2066 }2087 }

2067 },2088 },

2089 "owner_project_access": "active",

2068 "redacted_value": "redacted_value"2090 "redacted_value": "redacted_value"

2069}2091}

2070```2092```


2123 2145 

2124### Project API Key2146### Project API Key

2125 2147 

2126- `project_api_key: object { id, created_at, last_used_at, 4 more }`2148- `project_api_key: object { id, created_at, last_used_at, 5 more }`

2127 2149 

2128 Represents an individual API key in a project.2150 Represents an individual API key in a project.

2129 2151 


2201 2223 

2202 The user's project role.2224 The user's project role.

2203 2225 

2226 - `owner_project_access: "active" or "inactive"`

2227 

2228 Whether the API key's owner currently has effective access to the project.

2229 

2230 - `"active"`

2231 

2232 - `"inactive"`

2233 

2204 - `redacted_value: string`2234 - `redacted_value: string`

2205 2235 

2206 The redacted value of the API key2236 The redacted value of the API key

Details

22 22 

23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

24 24 

25- `--owner-project-access: optional "active" or "inactive" or "any"`

26 

27 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

28 

25### Returns29### Returns

26 30 

27- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`31- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`


102 106 

103 The user's project role.107 The user's project role.

104 108 

109 - `owner_project_access: "active" or "inactive"`

110 

111 Whether the API key's owner currently has effective access to the project.

112 

113 - `"active"`

114 

115 - `"inactive"`

116 

105 - `redacted_value: string`117 - `redacted_value: string`

106 118 

107 The redacted value of the API key119 The redacted value of the API key


149 "role": "role"161 "role": "role"

150 }162 }

151 },163 },

164 "owner_project_access": "active",

152 "redacted_value": "redacted_value"165 "redacted_value": "redacted_value"

153 }166 }

154 ],167 ],


179 192 

180### Returns193### Returns

181 194 

182- `project_api_key: object { id, created_at, last_used_at, 4 more }`195- `project_api_key: object { id, created_at, last_used_at, 5 more }`

183 196 

184 Represents an individual API key in a project.197 Represents an individual API key in a project.

185 198 


257 270 

258 The user's project role.271 The user's project role.

259 272 

273 - `owner_project_access: "active" or "inactive"`

274 

275 Whether the API key's owner currently has effective access to the project.

276 

277 - `"active"`

278 

279 - `"inactive"`

280 

260 - `redacted_value: string`281 - `redacted_value: string`

261 282 

262 The redacted value of the API key283 The redacted value of the API key


295 "role": "role"316 "role": "role"

296 }317 }

297 },318 },

319 "owner_project_access": "active",

298 "redacted_value": "redacted_value"320 "redacted_value": "redacted_value"

299}321}

300```322```


353 375 

354### Project API Key376### Project API Key

355 377 

356- `project_api_key: object { id, created_at, last_used_at, 4 more }`378- `project_api_key: object { id, created_at, last_used_at, 5 more }`

357 379 

358 Represents an individual API key in a project.380 Represents an individual API key in a project.

359 381 


431 453 

432 The user's project role.454 The user's project role.

433 455 

456 - `owner_project_access: "active" or "inactive"`

457 

458 Whether the API key's owner currently has effective access to the project.

459 

460 - `"active"`

461 

462 - `"inactive"`

463 

434 - `redacted_value: string`464 - `redacted_value: string`

435 465 

436 The redacted value of the API key466 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23- `--owner-project-access: optional "active" or "inactive" or "any"`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

23### Returns27### Returns

24 28 

25- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`29- `ProjectApiKeyListResponse: object { data, has_more, object, 2 more }`


100 104 

101 The user's project role.105 The user's project role.

102 106 

107 - `owner_project_access: "active" or "inactive"`

108 

109 Whether the API key's owner currently has effective access to the project.

110 

111 - `"active"`

112 

113 - `"inactive"`

114 

103 - `redacted_value: string`115 - `redacted_value: string`

104 116 

105 The redacted value of the API key117 The redacted value of the API key


147 "role": "role"159 "role": "role"

148 }160 }

149 },161 },

162 "owner_project_access": "active",

150 "redacted_value": "redacted_value"163 "redacted_value": "redacted_value"

151 }164 }

152 ],165 ],

Details

18 18 

19### Returns19### Returns

20 20 

21- `project_api_key: object { id, created_at, last_used_at, 4 more }`21- `project_api_key: object { id, created_at, last_used_at, 5 more }`

22 22 

23 Represents an individual API key in a project.23 Represents an individual API key in a project.

24 24 


96 96 

97 The user's project role.97 The user's project role.

98 98 

99 - `owner_project_access: "active" or "inactive"`

100 

101 Whether the API key's owner currently has effective access to the project.

102 

103 - `"active"`

104 

105 - `"inactive"`

106 

99 - `redacted_value: string`107 - `redacted_value: string`

100 108 

101 The redacted value of the API key109 The redacted value of the API key


134 "role": "role"142 "role": "role"

135 }143 }

136 },144 },

145 "owner_project_access": "active",

137 "redacted_value": "redacted_value"146 "redacted_value": "redacted_value"

138}147}

139```148```

Details

494 494 

495 - `"event"`495 - `"event"`

496 496 

497### Safety Identifier Blocked Webhook Event

498 

499- `safety_identifier_blocked_webhook_event: object { id, created_at, data, 2 more }`

500 

501 Sent when a request associated with a safety identifier has been blocked.

502 

503 - `id: string`

504 

505 The unique ID of the event.

506 

507 - `created_at: number`

508 

509 The Unix timestamp (in seconds) of when the request was blocked.

510 

511 - `data: object { safety_category, safety_identifier, model, 2 more }`

512 

513 Event data payload.

514 

515 - `safety_category: string`

516 

517 The safety category that triggered the block, such as `bio` or `cyber`.

518 

519 - `safety_identifier: string`

520 

521 The stable safety identifier associated with the blocked request.

522 

523 - `model: optional string`

524 

525 The model used for the blocked request, if available.

526 

527 - `project_id: optional string`

528 

529 The project associated with the blocked request, if available.

530 

531 - `request_id: optional string`

532 

533 The OpenAI request ID for the blocked request, if available.

534 

535 - `type: "safety_identifier.blocked"`

536 

537 The type of the event. Always `safety_identifier.blocked`.

538 

539 - `object: optional "event"`

540 

541 The object of the event. Always `event`.

542 

543 - `"event"`

544 

545### Unwrap Webhook Event497### Unwrap Webhook Event

546 498 

547- `unwrap_webhook_event: BatchCancelledWebhookEvent or BatchCompletedWebhookEvent or BatchExpiredWebhookEvent or 13 more`499- `unwrap_webhook_event: BatchCancelledWebhookEvent or BatchCompletedWebhookEvent or BatchExpiredWebhookEvent or 12 more`

548 500 

549 Sent when a batch API request has been cancelled.501 Sent when a batch API request has been cancelled.

550 502 


1009 The object of the event. Always `event`.961 The object of the event. Always `event`.

1010 962 

1011 - `"event"`963 - `"event"`

1012 

1013 - `safety_identifier_blocked_webhook_event: object { id, created_at, data, 2 more }`

1014 

1015 Sent when a request associated with a safety identifier has been blocked.

1016 

1017 - `id: string`

1018 

1019 The unique ID of the event.

1020 

1021 - `created_at: number`

1022 

1023 The Unix timestamp (in seconds) of when the request was blocked.

1024 

1025 - `data: object { safety_category, safety_identifier, model, 2 more }`

1026 

1027 Event data payload.

1028 

1029 - `safety_category: string`

1030 

1031 The safety category that triggered the block, such as `bio` or `cyber`.

1032 

1033 - `safety_identifier: string`

1034 

1035 The stable safety identifier associated with the blocked request.

1036 

1037 - `model: optional string`

1038 

1039 The model used for the blocked request, if available.

1040 

1041 - `project_id: optional string`

1042 

1043 The project associated with the blocked request, if available.

1044 

1045 - `request_id: optional string`

1046 

1047 The OpenAI request ID for the blocked request, if available.

1048 

1049 - `type: "safety_identifier.blocked"`

1050 

1051 The type of the event. Always `safety_identifier.blocked`.

1052 

1053 - `object: optional "event"`

1054 

1055 The object of the event. Always `event`.

1056 

1057 - `"event"`

Details

15336 15336 

15337 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.15337 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

15338 15338 

15339 - `OwnerProjectAccess param.Field[AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess]`

15340 

15341 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

15342 

15343 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessActive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "active"`

15344 

15345 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessInactive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "inactive"`

15346 

15347 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessAny AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "any"`

15348 

15339### Returns15349### Returns

15340 15350 

15341- `type ProjectAPIKey struct{…}`15351- `type ProjectAPIKey struct{…}`


15418 15428 

15419 The user's project role.15429 The user's project role.

15420 15430 

15431 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

15432 

15433 Whether the API key's owner currently has effective access to the project.

15434 

15435 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

15436 

15437 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

15438 

15421 - `RedactedValue string`15439 - `RedactedValue string`

15422 15440 

15423 The redacted value of the API key15441 The redacted value of the API key


15480 "role": "role"15498 "role": "role"

15481 }15499 }

15482 },15500 },

15501 "owner_project_access": "active",

15483 "redacted_value": "redacted_value"15502 "redacted_value": "redacted_value"

15484 }15503 }

15485 ],15504 ],


15586 15605 

15587 The user's project role.15606 The user's project role.

15588 15607 

15608 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

15609 

15610 Whether the API key's owner currently has effective access to the project.

15611 

15612 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

15613 

15614 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

15615 

15589 - `RedactedValue string`15616 - `RedactedValue string`

15590 15617 

15591 The redacted value of the API key15618 The redacted value of the API key


15644 "role": "role"15671 "role": "role"

15645 }15672 }

15646 },15673 },

15674 "owner_project_access": "active",

15647 "redacted_value": "redacted_value"15675 "redacted_value": "redacted_value"

15648}15676}

15649```15677```


15800 15828 

15801 The user's project role.15829 The user's project role.

15802 15830 

15831 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

15832 

15833 Whether the API key's owner currently has effective access to the project.

15834 

15835 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

15836 

15837 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

15838 

15803 - `RedactedValue string`15839 - `RedactedValue string`

15804 15840 

15805 The redacted value of the API key15841 The redacted value of the API key

Details

15334 15334 

15335 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.15335 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

15336 15336 

15337 - `OwnerProjectAccess param.Field[AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess]`

15338 

15339 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

15340 

15341 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessActive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "active"`

15342 

15343 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessInactive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "inactive"`

15344 

15345 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessAny AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "any"`

15346 

15337### Returns15347### Returns

15338 15348 

15339- `type ProjectAPIKey struct{…}`15349- `type ProjectAPIKey struct{…}`


15416 15426 

15417 The user's project role.15427 The user's project role.

15418 15428 

15429 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

15430 

15431 Whether the API key's owner currently has effective access to the project.

15432 

15433 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

15434 

15435 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

15436 

15419 - `RedactedValue string`15437 - `RedactedValue string`

15420 15438 

15421 The redacted value of the API key15439 The redacted value of the API key


15478 "role": "role"15496 "role": "role"

15479 }15497 }

15480 },15498 },

15499 "owner_project_access": "active",

15481 "redacted_value": "redacted_value"15500 "redacted_value": "redacted_value"

15482 }15501 }

15483 ],15502 ],


15584 15603 

15585 The user's project role.15604 The user's project role.

15586 15605 

15606 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

15607 

15608 Whether the API key's owner currently has effective access to the project.

15609 

15610 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

15611 

15612 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

15613 

15587 - `RedactedValue string`15614 - `RedactedValue string`

15588 15615 

15589 The redacted value of the API key15616 The redacted value of the API key


15642 "role": "role"15669 "role": "role"

15643 }15670 }

15644 },15671 },

15672 "owner_project_access": "active",

15645 "redacted_value": "redacted_value"15673 "redacted_value": "redacted_value"

15646}15674}

15647```15675```


15798 15826 

15799 The user's project role.15827 The user's project role.

15800 15828 

15829 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

15830 

15831 Whether the API key's owner currently has effective access to the project.

15832 

15833 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

15834 

15835 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

15836 

15801 - `RedactedValue string`15837 - `RedactedValue string`

15802 15838 

15803 The redacted value of the API key15839 The redacted value of the API key

Details

2171 2171 

2172 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.2172 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

2173 2173 

2174 - `OwnerProjectAccess param.Field[AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess]`

2175 

2176 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

2177 

2178 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessActive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "active"`

2179 

2180 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessInactive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "inactive"`

2181 

2182 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessAny AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "any"`

2183 

2174### Returns2184### Returns

2175 2185 

2176- `type ProjectAPIKey struct{…}`2186- `type ProjectAPIKey struct{…}`


2253 2263 

2254 The user's project role.2264 The user's project role.

2255 2265 

2266 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

2267 

2268 Whether the API key's owner currently has effective access to the project.

2269 

2270 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

2271 

2272 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

2273 

2256 - `RedactedValue string`2274 - `RedactedValue string`

2257 2275 

2258 The redacted value of the API key2276 The redacted value of the API key


2315 "role": "role"2333 "role": "role"

2316 }2334 }

2317 },2335 },

2336 "owner_project_access": "active",

2318 "redacted_value": "redacted_value"2337 "redacted_value": "redacted_value"

2319 }2338 }

2320 ],2339 ],


2421 2440 

2422 The user's project role.2441 The user's project role.

2423 2442 

2443 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

2444 

2445 Whether the API key's owner currently has effective access to the project.

2446 

2447 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

2448 

2449 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

2450 

2424 - `RedactedValue string`2451 - `RedactedValue string`

2425 2452 

2426 The redacted value of the API key2453 The redacted value of the API key


2479 "role": "role"2506 "role": "role"

2480 }2507 }

2481 },2508 },

2509 "owner_project_access": "active",

2482 "redacted_value": "redacted_value"2510 "redacted_value": "redacted_value"

2483}2511}

2484```2512```


2635 2663 

2636 The user's project role.2664 The user's project role.

2637 2665 

2666 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

2667 

2668 Whether the API key's owner currently has effective access to the project.

2669 

2670 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

2671 

2672 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

2673 

2638 - `RedactedValue string`2674 - `RedactedValue string`

2639 2675 

2640 The redacted value of the API key2676 The redacted value of the API key

Details

22 22 

23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

24 24 

25 - `OwnerProjectAccess param.Field[AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess]`

26 

27 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

28 

29 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessActive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "active"`

30 

31 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessInactive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "inactive"`

32 

33 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessAny AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "any"`

34 

25### Returns35### Returns

26 36 

27- `type ProjectAPIKey struct{…}`37- `type ProjectAPIKey struct{…}`


104 114 

105 The user's project role.115 The user's project role.

106 116 

117 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

118 

119 Whether the API key's owner currently has effective access to the project.

120 

121 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

122 

123 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

124 

107 - `RedactedValue string`125 - `RedactedValue string`

108 126 

109 The redacted value of the API key127 The redacted value of the API key


166 "role": "role"184 "role": "role"

167 }185 }

168 },186 },

187 "owner_project_access": "active",

169 "redacted_value": "redacted_value"188 "redacted_value": "redacted_value"

170 }189 }

171 ],190 ],


272 291 

273 The user's project role.292 The user's project role.

274 293 

294 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

295 

296 Whether the API key's owner currently has effective access to the project.

297 

298 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

299 

300 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

301 

275 - `RedactedValue string`302 - `RedactedValue string`

276 303 

277 The redacted value of the API key304 The redacted value of the API key


330 "role": "role"357 "role": "role"

331 }358 }

332 },359 },

360 "owner_project_access": "active",

333 "redacted_value": "redacted_value"361 "redacted_value": "redacted_value"

334}362}

335```363```


486 514 

487 The user's project role.515 The user's project role.

488 516 

517 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

518 

519 Whether the API key's owner currently has effective access to the project.

520 

521 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

522 

523 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

524 

489 - `RedactedValue string`525 - `RedactedValue string`

490 526 

491 The redacted value of the API key527 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23 - `OwnerProjectAccess param.Field[AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess]`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

27 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessActive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "active"`

28 

29 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessInactive AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "inactive"`

30 

31 - `const AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccessAny AdminOrganizationProjectAPIKeyListParamsOwnerProjectAccess = "any"`

32 

23### Returns33### Returns

24 34 

25- `type ProjectAPIKey struct{…}`35- `type ProjectAPIKey struct{…}`


102 112 

103 The user's project role.113 The user's project role.

104 114 

115 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

116 

117 Whether the API key's owner currently has effective access to the project.

118 

119 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

120 

121 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

122 

105 - `RedactedValue string`123 - `RedactedValue string`

106 124 

107 The redacted value of the API key125 The redacted value of the API key


164 "role": "role"182 "role": "role"

165 }183 }

166 },184 },

185 "owner_project_access": "active",

167 "redacted_value": "redacted_value"186 "redacted_value": "redacted_value"

168 }187 }

169 ],188 ],

Details

94 94 

95 The user's project role.95 The user's project role.

96 96 

97 - `OwnerProjectAccess ProjectAPIKeyOwnerProjectAccess`

98 

99 Whether the API key's owner currently has effective access to the project.

100 

101 - `const ProjectAPIKeyOwnerProjectAccessActive ProjectAPIKeyOwnerProjectAccess = "active"`

102 

103 - `const ProjectAPIKeyOwnerProjectAccessInactive ProjectAPIKeyOwnerProjectAccess = "inactive"`

104 

97 - `RedactedValue string`105 - `RedactedValue string`

98 106 

99 The redacted value of the API key107 The redacted value of the API key


152 "role": "role"160 "role": "role"

153 }161 }

154 },162 },

163 "owner_project_access": "active",

155 "redacted_value": "redacted_value"164 "redacted_value": "redacted_value"

156}165}

157```166```

Details

555 555 

556 - `const ResponseIncompleteWebhookEventObjectEvent ResponseIncompleteWebhookEventObject = "event"`556 - `const ResponseIncompleteWebhookEventObjectEvent ResponseIncompleteWebhookEventObject = "event"`

557 557 

558### Safety Identifier Blocked Webhook Event

559 

560- `type SafetyIdentifierBlockedWebhookEvent struct{…}`

561 

562 Sent when a request associated with a safety identifier has been blocked.

563 

564 - `ID string`

565 

566 The unique ID of the event.

567 

568 - `CreatedAt int64`

569 

570 The Unix timestamp (in seconds) of when the request was blocked.

571 

572 - `Data SafetyIdentifierBlockedWebhookEventData`

573 

574 Event data payload.

575 

576 - `SafetyCategory string`

577 

578 The safety category that triggered the block, such as `bio` or `cyber`.

579 

580 - `SafetyIdentifier string`

581 

582 The stable safety identifier associated with the blocked request.

583 

584 - `Model string`

585 

586 The model used for the blocked request, if available.

587 

588 - `ProjectID string`

589 

590 The project associated with the blocked request, if available.

591 

592 - `RequestID string`

593 

594 The OpenAI request ID for the blocked request, if available.

595 

596 - `Type SafetyIdentifierBlocked`

597 

598 The type of the event. Always `safety_identifier.blocked`.

599 

600 - `const SafetyIdentifierBlockedSafetyIdentifierBlocked SafetyIdentifierBlocked = "safety_identifier.blocked"`

601 

602 - `Object SafetyIdentifierBlockedWebhookEventObject`

603 

604 The object of the event. Always `event`.

605 

606 - `const SafetyIdentifierBlockedWebhookEventObjectEvent SafetyIdentifierBlockedWebhookEventObject = "event"`

607 

608### Unwrap Webhook Event558### Unwrap Webhook Event

609 559 

610- `type UnwrapWebhookEventUnion interface{…}`560- `type UnwrapWebhookEventUnion interface{…}`


1102 The object of the event. Always `event`.1052 The object of the event. Always `event`.

1103 1053 

1104 - `const ResponseIncompleteWebhookEventObjectEvent ResponseIncompleteWebhookEventObject = "event"`1054 - `const ResponseIncompleteWebhookEventObjectEvent ResponseIncompleteWebhookEventObject = "event"`

1105 

1106 - `type SafetyIdentifierBlockedWebhookEvent struct{…}`

1107 

1108 Sent when a request associated with a safety identifier has been blocked.

1109 

1110 - `ID string`

1111 

1112 The unique ID of the event.

1113 

1114 - `CreatedAt int64`

1115 

1116 The Unix timestamp (in seconds) of when the request was blocked.

1117 

1118 - `Data SafetyIdentifierBlockedWebhookEventData`

1119 

1120 Event data payload.

1121 

1122 - `SafetyCategory string`

1123 

1124 The safety category that triggered the block, such as `bio` or `cyber`.

1125 

1126 - `SafetyIdentifier string`

1127 

1128 The stable safety identifier associated with the blocked request.

1129 

1130 - `Model string`

1131 

1132 The model used for the blocked request, if available.

1133 

1134 - `ProjectID string`

1135 

1136 The project associated with the blocked request, if available.

1137 

1138 - `RequestID string`

1139 

1140 The OpenAI request ID for the blocked request, if available.

1141 

1142 - `Type SafetyIdentifierBlocked`

1143 

1144 The type of the event. Always `safety_identifier.blocked`.

1145 

1146 - `const SafetyIdentifierBlockedSafetyIdentifierBlocked SafetyIdentifierBlocked = "safety_identifier.blocked"`

1147 

1148 - `Object SafetyIdentifierBlockedWebhookEventObject`

1149 

1150 The object of the event. Always `event`.

1151 

1152 - `const SafetyIdentifierBlockedWebhookEventObjectEvent SafetyIdentifierBlockedWebhookEventObject = "event"`

Details

14996 14996 

14997 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.14997 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

14998 14998 

14999 - `Optional<OwnerProjectAccess> ownerProjectAccess`

15000 

15001 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

15002 

15003 - `ACTIVE("active")`

15004 

15005 - `INACTIVE("inactive")`

15006 

15007 - `ANY("any")`

15008 

14999### Returns15009### Returns

15000 15010 

15001- `class ProjectApiKey:`15011- `class ProjectApiKey:`


15078 15088 

15079 The user's project role.15089 The user's project role.

15080 15090 

15091 - `OwnerProjectAccess ownerProjectAccess`

15092 

15093 Whether the API key's owner currently has effective access to the project.

15094 

15095 - `ACTIVE("active")`

15096 

15097 - `INACTIVE("inactive")`

15098 

15081 - `String redactedValue`15099 - `String redactedValue`

15082 15100 

15083 The redacted value of the API key15101 The redacted value of the API key


15130 "role": "role"15148 "role": "role"

15131 }15149 }

15132 },15150 },

15151 "owner_project_access": "active",

15133 "redacted_value": "redacted_value"15152 "redacted_value": "redacted_value"

15134 }15153 }

15135 ],15154 ],


15238 15257 

15239 The user's project role.15258 The user's project role.

15240 15259 

15260 - `OwnerProjectAccess ownerProjectAccess`

15261 

15262 Whether the API key's owner currently has effective access to the project.

15263 

15264 - `ACTIVE("active")`

15265 

15266 - `INACTIVE("inactive")`

15267 

15241 - `String redactedValue`15268 - `String redactedValue`

15242 15269 

15243 The redacted value of the API key15270 The redacted value of the API key


15292 "role": "role"15319 "role": "role"

15293 }15320 }

15294 },15321 },

15322 "owner_project_access": "active",

15295 "redacted_value": "redacted_value"15323 "redacted_value": "redacted_value"

15296}15324}

15297```15325```


15446 15474 

15447 The user's project role.15475 The user's project role.

15448 15476 

15477 - `OwnerProjectAccess ownerProjectAccess`

15478 

15479 Whether the API key's owner currently has effective access to the project.

15480 

15481 - `ACTIVE("active")`

15482 

15483 - `INACTIVE("inactive")`

15484 

15449 - `String redactedValue`15485 - `String redactedValue`

15450 15486 

15451 The redacted value of the API key15487 The redacted value of the API key

Details

14994 14994 

14995 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.14995 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

14996 14996 

14997 - `Optional<OwnerProjectAccess> ownerProjectAccess`

14998 

14999 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

15000 

15001 - `ACTIVE("active")`

15002 

15003 - `INACTIVE("inactive")`

15004 

15005 - `ANY("any")`

15006 

14997### Returns15007### Returns

14998 15008 

14999- `class ProjectApiKey:`15009- `class ProjectApiKey:`


15076 15086 

15077 The user's project role.15087 The user's project role.

15078 15088 

15089 - `OwnerProjectAccess ownerProjectAccess`

15090 

15091 Whether the API key's owner currently has effective access to the project.

15092 

15093 - `ACTIVE("active")`

15094 

15095 - `INACTIVE("inactive")`

15096 

15079 - `String redactedValue`15097 - `String redactedValue`

15080 15098 

15081 The redacted value of the API key15099 The redacted value of the API key


15128 "role": "role"15146 "role": "role"

15129 }15147 }

15130 },15148 },

15149 "owner_project_access": "active",

15131 "redacted_value": "redacted_value"15150 "redacted_value": "redacted_value"

15132 }15151 }

15133 ],15152 ],


15236 15255 

15237 The user's project role.15256 The user's project role.

15238 15257 

15258 - `OwnerProjectAccess ownerProjectAccess`

15259 

15260 Whether the API key's owner currently has effective access to the project.

15261 

15262 - `ACTIVE("active")`

15263 

15264 - `INACTIVE("inactive")`

15265 

15239 - `String redactedValue`15266 - `String redactedValue`

15240 15267 

15241 The redacted value of the API key15268 The redacted value of the API key


15290 "role": "role"15317 "role": "role"

15291 }15318 }

15292 },15319 },

15320 "owner_project_access": "active",

15293 "redacted_value": "redacted_value"15321 "redacted_value": "redacted_value"

15294}15322}

15295```15323```


15444 15472 

15445 The user's project role.15473 The user's project role.

15446 15474 

15475 - `OwnerProjectAccess ownerProjectAccess`

15476 

15477 Whether the API key's owner currently has effective access to the project.

15478 

15479 - `ACTIVE("active")`

15480 

15481 - `INACTIVE("inactive")`

15482 

15447 - `String redactedValue`15483 - `String redactedValue`

15448 15484 

15449 The redacted value of the API key15485 The redacted value of the API key

Details

2077 2077 

2078 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.2078 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

2079 2079 

2080 - `Optional<OwnerProjectAccess> ownerProjectAccess`

2081 

2082 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

2083 

2084 - `ACTIVE("active")`

2085 

2086 - `INACTIVE("inactive")`

2087 

2088 - `ANY("any")`

2089 

2080### Returns2090### Returns

2081 2091 

2082- `class ProjectApiKey:`2092- `class ProjectApiKey:`


2159 2169 

2160 The user's project role.2170 The user's project role.

2161 2171 

2172 - `OwnerProjectAccess ownerProjectAccess`

2173 

2174 Whether the API key's owner currently has effective access to the project.

2175 

2176 - `ACTIVE("active")`

2177 

2178 - `INACTIVE("inactive")`

2179 

2162 - `String redactedValue`2180 - `String redactedValue`

2163 2181 

2164 The redacted value of the API key2182 The redacted value of the API key


2211 "role": "role"2229 "role": "role"

2212 }2230 }

2213 },2231 },

2232 "owner_project_access": "active",

2214 "redacted_value": "redacted_value"2233 "redacted_value": "redacted_value"

2215 }2234 }

2216 ],2235 ],


2319 2338 

2320 The user's project role.2339 The user's project role.

2321 2340 

2341 - `OwnerProjectAccess ownerProjectAccess`

2342 

2343 Whether the API key's owner currently has effective access to the project.

2344 

2345 - `ACTIVE("active")`

2346 

2347 - `INACTIVE("inactive")`

2348 

2322 - `String redactedValue`2349 - `String redactedValue`

2323 2350 

2324 The redacted value of the API key2351 The redacted value of the API key


2373 "role": "role"2400 "role": "role"

2374 }2401 }

2375 },2402 },

2403 "owner_project_access": "active",

2376 "redacted_value": "redacted_value"2404 "redacted_value": "redacted_value"

2377}2405}

2378```2406```


2527 2555 

2528 The user's project role.2556 The user's project role.

2529 2557 

2558 - `OwnerProjectAccess ownerProjectAccess`

2559 

2560 Whether the API key's owner currently has effective access to the project.

2561 

2562 - `ACTIVE("active")`

2563 

2564 - `INACTIVE("inactive")`

2565 

2530 - `String redactedValue`2566 - `String redactedValue`

2531 2567 

2532 The redacted value of the API key2568 The redacted value of the API key

Details

22 22 

23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

24 24 

25 - `Optional<OwnerProjectAccess> ownerProjectAccess`

26 

27 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

28 

29 - `ACTIVE("active")`

30 

31 - `INACTIVE("inactive")`

32 

33 - `ANY("any")`

34 

25### Returns35### Returns

26 36 

27- `class ProjectApiKey:`37- `class ProjectApiKey:`


104 114 

105 The user's project role.115 The user's project role.

106 116 

117 - `OwnerProjectAccess ownerProjectAccess`

118 

119 Whether the API key's owner currently has effective access to the project.

120 

121 - `ACTIVE("active")`

122 

123 - `INACTIVE("inactive")`

124 

107 - `String redactedValue`125 - `String redactedValue`

108 126 

109 The redacted value of the API key127 The redacted value of the API key


156 "role": "role"174 "role": "role"

157 }175 }

158 },176 },

177 "owner_project_access": "active",

159 "redacted_value": "redacted_value"178 "redacted_value": "redacted_value"

160 }179 }

161 ],180 ],


264 283 

265 The user's project role.284 The user's project role.

266 285 

286 - `OwnerProjectAccess ownerProjectAccess`

287 

288 Whether the API key's owner currently has effective access to the project.

289 

290 - `ACTIVE("active")`

291 

292 - `INACTIVE("inactive")`

293 

267 - `String redactedValue`294 - `String redactedValue`

268 295 

269 The redacted value of the API key296 The redacted value of the API key


318 "role": "role"345 "role": "role"

319 }346 }

320 },347 },

348 "owner_project_access": "active",

321 "redacted_value": "redacted_value"349 "redacted_value": "redacted_value"

322}350}

323```351```


472 500 

473 The user's project role.501 The user's project role.

474 502 

503 - `OwnerProjectAccess ownerProjectAccess`

504 

505 Whether the API key's owner currently has effective access to the project.

506 

507 - `ACTIVE("active")`

508 

509 - `INACTIVE("inactive")`

510 

475 - `String redactedValue`511 - `String redactedValue`

476 512 

477 The redacted value of the API key513 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23 - `Optional<OwnerProjectAccess> ownerProjectAccess`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

27 - `ACTIVE("active")`

28 

29 - `INACTIVE("inactive")`

30 

31 - `ANY("any")`

32 

23### Returns33### Returns

24 34 

25- `class ProjectApiKey:`35- `class ProjectApiKey:`


102 112 

103 The user's project role.113 The user's project role.

104 114 

115 - `OwnerProjectAccess ownerProjectAccess`

116 

117 Whether the API key's owner currently has effective access to the project.

118 

119 - `ACTIVE("active")`

120 

121 - `INACTIVE("inactive")`

122 

105 - `String redactedValue`123 - `String redactedValue`

106 124 

107 The redacted value of the API key125 The redacted value of the API key


154 "role": "role"172 "role": "role"

155 }173 }

156 },174 },

175 "owner_project_access": "active",

157 "redacted_value": "redacted_value"176 "redacted_value": "redacted_value"

158 }177 }

159 ],178 ],

Details

96 96 

97 The user's project role.97 The user's project role.

98 98 

99 - `OwnerProjectAccess ownerProjectAccess`

100 

101 Whether the API key's owner currently has effective access to the project.

102 

103 - `ACTIVE("active")`

104 

105 - `INACTIVE("inactive")`

106 

99 - `String redactedValue`107 - `String redactedValue`

100 108 

101 The redacted value of the API key109 The redacted value of the API key


150 "role": "role"158 "role": "role"

151 }159 }

152 },160 },

161 "owner_project_access": "active",

153 "redacted_value": "redacted_value"162 "redacted_value": "redacted_value"

154}163}

155```164```

Details

524 524 

525 - `EVENT("event")`525 - `EVENT("event")`

526 526 

527### Safety Identifier Blocked Webhook Event

528 

529- `class SafetyIdentifierBlockedWebhookEvent:`

530 

531 Sent when a request associated with a safety identifier has been blocked.

532 

533 - `String id`

534 

535 The unique ID of the event.

536 

537 - `long createdAt`

538 

539 The Unix timestamp (in seconds) of when the request was blocked.

540 

541 - `Data data`

542 

543 Event data payload.

544 

545 - `String safetyCategory`

546 

547 The safety category that triggered the block, such as `bio` or `cyber`.

548 

549 - `String safetyIdentifier`

550 

551 The stable safety identifier associated with the blocked request.

552 

553 - `Optional<String> model`

554 

555 The model used for the blocked request, if available.

556 

557 - `Optional<String> projectId`

558 

559 The project associated with the blocked request, if available.

560 

561 - `Optional<String> requestId`

562 

563 The OpenAI request ID for the blocked request, if available.

564 

565 - `JsonValue; type "safety_identifier.blocked"constant`

566 

567 The type of the event. Always `safety_identifier.blocked`.

568 

569 - `SAFETY_IDENTIFIER_BLOCKED("safety_identifier.blocked")`

570 

571 - `Optional<Object> object_`

572 

573 The object of the event. Always `event`.

574 

575 - `EVENT("event")`

576 

577### Unwrap Webhook Event527### Unwrap Webhook Event

578 528 

579- `class UnwrapWebhookEvent: A class that can be one of several variants.union`529- `class UnwrapWebhookEvent: A class that can be one of several variants.union`


1071 The object of the event. Always `event`.1021 The object of the event. Always `event`.

1072 1022 

1073 - `EVENT("event")`1023 - `EVENT("event")`

1074 

1075 - `class SafetyIdentifierBlockedWebhookEvent:`

1076 

1077 Sent when a request associated with a safety identifier has been blocked.

1078 

1079 - `String id`

1080 

1081 The unique ID of the event.

1082 

1083 - `long createdAt`

1084 

1085 The Unix timestamp (in seconds) of when the request was blocked.

1086 

1087 - `Data data`

1088 

1089 Event data payload.

1090 

1091 - `String safetyCategory`

1092 

1093 The safety category that triggered the block, such as `bio` or `cyber`.

1094 

1095 - `String safetyIdentifier`

1096 

1097 The stable safety identifier associated with the blocked request.

1098 

1099 - `Optional<String> model`

1100 

1101 The model used for the blocked request, if available.

1102 

1103 - `Optional<String> projectId`

1104 

1105 The project associated with the blocked request, if available.

1106 

1107 - `Optional<String> requestId`

1108 

1109 The OpenAI request ID for the blocked request, if available.

1110 

1111 - `JsonValue; type "safety_identifier.blocked"constant`

1112 

1113 The type of the event. Always `safety_identifier.blocked`.

1114 

1115 - `SAFETY_IDENTIFIER_BLOCKED("safety_identifier.blocked")`

1116 

1117 - `Optional<Object> object_`

1118 

1119 The object of the event. Always `event`.

1120 

1121 - `EVENT("event")`

Details

20643 20643 

20644 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.20644 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20645 20645 

20646- `owner_project_access: Optional[Literal["active", "inactive", "any"]]`

20647 

20648 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

20649 

20650 - `"active"`

20651 

20652 - `"inactive"`

20653 

20654 - `"any"`

20655 

20646### Returns20656### Returns

20647 20657 

20648- `class ProjectAPIKey: …`20658- `class ProjectAPIKey: …`


20725 20735 

20726 The user's project role.20736 The user's project role.

20727 20737 

20738 - `owner_project_access: Literal["active", "inactive"]`

20739 

20740 Whether the API key's owner currently has effective access to the project.

20741 

20742 - `"active"`

20743 

20744 - `"inactive"`

20745 

20728 - `redacted_value: str`20746 - `redacted_value: str`

20729 20747 

20730 The redacted value of the API key20748 The redacted value of the API key


20772 "role": "role"20790 "role": "role"

20773 }20791 }

20774 },20792 },

20793 "owner_project_access": "active",

20775 "redacted_value": "redacted_value"20794 "redacted_value": "redacted_value"

20776 }20795 }

20777 ],20796 ],


20878 20897 

20879 The user's project role.20898 The user's project role.

20880 20899 

20900 - `owner_project_access: Literal["active", "inactive"]`

20901 

20902 Whether the API key's owner currently has effective access to the project.

20903 

20904 - `"active"`

20905 

20906 - `"inactive"`

20907 

20881 - `redacted_value: str`20908 - `redacted_value: str`

20882 20909 

20883 The redacted value of the API key20910 The redacted value of the API key


20923 "role": "role"20950 "role": "role"

20924 }20951 }

20925 },20952 },

20953 "owner_project_access": "active",

20926 "redacted_value": "redacted_value"20954 "redacted_value": "redacted_value"

20927}20955}

20928```20956```


21066 21094 

21067 The user's project role.21095 The user's project role.

21068 21096 

21097 - `owner_project_access: Literal["active", "inactive"]`

21098 

21099 Whether the API key's owner currently has effective access to the project.

21100 

21101 - `"active"`

21102 

21103 - `"inactive"`

21104 

21069 - `redacted_value: str`21105 - `redacted_value: str`

21070 21106 

21071 The redacted value of the API key21107 The redacted value of the API key

Details

20641 20641 

20642 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.20642 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20643 20643 

20644- `owner_project_access: Optional[Literal["active", "inactive", "any"]]`

20645 

20646 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

20647 

20648 - `"active"`

20649 

20650 - `"inactive"`

20651 

20652 - `"any"`

20653 

20644### Returns20654### Returns

20645 20655 

20646- `class ProjectAPIKey: …`20656- `class ProjectAPIKey: …`


20723 20733 

20724 The user's project role.20734 The user's project role.

20725 20735 

20736 - `owner_project_access: Literal["active", "inactive"]`

20737 

20738 Whether the API key's owner currently has effective access to the project.

20739 

20740 - `"active"`

20741 

20742 - `"inactive"`

20743 

20726 - `redacted_value: str`20744 - `redacted_value: str`

20727 20745 

20728 The redacted value of the API key20746 The redacted value of the API key


20770 "role": "role"20788 "role": "role"

20771 }20789 }

20772 },20790 },

20791 "owner_project_access": "active",

20773 "redacted_value": "redacted_value"20792 "redacted_value": "redacted_value"

20774 }20793 }

20775 ],20794 ],


20876 20895 

20877 The user's project role.20896 The user's project role.

20878 20897 

20898 - `owner_project_access: Literal["active", "inactive"]`

20899 

20900 Whether the API key's owner currently has effective access to the project.

20901 

20902 - `"active"`

20903 

20904 - `"inactive"`

20905 

20879 - `redacted_value: str`20906 - `redacted_value: str`

20880 20907 

20881 The redacted value of the API key20908 The redacted value of the API key


20921 "role": "role"20948 "role": "role"

20922 }20949 }

20923 },20950 },

20951 "owner_project_access": "active",

20924 "redacted_value": "redacted_value"20952 "redacted_value": "redacted_value"

20925}20953}

20926```20954```


21064 21092 

21065 The user's project role.21093 The user's project role.

21066 21094 

21095 - `owner_project_access: Literal["active", "inactive"]`

21096 

21097 Whether the API key's owner currently has effective access to the project.

21098 

21099 - `"active"`

21100 

21101 - `"inactive"`

21102 

21067 - `redacted_value: str`21103 - `redacted_value: str`

21068 21104 

21069 The redacted value of the API key21105 The redacted value of the API key

Details

2224 2224 

2225 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.2225 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

2226 2226 

2227- `owner_project_access: Optional[Literal["active", "inactive", "any"]]`

2228 

2229 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

2230 

2231 - `"active"`

2232 

2233 - `"inactive"`

2234 

2235 - `"any"`

2236 

2227### Returns2237### Returns

2228 2238 

2229- `class ProjectAPIKey: …`2239- `class ProjectAPIKey: …`


2306 2316 

2307 The user's project role.2317 The user's project role.

2308 2318 

2319 - `owner_project_access: Literal["active", "inactive"]`

2320 

2321 Whether the API key's owner currently has effective access to the project.

2322 

2323 - `"active"`

2324 

2325 - `"inactive"`

2326 

2309 - `redacted_value: str`2327 - `redacted_value: str`

2310 2328 

2311 The redacted value of the API key2329 The redacted value of the API key


2353 "role": "role"2371 "role": "role"

2354 }2372 }

2355 },2373 },

2374 "owner_project_access": "active",

2356 "redacted_value": "redacted_value"2375 "redacted_value": "redacted_value"

2357 }2376 }

2358 ],2377 ],


2459 2478 

2460 The user's project role.2479 The user's project role.

2461 2480 

2481 - `owner_project_access: Literal["active", "inactive"]`

2482 

2483 Whether the API key's owner currently has effective access to the project.

2484 

2485 - `"active"`

2486 

2487 - `"inactive"`

2488 

2462 - `redacted_value: str`2489 - `redacted_value: str`

2463 2490 

2464 The redacted value of the API key2491 The redacted value of the API key


2504 "role": "role"2531 "role": "role"

2505 }2532 }

2506 },2533 },

2534 "owner_project_access": "active",

2507 "redacted_value": "redacted_value"2535 "redacted_value": "redacted_value"

2508}2536}

2509```2537```


2647 2675 

2648 The user's project role.2676 The user's project role.

2649 2677 

2678 - `owner_project_access: Literal["active", "inactive"]`

2679 

2680 Whether the API key's owner currently has effective access to the project.

2681 

2682 - `"active"`

2683 

2684 - `"inactive"`

2685 

2650 - `redacted_value: str`2686 - `redacted_value: str`

2651 2687 

2652 The redacted value of the API key2688 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23- `owner_project_access: Optional[Literal["active", "inactive", "any"]]`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

27 - `"active"`

28 

29 - `"inactive"`

30 

31 - `"any"`

32 

23### Returns33### Returns

24 34 

25- `class ProjectAPIKey: …`35- `class ProjectAPIKey: …`


102 112 

103 The user's project role.113 The user's project role.

104 114 

115 - `owner_project_access: Literal["active", "inactive"]`

116 

117 Whether the API key's owner currently has effective access to the project.

118 

119 - `"active"`

120 

121 - `"inactive"`

122 

105 - `redacted_value: str`123 - `redacted_value: str`

106 124 

107 The redacted value of the API key125 The redacted value of the API key


149 "role": "role"167 "role": "role"

150 }168 }

151 },169 },

170 "owner_project_access": "active",

152 "redacted_value": "redacted_value"171 "redacted_value": "redacted_value"

153 }172 }

154 ],173 ],


255 274 

256 The user's project role.275 The user's project role.

257 276 

277 - `owner_project_access: Literal["active", "inactive"]`

278 

279 Whether the API key's owner currently has effective access to the project.

280 

281 - `"active"`

282 

283 - `"inactive"`

284 

258 - `redacted_value: str`285 - `redacted_value: str`

259 286 

260 The redacted value of the API key287 The redacted value of the API key


300 "role": "role"327 "role": "role"

301 }328 }

302 },329 },

330 "owner_project_access": "active",

303 "redacted_value": "redacted_value"331 "redacted_value": "redacted_value"

304}332}

305```333```


443 471 

444 The user's project role.472 The user's project role.

445 473 

474 - `owner_project_access: Literal["active", "inactive"]`

475 

476 Whether the API key's owner currently has effective access to the project.

477 

478 - `"active"`

479 

480 - `"inactive"`

481 

446 - `redacted_value: str`482 - `redacted_value: str`

447 483 

448 The redacted value of the API key484 The redacted value of the API key

Details

18 18 

19 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.19 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20 20 

21- `owner_project_access: Optional[Literal["active", "inactive", "any"]]`

22 

23 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

24 

25 - `"active"`

26 

27 - `"inactive"`

28 

29 - `"any"`

30 

21### Returns31### Returns

22 32 

23- `class ProjectAPIKey: …`33- `class ProjectAPIKey: …`


100 110 

101 The user's project role.111 The user's project role.

102 112 

113 - `owner_project_access: Literal["active", "inactive"]`

114 

115 Whether the API key's owner currently has effective access to the project.

116 

117 - `"active"`

118 

119 - `"inactive"`

120 

103 - `redacted_value: str`121 - `redacted_value: str`

104 122 

105 The redacted value of the API key123 The redacted value of the API key


147 "role": "role"165 "role": "role"

148 }166 }

149 },167 },

168 "owner_project_access": "active",

150 "redacted_value": "redacted_value"169 "redacted_value": "redacted_value"

151 }170 }

152 ],171 ],

Details

94 94 

95 The user's project role.95 The user's project role.

96 96 

97 - `owner_project_access: Literal["active", "inactive"]`

98 

99 Whether the API key's owner currently has effective access to the project.

100 

101 - `"active"`

102 

103 - `"inactive"`

104 

97 - `redacted_value: str`105 - `redacted_value: str`

98 106 

99 The redacted value of the API key107 The redacted value of the API key


139 "role": "role"147 "role": "role"

140 }148 }

141 },149 },

150 "owner_project_access": "active",

142 "redacted_value": "redacted_value"151 "redacted_value": "redacted_value"

143}152}

144```153```

Details

544 544 

545 - `"event"`545 - `"event"`

546 546 

547### Safety Identifier Blocked Webhook Event

548 

549- `class SafetyIdentifierBlockedWebhookEvent: …`

550 

551 Sent when a request associated with a safety identifier has been blocked.

552 

553 - `id: str`

554 

555 The unique ID of the event.

556 

557 - `created_at: int`

558 

559 The Unix timestamp (in seconds) of when the request was blocked.

560 

561 - `data: Data`

562 

563 Event data payload.

564 

565 - `safety_category: str`

566 

567 The safety category that triggered the block, such as `bio` or `cyber`.

568 

569 - `safety_identifier: str`

570 

571 The stable safety identifier associated with the blocked request.

572 

573 - `model: Optional[str]`

574 

575 The model used for the blocked request, if available.

576 

577 - `project_id: Optional[str]`

578 

579 The project associated with the blocked request, if available.

580 

581 - `request_id: Optional[str]`

582 

583 The OpenAI request ID for the blocked request, if available.

584 

585 - `type: Literal["safety_identifier.blocked"]`

586 

587 The type of the event. Always `safety_identifier.blocked`.

588 

589 - `"safety_identifier.blocked"`

590 

591 - `object: Optional[Literal["event"]]`

592 

593 The object of the event. Always `event`.

594 

595 - `"event"`

596 

597### Unwrap Webhook Event547### Unwrap Webhook Event

598 548 

599- `UnwrapWebhookEvent`549- `UnwrapWebhookEvent`


1091 The object of the event. Always `event`.1041 The object of the event. Always `event`.

1092 1042 

1093 - `"event"`1043 - `"event"`

1094 

1095 - `class SafetyIdentifierBlockedWebhookEvent: …`

1096 

1097 Sent when a request associated with a safety identifier has been blocked.

1098 

1099 - `id: str`

1100 

1101 The unique ID of the event.

1102 

1103 - `created_at: int`

1104 

1105 The Unix timestamp (in seconds) of when the request was blocked.

1106 

1107 - `data: Data`

1108 

1109 Event data payload.

1110 

1111 - `safety_category: str`

1112 

1113 The safety category that triggered the block, such as `bio` or `cyber`.

1114 

1115 - `safety_identifier: str`

1116 

1117 The stable safety identifier associated with the blocked request.

1118 

1119 - `model: Optional[str]`

1120 

1121 The model used for the blocked request, if available.

1122 

1123 - `project_id: Optional[str]`

1124 

1125 The project associated with the blocked request, if available.

1126 

1127 - `request_id: Optional[str]`

1128 

1129 The OpenAI request ID for the blocked request, if available.

1130 

1131 - `type: Literal["safety_identifier.blocked"]`

1132 

1133 The type of the event. Always `safety_identifier.blocked`.

1134 

1135 - `"safety_identifier.blocked"`

1136 

1137 - `object: Optional[Literal["event"]]`

1138 

1139 The object of the event. Always `event`.

1140 

1141 - `"event"`

Details

22308 22308 

22309 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.22309 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22310 22310 

22311- `owner_project_access: optional "active" or "inactive" or "any"`

22312 

22313 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

22314 

22315 - `"active"`

22316 

22317 - `"inactive"`

22318 

22319 - `"any"`

22320 

22311### Returns22321### Returns

22312 22322 

22313- `data: array of ProjectAPIKey`22323- `data: array of ProjectAPIKey`


22388 22398 

22389 The user's project role.22399 The user's project role.

22390 22400 

22401 - `owner_project_access: "active" or "inactive"`

22402 

22403 Whether the API key's owner currently has effective access to the project.

22404 

22405 - `"active"`

22406 

22407 - `"inactive"`

22408 

22391 - `redacted_value: string`22409 - `redacted_value: string`

22392 22410 

22393 The redacted value of the API key22411 The redacted value of the API key


22436 "role": "role"22454 "role": "role"

22437 }22455 }

22438 },22456 },

22457 "owner_project_access": "active",

22439 "redacted_value": "redacted_value"22458 "redacted_value": "redacted_value"

22440 }22459 }

22441 ],22460 ],


22449### Example22468### Example

22450 22469 

22451```http22470```http

22452curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \22471curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20&owner_project_access=any \

22453 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \22472 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

22454 -H "Content-Type: application/json"22473 -H "Content-Type: application/json"

22455```22474```


22467 "created_at": 1711471533,22486 "created_at": 1711471533,

22468 "last_used_at": 1711471534,22487 "last_used_at": 1711471534,

22469 "id": "key_abc",22488 "id": "key_abc",

22489 "owner_project_access": "active",

22470 "owner": {22490 "owner": {

22471 "type": "user",22491 "type": "user",

22472 "user": {22492 "user": {


22499 22519 

22500### Returns22520### Returns

22501 22521 

22502- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`22522- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

22503 22523 

22504 Represents an individual API key in a project.22524 Represents an individual API key in a project.

22505 22525 


22579 22599 

22580 The user's project role.22600 The user's project role.

22581 22601 

22602 - `owner_project_access: "active" or "inactive"`

22603 

22604 Whether the API key's owner currently has effective access to the project.

22605 

22606 - `"active"`

22607 

22608 - `"inactive"`

22609 

22582 - `redacted_value: string`22610 - `redacted_value: string`

22583 22611 

22584 The redacted value of the API key22612 The redacted value of the API key


22615 "role": "role"22643 "role": "role"

22616 }22644 }

22617 },22645 },

22646 "owner_project_access": "active",

22618 "redacted_value": "redacted_value"22647 "redacted_value": "redacted_value"

22619}22648}

22620```22649```


22637 "created_at": 1711471533,22666 "created_at": 1711471533,

22638 "last_used_at": 1711471534,22667 "last_used_at": 1711471534,

22639 "id": "key_abc",22668 "id": "key_abc",

22669 "owner_project_access": "active",

22640 "owner": {22670 "owner": {

22641 "type": "user",22671 "type": "user",

22642 "user": {22672 "user": {


22715 22745 

22716### Project API Key22746### Project API Key

22717 22747 

22718- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`22748- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

22719 22749 

22720 Represents an individual API key in a project.22750 Represents an individual API key in a project.

22721 22751 


22795 22825 

22796 The user's project role.22826 The user's project role.

22797 22827 

22828 - `owner_project_access: "active" or "inactive"`

22829 

22830 Whether the API key's owner currently has effective access to the project.

22831 

22832 - `"active"`

22833 

22834 - `"inactive"`

22835 

22798 - `redacted_value: string`22836 - `redacted_value: string`

22799 22837 

22800 The redacted value of the API key22838 The redacted value of the API key

Details

22306 22306 

22307 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.22307 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22308 22308 

22309- `owner_project_access: optional "active" or "inactive" or "any"`

22310 

22311 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

22312 

22313 - `"active"`

22314 

22315 - `"inactive"`

22316 

22317 - `"any"`

22318 

22309### Returns22319### Returns

22310 22320 

22311- `data: array of ProjectAPIKey`22321- `data: array of ProjectAPIKey`


22386 22396 

22387 The user's project role.22397 The user's project role.

22388 22398 

22399 - `owner_project_access: "active" or "inactive"`

22400 

22401 Whether the API key's owner currently has effective access to the project.

22402 

22403 - `"active"`

22404 

22405 - `"inactive"`

22406 

22389 - `redacted_value: string`22407 - `redacted_value: string`

22390 22408 

22391 The redacted value of the API key22409 The redacted value of the API key


22434 "role": "role"22452 "role": "role"

22435 }22453 }

22436 },22454 },

22455 "owner_project_access": "active",

22437 "redacted_value": "redacted_value"22456 "redacted_value": "redacted_value"

22438 }22457 }

22439 ],22458 ],


22447### Example22466### Example

22448 22467 

22449```http22468```http

22450curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \22469curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20&owner_project_access=any \

22451 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \22470 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

22452 -H "Content-Type: application/json"22471 -H "Content-Type: application/json"

22453```22472```


22465 "created_at": 1711471533,22484 "created_at": 1711471533,

22466 "last_used_at": 1711471534,22485 "last_used_at": 1711471534,

22467 "id": "key_abc",22486 "id": "key_abc",

22487 "owner_project_access": "active",

22468 "owner": {22488 "owner": {

22469 "type": "user",22489 "type": "user",

22470 "user": {22490 "user": {


22497 22517 

22498### Returns22518### Returns

22499 22519 

22500- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`22520- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

22501 22521 

22502 Represents an individual API key in a project.22522 Represents an individual API key in a project.

22503 22523 


22577 22597 

22578 The user's project role.22598 The user's project role.

22579 22599 

22600 - `owner_project_access: "active" or "inactive"`

22601 

22602 Whether the API key's owner currently has effective access to the project.

22603 

22604 - `"active"`

22605 

22606 - `"inactive"`

22607 

22580 - `redacted_value: string`22608 - `redacted_value: string`

22581 22609 

22582 The redacted value of the API key22610 The redacted value of the API key


22613 "role": "role"22641 "role": "role"

22614 }22642 }

22615 },22643 },

22644 "owner_project_access": "active",

22616 "redacted_value": "redacted_value"22645 "redacted_value": "redacted_value"

22617}22646}

22618```22647```


22635 "created_at": 1711471533,22664 "created_at": 1711471533,

22636 "last_used_at": 1711471534,22665 "last_used_at": 1711471534,

22637 "id": "key_abc",22666 "id": "key_abc",

22667 "owner_project_access": "active",

22638 "owner": {22668 "owner": {

22639 "type": "user",22669 "type": "user",

22640 "user": {22670 "user": {


22713 22743 

22714### Project API Key22744### Project API Key

22715 22745 

22716- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`22746- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

22717 22747 

22718 Represents an individual API key in a project.22748 Represents an individual API key in a project.

22719 22749 


22793 22823 

22794 The user's project role.22824 The user's project role.

22795 22825 

22826 - `owner_project_access: "active" or "inactive"`

22827 

22828 Whether the API key's owner currently has effective access to the project.

22829 

22830 - `"active"`

22831 

22832 - `"inactive"`

22833 

22796 - `redacted_value: string`22834 - `redacted_value: string`

22797 22835 

22798 The redacted value of the API key22836 The redacted value of the API key

Details

2547 2547 

2548 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.2548 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

2549 2549 

2550- `owner_project_access: optional "active" or "inactive" or "any"`

2551 

2552 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

2553 

2554 - `"active"`

2555 

2556 - `"inactive"`

2557 

2558 - `"any"`

2559 

2550### Returns2560### Returns

2551 2561 

2552- `data: array of ProjectAPIKey`2562- `data: array of ProjectAPIKey`


2627 2637 

2628 The user's project role.2638 The user's project role.

2629 2639 

2640 - `owner_project_access: "active" or "inactive"`

2641 

2642 Whether the API key's owner currently has effective access to the project.

2643 

2644 - `"active"`

2645 

2646 - `"inactive"`

2647 

2630 - `redacted_value: string`2648 - `redacted_value: string`

2631 2649 

2632 The redacted value of the API key2650 The redacted value of the API key


2675 "role": "role"2693 "role": "role"

2676 }2694 }

2677 },2695 },

2696 "owner_project_access": "active",

2678 "redacted_value": "redacted_value"2697 "redacted_value": "redacted_value"

2679 }2698 }

2680 ],2699 ],


2688### Example2707### Example

2689 2708 

2690```http2709```http

2691curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \2710curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20&owner_project_access=any \

2692 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \2711 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

2693 -H "Content-Type: application/json"2712 -H "Content-Type: application/json"

2694```2713```


2706 "created_at": 1711471533,2725 "created_at": 1711471533,

2707 "last_used_at": 1711471534,2726 "last_used_at": 1711471534,

2708 "id": "key_abc",2727 "id": "key_abc",

2728 "owner_project_access": "active",

2709 "owner": {2729 "owner": {

2710 "type": "user",2730 "type": "user",

2711 "user": {2731 "user": {


2738 2758 

2739### Returns2759### Returns

2740 2760 

2741- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`2761- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

2742 2762 

2743 Represents an individual API key in a project.2763 Represents an individual API key in a project.

2744 2764 


2818 2838 

2819 The user's project role.2839 The user's project role.

2820 2840 

2841 - `owner_project_access: "active" or "inactive"`

2842 

2843 Whether the API key's owner currently has effective access to the project.

2844 

2845 - `"active"`

2846 

2847 - `"inactive"`

2848 

2821 - `redacted_value: string`2849 - `redacted_value: string`

2822 2850 

2823 The redacted value of the API key2851 The redacted value of the API key


2854 "role": "role"2882 "role": "role"

2855 }2883 }

2856 },2884 },

2885 "owner_project_access": "active",

2857 "redacted_value": "redacted_value"2886 "redacted_value": "redacted_value"

2858}2887}

2859```2888```


2876 "created_at": 1711471533,2905 "created_at": 1711471533,

2877 "last_used_at": 1711471534,2906 "last_used_at": 1711471534,

2878 "id": "key_abc",2907 "id": "key_abc",

2908 "owner_project_access": "active",

2879 "owner": {2909 "owner": {

2880 "type": "user",2910 "type": "user",

2881 "user": {2911 "user": {


2954 2984 

2955### Project API Key2985### Project API Key

2956 2986 

2957- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`2987- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

2958 2988 

2959 Represents an individual API key in a project.2989 Represents an individual API key in a project.

2960 2990 


3034 3064 

3035 The user's project role.3065 The user's project role.

3036 3066 

3067 - `owner_project_access: "active" or "inactive"`

3068 

3069 Whether the API key's owner currently has effective access to the project.

3070 

3071 - `"active"`

3072 

3073 - `"inactive"`

3074 

3037 - `redacted_value: string`3075 - `redacted_value: string`

3038 3076 

3039 The redacted value of the API key3077 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23- `owner_project_access: optional "active" or "inactive" or "any"`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

27 - `"active"`

28 

29 - `"inactive"`

30 

31 - `"any"`

32 

23### Returns33### Returns

24 34 

25- `data: array of ProjectAPIKey`35- `data: array of ProjectAPIKey`


100 110 

101 The user's project role.111 The user's project role.

102 112 

113 - `owner_project_access: "active" or "inactive"`

114 

115 Whether the API key's owner currently has effective access to the project.

116 

117 - `"active"`

118 

119 - `"inactive"`

120 

103 - `redacted_value: string`121 - `redacted_value: string`

104 122 

105 The redacted value of the API key123 The redacted value of the API key


148 "role": "role"166 "role": "role"

149 }167 }

150 },168 },

169 "owner_project_access": "active",

151 "redacted_value": "redacted_value"170 "redacted_value": "redacted_value"

152 }171 }

153 ],172 ],


161### Example180### Example

162 181 

163```http182```http

164curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \183curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20&owner_project_access=any \

165 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \184 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

166 -H "Content-Type: application/json"185 -H "Content-Type: application/json"

167```186```


179 "created_at": 1711471533,198 "created_at": 1711471533,

180 "last_used_at": 1711471534,199 "last_used_at": 1711471534,

181 "id": "key_abc",200 "id": "key_abc",

201 "owner_project_access": "active",

182 "owner": {202 "owner": {

183 "type": "user",203 "type": "user",

184 "user": {204 "user": {


211 231 

212### Returns232### Returns

213 233 

214- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`234- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

215 235 

216 Represents an individual API key in a project.236 Represents an individual API key in a project.

217 237 


291 311 

292 The user's project role.312 The user's project role.

293 313 

314 - `owner_project_access: "active" or "inactive"`

315 

316 Whether the API key's owner currently has effective access to the project.

317 

318 - `"active"`

319 

320 - `"inactive"`

321 

294 - `redacted_value: string`322 - `redacted_value: string`

295 323 

296 The redacted value of the API key324 The redacted value of the API key


327 "role": "role"355 "role": "role"

328 }356 }

329 },357 },

358 "owner_project_access": "active",

330 "redacted_value": "redacted_value"359 "redacted_value": "redacted_value"

331}360}

332```361```


349 "created_at": 1711471533,378 "created_at": 1711471533,

350 "last_used_at": 1711471534,379 "last_used_at": 1711471534,

351 "id": "key_abc",380 "id": "key_abc",

381 "owner_project_access": "active",

352 "owner": {382 "owner": {

353 "type": "user",383 "type": "user",

354 "user": {384 "user": {


427 457 

428### Project API Key458### Project API Key

429 459 

430- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`460- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

431 461 

432 Represents an individual API key in a project.462 Represents an individual API key in a project.

433 463 


507 537 

508 The user's project role.538 The user's project role.

509 539 

540 - `owner_project_access: "active" or "inactive"`

541 

542 Whether the API key's owner currently has effective access to the project.

543 

544 - `"active"`

545 

546 - `"inactive"`

547 

510 - `redacted_value: string`548 - `redacted_value: string`

511 549 

512 The redacted value of the API key550 The redacted value of the API key

Details

18 18 

19 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.19 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20 20 

21- `owner_project_access: optional "active" or "inactive" or "any"`

22 

23 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

24 

25 - `"active"`

26 

27 - `"inactive"`

28 

29 - `"any"`

30 

21### Returns31### Returns

22 32 

23- `data: array of ProjectAPIKey`33- `data: array of ProjectAPIKey`


98 108 

99 The user's project role.109 The user's project role.

100 110 

111 - `owner_project_access: "active" or "inactive"`

112 

113 Whether the API key's owner currently has effective access to the project.

114 

115 - `"active"`

116 

117 - `"inactive"`

118 

101 - `redacted_value: string`119 - `redacted_value: string`

102 120 

103 The redacted value of the API key121 The redacted value of the API key


146 "role": "role"164 "role": "role"

147 }165 }

148 },166 },

167 "owner_project_access": "active",

149 "redacted_value": "redacted_value"168 "redacted_value": "redacted_value"

150 }169 }

151 ],170 ],


159### Example178### Example

160 179 

161```http180```http

162curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20 \181curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key_abc&limit=20&owner_project_access=any \

163 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \182 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

164 -H "Content-Type: application/json"183 -H "Content-Type: application/json"

165```184```


177 "created_at": 1711471533,196 "created_at": 1711471533,

178 "last_used_at": 1711471534,197 "last_used_at": 1711471534,

179 "id": "key_abc",198 "id": "key_abc",

199 "owner_project_access": "active",

180 "owner": {200 "owner": {

181 "type": "user",201 "type": "user",

182 "user": {202 "user": {

Details

12 12 

13### Returns13### Returns

14 14 

15- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`15- `ProjectAPIKey object { id, created_at, last_used_at, 5 more }`

16 16 

17 Represents an individual API key in a project.17 Represents an individual API key in a project.

18 18 


92 92 

93 The user's project role.93 The user's project role.

94 94 

95 - `owner_project_access: "active" or "inactive"`

96 

97 Whether the API key's owner currently has effective access to the project.

98 

99 - `"active"`

100 

101 - `"inactive"`

102 

95 - `redacted_value: string`103 - `redacted_value: string`

96 104 

97 The redacted value of the API key105 The redacted value of the API key


128 "role": "role"136 "role": "role"

129 }137 }

130 },138 },

139 "owner_project_access": "active",

131 "redacted_value": "redacted_value"140 "redacted_value": "redacted_value"

132}141}

133```142```


150 "created_at": 1711471533,159 "created_at": 1711471533,

151 "last_used_at": 1711471534,160 "last_used_at": 1711471534,

152 "id": "key_abc",161 "id": "key_abc",

162 "owner_project_access": "active",

153 "owner": {163 "owner": {

154 "type": "user",164 "type": "user",

155 "user": {165 "user": {

Details

530 530 

531 - `"event"`531 - `"event"`

532 532 

533### Safety Identifier Blocked Webhook Event

534 

535- `SafetyIdentifierBlockedWebhookEvent object { id, created_at, data, 2 more }`

536 

537 Sent when a request associated with a safety identifier has been blocked.

538 

539 - `id: string`

540 

541 The unique ID of the event.

542 

543 - `created_at: number`

544 

545 The Unix timestamp (in seconds) of when the request was blocked.

546 

547 - `data: object { safety_category, safety_identifier, model, 2 more }`

548 

549 Event data payload.

550 

551 - `safety_category: string`

552 

553 The safety category that triggered the block, such as `bio` or `cyber`.

554 

555 - `safety_identifier: string`

556 

557 The stable safety identifier associated with the blocked request.

558 

559 - `model: optional string`

560 

561 The model used for the blocked request, if available.

562 

563 - `project_id: optional string`

564 

565 The project associated with the blocked request, if available.

566 

567 - `request_id: optional string`

568 

569 The OpenAI request ID for the blocked request, if available.

570 

571 - `type: "safety_identifier.blocked"`

572 

573 The type of the event. Always `safety_identifier.blocked`.

574 

575 - `"safety_identifier.blocked"`

576 

577 - `object: optional "event"`

578 

579 The object of the event. Always `event`.

580 

581 - `"event"`

582 

583### Unwrap Webhook Event533### Unwrap Webhook Event

584 534 

585- `UnwrapWebhookEvent = BatchCancelledWebhookEvent or BatchCompletedWebhookEvent or BatchExpiredWebhookEvent or 13 more`535- `UnwrapWebhookEvent = BatchCancelledWebhookEvent or BatchCompletedWebhookEvent or BatchExpiredWebhookEvent or 12 more`

586 536 

587 Sent when a batch API request has been cancelled.537 Sent when a batch API request has been cancelled.

588 538 


1077 The object of the event. Always `event`.1027 The object of the event. Always `event`.

1078 1028 

1079 - `"event"`1029 - `"event"`

1080 

1081 - `SafetyIdentifierBlockedWebhookEvent object { id, created_at, data, 2 more }`

1082 

1083 Sent when a request associated with a safety identifier has been blocked.

1084 

1085 - `id: string`

1086 

1087 The unique ID of the event.

1088 

1089 - `created_at: number`

1090 

1091 The Unix timestamp (in seconds) of when the request was blocked.

1092 

1093 - `data: object { safety_category, safety_identifier, model, 2 more }`

1094 

1095 Event data payload.

1096 

1097 - `safety_category: string`

1098 

1099 The safety category that triggered the block, such as `bio` or `cyber`.

1100 

1101 - `safety_identifier: string`

1102 

1103 The stable safety identifier associated with the blocked request.

1104 

1105 - `model: optional string`

1106 

1107 The model used for the blocked request, if available.

1108 

1109 - `project_id: optional string`

1110 

1111 The project associated with the blocked request, if available.

1112 

1113 - `request_id: optional string`

1114 

1115 The OpenAI request ID for the blocked request, if available.

1116 

1117 - `type: "safety_identifier.blocked"`

1118 

1119 The type of the event. Always `safety_identifier.blocked`.

1120 

1121 - `"safety_identifier.blocked"`

1122 

1123 - `object: optional "event"`

1124 

1125 The object of the event. Always `event`.

1126 

1127 - `"event"`

Details

20395 20395 

20396 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.20396 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20397 20397 

20398- `owner_project_access: :active | :inactive | :any`

20399 

20400 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

20401 

20402 - `:active`

20403 

20404 - `:inactive`

20405 

20406 - `:any`

20407 

20398### Returns20408### Returns

20399 20409 

20400- `class ProjectAPIKey`20410- `class ProjectAPIKey`


20477 20487 

20478 The user's project role.20488 The user's project role.

20479 20489 

20490 - `owner_project_access: :active | :inactive`

20491 

20492 Whether the API key's owner currently has effective access to the project.

20493 

20494 - `:active`

20495 

20496 - `:inactive`

20497 

20480 - `redacted_value: String`20498 - `redacted_value: String`

20481 20499 

20482 The redacted value of the API key20500 The redacted value of the API key


20520 "role": "role"20538 "role": "role"

20521 }20539 }

20522 },20540 },

20541 "owner_project_access": "active",

20523 "redacted_value": "redacted_value"20542 "redacted_value": "redacted_value"

20524 }20543 }

20525 ],20544 ],


20626 20645 

20627 The user's project role.20646 The user's project role.

20628 20647 

20648 - `owner_project_access: :active | :inactive`

20649 

20650 Whether the API key's owner currently has effective access to the project.

20651 

20652 - `:active`

20653 

20654 - `:inactive`

20655 

20629 - `redacted_value: String`20656 - `redacted_value: String`

20630 20657 

20631 The redacted value of the API key20658 The redacted value of the API key


20667 "role": "role"20694 "role": "role"

20668 }20695 }

20669 },20696 },

20697 "owner_project_access": "active",

20670 "redacted_value": "redacted_value"20698 "redacted_value": "redacted_value"

20671}20699}

20672```20700```


20806 20834 

20807 The user's project role.20835 The user's project role.

20808 20836 

20837 - `owner_project_access: :active | :inactive`

20838 

20839 Whether the API key's owner currently has effective access to the project.

20840 

20841 - `:active`

20842 

20843 - `:inactive`

20844 

20809 - `redacted_value: String`20845 - `redacted_value: String`

20810 20846 

20811 The redacted value of the API key20847 The redacted value of the API key

Details

20393 20393 

20394 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.20394 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20395 20395 

20396- `owner_project_access: :active | :inactive | :any`

20397 

20398 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

20399 

20400 - `:active`

20401 

20402 - `:inactive`

20403 

20404 - `:any`

20405 

20396### Returns20406### Returns

20397 20407 

20398- `class ProjectAPIKey`20408- `class ProjectAPIKey`


20475 20485 

20476 The user's project role.20486 The user's project role.

20477 20487 

20488 - `owner_project_access: :active | :inactive`

20489 

20490 Whether the API key's owner currently has effective access to the project.

20491 

20492 - `:active`

20493 

20494 - `:inactive`

20495 

20478 - `redacted_value: String`20496 - `redacted_value: String`

20479 20497 

20480 The redacted value of the API key20498 The redacted value of the API key


20518 "role": "role"20536 "role": "role"

20519 }20537 }

20520 },20538 },

20539 "owner_project_access": "active",

20521 "redacted_value": "redacted_value"20540 "redacted_value": "redacted_value"

20522 }20541 }

20523 ],20542 ],


20624 20643 

20625 The user's project role.20644 The user's project role.

20626 20645 

20646 - `owner_project_access: :active | :inactive`

20647 

20648 Whether the API key's owner currently has effective access to the project.

20649 

20650 - `:active`

20651 

20652 - `:inactive`

20653 

20627 - `redacted_value: String`20654 - `redacted_value: String`

20628 20655 

20629 The redacted value of the API key20656 The redacted value of the API key


20665 "role": "role"20692 "role": "role"

20666 }20693 }

20667 },20694 },

20695 "owner_project_access": "active",

20668 "redacted_value": "redacted_value"20696 "redacted_value": "redacted_value"

20669}20697}

20670```20698```


20804 20832 

20805 The user's project role.20833 The user's project role.

20806 20834 

20835 - `owner_project_access: :active | :inactive`

20836 

20837 Whether the API key's owner currently has effective access to the project.

20838 

20839 - `:active`

20840 

20841 - `:inactive`

20842 

20807 - `redacted_value: String`20843 - `redacted_value: String`

20808 20844 

20809 The redacted value of the API key20845 The redacted value of the API key

Details

2165 2165 

2166 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.2166 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

2167 2167 

2168- `owner_project_access: :active | :inactive | :any`

2169 

2170 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

2171 

2172 - `:active`

2173 

2174 - `:inactive`

2175 

2176 - `:any`

2177 

2168### Returns2178### Returns

2169 2179 

2170- `class ProjectAPIKey`2180- `class ProjectAPIKey`


2247 2257 

2248 The user's project role.2258 The user's project role.

2249 2259 

2260 - `owner_project_access: :active | :inactive`

2261 

2262 Whether the API key's owner currently has effective access to the project.

2263 

2264 - `:active`

2265 

2266 - `:inactive`

2267 

2250 - `redacted_value: String`2268 - `redacted_value: String`

2251 2269 

2252 The redacted value of the API key2270 The redacted value of the API key


2290 "role": "role"2308 "role": "role"

2291 }2309 }

2292 },2310 },

2311 "owner_project_access": "active",

2293 "redacted_value": "redacted_value"2312 "redacted_value": "redacted_value"

2294 }2313 }

2295 ],2314 ],


2396 2415 

2397 The user's project role.2416 The user's project role.

2398 2417 

2418 - `owner_project_access: :active | :inactive`

2419 

2420 Whether the API key's owner currently has effective access to the project.

2421 

2422 - `:active`

2423 

2424 - `:inactive`

2425 

2399 - `redacted_value: String`2426 - `redacted_value: String`

2400 2427 

2401 The redacted value of the API key2428 The redacted value of the API key


2437 "role": "role"2464 "role": "role"

2438 }2465 }

2439 },2466 },

2467 "owner_project_access": "active",

2440 "redacted_value": "redacted_value"2468 "redacted_value": "redacted_value"

2441}2469}

2442```2470```


2576 2604 

2577 The user's project role.2605 The user's project role.

2578 2606 

2607 - `owner_project_access: :active | :inactive`

2608 

2609 Whether the API key's owner currently has effective access to the project.

2610 

2611 - `:active`

2612 

2613 - `:inactive`

2614 

2579 - `redacted_value: String`2615 - `redacted_value: String`

2580 2616 

2581 The redacted value of the API key2617 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23- `owner_project_access: :active | :inactive | :any`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

27 - `:active`

28 

29 - `:inactive`

30 

31 - `:any`

32 

23### Returns33### Returns

24 34 

25- `class ProjectAPIKey`35- `class ProjectAPIKey`


102 112 

103 The user's project role.113 The user's project role.

104 114 

115 - `owner_project_access: :active | :inactive`

116 

117 Whether the API key's owner currently has effective access to the project.

118 

119 - `:active`

120 

121 - `:inactive`

122 

105 - `redacted_value: String`123 - `redacted_value: String`

106 124 

107 The redacted value of the API key125 The redacted value of the API key


145 "role": "role"163 "role": "role"

146 }164 }

147 },165 },

166 "owner_project_access": "active",

148 "redacted_value": "redacted_value"167 "redacted_value": "redacted_value"

149 }168 }

150 ],169 ],


251 270 

252 The user's project role.271 The user's project role.

253 272 

273 - `owner_project_access: :active | :inactive`

274 

275 Whether the API key's owner currently has effective access to the project.

276 

277 - `:active`

278 

279 - `:inactive`

280 

254 - `redacted_value: String`281 - `redacted_value: String`

255 282 

256 The redacted value of the API key283 The redacted value of the API key


292 "role": "role"319 "role": "role"

293 }320 }

294 },321 },

322 "owner_project_access": "active",

295 "redacted_value": "redacted_value"323 "redacted_value": "redacted_value"

296}324}

297```325```


431 459 

432 The user's project role.460 The user's project role.

433 461 

462 - `owner_project_access: :active | :inactive`

463 

464 Whether the API key's owner currently has effective access to the project.

465 

466 - `:active`

467 

468 - `:inactive`

469 

434 - `redacted_value: String`470 - `redacted_value: String`

435 471 

436 The redacted value of the API key472 The redacted value of the API key

Details

18 18 

19 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.19 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20 20 

21- `owner_project_access: :active | :inactive | :any`

22 

23 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

24 

25 - `:active`

26 

27 - `:inactive`

28 

29 - `:any`

30 

21### Returns31### Returns

22 32 

23- `class ProjectAPIKey`33- `class ProjectAPIKey`


100 110 

101 The user's project role.111 The user's project role.

102 112 

113 - `owner_project_access: :active | :inactive`

114 

115 Whether the API key's owner currently has effective access to the project.

116 

117 - `:active`

118 

119 - `:inactive`

120 

103 - `redacted_value: String`121 - `redacted_value: String`

104 122 

105 The redacted value of the API key123 The redacted value of the API key


143 "role": "role"161 "role": "role"

144 }162 }

145 },163 },

164 "owner_project_access": "active",

146 "redacted_value": "redacted_value"165 "redacted_value": "redacted_value"

147 }166 }

148 ],167 ],

Details

94 94 

95 The user's project role.95 The user's project role.

96 96 

97 - `owner_project_access: :active | :inactive`

98 

99 Whether the API key's owner currently has effective access to the project.

100 

101 - `:active`

102 

103 - `:inactive`

104 

97 - `redacted_value: String`105 - `redacted_value: String`

98 106 

99 The redacted value of the API key107 The redacted value of the API key


135 "role": "role"143 "role": "role"

136 }144 }

137 },145 },

146 "owner_project_access": "active",

138 "redacted_value": "redacted_value"147 "redacted_value": "redacted_value"

139}148}

140```149```

Details

544 544 

545 - `:event`545 - `:event`

546 546 

547### Safety Identifier Blocked Webhook Event

548 

549- `class SafetyIdentifierBlockedWebhookEvent`

550 

551 Sent when a request associated with a safety identifier has been blocked.

552 

553 - `id: String`

554 

555 The unique ID of the event.

556 

557 - `created_at: Integer`

558 

559 The Unix timestamp (in seconds) of when the request was blocked.

560 

561 - `data: Data{ safety_category, safety_identifier, model, 2 more}`

562 

563 Event data payload.

564 

565 - `safety_category: String`

566 

567 The safety category that triggered the block, such as `bio` or `cyber`.

568 

569 - `safety_identifier: String`

570 

571 The stable safety identifier associated with the blocked request.

572 

573 - `model: String`

574 

575 The model used for the blocked request, if available.

576 

577 - `project_id: String`

578 

579 The project associated with the blocked request, if available.

580 

581 - `request_id: String`

582 

583 The OpenAI request ID for the blocked request, if available.

584 

585 - `type: :"safety_identifier.blocked"`

586 

587 The type of the event. Always `safety_identifier.blocked`.

588 

589 - `:"safety_identifier.blocked"`

590 

591 - `object: :event`

592 

593 The object of the event. Always `event`.

594 

595 - `:event`

596 

597### Unwrap Webhook Event547### Unwrap Webhook Event

598 548 

599- `UnwrapWebhookEvent = BatchCancelledWebhookEvent | BatchCompletedWebhookEvent | BatchExpiredWebhookEvent | 13 more`549- `UnwrapWebhookEvent = BatchCancelledWebhookEvent | BatchCompletedWebhookEvent | BatchExpiredWebhookEvent | 12 more`

600 550 

601 Sent when a batch API request has been cancelled.551 Sent when a batch API request has been cancelled.

602 552 


1091 The object of the event. Always `event`.1041 The object of the event. Always `event`.

1092 1042 

1093 - `:event`1043 - `:event`

1094 

1095 - `class SafetyIdentifierBlockedWebhookEvent`

1096 

1097 Sent when a request associated with a safety identifier has been blocked.

1098 

1099 - `id: String`

1100 

1101 The unique ID of the event.

1102 

1103 - `created_at: Integer`

1104 

1105 The Unix timestamp (in seconds) of when the request was blocked.

1106 

1107 - `data: Data{ safety_category, safety_identifier, model, 2 more}`

1108 

1109 Event data payload.

1110 

1111 - `safety_category: String`

1112 

1113 The safety category that triggered the block, such as `bio` or `cyber`.

1114 

1115 - `safety_identifier: String`

1116 

1117 The stable safety identifier associated with the blocked request.

1118 

1119 - `model: String`

1120 

1121 The model used for the blocked request, if available.

1122 

1123 - `project_id: String`

1124 

1125 The project associated with the blocked request, if available.

1126 

1127 - `request_id: String`

1128 

1129 The OpenAI request ID for the blocked request, if available.

1130 

1131 - `type: :"safety_identifier.blocked"`

1132 

1133 The type of the event. Always `safety_identifier.blocked`.

1134 

1135 - `:"safety_identifier.blocked"`

1136 

1137 - `object: :event`

1138 

1139 The object of the event. Always `event`.

1140 

1141 - `:event`

Details

20779 20779 

20780 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.20780 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20781 20781 

20782 - `owner_project_access?: "active" | "inactive" | "any"`

20783 

20784 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

20785 

20786 - `"active"`

20787 

20788 - `"inactive"`

20789 

20790 - `"any"`

20791 

20782### Returns20792### Returns

20783 20793 

20784- `ProjectAPIKey`20794- `ProjectAPIKey`


20861 20871 

20862 The user's project role.20872 The user's project role.

20863 20873 

20874 - `owner_project_access: "active" | "inactive"`

20875 

20876 Whether the API key's owner currently has effective access to the project.

20877 

20878 - `"active"`

20879 

20880 - `"inactive"`

20881 

20864 - `redacted_value: string`20882 - `redacted_value: string`

20865 20883 

20866 The redacted value of the API key20884 The redacted value of the API key


20907 "role": "role"20925 "role": "role"

20908 }20926 }

20909 },20927 },

20928 "owner_project_access": "active",

20910 "redacted_value": "redacted_value"20929 "redacted_value": "redacted_value"

20911 }20930 }

20912 ],20931 ],


21017 21036 

21018 The user's project role.21037 The user's project role.

21019 21038 

21039 - `owner_project_access: "active" | "inactive"`

21040 

21041 Whether the API key's owner currently has effective access to the project.

21042 

21043 - `"active"`

21044 

21045 - `"inactive"`

21046 

21020 - `redacted_value: string`21047 - `redacted_value: string`

21021 21048 

21022 The redacted value of the API key21049 The redacted value of the API key


21062 "role": "role"21089 "role": "role"

21063 }21090 }

21064 },21091 },

21092 "owner_project_access": "active",

21065 "redacted_value": "redacted_value"21093 "redacted_value": "redacted_value"

21066}21094}

21067```21095```


21209 21237 

21210 The user's project role.21238 The user's project role.

21211 21239 

21240 - `owner_project_access: "active" | "inactive"`

21241 

21242 Whether the API key's owner currently has effective access to the project.

21243 

21244 - `"active"`

21245 

21246 - `"inactive"`

21247 

21212 - `redacted_value: string`21248 - `redacted_value: string`

21213 21249 

21214 The redacted value of the API key21250 The redacted value of the API key

Details

20777 20777 

20778 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.20778 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

20779 20779 

20780 - `owner_project_access?: "active" | "inactive" | "any"`

20781 

20782 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

20783 

20784 - `"active"`

20785 

20786 - `"inactive"`

20787 

20788 - `"any"`

20789 

20780### Returns20790### Returns

20781 20791 

20782- `ProjectAPIKey`20792- `ProjectAPIKey`


20859 20869 

20860 The user's project role.20870 The user's project role.

20861 20871 

20872 - `owner_project_access: "active" | "inactive"`

20873 

20874 Whether the API key's owner currently has effective access to the project.

20875 

20876 - `"active"`

20877 

20878 - `"inactive"`

20879 

20862 - `redacted_value: string`20880 - `redacted_value: string`

20863 20881 

20864 The redacted value of the API key20882 The redacted value of the API key


20905 "role": "role"20923 "role": "role"

20906 }20924 }

20907 },20925 },

20926 "owner_project_access": "active",

20908 "redacted_value": "redacted_value"20927 "redacted_value": "redacted_value"

20909 }20928 }

20910 ],20929 ],


21015 21034 

21016 The user's project role.21035 The user's project role.

21017 21036 

21037 - `owner_project_access: "active" | "inactive"`

21038 

21039 Whether the API key's owner currently has effective access to the project.

21040 

21041 - `"active"`

21042 

21043 - `"inactive"`

21044 

21018 - `redacted_value: string`21045 - `redacted_value: string`

21019 21046 

21020 The redacted value of the API key21047 The redacted value of the API key


21060 "role": "role"21087 "role": "role"

21061 }21088 }

21062 },21089 },

21090 "owner_project_access": "active",

21063 "redacted_value": "redacted_value"21091 "redacted_value": "redacted_value"

21064}21092}

21065```21093```


21207 21235 

21208 The user's project role.21236 The user's project role.

21209 21237 

21238 - `owner_project_access: "active" | "inactive"`

21239 

21240 Whether the API key's owner currently has effective access to the project.

21241 

21242 - `"active"`

21243 

21244 - `"inactive"`

21245 

21210 - `redacted_value: string`21246 - `redacted_value: string`

21211 21247 

21212 The redacted value of the API key21248 The redacted value of the API key

Details

2286 2286 

2287 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.2287 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

2288 2288 

2289 - `owner_project_access?: "active" | "inactive" | "any"`

2290 

2291 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

2292 

2293 - `"active"`

2294 

2295 - `"inactive"`

2296 

2297 - `"any"`

2298 

2289### Returns2299### Returns

2290 2300 

2291- `ProjectAPIKey`2301- `ProjectAPIKey`


2368 2378 

2369 The user's project role.2379 The user's project role.

2370 2380 

2381 - `owner_project_access: "active" | "inactive"`

2382 

2383 Whether the API key's owner currently has effective access to the project.

2384 

2385 - `"active"`

2386 

2387 - `"inactive"`

2388 

2371 - `redacted_value: string`2389 - `redacted_value: string`

2372 2390 

2373 The redacted value of the API key2391 The redacted value of the API key


2414 "role": "role"2432 "role": "role"

2415 }2433 }

2416 },2434 },

2435 "owner_project_access": "active",

2417 "redacted_value": "redacted_value"2436 "redacted_value": "redacted_value"

2418 }2437 }

2419 ],2438 ],


2524 2543 

2525 The user's project role.2544 The user's project role.

2526 2545 

2546 - `owner_project_access: "active" | "inactive"`

2547 

2548 Whether the API key's owner currently has effective access to the project.

2549 

2550 - `"active"`

2551 

2552 - `"inactive"`

2553 

2527 - `redacted_value: string`2554 - `redacted_value: string`

2528 2555 

2529 The redacted value of the API key2556 The redacted value of the API key


2569 "role": "role"2596 "role": "role"

2570 }2597 }

2571 },2598 },

2599 "owner_project_access": "active",

2572 "redacted_value": "redacted_value"2600 "redacted_value": "redacted_value"

2573}2601}

2574```2602```


2716 2744 

2717 The user's project role.2745 The user's project role.

2718 2746 

2747 - `owner_project_access: "active" | "inactive"`

2748 

2749 Whether the API key's owner currently has effective access to the project.

2750 

2751 - `"active"`

2752 

2753 - `"inactive"`

2754 

2719 - `redacted_value: string`2755 - `redacted_value: string`

2720 2756 

2721 The redacted value of the API key2757 The redacted value of the API key

Details

22 22 

23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.23 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

24 24 

25 - `owner_project_access?: "active" | "inactive" | "any"`

26 

27 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

28 

29 - `"active"`

30 

31 - `"inactive"`

32 

33 - `"any"`

34 

25### Returns35### Returns

26 36 

27- `ProjectAPIKey`37- `ProjectAPIKey`


104 114 

105 The user's project role.115 The user's project role.

106 116 

117 - `owner_project_access: "active" | "inactive"`

118 

119 Whether the API key's owner currently has effective access to the project.

120 

121 - `"active"`

122 

123 - `"inactive"`

124 

107 - `redacted_value: string`125 - `redacted_value: string`

108 126 

109 The redacted value of the API key127 The redacted value of the API key


150 "role": "role"168 "role": "role"

151 }169 }

152 },170 },

171 "owner_project_access": "active",

153 "redacted_value": "redacted_value"172 "redacted_value": "redacted_value"

154 }173 }

155 ],174 ],


260 279 

261 The user's project role.280 The user's project role.

262 281 

282 - `owner_project_access: "active" | "inactive"`

283 

284 Whether the API key's owner currently has effective access to the project.

285 

286 - `"active"`

287 

288 - `"inactive"`

289 

263 - `redacted_value: string`290 - `redacted_value: string`

264 291 

265 The redacted value of the API key292 The redacted value of the API key


305 "role": "role"332 "role": "role"

306 }333 }

307 },334 },

335 "owner_project_access": "active",

308 "redacted_value": "redacted_value"336 "redacted_value": "redacted_value"

309}337}

310```338```


452 480 

453 The user's project role.481 The user's project role.

454 482 

483 - `owner_project_access: "active" | "inactive"`

484 

485 Whether the API key's owner currently has effective access to the project.

486 

487 - `"active"`

488 

489 - `"inactive"`

490 

455 - `redacted_value: string`491 - `redacted_value: string`

456 492 

457 The redacted value of the API key493 The redacted value of the API key

Details

20 20 

21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.21 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

22 22 

23 - `owner_project_access?: "active" | "inactive" | "any"`

24 

25 Filter API keys by whether the owner currently has effective access to the project. Use `active` for owners with access, `inactive` for owners without access, or `any` for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys.

26 

27 - `"active"`

28 

29 - `"inactive"`

30 

31 - `"any"`

32 

23### Returns33### Returns

24 34 

25- `ProjectAPIKey`35- `ProjectAPIKey`


102 112 

103 The user's project role.113 The user's project role.

104 114 

115 - `owner_project_access: "active" | "inactive"`

116 

117 Whether the API key's owner currently has effective access to the project.

118 

119 - `"active"`

120 

121 - `"inactive"`

122 

105 - `redacted_value: string`123 - `redacted_value: string`

106 124 

107 The redacted value of the API key125 The redacted value of the API key


148 "role": "role"166 "role": "role"

149 }167 }

150 },168 },

169 "owner_project_access": "active",

151 "redacted_value": "redacted_value"170 "redacted_value": "redacted_value"

152 }171 }

153 ],172 ],

Details

98 98 

99 The user's project role.99 The user's project role.

100 100 

101 - `owner_project_access: "active" | "inactive"`

102 

103 Whether the API key's owner currently has effective access to the project.

104 

105 - `"active"`

106 

107 - `"inactive"`

108 

101 - `redacted_value: string`109 - `redacted_value: string`

102 110 

103 The redacted value of the API key111 The redacted value of the API key


143 "role": "role"151 "role": "role"

144 }152 }

145 },153 },

154 "owner_project_access": "active",

146 "redacted_value": "redacted_value"155 "redacted_value": "redacted_value"

147}156}

148```157```

Details

544 544 

545 - `"event"`545 - `"event"`

546 546 

547### Safety Identifier Blocked Webhook Event

548 

549- `SafetyIdentifierBlockedWebhookEvent`

550 

551 Sent when a request associated with a safety identifier has been blocked.

552 

553 - `id: string`

554 

555 The unique ID of the event.

556 

557 - `created_at: number`

558 

559 The Unix timestamp (in seconds) of when the request was blocked.

560 

561 - `data: Data`

562 

563 Event data payload.

564 

565 - `safety_category: string`

566 

567 The safety category that triggered the block, such as `bio` or `cyber`.

568 

569 - `safety_identifier: string`

570 

571 The stable safety identifier associated with the blocked request.

572 

573 - `model?: string`

574 

575 The model used for the blocked request, if available.

576 

577 - `project_id?: string`

578 

579 The project associated with the blocked request, if available.

580 

581 - `request_id?: string`

582 

583 The OpenAI request ID for the blocked request, if available.

584 

585 - `type: "safety_identifier.blocked"`

586 

587 The type of the event. Always `safety_identifier.blocked`.

588 

589 - `"safety_identifier.blocked"`

590 

591 - `object?: "event"`

592 

593 The object of the event. Always `event`.

594 

595 - `"event"`

596 

597### Unwrap Webhook Event547### Unwrap Webhook Event

598 548 

599- `UnwrapWebhookEvent = BatchCancelledWebhookEvent | BatchCompletedWebhookEvent | BatchExpiredWebhookEvent | 13 more`549- `UnwrapWebhookEvent = BatchCancelledWebhookEvent | BatchCompletedWebhookEvent | BatchExpiredWebhookEvent | 12 more`

600 550 

601 Sent when a batch API request has been cancelled.551 Sent when a batch API request has been cancelled.

602 552 


1091 The object of the event. Always `event`.1041 The object of the event. Always `event`.

1092 1042 

1093 - `"event"`1043 - `"event"`

1094 

1095 - `SafetyIdentifierBlockedWebhookEvent`

1096 

1097 Sent when a request associated with a safety identifier has been blocked.

1098 

1099 - `id: string`

1100 

1101 The unique ID of the event.

1102 

1103 - `created_at: number`

1104 

1105 The Unix timestamp (in seconds) of when the request was blocked.

1106 

1107 - `data: Data`

1108 

1109 Event data payload.

1110 

1111 - `safety_category: string`

1112 

1113 The safety category that triggered the block, such as `bio` or `cyber`.

1114 

1115 - `safety_identifier: string`

1116 

1117 The stable safety identifier associated with the blocked request.

1118 

1119 - `model?: string`

1120 

1121 The model used for the blocked request, if available.

1122 

1123 - `project_id?: string`

1124 

1125 The project associated with the blocked request, if available.

1126 

1127 - `request_id?: string`

1128 

1129 The OpenAI request ID for the blocked request, if available.

1130 

1131 - `type: "safety_identifier.blocked"`

1132 

1133 The type of the event. Always `safety_identifier.blocked`.

1134 

1135 - `"safety_identifier.blocked"`

1136 

1137 - `object?: "event"`

1138 

1139 The object of the event. Always `event`.

1140 

1141 - `"event"`