SpyBara
Go Premium

Reference 2026-07-15 02:58 UTC to 2026-07-16 20:57 UTC

232 files changed +7,306 −900. View all changes and history on the product overview
2026
Fri 31 21:03 Thu 30 23:58 Wed 29 15:02 Thu 23 18:00 Thu 16 20:57 Tue 14 06:58 Mon 13 15:59 Sun 12 06:58 Thu 9 20:58
Details

28 28 

29 Return only events whose `effective_at` (Unix seconds) is in this range.29 Return only events whose `effective_at` (Unix seconds) is in this range.

30 30 

31- `--event-type: optional array of "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`31- `--event-type: optional array of "api_key.created" or "api_key.updated" or "api_key.deleted" or 140 more`

32 32 

33 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).33 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).

34 34 


62 62 

63 The Unix timestamp (in seconds) of the event.63 The Unix timestamp (in seconds) of the event.

64 64 

65 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`65 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 140 more`

66 66 

67 The event type.67 The event type.

68 68 


184 184 

185 - `"user.deleted"`185 - `"user.deleted"`

186 186 

187 - `"tenant.metadata.updated"`

188 

189 - `"tenant.microsoft_entra_mapping.upserted"`

190 

191 - `"tenant.microsoft_entra_mapping.deleted"`

192 

193 - `"tenant.workload_identity.provider.created"`

194 

195 - `"tenant.workload_identity.provider.updated"`

196 

197 - `"tenant.workload_identity.provider.archived"`

198 

199 - `"tenant.workload_identity.mapping.created"`

200 

201 - `"tenant.workload_identity.mapping.updated"`

202 

203 - `"tenant.workload_identity.mapping.archived"`

204 

205 - `"tenant.workload_identity.binding.created"`

206 

207 - `"tenant.workload_identity.principal.provisioned"`

208 

209 - `"tenant.admin_api_key.created"`

210 

211 - `"tenant.admin_api_key.updated"`

212 

213 - `"tenant.admin_api_key.deleted"`

214 

215 - `"tenant.project_api_key.created"`

216 

217 - `"tenant.chatgpt_access_token.revoked"`

218 

219 - `"tenant.migration.completed"`

220 

221 - `"tenant.sso.migrated"`

222 

223 - `"tenant.domains.migrated"`

224 

225 - `"tenant.sso_connection.created"`

226 

227 - `"tenant.sso_connection.updated"`

228 

229 - `"tenant.sso_connection.deleted"`

230 

231 - `"tenant.sso_connection.setup.started"`

232 

233 - `"tenant.policy.created"`

234 

235 - `"tenant.policy.updated"`

236 

237 - `"tenant.policy.deleted"`

238 

239 - `"tenant.policy.attached"`

240 

241 - `"tenant.policy.detached"`

242 

243 - `"tenant.principal_authentication_policy.resolved"`

244 

245 - `"tenant.scim.setup.started"`

246 

247 - `"tenant.scim.deletion.requested"`

248 

249 - `"tenant.scim.directory.created"`

250 

251 - `"tenant.product_access_policy.updated"`

252 

253 - `"tenant.resource_share_grant.created"`

254 

255 - `"tenant.resource_share_grant.updated"`

256 

257 - `"tenant.resource_share_grant.accepted"`

258 

259 - `"tenant.resource_share_grant.declined"`

260 

261 - `"tenant.resource_share_grant.revoked"`

262 

263 - `"tenant.resource_share_grant.deleted"`

264 

265 - `"tenant.service_account.updated"`

266 

267 - `"tenant.service_account.deleted"`

268 

269 - `"tenant.service_account.token.revoked"`

270 

271 - `"tenant.billing.overage_limit.updated"`

272 

273 - `"tenant.billing.alerts.updated"`

274 

275 - `"tenant.billing.info.updated"`

276 

277 - `"tenant.usage_limit.workspace.updated"`

278 

279 - `"tenant.usage_limit.group.updated"`

280 

281 - `"tenant.usage_limit.user.updated"`

282 

283 - `"tenant.usage_limit.increase_request.updated"`

284 

285 - `"tenant.usage_limit.increase_request.resolved"`

286 

287 - `"tenant.group.created"`

288 

289 - `"tenant.group.updated"`

290 

291 - `"tenant.group.deleted"`

292 

293 - `"tenant.group.member.added"`

294 

295 - `"tenant.group.member.removed"`

296 

297 - `"tenant.migration_rollout.status.updated"`

298 

299 - `"tenant.migration_rollout.tier.updated"`

300 

301 - `"tenant.role.metadata.updated"`

302 

303 - `"tenant.custom_role.created"`

304 

305 - `"tenant.custom_role.updated"`

306 

307 - `"tenant.custom_role.deleted"`

308 

309 - `"tenant.role_assignment.created"`

310 

311 - `"tenant.role_assignment.deleted"`

312 

313 - `"tenant.resource_role_assignment.created"`

314 

315 - `"tenant.resource_role_assignment.deleted"`

316 

317 - `"tenant.resource_access.updated"`

318 

319 - `"tenant.resource_access.deleted"`

320 

321 - `"tenant.session_policy.created"`

322 

323 - `"tenant.session_policy.updated"`

324 

325 - `"tenant.session_policy.deleted"`

326 

327 - `"tenant.session_revocation.started"`

328 

329 - `"tenant.third_party_app_policy.updated"`

330 

331 - `"tenant.user.added"`

332 

333 - `"tenant.user.updated"`

334 

335 - `"tenant.user.removed"`

336 

337 - `"tenant.user.looked_up"`

338 

339 - `"tenant.user.invited"`

340 

341 - `"tenant.membership.revoked"`

342 

343 - `"tenant.api_organization_invite.upserted"`

344 

345 - `"tenant.api_organization_invite.deleted"`

346 

347 - `"tenant.chatgpt_workspace_invite.upserted"`

348 

349 - `"tenant.membership.accepted"`

350 

351 - `"tenant.membership.declined"`

352 

353 - `"tenant.workspace_invite_email_settings.updated"`

354 

187 - `actor: optional object { api_key, session, type }`355 - `actor: optional object { api_key, session, type }`

188 356 

189 The actor who performed the audit logged action.357 The actor who performed the audit logged action.

Details

4 4 

5**post** `/organization/projects/{project_id}/service_accounts`5**post** `/organization/projects/{project_id}/service_accounts`

6 6 

7Creates a new service account in the project. This also returns an unredacted API key for the service account.7Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

8 8 

9### Parameters9### Parameters

10 10 


16 16 

17 The name of the service account being created.17 The name of the service account being created.

18 18 

19- `--create-service-account-only: optional boolean`

20 

21 Create the service account without default roles or an API key.

22 

19### Returns23### Returns

20 24 

21- `AdminOrganizationProjectServiceAccountNewResponse: object { id, api_key, created_at, 3 more }`25- `AdminOrganizationProjectServiceAccountNewResponse: object { id, api_key, created_at, 3 more }`


42 46 

43 - `object: "organization.project.service_account"`47 - `object: "organization.project.service_account"`

44 48 

45 - `role: "member"`49 - `role: "member" or "none"`

50 

51 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

52 

53 - `"member"`

46 54 

47 Service accounts can only have one role of type `member`55 - `"none"`

48 56 

49### Example57### Example

50 58 

Details

42 42 

43 The object type, which is always `organization.project.service_account`43 The object type, which is always `organization.project.service_account`

44 44 

45 - `role: "owner" or "member"`45 - `role: "owner" or "member" or "none"`

46 46 

47 `owner` or `member`47 `owner`, `member`, or `none`

48 48 

49 - `"owner"`49 - `"owner"`

50 50 

51 - `"member"`51 - `"member"`

52 52 

53 - `"none"`

54 

53 - `has_more: boolean`55 - `has_more: boolean`

54 56 

55 - `object: "list"`57 - `object: "list"`

Details

38 38 

39 The object type, which is always `organization.project.service_account`39 The object type, which is always `organization.project.service_account`

40 40 

41 - `role: "owner" or "member"`41 - `role: "owner" or "member" or "none"`

42 42 

43 `owner` or `member`43 `owner`, `member`, or `none`

44 44 

45 - `"owner"`45 - `"owner"`

46 46 

47 - `"member"`47 - `"member"`

48 48 

49 - `"none"`

50 

49### Example51### Example

50 52 

51```cli53```cli

Details

46 46 

47 The object type, which is always `organization.project.service_account`47 The object type, which is always `organization.project.service_account`

48 48 

49 - `role: "owner" or "member"`49 - `role: "owner" or "member" or "none"`

50 50 

51 `owner` or `member`51 `owner`, `member`, or `none`

52 52 

53 - `"owner"`53 - `"owner"`

54 54 

55 - `"member"`55 - `"member"`

56 56 

57 - `"none"`

58 

57### Example59### Example

58 60 

59```cli61```cli

Details

1## Create project service account API key

2 

3`$ openai admin:organization:projects:service-accounts:api-keys create`

4 

5**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

6 

7Creates an API key for a service account in the project.

8 

9### Parameters

10 

11- `--project-id: string`

12 

13 The ID of the project.

14 

15- `--service-account-id: string`

16 

17 The ID of the service account.

18 

19- `--name: optional string`

20 

21 API key name.

22 

23- `--scope: optional array of string`

24 

25 API key scopes.

26 

27### Returns

28 

29- `AdminOrganizationProjectServiceAccountAPIKeyNewResponse: object { id, created_at, name, 2 more }`

30 

31 - `id: string`

32 

33 - `created_at: number`

34 

35 - `name: string`

36 

37 - `object: "organization.project.service_account.api_key"`

38 

39 The object type, which is always `organization.project.service_account.api_key`

40 

41 - `value: string`

42 

43### Example

44 

45```cli

46openai admin:organization:projects:service-accounts:api-keys create \

47 --admin-api-key 'My Admin API Key' \

48 --project-id project_id \

49 --service-account-id service_account_id

50```

51 

52#### Response

53 

54```json

55{

56 "id": "id",

57 "created_at": 0,

58 "name": "name",

59 "object": "organization.project.service_account.api_key",

60 "value": "value"

61}

62```

Details

62 62 

63 - `object: "bucket"`63 - `object: "bucket"`

64 64 

65 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`65 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

66 66 

67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

68 68 

69 The aggregated completions usage details of the specific time bucket.69 The aggregated completions usage details of the specific time bucket.

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


80 80 

81 - `output_tokens: number`81 - `output_tokens: number`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: optional string`85 - `api_key_id: optional string`

86 86 


92 92 

93 - `input_audio_tokens: optional number`93 - `input_audio_tokens: optional number`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: optional number`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: optional number`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: optional number`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: optional number`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: optional number`113 - `input_cached_tokens: optional number`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: optional number`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: optional number`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: optional number`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: optional string`129 - `model: optional string`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: optional number`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: optional number`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: optional string`145 - `project_id: optional string`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


431 "api_key_id": "api_key_id",467 "api_key_id": "api_key_id",

432 "batch": true,468 "batch": true,

433 "input_audio_tokens": 0,469 "input_audio_tokens": 0,

470 "input_cache_write_tokens": 0,

471 "input_cached_audio_tokens": 0,

472 "input_cached_image_tokens": 0,

473 "input_cached_text_tokens": 0,

434 "input_cached_tokens": 0,474 "input_cached_tokens": 0,

475 "input_image_tokens": 0,

476 "input_text_tokens": 0,

477 "input_uncached_tokens": 0,

435 "model": "model",478 "model": "model",

436 "output_audio_tokens": 0,479 "output_audio_tokens": 0,

480 "output_image_tokens": 0,

481 "output_text_tokens": 0,

437 "project_id": "project_id",482 "project_id": "project_id",

438 "service_tier": "service_tier",483 "service_tier": "service_tier",

439 "user_id": "user_id"484 "user_id": "user_id"

Details

62 62 

63 - `object: "bucket"`63 - `object: "bucket"`

64 64 

65 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`65 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

66 66 

67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

68 68 

69 The aggregated completions usage details of the specific time bucket.69 The aggregated completions usage details of the specific time bucket.

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


80 80 

81 - `output_tokens: number`81 - `output_tokens: number`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: optional string`85 - `api_key_id: optional string`

86 86 


92 92 

93 - `input_audio_tokens: optional number`93 - `input_audio_tokens: optional number`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: optional number`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: optional number`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: optional number`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: optional number`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: optional number`113 - `input_cached_tokens: optional number`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: optional number`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: optional number`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: optional number`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: optional string`129 - `model: optional string`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: optional number`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: optional number`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: optional string`145 - `project_id: optional string`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


431 "api_key_id": "api_key_id",467 "api_key_id": "api_key_id",

432 "batch": true,468 "batch": true,

433 "input_audio_tokens": 0,469 "input_audio_tokens": 0,

470 "input_cache_write_tokens": 0,

471 "input_cached_audio_tokens": 0,

472 "input_cached_image_tokens": 0,

473 "input_cached_text_tokens": 0,

434 "input_cached_tokens": 0,474 "input_cached_tokens": 0,

475 "input_image_tokens": 0,

476 "input_text_tokens": 0,

477 "input_uncached_tokens": 0,

435 "model": "model",478 "model": "model",

436 "output_audio_tokens": 0,479 "output_audio_tokens": 0,

480 "output_image_tokens": 0,

481 "output_text_tokens": 0,

437 "project_id": "project_id",482 "project_id": "project_id",

438 "service_tier": "service_tier",483 "service_tier": "service_tier",

439 "user_id": "user_id"484 "user_id": "user_id"

Details

50 50 

51 - `object: "bucket"`51 - `object: "bucket"`

52 52 

53 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`53 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

54 54 

55 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`55 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

56 56 

57 The aggregated completions usage details of the specific time bucket.57 The aggregated completions usage details of the specific time bucket.

58 58 

59 - `input_tokens: number`59 - `input_tokens: number`

60 60 

61 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.61 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

62 62 

63 - `num_model_requests: number`63 - `num_model_requests: number`

64 64 


68 68 

69 - `output_tokens: number`69 - `output_tokens: number`

70 70 

71 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `api_key_id: optional string`73 - `api_key_id: optional string`

74 74 


80 80 

81 - `input_audio_tokens: optional number`81 - `input_audio_tokens: optional number`

82 82 

83 The aggregated number of audio input tokens used, including cached tokens.83 The aggregated number of uncached audio input tokens used.

84 

85 - `input_cache_write_tokens: optional number`

86 

87 The aggregated number of input tokens written to the cache.

88 

89 - `input_cached_audio_tokens: optional number`

90 

91 The aggregated number of cached audio input tokens used.

92 

93 - `input_cached_image_tokens: optional number`

94 

95 The aggregated number of cached image input tokens used.

96 

97 - `input_cached_text_tokens: optional number`

98 

99 The aggregated number of cached text input tokens used.

84 100 

85 - `input_cached_tokens: optional number`101 - `input_cached_tokens: optional number`

86 102 

87 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 

105 - `input_image_tokens: optional number`

106 

107 The aggregated number of uncached image input tokens used.

108 

109 - `input_text_tokens: optional number`

110 

111 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

112 

113 - `input_uncached_tokens: optional number`

114 

115 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

88 116 

89 - `model: optional string`117 - `model: optional string`

90 118 


94 122 

95 The aggregated number of audio output tokens used.123 The aggregated number of audio output tokens used.

96 124 

125 - `output_image_tokens: optional number`

126 

127 The aggregated number of image output tokens used.

128 

129 - `output_text_tokens: optional number`

130 

131 The aggregated number of text output tokens used.

132 

97 - `project_id: optional string`133 - `project_id: optional string`

98 134 

99 When `group_by=project_id`, this field provides the project ID of the grouped usage result.135 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


419 "api_key_id": "api_key_id",455 "api_key_id": "api_key_id",

420 "batch": true,456 "batch": true,

421 "input_audio_tokens": 0,457 "input_audio_tokens": 0,

458 "input_cache_write_tokens": 0,

459 "input_cached_audio_tokens": 0,

460 "input_cached_image_tokens": 0,

461 "input_cached_text_tokens": 0,

422 "input_cached_tokens": 0,462 "input_cached_tokens": 0,

463 "input_image_tokens": 0,

464 "input_text_tokens": 0,

465 "input_uncached_tokens": 0,

423 "model": "model",466 "model": "model",

424 "output_audio_tokens": 0,467 "output_audio_tokens": 0,

468 "output_image_tokens": 0,

469 "output_text_tokens": 0,

425 "project_id": "project_id",470 "project_id": "project_id",

426 "service_tier": "service_tier",471 "service_tier": "service_tier",

427 "user_id": "user_id"472 "user_id": "user_id"

Details

66 66 

67 - `object: "bucket"`67 - `object: "bucket"`

68 68 

69 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`69 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

70 70 

71 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`71 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

72 72 

73 The aggregated completions usage details of the specific time bucket.73 The aggregated completions usage details of the specific time bucket.

74 74 

75 - `input_tokens: number`75 - `input_tokens: number`

76 76 

77 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.77 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

78 78 

79 - `num_model_requests: number`79 - `num_model_requests: number`

80 80 


84 84 

85 - `output_tokens: number`85 - `output_tokens: number`

86 86 

87 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.87 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

88 88 

89 - `api_key_id: optional string`89 - `api_key_id: optional string`

90 90 


96 96 

97 - `input_audio_tokens: optional number`97 - `input_audio_tokens: optional number`

98 98 

99 The aggregated number of audio input tokens used, including cached tokens.99 The aggregated number of uncached audio input tokens used.

100 

101 - `input_cache_write_tokens: optional number`

102 

103 The aggregated number of input tokens written to the cache.

104 

105 - `input_cached_audio_tokens: optional number`

106 

107 The aggregated number of cached audio input tokens used.

108 

109 - `input_cached_image_tokens: optional number`

110 

111 The aggregated number of cached image input tokens used.

112 

113 - `input_cached_text_tokens: optional number`

114 

115 The aggregated number of cached text input tokens used.

100 116 

101 - `input_cached_tokens: optional number`117 - `input_cached_tokens: optional number`

102 118 

103 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.119 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

120 

121 - `input_image_tokens: optional number`

122 

123 The aggregated number of uncached image input tokens used.

124 

125 - `input_text_tokens: optional number`

126 

127 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

128 

129 - `input_uncached_tokens: optional number`

130 

131 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

104 132 

105 - `model: optional string`133 - `model: optional string`

106 134 


110 138 

111 The aggregated number of audio output tokens used.139 The aggregated number of audio output tokens used.

112 140 

141 - `output_image_tokens: optional number`

142 

143 The aggregated number of image output tokens used.

144 

145 - `output_text_tokens: optional number`

146 

147 The aggregated number of text output tokens used.

148 

113 - `project_id: optional string`149 - `project_id: optional string`

114 150 

115 When `group_by=project_id`, this field provides the project ID of the grouped usage result.151 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


435 "api_key_id": "api_key_id",471 "api_key_id": "api_key_id",

436 "batch": true,472 "batch": true,

437 "input_audio_tokens": 0,473 "input_audio_tokens": 0,

474 "input_cache_write_tokens": 0,

475 "input_cached_audio_tokens": 0,

476 "input_cached_image_tokens": 0,

477 "input_cached_text_tokens": 0,

438 "input_cached_tokens": 0,478 "input_cached_tokens": 0,

479 "input_image_tokens": 0,

480 "input_text_tokens": 0,

481 "input_uncached_tokens": 0,

439 "model": "model",482 "model": "model",

440 "output_audio_tokens": 0,483 "output_audio_tokens": 0,

484 "output_image_tokens": 0,

485 "output_text_tokens": 0,

441 "project_id": "project_id",486 "project_id": "project_id",

442 "service_tier": "service_tier",487 "service_tier": "service_tier",

443 "user_id": "user_id"488 "user_id": "user_id"

Details

50 50 

51 - `object: "bucket"`51 - `object: "bucket"`

52 52 

53 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`53 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

54 54 

55 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`55 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

56 56 

57 The aggregated completions usage details of the specific time bucket.57 The aggregated completions usage details of the specific time bucket.

58 58 

59 - `input_tokens: number`59 - `input_tokens: number`

60 60 

61 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.61 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

62 62 

63 - `num_model_requests: number`63 - `num_model_requests: number`

64 64 


68 68 

69 - `output_tokens: number`69 - `output_tokens: number`

70 70 

71 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `api_key_id: optional string`73 - `api_key_id: optional string`

74 74 


80 80 

81 - `input_audio_tokens: optional number`81 - `input_audio_tokens: optional number`

82 82 

83 The aggregated number of audio input tokens used, including cached tokens.83 The aggregated number of uncached audio input tokens used.

84 

85 - `input_cache_write_tokens: optional number`

86 

87 The aggregated number of input tokens written to the cache.

88 

89 - `input_cached_audio_tokens: optional number`

90 

91 The aggregated number of cached audio input tokens used.

92 

93 - `input_cached_image_tokens: optional number`

94 

95 The aggregated number of cached image input tokens used.

96 

97 - `input_cached_text_tokens: optional number`

98 

99 The aggregated number of cached text input tokens used.

84 100 

85 - `input_cached_tokens: optional number`101 - `input_cached_tokens: optional number`

86 102 

87 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 

105 - `input_image_tokens: optional number`

106 

107 The aggregated number of uncached image input tokens used.

108 

109 - `input_text_tokens: optional number`

110 

111 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

112 

113 - `input_uncached_tokens: optional number`

114 

115 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

88 116 

89 - `model: optional string`117 - `model: optional string`

90 118 


94 122 

95 The aggregated number of audio output tokens used.123 The aggregated number of audio output tokens used.

96 124 

125 - `output_image_tokens: optional number`

126 

127 The aggregated number of image output tokens used.

128 

129 - `output_text_tokens: optional number`

130 

131 The aggregated number of text output tokens used.

132 

97 - `project_id: optional string`133 - `project_id: optional string`

98 134 

99 When `group_by=project_id`, this field provides the project ID of the grouped usage result.135 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


419 "api_key_id": "api_key_id",455 "api_key_id": "api_key_id",

420 "batch": true,456 "batch": true,

421 "input_audio_tokens": 0,457 "input_audio_tokens": 0,

458 "input_cache_write_tokens": 0,

459 "input_cached_audio_tokens": 0,

460 "input_cached_image_tokens": 0,

461 "input_cached_text_tokens": 0,

422 "input_cached_tokens": 0,462 "input_cached_tokens": 0,

463 "input_image_tokens": 0,

464 "input_text_tokens": 0,

465 "input_uncached_tokens": 0,

423 "model": "model",466 "model": "model",

424 "output_audio_tokens": 0,467 "output_audio_tokens": 0,

468 "output_image_tokens": 0,

469 "output_text_tokens": 0,

425 "project_id": "project_id",470 "project_id": "project_id",

426 "service_tier": "service_tier",471 "service_tier": "service_tier",

427 "user_id": "user_id"472 "user_id": "user_id"

Details

62 62 

63 - `object: "bucket"`63 - `object: "bucket"`

64 64 

65 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`65 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

66 66 

67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

68 68 

69 The aggregated completions usage details of the specific time bucket.69 The aggregated completions usage details of the specific time bucket.

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


80 80 

81 - `output_tokens: number`81 - `output_tokens: number`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: optional string`85 - `api_key_id: optional string`

86 86 


92 92 

93 - `input_audio_tokens: optional number`93 - `input_audio_tokens: optional number`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: optional number`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: optional number`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: optional number`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: optional number`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: optional number`113 - `input_cached_tokens: optional number`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: optional number`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: optional number`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: optional number`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: optional string`129 - `model: optional string`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: optional number`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: optional number`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: optional string`145 - `project_id: optional string`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


431 "api_key_id": "api_key_id",467 "api_key_id": "api_key_id",

432 "batch": true,468 "batch": true,

433 "input_audio_tokens": 0,469 "input_audio_tokens": 0,

470 "input_cache_write_tokens": 0,

471 "input_cached_audio_tokens": 0,

472 "input_cached_image_tokens": 0,

473 "input_cached_text_tokens": 0,

434 "input_cached_tokens": 0,474 "input_cached_tokens": 0,

475 "input_image_tokens": 0,

476 "input_text_tokens": 0,

477 "input_uncached_tokens": 0,

435 "model": "model",478 "model": "model",

436 "output_audio_tokens": 0,479 "output_audio_tokens": 0,

480 "output_image_tokens": 0,

481 "output_text_tokens": 0,

437 "project_id": "project_id",482 "project_id": "project_id",

438 "service_tier": "service_tier",483 "service_tier": "service_tier",

439 "user_id": "user_id"484 "user_id": "user_id"

Details

62 62 

63 - `object: "bucket"`63 - `object: "bucket"`

64 64 

65 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`65 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

66 66 

67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

68 68 

69 The aggregated completions usage details of the specific time bucket.69 The aggregated completions usage details of the specific time bucket.

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


80 80 

81 - `output_tokens: number`81 - `output_tokens: number`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: optional string`85 - `api_key_id: optional string`

86 86 


92 92 

93 - `input_audio_tokens: optional number`93 - `input_audio_tokens: optional number`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: optional number`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: optional number`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: optional number`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: optional number`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: optional number`113 - `input_cached_tokens: optional number`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: optional number`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: optional number`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: optional number`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: optional string`129 - `model: optional string`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: optional number`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: optional number`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: optional string`145 - `project_id: optional string`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


431 "api_key_id": "api_key_id",467 "api_key_id": "api_key_id",

432 "batch": true,468 "batch": true,

433 "input_audio_tokens": 0,469 "input_audio_tokens": 0,

470 "input_cache_write_tokens": 0,

471 "input_cached_audio_tokens": 0,

472 "input_cached_image_tokens": 0,

473 "input_cached_text_tokens": 0,

434 "input_cached_tokens": 0,474 "input_cached_tokens": 0,

475 "input_image_tokens": 0,

476 "input_text_tokens": 0,

477 "input_uncached_tokens": 0,

435 "model": "model",478 "model": "model",

436 "output_audio_tokens": 0,479 "output_audio_tokens": 0,

480 "output_image_tokens": 0,

481 "output_text_tokens": 0,

437 "project_id": "project_id",482 "project_id": "project_id",

438 "service_tier": "service_tier",483 "service_tier": "service_tier",

439 "user_id": "user_id"484 "user_id": "user_id"

Details

70 70 

71 - `object: "bucket"`71 - `object: "bucket"`

72 72 

73 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`73 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

74 74 

75 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`75 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

76 76 

77 The aggregated completions usage details of the specific time bucket.77 The aggregated completions usage details of the specific time bucket.

78 78 

79 - `input_tokens: number`79 - `input_tokens: number`

80 80 

81 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.81 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

82 82 

83 - `num_model_requests: number`83 - `num_model_requests: number`

84 84 


88 88 

89 - `output_tokens: number`89 - `output_tokens: number`

90 90 

91 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `api_key_id: optional string`93 - `api_key_id: optional string`

94 94 


100 100 

101 - `input_audio_tokens: optional number`101 - `input_audio_tokens: optional number`

102 102 

103 The aggregated number of audio input tokens used, including cached tokens.103 The aggregated number of uncached audio input tokens used.

104 

105 - `input_cache_write_tokens: optional number`

106 

107 The aggregated number of input tokens written to the cache.

108 

109 - `input_cached_audio_tokens: optional number`

110 

111 The aggregated number of cached audio input tokens used.

112 

113 - `input_cached_image_tokens: optional number`

114 

115 The aggregated number of cached image input tokens used.

116 

117 - `input_cached_text_tokens: optional number`

118 

119 The aggregated number of cached text input tokens used.

104 120 

105 - `input_cached_tokens: optional number`121 - `input_cached_tokens: optional number`

106 122 

107 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.123 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

124 

125 - `input_image_tokens: optional number`

126 

127 The aggregated number of uncached image input tokens used.

128 

129 - `input_text_tokens: optional number`

130 

131 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

132 

133 - `input_uncached_tokens: optional number`

134 

135 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

108 136 

109 - `model: optional string`137 - `model: optional string`

110 138 


114 142 

115 The aggregated number of audio output tokens used.143 The aggregated number of audio output tokens used.

116 144 

145 - `output_image_tokens: optional number`

146 

147 The aggregated number of image output tokens used.

148 

149 - `output_text_tokens: optional number`

150 

151 The aggregated number of text output tokens used.

152 

117 - `project_id: optional string`153 - `project_id: optional string`

118 154 

119 When `group_by=project_id`, this field provides the project ID of the grouped usage result.155 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


439 "api_key_id": "api_key_id",475 "api_key_id": "api_key_id",

440 "batch": true,476 "batch": true,

441 "input_audio_tokens": 0,477 "input_audio_tokens": 0,

478 "input_cache_write_tokens": 0,

479 "input_cached_audio_tokens": 0,

480 "input_cached_image_tokens": 0,

481 "input_cached_text_tokens": 0,

442 "input_cached_tokens": 0,482 "input_cached_tokens": 0,

483 "input_image_tokens": 0,

484 "input_text_tokens": 0,

485 "input_uncached_tokens": 0,

443 "model": "model",486 "model": "model",

444 "output_audio_tokens": 0,487 "output_audio_tokens": 0,

488 "output_image_tokens": 0,

489 "output_text_tokens": 0,

445 "project_id": "project_id",490 "project_id": "project_id",

446 "service_tier": "service_tier",491 "service_tier": "service_tier",

447 "user_id": "user_id"492 "user_id": "user_id"

Details

62 62 

63 - `object: "bucket"`63 - `object: "bucket"`

64 64 

65 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`65 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

66 66 

67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`67 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

68 68 

69 The aggregated completions usage details of the specific time bucket.69 The aggregated completions usage details of the specific time bucket.

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


80 80 

81 - `output_tokens: number`81 - `output_tokens: number`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: optional string`85 - `api_key_id: optional string`

86 86 


92 92 

93 - `input_audio_tokens: optional number`93 - `input_audio_tokens: optional number`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: optional number`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: optional number`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: optional number`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: optional number`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: optional number`113 - `input_cached_tokens: optional number`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: optional number`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: optional number`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: optional number`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: optional string`129 - `model: optional string`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: optional number`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: optional number`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: optional string`145 - `project_id: optional string`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


431 "api_key_id": "api_key_id",467 "api_key_id": "api_key_id",

432 "batch": true,468 "batch": true,

433 "input_audio_tokens": 0,469 "input_audio_tokens": 0,

470 "input_cache_write_tokens": 0,

471 "input_cached_audio_tokens": 0,

472 "input_cached_image_tokens": 0,

473 "input_cached_text_tokens": 0,

434 "input_cached_tokens": 0,474 "input_cached_tokens": 0,

475 "input_image_tokens": 0,

476 "input_text_tokens": 0,

477 "input_uncached_tokens": 0,

435 "model": "model",478 "model": "model",

436 "output_audio_tokens": 0,479 "output_audio_tokens": 0,

480 "output_image_tokens": 0,

481 "output_text_tokens": 0,

437 "project_id": "project_id",482 "project_id": "project_id",

438 "service_tier": "service_tier",483 "service_tier": "service_tier",

439 "user_id": "user_id"484 "user_id": "user_id"

Details

50 50 

51 - `object: "bucket"`51 - `object: "bucket"`

52 52 

53 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`53 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

54 54 

55 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`55 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

56 56 

57 The aggregated completions usage details of the specific time bucket.57 The aggregated completions usage details of the specific time bucket.

58 58 

59 - `input_tokens: number`59 - `input_tokens: number`

60 60 

61 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.61 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

62 62 

63 - `num_model_requests: number`63 - `num_model_requests: number`

64 64 


68 68 

69 - `output_tokens: number`69 - `output_tokens: number`

70 70 

71 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `api_key_id: optional string`73 - `api_key_id: optional string`

74 74 


80 80 

81 - `input_audio_tokens: optional number`81 - `input_audio_tokens: optional number`

82 82 

83 The aggregated number of audio input tokens used, including cached tokens.83 The aggregated number of uncached audio input tokens used.

84 

85 - `input_cache_write_tokens: optional number`

86 

87 The aggregated number of input tokens written to the cache.

88 

89 - `input_cached_audio_tokens: optional number`

90 

91 The aggregated number of cached audio input tokens used.

92 

93 - `input_cached_image_tokens: optional number`

94 

95 The aggregated number of cached image input tokens used.

96 

97 - `input_cached_text_tokens: optional number`

98 

99 The aggregated number of cached text input tokens used.

84 100 

85 - `input_cached_tokens: optional number`101 - `input_cached_tokens: optional number`

86 102 

87 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 

105 - `input_image_tokens: optional number`

106 

107 The aggregated number of uncached image input tokens used.

108 

109 - `input_text_tokens: optional number`

110 

111 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

112 

113 - `input_uncached_tokens: optional number`

114 

115 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

88 116 

89 - `model: optional string`117 - `model: optional string`

90 118 


94 122 

95 The aggregated number of audio output tokens used.123 The aggregated number of audio output tokens used.

96 124 

125 - `output_image_tokens: optional number`

126 

127 The aggregated number of image output tokens used.

128 

129 - `output_text_tokens: optional number`

130 

131 The aggregated number of text output tokens used.

132 

97 - `project_id: optional string`133 - `project_id: optional string`

98 134 

99 When `group_by=project_id`, this field provides the project ID of the grouped usage result.135 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


419 "api_key_id": "api_key_id",455 "api_key_id": "api_key_id",

420 "batch": true,456 "batch": true,

421 "input_audio_tokens": 0,457 "input_audio_tokens": 0,

458 "input_cache_write_tokens": 0,

459 "input_cached_audio_tokens": 0,

460 "input_cached_image_tokens": 0,

461 "input_cached_text_tokens": 0,

422 "input_cached_tokens": 0,462 "input_cached_tokens": 0,

463 "input_image_tokens": 0,

464 "input_text_tokens": 0,

465 "input_uncached_tokens": 0,

423 "model": "model",466 "model": "model",

424 "output_audio_tokens": 0,467 "output_audio_tokens": 0,

468 "output_image_tokens": 0,

469 "output_text_tokens": 0,

425 "project_id": "project_id",470 "project_id": "project_id",

426 "service_tier": "service_tier",471 "service_tier": "service_tier",

427 "user_id": "user_id"472 "user_id": "user_id"

Details

66 66 

67 - `object: "bucket"`67 - `object: "bucket"`

68 68 

69 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`69 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

70 70 

71 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 10 more }`71 - `organization.usage.completions.result: object { input_tokens, num_model_requests, object, 19 more }`

72 72 

73 The aggregated completions usage details of the specific time bucket.73 The aggregated completions usage details of the specific time bucket.

74 74 

75 - `input_tokens: number`75 - `input_tokens: number`

76 76 

77 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.77 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

78 78 

79 - `num_model_requests: number`79 - `num_model_requests: number`

80 80 


84 84 

85 - `output_tokens: number`85 - `output_tokens: number`

86 86 

87 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.87 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

88 88 

89 - `api_key_id: optional string`89 - `api_key_id: optional string`

90 90 


96 96 

97 - `input_audio_tokens: optional number`97 - `input_audio_tokens: optional number`

98 98 

99 The aggregated number of audio input tokens used, including cached tokens.99 The aggregated number of uncached audio input tokens used.

100 

101 - `input_cache_write_tokens: optional number`

102 

103 The aggregated number of input tokens written to the cache.

104 

105 - `input_cached_audio_tokens: optional number`

106 

107 The aggregated number of cached audio input tokens used.

108 

109 - `input_cached_image_tokens: optional number`

110 

111 The aggregated number of cached image input tokens used.

112 

113 - `input_cached_text_tokens: optional number`

114 

115 The aggregated number of cached text input tokens used.

100 116 

101 - `input_cached_tokens: optional number`117 - `input_cached_tokens: optional number`

102 118 

103 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.119 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

120 

121 - `input_image_tokens: optional number`

122 

123 The aggregated number of uncached image input tokens used.

124 

125 - `input_text_tokens: optional number`

126 

127 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

128 

129 - `input_uncached_tokens: optional number`

130 

131 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

104 132 

105 - `model: optional string`133 - `model: optional string`

106 134 


110 138 

111 The aggregated number of audio output tokens used.139 The aggregated number of audio output tokens used.

112 140 

141 - `output_image_tokens: optional number`

142 

143 The aggregated number of image output tokens used.

144 

145 - `output_text_tokens: optional number`

146 

147 The aggregated number of text output tokens used.

148 

113 - `project_id: optional string`149 - `project_id: optional string`

114 150 

115 When `group_by=project_id`, this field provides the project ID of the grouped usage result.151 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


435 "api_key_id": "api_key_id",471 "api_key_id": "api_key_id",

436 "batch": true,472 "batch": true,

437 "input_audio_tokens": 0,473 "input_audio_tokens": 0,

474 "input_cache_write_tokens": 0,

475 "input_cached_audio_tokens": 0,

476 "input_cached_image_tokens": 0,

477 "input_cached_text_tokens": 0,

438 "input_cached_tokens": 0,478 "input_cached_tokens": 0,

479 "input_image_tokens": 0,

480 "input_text_tokens": 0,

481 "input_uncached_tokens": 0,

439 "model": "model",482 "model": "model",

440 "output_audio_tokens": 0,483 "output_audio_tokens": 0,

484 "output_image_tokens": 0,

485 "output_text_tokens": 0,

441 "project_id": "project_id",486 "project_id": "project_id",

442 "service_tier": "service_tier",487 "service_tier": "service_tier",

443 "user_id": "user_id"488 "user_id": "user_id"

Details

1379 1379 

1380 The content type. Always `output_text`.1380 The content type. Always `output_text`.

1381 1381 

1382 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1382 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1383 1383 

1384 Citations associated with the text content.1384 Citations associated with the text content.

1385 1385 

1386 - `union_member_0: array of object { file_id, filename, index, type }`1386 - `file_citation: object { file_id, filename, index, type }`

1387 1387 

1388 - `file_id: string`1388 - `file_id: string`

1389 1389 


1401 1401 

1402 The citation type. Always `file_citation`.1402 The citation type. Always `file_citation`.

1403 1403 

1404 - `union_member_1: array of object { end_index, start_index, title, 2 more }`1404 - `url_citation: object { end_index, start_index, title, 2 more }`

1405 1405 

1406 - `end_index: number`1406 - `end_index: number`

1407 1407 


1423 1423 

1424 The URL of the cited resource.1424 The URL of the cited resource.

1425 1425 

1426 - `union_member_2: array of object { container_id, end_index, file_id, 3 more }`1426 - `container_file_citation: object { container_id, end_index, file_id, 3 more }`

1427 1427 

1428 - `container_id: string`1428 - `container_id: string`

1429 1429 


2730 2730 

2731 - `encrypted_content: optional string`2731 - `encrypted_content: optional string`

2732 2732 

2733 The encrypted content of the reasoning item - populated when a response is2733 The encrypted content of the reasoning item. This is populated by default

2734 generated with `reasoning.encrypted_content` in the `include` parameter.2734 for reasoning items returned by `POST /v1/responses` and WebSocket

2735 `response.create` requests.

2735 2736 

2736 - `status: optional "in_progress" or "completed" or "incomplete"`2737 - `status: optional "in_progress" or "completed" or "incomplete"`

2737 2738 


4528 4529 

4529 - `encrypted_content: optional string`4530 - `encrypted_content: optional string`

4530 4531 

4531 The encrypted content of the reasoning item - populated when a response is4532 The encrypted content of the reasoning item. This is populated by default

4532 generated with `reasoning.encrypted_content` in the `include` parameter.4533 for reasoning items returned by `POST /v1/responses` and WebSocket

4534 `response.create` requests.

4533 4535 

4534 - `status: optional "in_progress" or "completed" or "incomplete"`4536 - `status: optional "in_progress" or "completed" or "incomplete"`

4535 4537 

Details

1256 1256 

1257 - `encrypted_content: optional string`1257 - `encrypted_content: optional string`

1258 1258 

1259 The encrypted content of the reasoning item - populated when a response is1259 The encrypted content of the reasoning item. This is populated by default

1260 generated with `reasoning.encrypted_content` in the `include` parameter.1260 for reasoning items returned by `POST /v1/responses` and WebSocket

1261 `response.create` requests.

1261 1262 

1262 - `status: optional "in_progress" or "completed" or "incomplete"`1263 - `status: optional "in_progress" or "completed" or "incomplete"`

1263 1264 

Details

1598 1598 

1599 The content type. Always `output_text`.1599 The content type. Always `output_text`.

1600 1600 

1601 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1601 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1602 1602 

1603 Citations associated with the text content.1603 Citations associated with the text content.

1604 1604 

1605 - `union_member_0: array of object { file_id, filename, index, type }`1605 - `file_citation: object { file_id, filename, index, type }`

1606 1606 

1607 - `file_id: string`1607 - `file_id: string`

1608 1608 


1620 1620 

1621 The citation type. Always `file_citation`.1621 The citation type. Always `file_citation`.

1622 1622 

1623 - `union_member_1: array of object { end_index, start_index, title, 2 more }`1623 - `url_citation: object { end_index, start_index, title, 2 more }`

1624 1624 

1625 - `end_index: number`1625 - `end_index: number`

1626 1626 


1642 1642 

1643 The URL of the cited resource.1643 The URL of the cited resource.

1644 1644 

1645 - `union_member_2: array of object { container_id, end_index, file_id, 3 more }`1645 - `container_file_citation: object { container_id, end_index, file_id, 3 more }`

1646 1646 

1647 - `container_id: string`1647 - `container_id: string`

1648 1648 


2949 2949 

2950 - `encrypted_content: optional string`2950 - `encrypted_content: optional string`

2951 2951 

2952 The encrypted content of the reasoning item - populated when a response is2952 The encrypted content of the reasoning item. This is populated by default

2953 generated with `reasoning.encrypted_content` in the `include` parameter.2953 for reasoning items returned by `POST /v1/responses` and WebSocket

2954 `response.create` requests.

2954 2955 

2955 - `status: optional "in_progress" or "completed" or "incomplete"`2956 - `status: optional "in_progress" or "completed" or "incomplete"`

2956 2957 


4747 4748 

4748 - `encrypted_content: optional string`4749 - `encrypted_content: optional string`

4749 4750 

4750 The encrypted content of the reasoning item - populated when a response is4751 The encrypted content of the reasoning item. This is populated by default

4751 generated with `reasoning.encrypted_content` in the `include` parameter.4752 for reasoning items returned by `POST /v1/responses` and WebSocket

4753 `response.create` requests.

4752 4754 

4753 - `status: optional "in_progress" or "completed" or "incomplete"`4755 - `status: optional "in_progress" or "completed" or "incomplete"`

4754 4756 

Details

1396 1396 

1397 The content type. Always `output_text`.1397 The content type. Always `output_text`.

1398 1398 

1399 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1399 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1400 1400 

1401 Citations associated with the text content.1401 Citations associated with the text content.

1402 1402 

1403 - `union_member_0: array of object { file_id, filename, index, type }`1403 - `file_citation: object { file_id, filename, index, type }`

1404 1404 

1405 - `file_id: string`1405 - `file_id: string`

1406 1406 


1418 1418 

1419 The citation type. Always `file_citation`.1419 The citation type. Always `file_citation`.

1420 1420 

1421 - `union_member_1: array of object { end_index, start_index, title, 2 more }`1421 - `url_citation: object { end_index, start_index, title, 2 more }`

1422 1422 

1423 - `end_index: number`1423 - `end_index: number`

1424 1424 


1440 1440 

1441 The URL of the cited resource.1441 The URL of the cited resource.

1442 1442 

1443 - `union_member_2: array of object { container_id, end_index, file_id, 3 more }`1443 - `container_file_citation: object { container_id, end_index, file_id, 3 more }`

1444 1444 

1445 - `container_id: string`1445 - `container_id: string`

1446 1446 


2747 2747 

2748 - `encrypted_content: optional string`2748 - `encrypted_content: optional string`

2749 2749 

2750 The encrypted content of the reasoning item - populated when a response is2750 The encrypted content of the reasoning item. This is populated by default

2751 generated with `reasoning.encrypted_content` in the `include` parameter.2751 for reasoning items returned by `POST /v1/responses` and WebSocket

2752 `response.create` requests.

2752 2753 

2753 - `status: optional "in_progress" or "completed" or "incomplete"`2754 - `status: optional "in_progress" or "completed" or "incomplete"`

2754 2755 


4545 4546 

4546 - `encrypted_content: optional string`4547 - `encrypted_content: optional string`

4547 4548 

4548 The encrypted content of the reasoning item - populated when a response is4549 The encrypted content of the reasoning item. This is populated by default

4549 generated with `reasoning.encrypted_content` in the `include` parameter.4550 for reasoning items returned by `POST /v1/responses` and WebSocket

4551 `response.create` requests.

4550 4552 

4551 - `status: optional "in_progress" or "completed" or "incomplete"`4553 - `status: optional "in_progress" or "completed" or "incomplete"`

4552 4554 

Details

2554 2554 

2555 - `encrypted_content: optional string`2555 - `encrypted_content: optional string`

2556 2556 

2557 The encrypted content of the reasoning item - populated when a response is2557 The encrypted content of the reasoning item. This is populated by default

2558 generated with `reasoning.encrypted_content` in the `include` parameter.2558 for reasoning items returned by `POST /v1/responses` and WebSocket

2559 `response.create` requests.

2559 2560 

2560 - `status: optional "in_progress" or "completed" or "incomplete"`2561 - `status: optional "in_progress" or "completed" or "incomplete"`

2561 2562 

Details

2315 2315 

2316 - `encrypted_content: optional string`2316 - `encrypted_content: optional string`

2317 2317 

2318 The encrypted content of the reasoning item - populated when a response is2318 The encrypted content of the reasoning item. This is populated by default

2319 generated with `reasoning.encrypted_content` in the `include` parameter.2319 for reasoning items returned by `POST /v1/responses` and WebSocket

2320 `response.create` requests.

2320 2321 

2321 - `status: optional "in_progress" or "completed" or "incomplete"`2322 - `status: optional "in_progress" or "completed" or "incomplete"`

2322 2323 

Details

2334 2334 

2335 - `encrypted_content: optional string`2335 - `encrypted_content: optional string`

2336 2336 

2337 The encrypted content of the reasoning item - populated when a response is2337 The encrypted content of the reasoning item. This is populated by default

2338 generated with `reasoning.encrypted_content` in the `include` parameter.2338 for reasoning items returned by `POST /v1/responses` and WebSocket

2339 `response.create` requests.

2339 2340 

2340 - `status: optional "in_progress" or "completed" or "incomplete"`2341 - `status: optional "in_progress" or "completed" or "incomplete"`

2341 2342 

Details

2311 2311 

2312 - `encrypted_content: optional string`2312 - `encrypted_content: optional string`

2313 2313 

2314 The encrypted content of the reasoning item - populated when a response is2314 The encrypted content of the reasoning item. This is populated by default

2315 generated with `reasoning.encrypted_content` in the `include` parameter.2315 for reasoning items returned by `POST /v1/responses` and WebSocket

2316 `response.create` requests.

2316 2317 

2317 - `status: optional "in_progress" or "completed" or "incomplete"`2318 - `status: optional "in_progress" or "completed" or "incomplete"`

2318 2319 

Details

2464 2464 

2465 - `encrypted_content: optional string`2465 - `encrypted_content: optional string`

2466 2466 

2467 The encrypted content of the reasoning item - populated when a response is2467 The encrypted content of the reasoning item. This is populated by default

2468 generated with `reasoning.encrypted_content` in the `include` parameter.2468 for reasoning items returned by `POST /v1/responses` and WebSocket

2469 `response.create` requests.

2469 2470 

2470 - `status: optional "in_progress" or "completed" or "incomplete"`2471 - `status: optional "in_progress" or "completed" or "incomplete"`

2471 2472 


3844 3845 

3845 - `encrypted_content: optional string`3846 - `encrypted_content: optional string`

3846 3847 

3847 The encrypted content of the reasoning item - populated when a response is3848 The encrypted content of the reasoning item. This is populated by default

3848 generated with `reasoning.encrypted_content` in the `include` parameter.3849 for reasoning items returned by `POST /v1/responses` and WebSocket

3850 `response.create` requests.

3849 3851 

3850 - `status: optional "in_progress" or "completed" or "incomplete"`3852 - `status: optional "in_progress" or "completed" or "incomplete"`

3851 3853 

Details

1089 1089 

1090 - `encrypted_content: optional string`1090 - `encrypted_content: optional string`

1091 1091 

1092 The encrypted content of the reasoning item - populated when a response is1092 The encrypted content of the reasoning item. This is populated by default

1093 generated with `reasoning.encrypted_content` in the `include` parameter.1093 for reasoning items returned by `POST /v1/responses` and WebSocket

1094 `response.create` requests.

1094 1095 

1095 - `status: optional "in_progress" or "completed" or "incomplete"`1096 - `status: optional "in_progress" or "completed" or "incomplete"`

1096 1097 

Details

2679 2679 

2680 - `encrypted_content: optional string`2680 - `encrypted_content: optional string`

2681 2681 

2682 The encrypted content of the reasoning item - populated when a response is2682 The encrypted content of the reasoning item. This is populated by default

2683 generated with `reasoning.encrypted_content` in the `include` parameter.2683 for reasoning items returned by `POST /v1/responses` and WebSocket

2684 `response.create` requests.

2684 2685 

2685 - `status: optional "in_progress" or "completed" or "incomplete"`2686 - `status: optional "in_progress" or "completed" or "incomplete"`

2686 2687 


4059 4060 

4060 - `encrypted_content: optional string`4061 - `encrypted_content: optional string`

4061 4062 

4062 The encrypted content of the reasoning item - populated when a response is4063 The encrypted content of the reasoning item. This is populated by default

4063 generated with `reasoning.encrypted_content` in the `include` parameter.4064 for reasoning items returned by `POST /v1/responses` and WebSocket

4065 `response.create` requests.

4064 4066 

4065 - `status: optional "in_progress" or "completed" or "incomplete"`4067 - `status: optional "in_progress" or "completed" or "incomplete"`

4066 4068 

Details

2481 2481 

2482 - `encrypted_content: optional string`2482 - `encrypted_content: optional string`

2483 2483 

2484 The encrypted content of the reasoning item - populated when a response is2484 The encrypted content of the reasoning item. This is populated by default

2485 generated with `reasoning.encrypted_content` in the `include` parameter.2485 for reasoning items returned by `POST /v1/responses` and WebSocket

2486 `response.create` requests.

2486 2487 

2487 - `status: optional "in_progress" or "completed" or "incomplete"`2488 - `status: optional "in_progress" or "completed" or "incomplete"`

2488 2489 


3861 3862 

3862 - `encrypted_content: optional string`3863 - `encrypted_content: optional string`

3863 3864 

3864 The encrypted content of the reasoning item - populated when a response is3865 The encrypted content of the reasoning item. This is populated by default

3865 generated with `reasoning.encrypted_content` in the `include` parameter.3866 for reasoning items returned by `POST /v1/responses` and WebSocket

3867 `response.create` requests.

3866 3868 

3867 - `status: optional "in_progress" or "completed" or "incomplete"`3869 - `status: optional "in_progress" or "completed" or "incomplete"`

3868 3870 

Details

2314 2314 

2315 - `encrypted_content: optional string`2315 - `encrypted_content: optional string`

2316 2316 

2317 The encrypted content of the reasoning item - populated when a response is2317 The encrypted content of the reasoning item. This is populated by default

2318 generated with `reasoning.encrypted_content` in the `include` parameter.2318 for reasoning items returned by `POST /v1/responses` and WebSocket

2319 `response.create` requests.

2319 2320 

2320 - `status: optional "in_progress" or "completed" or "incomplete"`2321 - `status: optional "in_progress" or "completed" or "incomplete"`

2321 2322 

Details

168 168 

169 - `const AdminOrganizationAuditLogListParamsEventTypeUserDeleted AdminOrganizationAuditLogListParamsEventType = "user.deleted"`169 - `const AdminOrganizationAuditLogListParamsEventTypeUserDeleted AdminOrganizationAuditLogListParamsEventType = "user.deleted"`

170 170 

171 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMetadataUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.metadata.updated"`

172 

173 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMicrosoftEntraMappingUpserted AdminOrganizationAuditLogListParamsEventType = "tenant.microsoft_entra_mapping.upserted"`

174 

175 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMicrosoftEntraMappingDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.microsoft_entra_mapping.deleted"`

176 

177 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityProviderCreated AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.provider.created"`

178 

179 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityProviderUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.provider.updated"`

180 

181 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityProviderArchived AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.provider.archived"`

182 

183 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityMappingCreated AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.mapping.created"`

184 

185 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityMappingUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.mapping.updated"`

186 

187 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityMappingArchived AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.mapping.archived"`

188 

189 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityBindingCreated AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.binding.created"`

190 

191 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkloadIdentityPrincipalProvisioned AdminOrganizationAuditLogListParamsEventType = "tenant.workload_identity.principal.provisioned"`

192 

193 - `const AdminOrganizationAuditLogListParamsEventTypeTenantAdminAPIKeyCreated AdminOrganizationAuditLogListParamsEventType = "tenant.admin_api_key.created"`

194 

195 - `const AdminOrganizationAuditLogListParamsEventTypeTenantAdminAPIKeyUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.admin_api_key.updated"`

196 

197 - `const AdminOrganizationAuditLogListParamsEventTypeTenantAdminAPIKeyDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.admin_api_key.deleted"`

198 

199 - `const AdminOrganizationAuditLogListParamsEventTypeTenantProjectAPIKeyCreated AdminOrganizationAuditLogListParamsEventType = "tenant.project_api_key.created"`

200 

201 - `const AdminOrganizationAuditLogListParamsEventTypeTenantChatgptAccessTokenRevoked AdminOrganizationAuditLogListParamsEventType = "tenant.chatgpt_access_token.revoked"`

202 

203 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMigrationCompleted AdminOrganizationAuditLogListParamsEventType = "tenant.migration.completed"`

204 

205 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSSOMigrated AdminOrganizationAuditLogListParamsEventType = "tenant.sso.migrated"`

206 

207 - `const AdminOrganizationAuditLogListParamsEventTypeTenantDomainsMigrated AdminOrganizationAuditLogListParamsEventType = "tenant.domains.migrated"`

208 

209 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSSOConnectionCreated AdminOrganizationAuditLogListParamsEventType = "tenant.sso_connection.created"`

210 

211 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSSOConnectionUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.sso_connection.updated"`

212 

213 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSSOConnectionDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.sso_connection.deleted"`

214 

215 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSSOConnectionSetupStarted AdminOrganizationAuditLogListParamsEventType = "tenant.sso_connection.setup.started"`

216 

217 - `const AdminOrganizationAuditLogListParamsEventTypeTenantPolicyCreated AdminOrganizationAuditLogListParamsEventType = "tenant.policy.created"`

218 

219 - `const AdminOrganizationAuditLogListParamsEventTypeTenantPolicyUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.policy.updated"`

220 

221 - `const AdminOrganizationAuditLogListParamsEventTypeTenantPolicyDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.policy.deleted"`

222 

223 - `const AdminOrganizationAuditLogListParamsEventTypeTenantPolicyAttached AdminOrganizationAuditLogListParamsEventType = "tenant.policy.attached"`

224 

225 - `const AdminOrganizationAuditLogListParamsEventTypeTenantPolicyDetached AdminOrganizationAuditLogListParamsEventType = "tenant.policy.detached"`

226 

227 - `const AdminOrganizationAuditLogListParamsEventTypeTenantPrincipalAuthenticationPolicyResolved AdminOrganizationAuditLogListParamsEventType = "tenant.principal_authentication_policy.resolved"`

228 

229 - `const AdminOrganizationAuditLogListParamsEventTypeTenantScimSetupStarted AdminOrganizationAuditLogListParamsEventType = "tenant.scim.setup.started"`

230 

231 - `const AdminOrganizationAuditLogListParamsEventTypeTenantScimDeletionRequested AdminOrganizationAuditLogListParamsEventType = "tenant.scim.deletion.requested"`

232 

233 - `const AdminOrganizationAuditLogListParamsEventTypeTenantScimDirectoryCreated AdminOrganizationAuditLogListParamsEventType = "tenant.scim.directory.created"`

234 

235 - `const AdminOrganizationAuditLogListParamsEventTypeTenantProductAccessPolicyUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.product_access_policy.updated"`

236 

237 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceShareGrantCreated AdminOrganizationAuditLogListParamsEventType = "tenant.resource_share_grant.created"`

238 

239 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceShareGrantUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.resource_share_grant.updated"`

240 

241 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceShareGrantAccepted AdminOrganizationAuditLogListParamsEventType = "tenant.resource_share_grant.accepted"`

242 

243 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceShareGrantDeclined AdminOrganizationAuditLogListParamsEventType = "tenant.resource_share_grant.declined"`

244 

245 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceShareGrantRevoked AdminOrganizationAuditLogListParamsEventType = "tenant.resource_share_grant.revoked"`

246 

247 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceShareGrantDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.resource_share_grant.deleted"`

248 

249 - `const AdminOrganizationAuditLogListParamsEventTypeTenantServiceAccountUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.service_account.updated"`

250 

251 - `const AdminOrganizationAuditLogListParamsEventTypeTenantServiceAccountDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.service_account.deleted"`

252 

253 - `const AdminOrganizationAuditLogListParamsEventTypeTenantServiceAccountTokenRevoked AdminOrganizationAuditLogListParamsEventType = "tenant.service_account.token.revoked"`

254 

255 - `const AdminOrganizationAuditLogListParamsEventTypeTenantBillingOverageLimitUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.billing.overage_limit.updated"`

256 

257 - `const AdminOrganizationAuditLogListParamsEventTypeTenantBillingAlertsUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.billing.alerts.updated"`

258 

259 - `const AdminOrganizationAuditLogListParamsEventTypeTenantBillingInfoUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.billing.info.updated"`

260 

261 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUsageLimitWorkspaceUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.usage_limit.workspace.updated"`

262 

263 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUsageLimitGroupUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.usage_limit.group.updated"`

264 

265 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUsageLimitUserUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.usage_limit.user.updated"`

266 

267 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUsageLimitIncreaseRequestUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.usage_limit.increase_request.updated"`

268 

269 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUsageLimitIncreaseRequestResolved AdminOrganizationAuditLogListParamsEventType = "tenant.usage_limit.increase_request.resolved"`

270 

271 - `const AdminOrganizationAuditLogListParamsEventTypeTenantGroupCreated AdminOrganizationAuditLogListParamsEventType = "tenant.group.created"`

272 

273 - `const AdminOrganizationAuditLogListParamsEventTypeTenantGroupUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.group.updated"`

274 

275 - `const AdminOrganizationAuditLogListParamsEventTypeTenantGroupDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.group.deleted"`

276 

277 - `const AdminOrganizationAuditLogListParamsEventTypeTenantGroupMemberAdded AdminOrganizationAuditLogListParamsEventType = "tenant.group.member.added"`

278 

279 - `const AdminOrganizationAuditLogListParamsEventTypeTenantGroupMemberRemoved AdminOrganizationAuditLogListParamsEventType = "tenant.group.member.removed"`

280 

281 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMigrationRolloutStatusUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.migration_rollout.status.updated"`

282 

283 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMigrationRolloutTierUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.migration_rollout.tier.updated"`

284 

285 - `const AdminOrganizationAuditLogListParamsEventTypeTenantRoleMetadataUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.role.metadata.updated"`

286 

287 - `const AdminOrganizationAuditLogListParamsEventTypeTenantCustomRoleCreated AdminOrganizationAuditLogListParamsEventType = "tenant.custom_role.created"`

288 

289 - `const AdminOrganizationAuditLogListParamsEventTypeTenantCustomRoleUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.custom_role.updated"`

290 

291 - `const AdminOrganizationAuditLogListParamsEventTypeTenantCustomRoleDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.custom_role.deleted"`

292 

293 - `const AdminOrganizationAuditLogListParamsEventTypeTenantRoleAssignmentCreated AdminOrganizationAuditLogListParamsEventType = "tenant.role_assignment.created"`

294 

295 - `const AdminOrganizationAuditLogListParamsEventTypeTenantRoleAssignmentDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.role_assignment.deleted"`

296 

297 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceRoleAssignmentCreated AdminOrganizationAuditLogListParamsEventType = "tenant.resource_role_assignment.created"`

298 

299 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceRoleAssignmentDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.resource_role_assignment.deleted"`

300 

301 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceAccessUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.resource_access.updated"`

302 

303 - `const AdminOrganizationAuditLogListParamsEventTypeTenantResourceAccessDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.resource_access.deleted"`

304 

305 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSessionPolicyCreated AdminOrganizationAuditLogListParamsEventType = "tenant.session_policy.created"`

306 

307 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSessionPolicyUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.session_policy.updated"`

308 

309 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSessionPolicyDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.session_policy.deleted"`

310 

311 - `const AdminOrganizationAuditLogListParamsEventTypeTenantSessionRevocationStarted AdminOrganizationAuditLogListParamsEventType = "tenant.session_revocation.started"`

312 

313 - `const AdminOrganizationAuditLogListParamsEventTypeTenantThirdPartyAppPolicyUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.third_party_app_policy.updated"`

314 

315 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUserAdded AdminOrganizationAuditLogListParamsEventType = "tenant.user.added"`

316 

317 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUserUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.user.updated"`

318 

319 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUserRemoved AdminOrganizationAuditLogListParamsEventType = "tenant.user.removed"`

320 

321 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUserLookedUp AdminOrganizationAuditLogListParamsEventType = "tenant.user.looked_up"`

322 

323 - `const AdminOrganizationAuditLogListParamsEventTypeTenantUserInvited AdminOrganizationAuditLogListParamsEventType = "tenant.user.invited"`

324 

325 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMembershipRevoked AdminOrganizationAuditLogListParamsEventType = "tenant.membership.revoked"`

326 

327 - `const AdminOrganizationAuditLogListParamsEventTypeTenantAPIOrganizationInviteUpserted AdminOrganizationAuditLogListParamsEventType = "tenant.api_organization_invite.upserted"`

328 

329 - `const AdminOrganizationAuditLogListParamsEventTypeTenantAPIOrganizationInviteDeleted AdminOrganizationAuditLogListParamsEventType = "tenant.api_organization_invite.deleted"`

330 

331 - `const AdminOrganizationAuditLogListParamsEventTypeTenantChatgptWorkspaceInviteUpserted AdminOrganizationAuditLogListParamsEventType = "tenant.chatgpt_workspace_invite.upserted"`

332 

333 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMembershipAccepted AdminOrganizationAuditLogListParamsEventType = "tenant.membership.accepted"`

334 

335 - `const AdminOrganizationAuditLogListParamsEventTypeTenantMembershipDeclined AdminOrganizationAuditLogListParamsEventType = "tenant.membership.declined"`

336 

337 - `const AdminOrganizationAuditLogListParamsEventTypeTenantWorkspaceInviteEmailSettingsUpdated AdminOrganizationAuditLogListParamsEventType = "tenant.workspace_invite_email_settings.updated"`

338 

171 - `Limit param.Field[int64]`339 - `Limit param.Field[int64]`

172 340 

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


320 488 

321 - `const AdminOrganizationAuditLogListResponseTypeUserDeleted AdminOrganizationAuditLogListResponseType = "user.deleted"`489 - `const AdminOrganizationAuditLogListResponseTypeUserDeleted AdminOrganizationAuditLogListResponseType = "user.deleted"`

322 490 

491 - `const AdminOrganizationAuditLogListResponseTypeTenantMetadataUpdated AdminOrganizationAuditLogListResponseType = "tenant.metadata.updated"`

492 

493 - `const AdminOrganizationAuditLogListResponseTypeTenantMicrosoftEntraMappingUpserted AdminOrganizationAuditLogListResponseType = "tenant.microsoft_entra_mapping.upserted"`

494 

495 - `const AdminOrganizationAuditLogListResponseTypeTenantMicrosoftEntraMappingDeleted AdminOrganizationAuditLogListResponseType = "tenant.microsoft_entra_mapping.deleted"`

496 

497 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityProviderCreated AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.provider.created"`

498 

499 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityProviderUpdated AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.provider.updated"`

500 

501 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityProviderArchived AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.provider.archived"`

502 

503 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityMappingCreated AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.mapping.created"`

504 

505 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityMappingUpdated AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.mapping.updated"`

506 

507 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityMappingArchived AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.mapping.archived"`

508 

509 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityBindingCreated AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.binding.created"`

510 

511 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkloadIdentityPrincipalProvisioned AdminOrganizationAuditLogListResponseType = "tenant.workload_identity.principal.provisioned"`

512 

513 - `const AdminOrganizationAuditLogListResponseTypeTenantAdminAPIKeyCreated AdminOrganizationAuditLogListResponseType = "tenant.admin_api_key.created"`

514 

515 - `const AdminOrganizationAuditLogListResponseTypeTenantAdminAPIKeyUpdated AdminOrganizationAuditLogListResponseType = "tenant.admin_api_key.updated"`

516 

517 - `const AdminOrganizationAuditLogListResponseTypeTenantAdminAPIKeyDeleted AdminOrganizationAuditLogListResponseType = "tenant.admin_api_key.deleted"`

518 

519 - `const AdminOrganizationAuditLogListResponseTypeTenantProjectAPIKeyCreated AdminOrganizationAuditLogListResponseType = "tenant.project_api_key.created"`

520 

521 - `const AdminOrganizationAuditLogListResponseTypeTenantChatgptAccessTokenRevoked AdminOrganizationAuditLogListResponseType = "tenant.chatgpt_access_token.revoked"`

522 

523 - `const AdminOrganizationAuditLogListResponseTypeTenantMigrationCompleted AdminOrganizationAuditLogListResponseType = "tenant.migration.completed"`

524 

525 - `const AdminOrganizationAuditLogListResponseTypeTenantSSOMigrated AdminOrganizationAuditLogListResponseType = "tenant.sso.migrated"`

526 

527 - `const AdminOrganizationAuditLogListResponseTypeTenantDomainsMigrated AdminOrganizationAuditLogListResponseType = "tenant.domains.migrated"`

528 

529 - `const AdminOrganizationAuditLogListResponseTypeTenantSSOConnectionCreated AdminOrganizationAuditLogListResponseType = "tenant.sso_connection.created"`

530 

531 - `const AdminOrganizationAuditLogListResponseTypeTenantSSOConnectionUpdated AdminOrganizationAuditLogListResponseType = "tenant.sso_connection.updated"`

532 

533 - `const AdminOrganizationAuditLogListResponseTypeTenantSSOConnectionDeleted AdminOrganizationAuditLogListResponseType = "tenant.sso_connection.deleted"`

534 

535 - `const AdminOrganizationAuditLogListResponseTypeTenantSSOConnectionSetupStarted AdminOrganizationAuditLogListResponseType = "tenant.sso_connection.setup.started"`

536 

537 - `const AdminOrganizationAuditLogListResponseTypeTenantPolicyCreated AdminOrganizationAuditLogListResponseType = "tenant.policy.created"`

538 

539 - `const AdminOrganizationAuditLogListResponseTypeTenantPolicyUpdated AdminOrganizationAuditLogListResponseType = "tenant.policy.updated"`

540 

541 - `const AdminOrganizationAuditLogListResponseTypeTenantPolicyDeleted AdminOrganizationAuditLogListResponseType = "tenant.policy.deleted"`

542 

543 - `const AdminOrganizationAuditLogListResponseTypeTenantPolicyAttached AdminOrganizationAuditLogListResponseType = "tenant.policy.attached"`

544 

545 - `const AdminOrganizationAuditLogListResponseTypeTenantPolicyDetached AdminOrganizationAuditLogListResponseType = "tenant.policy.detached"`

546 

547 - `const AdminOrganizationAuditLogListResponseTypeTenantPrincipalAuthenticationPolicyResolved AdminOrganizationAuditLogListResponseType = "tenant.principal_authentication_policy.resolved"`

548 

549 - `const AdminOrganizationAuditLogListResponseTypeTenantScimSetupStarted AdminOrganizationAuditLogListResponseType = "tenant.scim.setup.started"`

550 

551 - `const AdminOrganizationAuditLogListResponseTypeTenantScimDeletionRequested AdminOrganizationAuditLogListResponseType = "tenant.scim.deletion.requested"`

552 

553 - `const AdminOrganizationAuditLogListResponseTypeTenantScimDirectoryCreated AdminOrganizationAuditLogListResponseType = "tenant.scim.directory.created"`

554 

555 - `const AdminOrganizationAuditLogListResponseTypeTenantProductAccessPolicyUpdated AdminOrganizationAuditLogListResponseType = "tenant.product_access_policy.updated"`

556 

557 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceShareGrantCreated AdminOrganizationAuditLogListResponseType = "tenant.resource_share_grant.created"`

558 

559 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceShareGrantUpdated AdminOrganizationAuditLogListResponseType = "tenant.resource_share_grant.updated"`

560 

561 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceShareGrantAccepted AdminOrganizationAuditLogListResponseType = "tenant.resource_share_grant.accepted"`

562 

563 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceShareGrantDeclined AdminOrganizationAuditLogListResponseType = "tenant.resource_share_grant.declined"`

564 

565 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceShareGrantRevoked AdminOrganizationAuditLogListResponseType = "tenant.resource_share_grant.revoked"`

566 

567 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceShareGrantDeleted AdminOrganizationAuditLogListResponseType = "tenant.resource_share_grant.deleted"`

568 

569 - `const AdminOrganizationAuditLogListResponseTypeTenantServiceAccountUpdated AdminOrganizationAuditLogListResponseType = "tenant.service_account.updated"`

570 

571 - `const AdminOrganizationAuditLogListResponseTypeTenantServiceAccountDeleted AdminOrganizationAuditLogListResponseType = "tenant.service_account.deleted"`

572 

573 - `const AdminOrganizationAuditLogListResponseTypeTenantServiceAccountTokenRevoked AdminOrganizationAuditLogListResponseType = "tenant.service_account.token.revoked"`

574 

575 - `const AdminOrganizationAuditLogListResponseTypeTenantBillingOverageLimitUpdated AdminOrganizationAuditLogListResponseType = "tenant.billing.overage_limit.updated"`

576 

577 - `const AdminOrganizationAuditLogListResponseTypeTenantBillingAlertsUpdated AdminOrganizationAuditLogListResponseType = "tenant.billing.alerts.updated"`

578 

579 - `const AdminOrganizationAuditLogListResponseTypeTenantBillingInfoUpdated AdminOrganizationAuditLogListResponseType = "tenant.billing.info.updated"`

580 

581 - `const AdminOrganizationAuditLogListResponseTypeTenantUsageLimitWorkspaceUpdated AdminOrganizationAuditLogListResponseType = "tenant.usage_limit.workspace.updated"`

582 

583 - `const AdminOrganizationAuditLogListResponseTypeTenantUsageLimitGroupUpdated AdminOrganizationAuditLogListResponseType = "tenant.usage_limit.group.updated"`

584 

585 - `const AdminOrganizationAuditLogListResponseTypeTenantUsageLimitUserUpdated AdminOrganizationAuditLogListResponseType = "tenant.usage_limit.user.updated"`

586 

587 - `const AdminOrganizationAuditLogListResponseTypeTenantUsageLimitIncreaseRequestUpdated AdminOrganizationAuditLogListResponseType = "tenant.usage_limit.increase_request.updated"`

588 

589 - `const AdminOrganizationAuditLogListResponseTypeTenantUsageLimitIncreaseRequestResolved AdminOrganizationAuditLogListResponseType = "tenant.usage_limit.increase_request.resolved"`

590 

591 - `const AdminOrganizationAuditLogListResponseTypeTenantGroupCreated AdminOrganizationAuditLogListResponseType = "tenant.group.created"`

592 

593 - `const AdminOrganizationAuditLogListResponseTypeTenantGroupUpdated AdminOrganizationAuditLogListResponseType = "tenant.group.updated"`

594 

595 - `const AdminOrganizationAuditLogListResponseTypeTenantGroupDeleted AdminOrganizationAuditLogListResponseType = "tenant.group.deleted"`

596 

597 - `const AdminOrganizationAuditLogListResponseTypeTenantGroupMemberAdded AdminOrganizationAuditLogListResponseType = "tenant.group.member.added"`

598 

599 - `const AdminOrganizationAuditLogListResponseTypeTenantGroupMemberRemoved AdminOrganizationAuditLogListResponseType = "tenant.group.member.removed"`

600 

601 - `const AdminOrganizationAuditLogListResponseTypeTenantMigrationRolloutStatusUpdated AdminOrganizationAuditLogListResponseType = "tenant.migration_rollout.status.updated"`

602 

603 - `const AdminOrganizationAuditLogListResponseTypeTenantMigrationRolloutTierUpdated AdminOrganizationAuditLogListResponseType = "tenant.migration_rollout.tier.updated"`

604 

605 - `const AdminOrganizationAuditLogListResponseTypeTenantRoleMetadataUpdated AdminOrganizationAuditLogListResponseType = "tenant.role.metadata.updated"`

606 

607 - `const AdminOrganizationAuditLogListResponseTypeTenantCustomRoleCreated AdminOrganizationAuditLogListResponseType = "tenant.custom_role.created"`

608 

609 - `const AdminOrganizationAuditLogListResponseTypeTenantCustomRoleUpdated AdminOrganizationAuditLogListResponseType = "tenant.custom_role.updated"`

610 

611 - `const AdminOrganizationAuditLogListResponseTypeTenantCustomRoleDeleted AdminOrganizationAuditLogListResponseType = "tenant.custom_role.deleted"`

612 

613 - `const AdminOrganizationAuditLogListResponseTypeTenantRoleAssignmentCreated AdminOrganizationAuditLogListResponseType = "tenant.role_assignment.created"`

614 

615 - `const AdminOrganizationAuditLogListResponseTypeTenantRoleAssignmentDeleted AdminOrganizationAuditLogListResponseType = "tenant.role_assignment.deleted"`

616 

617 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceRoleAssignmentCreated AdminOrganizationAuditLogListResponseType = "tenant.resource_role_assignment.created"`

618 

619 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceRoleAssignmentDeleted AdminOrganizationAuditLogListResponseType = "tenant.resource_role_assignment.deleted"`

620 

621 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceAccessUpdated AdminOrganizationAuditLogListResponseType = "tenant.resource_access.updated"`

622 

623 - `const AdminOrganizationAuditLogListResponseTypeTenantResourceAccessDeleted AdminOrganizationAuditLogListResponseType = "tenant.resource_access.deleted"`

624 

625 - `const AdminOrganizationAuditLogListResponseTypeTenantSessionPolicyCreated AdminOrganizationAuditLogListResponseType = "tenant.session_policy.created"`

626 

627 - `const AdminOrganizationAuditLogListResponseTypeTenantSessionPolicyUpdated AdminOrganizationAuditLogListResponseType = "tenant.session_policy.updated"`

628 

629 - `const AdminOrganizationAuditLogListResponseTypeTenantSessionPolicyDeleted AdminOrganizationAuditLogListResponseType = "tenant.session_policy.deleted"`

630 

631 - `const AdminOrganizationAuditLogListResponseTypeTenantSessionRevocationStarted AdminOrganizationAuditLogListResponseType = "tenant.session_revocation.started"`

632 

633 - `const AdminOrganizationAuditLogListResponseTypeTenantThirdPartyAppPolicyUpdated AdminOrganizationAuditLogListResponseType = "tenant.third_party_app_policy.updated"`

634 

635 - `const AdminOrganizationAuditLogListResponseTypeTenantUserAdded AdminOrganizationAuditLogListResponseType = "tenant.user.added"`

636 

637 - `const AdminOrganizationAuditLogListResponseTypeTenantUserUpdated AdminOrganizationAuditLogListResponseType = "tenant.user.updated"`

638 

639 - `const AdminOrganizationAuditLogListResponseTypeTenantUserRemoved AdminOrganizationAuditLogListResponseType = "tenant.user.removed"`

640 

641 - `const AdminOrganizationAuditLogListResponseTypeTenantUserLookedUp AdminOrganizationAuditLogListResponseType = "tenant.user.looked_up"`

642 

643 - `const AdminOrganizationAuditLogListResponseTypeTenantUserInvited AdminOrganizationAuditLogListResponseType = "tenant.user.invited"`

644 

645 - `const AdminOrganizationAuditLogListResponseTypeTenantMembershipRevoked AdminOrganizationAuditLogListResponseType = "tenant.membership.revoked"`

646 

647 - `const AdminOrganizationAuditLogListResponseTypeTenantAPIOrganizationInviteUpserted AdminOrganizationAuditLogListResponseType = "tenant.api_organization_invite.upserted"`

648 

649 - `const AdminOrganizationAuditLogListResponseTypeTenantAPIOrganizationInviteDeleted AdminOrganizationAuditLogListResponseType = "tenant.api_organization_invite.deleted"`

650 

651 - `const AdminOrganizationAuditLogListResponseTypeTenantChatgptWorkspaceInviteUpserted AdminOrganizationAuditLogListResponseType = "tenant.chatgpt_workspace_invite.upserted"`

652 

653 - `const AdminOrganizationAuditLogListResponseTypeTenantMembershipAccepted AdminOrganizationAuditLogListResponseType = "tenant.membership.accepted"`

654 

655 - `const AdminOrganizationAuditLogListResponseTypeTenantMembershipDeclined AdminOrganizationAuditLogListResponseType = "tenant.membership.declined"`

656 

657 - `const AdminOrganizationAuditLogListResponseTypeTenantWorkspaceInviteEmailSettingsUpdated AdminOrganizationAuditLogListResponseType = "tenant.workspace_invite_email_settings.updated"`

658 

323 - `Actor AdminOrganizationAuditLogListResponseActor`659 - `Actor AdminOrganizationAuditLogListResponseActor`

324 660 

325 The actor who performed the audit logged action.661 The actor who performed the audit logged action.

Details

4 4 

5**post** `/organization/projects/{project_id}/service_accounts`5**post** `/organization/projects/{project_id}/service_accounts`

6 6 

7Creates a new service account in the project. This also returns an unredacted API key for the service account.7Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

8 8 

9### Parameters9### Parameters

10 10 


16 16 

17 The name of the service account being created.17 The name of the service account being created.

18 18 

19 - `CreateServiceAccountOnly param.Field[bool]`

20 

21 Create the service account without default roles or an API key.

22 

19### Returns23### Returns

20 24 

21- `type AdminOrganizationProjectServiceAccountNewResponse struct{…}`25- `type AdminOrganizationProjectServiceAccountNewResponse struct{…}`


46 50 

47 - `const OrganizationProjectServiceAccountOrganizationProjectServiceAccount OrganizationProjectServiceAccount = "organization.project.service_account"`51 - `const OrganizationProjectServiceAccountOrganizationProjectServiceAccount OrganizationProjectServiceAccount = "organization.project.service_account"`

48 52 

49 - `Role Member`53 - `Role AdminOrganizationProjectServiceAccountNewResponseRole`

54 

55 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

50 56 

51 Service accounts can only have one role of type `member`57 - `const AdminOrganizationProjectServiceAccountNewResponseRoleMember AdminOrganizationProjectServiceAccountNewResponseRole = "member"`

52 58 

53 - `const MemberMember Member = "member"`59 - `const AdminOrganizationProjectServiceAccountNewResponseRoleNone AdminOrganizationProjectServiceAccountNewResponseRole = "none"`

54 60 

55### Example61### Example

56 62 

Details

46 46 

47 - `Role ProjectServiceAccountRole`47 - `Role ProjectServiceAccountRole`

48 48 

49 `owner` or `member`49 `owner`, `member`, or `none`

50 50 

51 - `const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"`51 - `const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"`

52 52 

53 - `const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"`53 - `const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"`

54 54 

55 - `const ProjectServiceAccountRoleNone ProjectServiceAccountRole = "none"`

56 

55### Example57### Example

56 58 

57```go59```go

Details

38 38 

39 - `Role ProjectServiceAccountRole`39 - `Role ProjectServiceAccountRole`

40 40 

41 `owner` or `member`41 `owner`, `member`, or `none`

42 42 

43 - `const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"`43 - `const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"`

44 44 

45 - `const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"`45 - `const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"`

46 46 

47 - `const ProjectServiceAccountRoleNone ProjectServiceAccountRole = "none"`

48 

47### Example49### Example

48 50 

49```go51```go

Details

52 52 

53 - `Role ProjectServiceAccountRole`53 - `Role ProjectServiceAccountRole`

54 54 

55 `owner` or `member`55 `owner`, `member`, or `none`

56 56 

57 - `const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"`57 - `const ProjectServiceAccountRoleOwner ProjectServiceAccountRole = "owner"`

58 58 

59 - `const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"`59 - `const ProjectServiceAccountRoleMember ProjectServiceAccountRole = "member"`

60 60 

61 - `const ProjectServiceAccountRoleNone ProjectServiceAccountRole = "none"`

62 

61### Example63### Example

62 64 

63```go65```go

Details

1## Create project service account API key

2 

3`client.Admin.Organization.Projects.ServiceAccounts.APIKeys.New(ctx, projectID, serviceAccountID, body) (*AdminOrganizationProjectServiceAccountAPIKeyNewResponse, error)`

4 

5**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

6 

7Creates an API key for a service account in the project.

8 

9### Parameters

10 

11- `projectID string`

12 

13- `serviceAccountID string`

14 

15- `body AdminOrganizationProjectServiceAccountAPIKeyNewParams`

16 

17 - `Name param.Field[string]`

18 

19 API key name.

20 

21 - `Scopes param.Field[[]string]`

22 

23 API key scopes.

24 

25### Returns

26 

27- `type AdminOrganizationProjectServiceAccountAPIKeyNewResponse struct{…}`

28 

29 - `ID string`

30 

31 - `CreatedAt int64`

32 

33 - `Name string`

34 

35 - `Object OrganizationProjectServiceAccountAPIKey`

36 

37 The object type, which is always `organization.project.service_account.api_key`

38 

39 - `const OrganizationProjectServiceAccountAPIKeyOrganizationProjectServiceAccountAPIKey OrganizationProjectServiceAccountAPIKey = "organization.project.service_account.api_key"`

40 

41 - `Value string`

42 

43### Example

44 

45```go

46package main

47 

48import (

49 "context"

50 "fmt"

51 

52 "github.com/openai/openai-go"

53 "github.com/openai/openai-go/option"

54)

55 

56func main() {

57 client := openai.NewClient(

58 option.WithAdminAPIKey("My Admin API Key"),

59 )

60 apiKey, err := client.Admin.Organization.Projects.ServiceAccounts.APIKeys.New(

61 context.TODO(),

62 "project_id",

63 "service_account_id",

64 openai.AdminOrganizationProjectServiceAccountAPIKeyNewParams{

65 

66 },

67 )

68 if err != nil {

69 panic(err.Error())

70 }

71 fmt.Printf("%+v\n", apiKey.ID)

72}

73```

74 

75#### Response

76 

77```json

78{

79 "id": "id",

80 "created_at": 0,

81 "name": "name",

82 "object": "organization.project.service_account.api_key",

83 "value": "value"

84}

85```

Details

88 88 

89 - `InputTokens int64`89 - `InputTokens int64`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `NumModelRequests int64`93 - `NumModelRequests int64`

94 94 


100 100 

101 - `OutputTokens int64`101 - `OutputTokens int64`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `APIKeyID string`105 - `APIKeyID string`

106 106 


112 112 

113 - `InputAudioTokens int64`113 - `InputAudioTokens int64`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `InputCacheWriteTokens int64`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `InputCachedAudioTokens int64`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `InputCachedImageTokens int64`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `InputCachedTextTokens int64`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `InputCachedTokens int64`133 - `InputCachedTokens int64`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `InputImageTokens int64`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `InputTextTokens int64`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `InputUncachedTokens int64`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Model string`149 - `Model string`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `OutputImageTokens int64`

158 

159 The aggregated number of image output tokens used.

160 

161 - `OutputTextTokens int64`

162 

163 The aggregated number of text output tokens used.

164 

129 - `ProjectID string`165 - `ProjectID string`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


492 "api_key_id": "api_key_id",528 "api_key_id": "api_key_id",

493 "batch": true,529 "batch": true,

494 "input_audio_tokens": 0,530 "input_audio_tokens": 0,

531 "input_cache_write_tokens": 0,

532 "input_cached_audio_tokens": 0,

533 "input_cached_image_tokens": 0,

534 "input_cached_text_tokens": 0,

495 "input_cached_tokens": 0,535 "input_cached_tokens": 0,

536 "input_image_tokens": 0,

537 "input_text_tokens": 0,

538 "input_uncached_tokens": 0,

496 "model": "model",539 "model": "model",

497 "output_audio_tokens": 0,540 "output_audio_tokens": 0,

541 "output_image_tokens": 0,

542 "output_text_tokens": 0,

498 "project_id": "project_id",543 "project_id": "project_id",

499 "service_tier": "service_tier",544 "service_tier": "service_tier",

500 "user_id": "user_id"545 "user_id": "user_id"

Details

88 88 

89 - `InputTokens int64`89 - `InputTokens int64`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `NumModelRequests int64`93 - `NumModelRequests int64`

94 94 


100 100 

101 - `OutputTokens int64`101 - `OutputTokens int64`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `APIKeyID string`105 - `APIKeyID string`

106 106 


112 112 

113 - `InputAudioTokens int64`113 - `InputAudioTokens int64`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `InputCacheWriteTokens int64`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `InputCachedAudioTokens int64`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `InputCachedImageTokens int64`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `InputCachedTextTokens int64`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `InputCachedTokens int64`133 - `InputCachedTokens int64`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `InputImageTokens int64`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `InputTextTokens int64`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `InputUncachedTokens int64`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Model string`149 - `Model string`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `OutputImageTokens int64`

158 

159 The aggregated number of image output tokens used.

160 

161 - `OutputTextTokens int64`

162 

163 The aggregated number of text output tokens used.

164 

129 - `ProjectID string`165 - `ProjectID string`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


492 "api_key_id": "api_key_id",528 "api_key_id": "api_key_id",

493 "batch": true,529 "batch": true,

494 "input_audio_tokens": 0,530 "input_audio_tokens": 0,

531 "input_cache_write_tokens": 0,

532 "input_cached_audio_tokens": 0,

533 "input_cached_image_tokens": 0,

534 "input_cached_text_tokens": 0,

495 "input_cached_tokens": 0,535 "input_cached_tokens": 0,

536 "input_image_tokens": 0,

537 "input_text_tokens": 0,

538 "input_uncached_tokens": 0,

496 "model": "model",539 "model": "model",

497 "output_audio_tokens": 0,540 "output_audio_tokens": 0,

541 "output_image_tokens": 0,

542 "output_text_tokens": 0,

498 "project_id": "project_id",543 "project_id": "project_id",

499 "service_tier": "service_tier",544 "service_tier": "service_tier",

500 "user_id": "user_id"545 "user_id": "user_id"

Details

70 70 

71 - `InputTokens int64`71 - `InputTokens int64`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `NumModelRequests int64`75 - `NumModelRequests int64`

76 76 


82 82 

83 - `OutputTokens int64`83 - `OutputTokens int64`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `APIKeyID string`87 - `APIKeyID string`

88 88 


94 94 

95 - `InputAudioTokens int64`95 - `InputAudioTokens int64`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `InputCacheWriteTokens int64`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `InputCachedAudioTokens int64`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `InputCachedImageTokens int64`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `InputCachedTextTokens int64`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `InputCachedTokens int64`115 - `InputCachedTokens int64`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `InputImageTokens int64`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `InputTextTokens int64`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `InputUncachedTokens int64`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `Model string`131 - `Model string`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `OutputImageTokens int64`

140 

141 The aggregated number of image output tokens used.

142 

143 - `OutputTextTokens int64`

144 

145 The aggregated number of text output tokens used.

146 

111 - `ProjectID string`147 - `ProjectID string`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


474 "api_key_id": "api_key_id",510 "api_key_id": "api_key_id",

475 "batch": true,511 "batch": true,

476 "input_audio_tokens": 0,512 "input_audio_tokens": 0,

513 "input_cache_write_tokens": 0,

514 "input_cached_audio_tokens": 0,

515 "input_cached_image_tokens": 0,

516 "input_cached_text_tokens": 0,

477 "input_cached_tokens": 0,517 "input_cached_tokens": 0,

518 "input_image_tokens": 0,

519 "input_text_tokens": 0,

520 "input_uncached_tokens": 0,

478 "model": "model",521 "model": "model",

479 "output_audio_tokens": 0,522 "output_audio_tokens": 0,

523 "output_image_tokens": 0,

524 "output_text_tokens": 0,

480 "project_id": "project_id",525 "project_id": "project_id",

481 "service_tier": "service_tier",526 "service_tier": "service_tier",

482 "user_id": "user_id"527 "user_id": "user_id"

Details

96 96 

97 - `InputTokens int64`97 - `InputTokens int64`

98 98 

99 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.99 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

100 100 

101 - `NumModelRequests int64`101 - `NumModelRequests int64`

102 102 


108 108 

109 - `OutputTokens int64`109 - `OutputTokens int64`

110 110 

111 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.111 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

112 112 

113 - `APIKeyID string`113 - `APIKeyID string`

114 114 


120 120 

121 - `InputAudioTokens int64`121 - `InputAudioTokens int64`

122 122 

123 The aggregated number of audio input tokens used, including cached tokens.123 The aggregated number of uncached audio input tokens used.

124 

125 - `InputCacheWriteTokens int64`

126 

127 The aggregated number of input tokens written to the cache.

128 

129 - `InputCachedAudioTokens int64`

130 

131 The aggregated number of cached audio input tokens used.

132 

133 - `InputCachedImageTokens int64`

134 

135 The aggregated number of cached image input tokens used.

136 

137 - `InputCachedTextTokens int64`

138 

139 The aggregated number of cached text input tokens used.

124 140 

125 - `InputCachedTokens int64`141 - `InputCachedTokens int64`

126 142 

127 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.143 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

144 

145 - `InputImageTokens int64`

146 

147 The aggregated number of uncached image input tokens used.

148 

149 - `InputTextTokens int64`

150 

151 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

152 

153 - `InputUncachedTokens int64`

154 

155 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

128 156 

129 - `Model string`157 - `Model string`

130 158 


134 162 

135 The aggregated number of audio output tokens used.163 The aggregated number of audio output tokens used.

136 164 

165 - `OutputImageTokens int64`

166 

167 The aggregated number of image output tokens used.

168 

169 - `OutputTextTokens int64`

170 

171 The aggregated number of text output tokens used.

172 

137 - `ProjectID string`173 - `ProjectID string`

138 174 

139 When `group_by=project_id`, this field provides the project ID of the grouped usage result.175 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


500 "api_key_id": "api_key_id",536 "api_key_id": "api_key_id",

501 "batch": true,537 "batch": true,

502 "input_audio_tokens": 0,538 "input_audio_tokens": 0,

539 "input_cache_write_tokens": 0,

540 "input_cached_audio_tokens": 0,

541 "input_cached_image_tokens": 0,

542 "input_cached_text_tokens": 0,

503 "input_cached_tokens": 0,543 "input_cached_tokens": 0,

544 "input_image_tokens": 0,

545 "input_text_tokens": 0,

546 "input_uncached_tokens": 0,

504 "model": "model",547 "model": "model",

505 "output_audio_tokens": 0,548 "output_audio_tokens": 0,

549 "output_image_tokens": 0,

550 "output_text_tokens": 0,

506 "project_id": "project_id",551 "project_id": "project_id",

507 "service_tier": "service_tier",552 "service_tier": "service_tier",

508 "user_id": "user_id"553 "user_id": "user_id"

Details

70 70 

71 - `InputTokens int64`71 - `InputTokens int64`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `NumModelRequests int64`75 - `NumModelRequests int64`

76 76 


82 82 

83 - `OutputTokens int64`83 - `OutputTokens int64`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `APIKeyID string`87 - `APIKeyID string`

88 88 


94 94 

95 - `InputAudioTokens int64`95 - `InputAudioTokens int64`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `InputCacheWriteTokens int64`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `InputCachedAudioTokens int64`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `InputCachedImageTokens int64`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `InputCachedTextTokens int64`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `InputCachedTokens int64`115 - `InputCachedTokens int64`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `InputImageTokens int64`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `InputTextTokens int64`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `InputUncachedTokens int64`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `Model string`131 - `Model string`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `OutputImageTokens int64`

140 

141 The aggregated number of image output tokens used.

142 

143 - `OutputTextTokens int64`

144 

145 The aggregated number of text output tokens used.

146 

111 - `ProjectID string`147 - `ProjectID string`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


474 "api_key_id": "api_key_id",510 "api_key_id": "api_key_id",

475 "batch": true,511 "batch": true,

476 "input_audio_tokens": 0,512 "input_audio_tokens": 0,

513 "input_cache_write_tokens": 0,

514 "input_cached_audio_tokens": 0,

515 "input_cached_image_tokens": 0,

516 "input_cached_text_tokens": 0,

477 "input_cached_tokens": 0,517 "input_cached_tokens": 0,

518 "input_image_tokens": 0,

519 "input_text_tokens": 0,

520 "input_uncached_tokens": 0,

478 "model": "model",521 "model": "model",

479 "output_audio_tokens": 0,522 "output_audio_tokens": 0,

523 "output_image_tokens": 0,

524 "output_text_tokens": 0,

480 "project_id": "project_id",525 "project_id": "project_id",

481 "service_tier": "service_tier",526 "service_tier": "service_tier",

482 "user_id": "user_id"527 "user_id": "user_id"

Details

88 88 

89 - `InputTokens int64`89 - `InputTokens int64`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `NumModelRequests int64`93 - `NumModelRequests int64`

94 94 


100 100 

101 - `OutputTokens int64`101 - `OutputTokens int64`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `APIKeyID string`105 - `APIKeyID string`

106 106 


112 112 

113 - `InputAudioTokens int64`113 - `InputAudioTokens int64`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `InputCacheWriteTokens int64`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `InputCachedAudioTokens int64`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `InputCachedImageTokens int64`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `InputCachedTextTokens int64`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `InputCachedTokens int64`133 - `InputCachedTokens int64`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `InputImageTokens int64`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `InputTextTokens int64`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `InputUncachedTokens int64`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Model string`149 - `Model string`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `OutputImageTokens int64`

158 

159 The aggregated number of image output tokens used.

160 

161 - `OutputTextTokens int64`

162 

163 The aggregated number of text output tokens used.

164 

129 - `ProjectID string`165 - `ProjectID string`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


492 "api_key_id": "api_key_id",528 "api_key_id": "api_key_id",

493 "batch": true,529 "batch": true,

494 "input_audio_tokens": 0,530 "input_audio_tokens": 0,

531 "input_cache_write_tokens": 0,

532 "input_cached_audio_tokens": 0,

533 "input_cached_image_tokens": 0,

534 "input_cached_text_tokens": 0,

495 "input_cached_tokens": 0,535 "input_cached_tokens": 0,

536 "input_image_tokens": 0,

537 "input_text_tokens": 0,

538 "input_uncached_tokens": 0,

496 "model": "model",539 "model": "model",

497 "output_audio_tokens": 0,540 "output_audio_tokens": 0,

541 "output_image_tokens": 0,

542 "output_text_tokens": 0,

498 "project_id": "project_id",543 "project_id": "project_id",

499 "service_tier": "service_tier",544 "service_tier": "service_tier",

500 "user_id": "user_id"545 "user_id": "user_id"

Details

88 88 

89 - `InputTokens int64`89 - `InputTokens int64`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `NumModelRequests int64`93 - `NumModelRequests int64`

94 94 


100 100 

101 - `OutputTokens int64`101 - `OutputTokens int64`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `APIKeyID string`105 - `APIKeyID string`

106 106 


112 112 

113 - `InputAudioTokens int64`113 - `InputAudioTokens int64`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `InputCacheWriteTokens int64`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `InputCachedAudioTokens int64`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `InputCachedImageTokens int64`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `InputCachedTextTokens int64`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `InputCachedTokens int64`133 - `InputCachedTokens int64`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `InputImageTokens int64`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `InputTextTokens int64`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `InputUncachedTokens int64`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Model string`149 - `Model string`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `OutputImageTokens int64`

158 

159 The aggregated number of image output tokens used.

160 

161 - `OutputTextTokens int64`

162 

163 The aggregated number of text output tokens used.

164 

129 - `ProjectID string`165 - `ProjectID string`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


492 "api_key_id": "api_key_id",528 "api_key_id": "api_key_id",

493 "batch": true,529 "batch": true,

494 "input_audio_tokens": 0,530 "input_audio_tokens": 0,

531 "input_cache_write_tokens": 0,

532 "input_cached_audio_tokens": 0,

533 "input_cached_image_tokens": 0,

534 "input_cached_text_tokens": 0,

495 "input_cached_tokens": 0,535 "input_cached_tokens": 0,

536 "input_image_tokens": 0,

537 "input_text_tokens": 0,

538 "input_uncached_tokens": 0,

496 "model": "model",539 "model": "model",

497 "output_audio_tokens": 0,540 "output_audio_tokens": 0,

541 "output_image_tokens": 0,

542 "output_text_tokens": 0,

498 "project_id": "project_id",543 "project_id": "project_id",

499 "service_tier": "service_tier",544 "service_tier": "service_tier",

500 "user_id": "user_id"545 "user_id": "user_id"

Details

116 116 

117 - `InputTokens int64`117 - `InputTokens int64`

118 118 

119 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.119 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

120 120 

121 - `NumModelRequests int64`121 - `NumModelRequests int64`

122 122 


128 128 

129 - `OutputTokens int64`129 - `OutputTokens int64`

130 130 

131 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.131 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

132 132 

133 - `APIKeyID string`133 - `APIKeyID string`

134 134 


140 140 

141 - `InputAudioTokens int64`141 - `InputAudioTokens int64`

142 142 

143 The aggregated number of audio input tokens used, including cached tokens.143 The aggregated number of uncached audio input tokens used.

144 

145 - `InputCacheWriteTokens int64`

146 

147 The aggregated number of input tokens written to the cache.

148 

149 - `InputCachedAudioTokens int64`

150 

151 The aggregated number of cached audio input tokens used.

152 

153 - `InputCachedImageTokens int64`

154 

155 The aggregated number of cached image input tokens used.

156 

157 - `InputCachedTextTokens int64`

158 

159 The aggregated number of cached text input tokens used.

144 160 

145 - `InputCachedTokens int64`161 - `InputCachedTokens int64`

146 162 

147 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.163 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

164 

165 - `InputImageTokens int64`

166 

167 The aggregated number of uncached image input tokens used.

168 

169 - `InputTextTokens int64`

170 

171 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

172 

173 - `InputUncachedTokens int64`

174 

175 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

148 176 

149 - `Model string`177 - `Model string`

150 178 


154 182 

155 The aggregated number of audio output tokens used.183 The aggregated number of audio output tokens used.

156 184 

185 - `OutputImageTokens int64`

186 

187 The aggregated number of image output tokens used.

188 

189 - `OutputTextTokens int64`

190 

191 The aggregated number of text output tokens used.

192 

157 - `ProjectID string`193 - `ProjectID string`

158 194 

159 When `group_by=project_id`, this field provides the project ID of the grouped usage result.195 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


520 "api_key_id": "api_key_id",556 "api_key_id": "api_key_id",

521 "batch": true,557 "batch": true,

522 "input_audio_tokens": 0,558 "input_audio_tokens": 0,

559 "input_cache_write_tokens": 0,

560 "input_cached_audio_tokens": 0,

561 "input_cached_image_tokens": 0,

562 "input_cached_text_tokens": 0,

523 "input_cached_tokens": 0,563 "input_cached_tokens": 0,

564 "input_image_tokens": 0,

565 "input_text_tokens": 0,

566 "input_uncached_tokens": 0,

524 "model": "model",567 "model": "model",

525 "output_audio_tokens": 0,568 "output_audio_tokens": 0,

569 "output_image_tokens": 0,

570 "output_text_tokens": 0,

526 "project_id": "project_id",571 "project_id": "project_id",

527 "service_tier": "service_tier",572 "service_tier": "service_tier",

528 "user_id": "user_id"573 "user_id": "user_id"

Details

88 88 

89 - `InputTokens int64`89 - `InputTokens int64`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `NumModelRequests int64`93 - `NumModelRequests int64`

94 94 


100 100 

101 - `OutputTokens int64`101 - `OutputTokens int64`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `APIKeyID string`105 - `APIKeyID string`

106 106 


112 112 

113 - `InputAudioTokens int64`113 - `InputAudioTokens int64`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `InputCacheWriteTokens int64`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `InputCachedAudioTokens int64`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `InputCachedImageTokens int64`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `InputCachedTextTokens int64`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `InputCachedTokens int64`133 - `InputCachedTokens int64`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `InputImageTokens int64`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `InputTextTokens int64`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `InputUncachedTokens int64`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Model string`149 - `Model string`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `OutputImageTokens int64`

158 

159 The aggregated number of image output tokens used.

160 

161 - `OutputTextTokens int64`

162 

163 The aggregated number of text output tokens used.

164 

129 - `ProjectID string`165 - `ProjectID string`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


492 "api_key_id": "api_key_id",528 "api_key_id": "api_key_id",

493 "batch": true,529 "batch": true,

494 "input_audio_tokens": 0,530 "input_audio_tokens": 0,

531 "input_cache_write_tokens": 0,

532 "input_cached_audio_tokens": 0,

533 "input_cached_image_tokens": 0,

534 "input_cached_text_tokens": 0,

495 "input_cached_tokens": 0,535 "input_cached_tokens": 0,

536 "input_image_tokens": 0,

537 "input_text_tokens": 0,

538 "input_uncached_tokens": 0,

496 "model": "model",539 "model": "model",

497 "output_audio_tokens": 0,540 "output_audio_tokens": 0,

541 "output_image_tokens": 0,

542 "output_text_tokens": 0,

498 "project_id": "project_id",543 "project_id": "project_id",

499 "service_tier": "service_tier",544 "service_tier": "service_tier",

500 "user_id": "user_id"545 "user_id": "user_id"

Details

70 70 

71 - `InputTokens int64`71 - `InputTokens int64`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `NumModelRequests int64`75 - `NumModelRequests int64`

76 76 


82 82 

83 - `OutputTokens int64`83 - `OutputTokens int64`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `APIKeyID string`87 - `APIKeyID string`

88 88 


94 94 

95 - `InputAudioTokens int64`95 - `InputAudioTokens int64`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `InputCacheWriteTokens int64`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `InputCachedAudioTokens int64`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `InputCachedImageTokens int64`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `InputCachedTextTokens int64`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `InputCachedTokens int64`115 - `InputCachedTokens int64`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `InputImageTokens int64`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `InputTextTokens int64`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `InputUncachedTokens int64`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `Model string`131 - `Model string`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `OutputImageTokens int64`

140 

141 The aggregated number of image output tokens used.

142 

143 - `OutputTextTokens int64`

144 

145 The aggregated number of text output tokens used.

146 

111 - `ProjectID string`147 - `ProjectID string`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


474 "api_key_id": "api_key_id",510 "api_key_id": "api_key_id",

475 "batch": true,511 "batch": true,

476 "input_audio_tokens": 0,512 "input_audio_tokens": 0,

513 "input_cache_write_tokens": 0,

514 "input_cached_audio_tokens": 0,

515 "input_cached_image_tokens": 0,

516 "input_cached_text_tokens": 0,

477 "input_cached_tokens": 0,517 "input_cached_tokens": 0,

518 "input_image_tokens": 0,

519 "input_text_tokens": 0,

520 "input_uncached_tokens": 0,

478 "model": "model",521 "model": "model",

479 "output_audio_tokens": 0,522 "output_audio_tokens": 0,

523 "output_image_tokens": 0,

524 "output_text_tokens": 0,

480 "project_id": "project_id",525 "project_id": "project_id",

481 "service_tier": "service_tier",526 "service_tier": "service_tier",

482 "user_id": "user_id"527 "user_id": "user_id"

Details

100 100 

101 - `InputTokens int64`101 - `InputTokens int64`

102 102 

103 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `NumModelRequests int64`105 - `NumModelRequests int64`

106 106 


112 112 

113 - `OutputTokens int64`113 - `OutputTokens int64`

114 114 

115 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 116 

117 - `APIKeyID string`117 - `APIKeyID string`

118 118 


124 124 

125 - `InputAudioTokens int64`125 - `InputAudioTokens int64`

126 126 

127 The aggregated number of audio input tokens used, including cached tokens.127 The aggregated number of uncached audio input tokens used.

128 

129 - `InputCacheWriteTokens int64`

130 

131 The aggregated number of input tokens written to the cache.

132 

133 - `InputCachedAudioTokens int64`

134 

135 The aggregated number of cached audio input tokens used.

136 

137 - `InputCachedImageTokens int64`

138 

139 The aggregated number of cached image input tokens used.

140 

141 - `InputCachedTextTokens int64`

142 

143 The aggregated number of cached text input tokens used.

128 144 

129 - `InputCachedTokens int64`145 - `InputCachedTokens int64`

130 146 

131 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.147 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

148 

149 - `InputImageTokens int64`

150 

151 The aggregated number of uncached image input tokens used.

152 

153 - `InputTextTokens int64`

154 

155 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

156 

157 - `InputUncachedTokens int64`

158 

159 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

132 160 

133 - `Model string`161 - `Model string`

134 162 


138 166 

139 The aggregated number of audio output tokens used.167 The aggregated number of audio output tokens used.

140 168 

169 - `OutputImageTokens int64`

170 

171 The aggregated number of image output tokens used.

172 

173 - `OutputTextTokens int64`

174 

175 The aggregated number of text output tokens used.

176 

141 - `ProjectID string`177 - `ProjectID string`

142 178 

143 When `group_by=project_id`, this field provides the project ID of the grouped usage result.179 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


504 "api_key_id": "api_key_id",540 "api_key_id": "api_key_id",

505 "batch": true,541 "batch": true,

506 "input_audio_tokens": 0,542 "input_audio_tokens": 0,

543 "input_cache_write_tokens": 0,

544 "input_cached_audio_tokens": 0,

545 "input_cached_image_tokens": 0,

546 "input_cached_text_tokens": 0,

507 "input_cached_tokens": 0,547 "input_cached_tokens": 0,

548 "input_image_tokens": 0,

549 "input_text_tokens": 0,

550 "input_uncached_tokens": 0,

508 "model": "model",551 "model": "model",

509 "output_audio_tokens": 0,552 "output_audio_tokens": 0,

553 "output_image_tokens": 0,

554 "output_text_tokens": 0,

510 "project_id": "project_id",555 "project_id": "project_id",

511 "service_tier": "service_tier",556 "service_tier": "service_tier",

512 "user_id": "user_id"557 "user_id": "user_id"

Details

1438 1438 

1439 - `const OutputTextOutputText OutputText = "output_text"`1439 - `const OutputTextOutputText OutputText = "output_text"`

1440 1440 

1441 - `Annotations BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsUnion`1441 - `Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnion`

1442 1442 

1443 Citations associated with the text content.1443 Citations associated with the text content.

1444 1444 

1445 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArrayItem`1445 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}`

1446 1446 

1447 - `FileID string`1447 - `FileID string`

1448 1448 


1462 1462 

1463 - `const FileCitationFileCitation FileCitation = "file_citation"`1463 - `const FileCitationFileCitation FileCitation = "file_citation"`

1464 1464 

1465 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2Item`1465 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}`

1466 1466 

1467 - `EndIndex int64`1467 - `EndIndex int64`

1468 1468 


1486 1486 

1487 The URL of the cited resource.1487 The URL of the cited resource.

1488 1488 

1489 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3Item`1489 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}`

1490 1490 

1491 - `ContainerID string`1491 - `ContainerID string`

1492 1492 


2859 2859 

2860 - `EncryptedContent string`2860 - `EncryptedContent string`

2861 2861 

2862 The encrypted content of the reasoning item - populated when a response is2862 The encrypted content of the reasoning item. This is populated by default

2863 generated with `reasoning.encrypted_content` in the `include` parameter.2863 for reasoning items returned by `POST /v1/responses` and WebSocket

2864 `response.create` requests.

2864 2865 

2865 - `Status BetaResponseReasoningItemStatus`2866 - `Status BetaResponseReasoningItemStatus`

2866 2867 

Details

1551 1551 

1552 - `const OutputTextOutputText OutputText = "output_text"`1552 - `const OutputTextOutputText OutputText = "output_text"`

1553 1553 

1554 - `Annotations BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsUnion`1554 - `Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnion`

1555 1555 

1556 Citations associated with the text content.1556 Citations associated with the text content.

1557 1557 

1558 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArrayItem`1558 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}`

1559 1559 

1560 - `FileID string`1560 - `FileID string`

1561 1561 


1575 1575 

1576 - `const FileCitationFileCitation FileCitation = "file_citation"`1576 - `const FileCitationFileCitation FileCitation = "file_citation"`

1577 1577 

1578 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2Item`1578 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}`

1579 1579 

1580 - `EndIndex int64`1580 - `EndIndex int64`

1581 1581 


1599 1599 

1600 The URL of the cited resource.1600 The URL of the cited resource.

1601 1601 

1602 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3Item`1602 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}`

1603 1603 

1604 - `ContainerID string`1604 - `ContainerID string`

1605 1605 


2972 2972 

2973 - `EncryptedContent string`2973 - `EncryptedContent string`

2974 2974 

2975 The encrypted content of the reasoning item - populated when a response is2975 The encrypted content of the reasoning item. This is populated by default

2976 generated with `reasoning.encrypted_content` in the `include` parameter.2976 for reasoning items returned by `POST /v1/responses` and WebSocket

2977 `response.create` requests.

2977 2978 

2978 - `Status BetaResponseReasoningItemStatus`2979 - `Status BetaResponseReasoningItemStatus`

2979 2980 


5387 5388 

5388 - `EncryptedContent string`5389 - `EncryptedContent string`

5389 5390 

5390 The encrypted content of the reasoning item - populated when a response is5391 The encrypted content of the reasoning item. This is populated by default

5391 generated with `reasoning.encrypted_content` in the `include` parameter.5392 for reasoning items returned by `POST /v1/responses` and WebSocket

5393 `response.create` requests.

5392 5394 

5393 - `Status BetaResponseReasoningItemStatus`5395 - `Status BetaResponseReasoningItemStatus`

5394 5396 

Details

1424 1424 

1425 - `const OutputTextOutputText OutputText = "output_text"`1425 - `const OutputTextOutputText OutputText = "output_text"`

1426 1426 

1427 - `Annotations BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsUnion`1427 - `Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnion`

1428 1428 

1429 Citations associated with the text content.1429 Citations associated with the text content.

1430 1430 

1431 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArrayItem`1431 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}`

1432 1432 

1433 - `FileID string`1433 - `FileID string`

1434 1434 


1448 1448 

1449 - `const FileCitationFileCitation FileCitation = "file_citation"`1449 - `const FileCitationFileCitation FileCitation = "file_citation"`

1450 1450 

1451 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2Item`1451 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}`

1452 1452 

1453 - `EndIndex int64`1453 - `EndIndex int64`

1454 1454 


1472 1472 

1473 The URL of the cited resource.1473 The URL of the cited resource.

1474 1474 

1475 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3Item`1475 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}`

1476 1476 

1477 - `ContainerID string`1477 - `ContainerID string`

1478 1478 


2845 2845 

2846 - `EncryptedContent string`2846 - `EncryptedContent string`

2847 2847 

2848 The encrypted content of the reasoning item - populated when a response is2848 The encrypted content of the reasoning item. This is populated by default

2849 generated with `reasoning.encrypted_content` in the `include` parameter.2849 for reasoning items returned by `POST /v1/responses` and WebSocket

2850 `response.create` requests.

2850 2851 

2851 - `Status BetaResponseReasoningItemStatus`2852 - `Status BetaResponseReasoningItemStatus`

2852 2853 


6068 6069 

6069 - `const OutputTextOutputText OutputText = "output_text"`6070 - `const OutputTextOutputText OutputText = "output_text"`

6070 6071 

6071 - `Annotations BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsUnion`6072 - `Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnion`

6072 6073 

6073 Citations associated with the text content.6074 Citations associated with the text content.

6074 6075 

6075 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArrayItem`6076 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}`

6076 6077 

6077 - `FileID string`6078 - `FileID string`

6078 6079 


6092 6093 

6093 - `const FileCitationFileCitation FileCitation = "file_citation"`6094 - `const FileCitationFileCitation FileCitation = "file_citation"`

6094 6095 

6095 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2Item`6096 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}`

6096 6097 

6097 - `EndIndex int64`6098 - `EndIndex int64`

6098 6099 


6116 6117 

6117 The URL of the cited resource.6118 The URL of the cited resource.

6118 6119 

6119 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3Item`6120 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}`

6120 6121 

6121 - `ContainerID string`6122 - `ContainerID string`

6122 6123 


7489 7490 

7490 - `EncryptedContent string`7491 - `EncryptedContent string`

7491 7492 

7492 The encrypted content of the reasoning item - populated when a response is7493 The encrypted content of the reasoning item. This is populated by default

7493 generated with `reasoning.encrypted_content` in the `include` parameter.7494 for reasoning items returned by `POST /v1/responses` and WebSocket

7495 `response.create` requests.

7494 7496 

7495 - `Status BetaResponseReasoningItemStatus`7497 - `Status BetaResponseReasoningItemStatus`

7496 7498 

Details

1473 1473 

1474 - `const OutputTextOutputText OutputText = "output_text"`1474 - `const OutputTextOutputText OutputText = "output_text"`

1475 1475 

1476 - `Annotations BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsUnion`1476 - `Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnion`

1477 1477 

1478 Citations associated with the text content.1478 Citations associated with the text content.

1479 1479 

1480 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArrayItem`1480 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}`

1481 1481 

1482 - `FileID string`1482 - `FileID string`

1483 1483 


1497 1497 

1498 - `const FileCitationFileCitation FileCitation = "file_citation"`1498 - `const FileCitationFileCitation FileCitation = "file_citation"`

1499 1499 

1500 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2Item`1500 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}`

1501 1501 

1502 - `EndIndex int64`1502 - `EndIndex int64`

1503 1503 


1521 1521 

1522 The URL of the cited resource.1522 The URL of the cited resource.

1523 1523 

1524 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3Item`1524 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}`

1525 1525 

1526 - `ContainerID string`1526 - `ContainerID string`

1527 1527 


2894 2894 

2895 - `EncryptedContent string`2895 - `EncryptedContent string`

2896 2896 

2897 The encrypted content of the reasoning item - populated when a response is2897 The encrypted content of the reasoning item. This is populated by default

2898 generated with `reasoning.encrypted_content` in the `include` parameter.2898 for reasoning items returned by `POST /v1/responses` and WebSocket

2899 `response.create` requests.

2899 2900 

2900 - `Status BetaResponseReasoningItemStatus`2901 - `Status BetaResponseReasoningItemStatus`

2901 2902 

Details

2670 2670 

2671 - `EncryptedContent string`2671 - `EncryptedContent string`

2672 2672 

2673 The encrypted content of the reasoning item - populated when a response is2673 The encrypted content of the reasoning item. This is populated by default

2674 generated with `reasoning.encrypted_content` in the `include` parameter.2674 for reasoning items returned by `POST /v1/responses` and WebSocket

2675 `response.create` requests.

2675 2676 

2676 - `Status BetaResponseReasoningItemStatus`2677 - `Status BetaResponseReasoningItemStatus`

2677 2678 

Details

1366 1366 

1367 - `const OutputTextOutputText OutputText = "output_text"`1367 - `const OutputTextOutputText OutputText = "output_text"`

1368 1368 

1369 - `Annotations BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsUnion`1369 - `Annotations []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationUnion`

1370 1370 

1371 Citations associated with the text content.1371 Citations associated with the text content.

1372 1372 

1373 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArrayItem`1373 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationFileCitation struct{…}`

1374 1374 

1375 - `FileID string`1375 - `FileID string`

1376 1376 


1390 1390 

1391 - `const FileCitationFileCitation FileCitation = "file_citation"`1391 - `const FileCitationFileCitation FileCitation = "file_citation"`

1392 1392 

1393 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray2Item`1393 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationURLCitation struct{…}`

1394 1394 

1395 - `EndIndex int64`1395 - `EndIndex int64`

1396 1396 


1414 1414 

1415 The URL of the cited resource.1415 The URL of the cited resource.

1416 1416 

1417 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3 []BetaResponseInputItemMultiAgentCallOutputOutputAnnotationsArray3Item`1417 - `type BetaResponseInputItemMultiAgentCallOutputOutputAnnotationContainerFileCitation struct{…}`

1418 1418 

1419 - `ContainerID string`1419 - `ContainerID string`

1420 1420 


2787 2787 

2788 - `EncryptedContent string`2788 - `EncryptedContent string`

2789 2789 

2790 The encrypted content of the reasoning item - populated when a response is2790 The encrypted content of the reasoning item. This is populated by default

2791 generated with `reasoning.encrypted_content` in the `include` parameter.2791 for reasoning items returned by `POST /v1/responses` and WebSocket

2792 `response.create` requests.

2792 2793 

2793 - `Status BetaResponseReasoningItemStatus`2794 - `Status BetaResponseReasoningItemStatus`

2794 2795 

Details

2544 2544 

2545 - `EncryptedContent string`2545 - `EncryptedContent string`

2546 2546 

2547 The encrypted content of the reasoning item - populated when a response is2547 The encrypted content of the reasoning item. This is populated by default

2548 generated with `reasoning.encrypted_content` in the `include` parameter.2548 for reasoning items returned by `POST /v1/responses` and WebSocket

2549 `response.create` requests.

2549 2550 

2550 - `Status ResponseReasoningItemStatus`2551 - `Status ResponseReasoningItemStatus`

2551 2552 

Details

2546 2546 

2547 - `EncryptedContent string`2547 - `EncryptedContent string`

2548 2548 

2549 The encrypted content of the reasoning item - populated when a response is2549 The encrypted content of the reasoning item. This is populated by default

2550 generated with `reasoning.encrypted_content` in the `include` parameter.2550 for reasoning items returned by `POST /v1/responses` and WebSocket

2551 `response.create` requests.

2551 2552 

2552 - `Status ResponseReasoningItemStatus`2553 - `Status ResponseReasoningItemStatus`

2553 2554 


5920 5921 

5921 - `EncryptedContent string`5922 - `EncryptedContent string`

5922 5923 

5923 The encrypted content of the reasoning item - populated when a response is5924 The encrypted content of the reasoning item. This is populated by default

5924 generated with `reasoning.encrypted_content` in the `include` parameter.5925 for reasoning items returned by `POST /v1/responses` and WebSocket

5926 `response.create` requests.

5925 5927 

5926 - `Status ResponseReasoningItemStatus`5928 - `Status ResponseReasoningItemStatus`

5927 5929 

Details

2524 2524 

2525 - `EncryptedContent string`2525 - `EncryptedContent string`

2526 2526 

2527 The encrypted content of the reasoning item - populated when a response is2527 The encrypted content of the reasoning item. This is populated by default

2528 generated with `reasoning.encrypted_content` in the `include` parameter.2528 for reasoning items returned by `POST /v1/responses` and WebSocket

2529 `response.create` requests.

2529 2530 

2530 - `Status ResponseReasoningItemStatus`2531 - `Status ResponseReasoningItemStatus`

2531 2532 

Details

2499 2499 

2500 - `EncryptedContent string`2500 - `EncryptedContent string`

2501 2501 

2502 The encrypted content of the reasoning item - populated when a response is2502 The encrypted content of the reasoning item. This is populated by default

2503 generated with `reasoning.encrypted_content` in the `include` parameter.2503 for reasoning items returned by `POST /v1/responses` and WebSocket

2504 `response.create` requests.

2504 2505 

2505 - `Status ResponseReasoningItemStatus`2506 - `Status ResponseReasoningItemStatus`

2506 2507 

Details

2631 2631 

2632 - `EncryptedContent string`2632 - `EncryptedContent string`

2633 2633 

2634 The encrypted content of the reasoning item - populated when a response is2634 The encrypted content of the reasoning item. This is populated by default

2635 generated with `reasoning.encrypted_content` in the `include` parameter.2635 for reasoning items returned by `POST /v1/responses` and WebSocket

2636 `response.create` requests.

2636 2637 

2637 - `Status ResponseReasoningItemStatus`2638 - `Status ResponseReasoningItemStatus`

2638 2639 

Details

2752 2752 

2753 - `EncryptedContent string`2753 - `EncryptedContent string`

2754 2754 

2755 The encrypted content of the reasoning item - populated when a response is2755 The encrypted content of the reasoning item. This is populated by default

2756 generated with `reasoning.encrypted_content` in the `include` parameter.2756 for reasoning items returned by `POST /v1/responses` and WebSocket

2757 `response.create` requests.

2757 2758 

2758 - `Status ResponseReasoningItemStatus`2759 - `Status ResponseReasoningItemStatus`

2759 2760 


4854 4855 

4855 - `EncryptedContent string`4856 - `EncryptedContent string`

4856 4857 

4857 The encrypted content of the reasoning item - populated when a response is4858 The encrypted content of the reasoning item. This is populated by default

4858 generated with `reasoning.encrypted_content` in the `include` parameter.4859 for reasoning items returned by `POST /v1/responses` and WebSocket

4860 `response.create` requests.

4859 4861 

4860 - `Status ResponseReasoningItemStatus`4862 - `Status ResponseReasoningItemStatus`

4861 4863 

Details

2625 2625 

2626 - `EncryptedContent string`2626 - `EncryptedContent string`

2627 2627 

2628 The encrypted content of the reasoning item - populated when a response is2628 The encrypted content of the reasoning item. This is populated by default

2629 generated with `reasoning.encrypted_content` in the `include` parameter.2629 for reasoning items returned by `POST /v1/responses` and WebSocket

2630 `response.create` requests.

2630 2631 

2631 - `Status ResponseReasoningItemStatus`2632 - `Status ResponseReasoningItemStatus`

2632 2633 


6606 6607 

6607 - `EncryptedContent string`6608 - `EncryptedContent string`

6608 6609 

6609 The encrypted content of the reasoning item - populated when a response is6610 The encrypted content of the reasoning item. This is populated by default

6610 generated with `reasoning.encrypted_content` in the `include` parameter.6611 for reasoning items returned by `POST /v1/responses` and WebSocket

6612 `response.create` requests.

6611 6613 

6612 - `Status ResponseReasoningItemStatus`6614 - `Status ResponseReasoningItemStatus`

6613 6615 

Details

2668 2668 

2669 - `EncryptedContent string`2669 - `EncryptedContent string`

2670 2670 

2671 The encrypted content of the reasoning item - populated when a response is2671 The encrypted content of the reasoning item. This is populated by default

2672 generated with `reasoning.encrypted_content` in the `include` parameter.2672 for reasoning items returned by `POST /v1/responses` and WebSocket

2673 `response.create` requests.

2673 2674 

2674 - `Status ResponseReasoningItemStatus`2675 - `Status ResponseReasoningItemStatus`

2675 2676 

Details

2436 2436 

2437 - `EncryptedContent string`2437 - `EncryptedContent string`

2438 2438 

2439 The encrypted content of the reasoning item - populated when a response is2439 The encrypted content of the reasoning item. This is populated by default

2440 generated with `reasoning.encrypted_content` in the `include` parameter.2440 for reasoning items returned by `POST /v1/responses` and WebSocket

2441 `response.create` requests.

2441 2442 

2442 - `Status ResponseReasoningItemStatus`2443 - `Status ResponseReasoningItemStatus`

2443 2444 

Details

2567 2567 

2568 - `EncryptedContent string`2568 - `EncryptedContent string`

2569 2569 

2570 The encrypted content of the reasoning item - populated when a response is2570 The encrypted content of the reasoning item. This is populated by default

2571 generated with `reasoning.encrypted_content` in the `include` parameter.2571 for reasoning items returned by `POST /v1/responses` and WebSocket

2572 `response.create` requests.

2572 2573 

2573 - `Status ResponseReasoningItemStatus`2574 - `Status ResponseReasoningItemStatus`

2574 2575 

Details

168 168 

169 - `USER_DELETED("user.deleted")`169 - `USER_DELETED("user.deleted")`

170 170 

171 - `TENANT_METADATA_UPDATED("tenant.metadata.updated")`

172 

173 - `TENANT_MICROSOFT_ENTRA_MAPPING_UPSERTED("tenant.microsoft_entra_mapping.upserted")`

174 

175 - `TENANT_MICROSOFT_ENTRA_MAPPING_DELETED("tenant.microsoft_entra_mapping.deleted")`

176 

177 - `TENANT_WORKLOAD_IDENTITY_PROVIDER_CREATED("tenant.workload_identity.provider.created")`

178 

179 - `TENANT_WORKLOAD_IDENTITY_PROVIDER_UPDATED("tenant.workload_identity.provider.updated")`

180 

181 - `TENANT_WORKLOAD_IDENTITY_PROVIDER_ARCHIVED("tenant.workload_identity.provider.archived")`

182 

183 - `TENANT_WORKLOAD_IDENTITY_MAPPING_CREATED("tenant.workload_identity.mapping.created")`

184 

185 - `TENANT_WORKLOAD_IDENTITY_MAPPING_UPDATED("tenant.workload_identity.mapping.updated")`

186 

187 - `TENANT_WORKLOAD_IDENTITY_MAPPING_ARCHIVED("tenant.workload_identity.mapping.archived")`

188 

189 - `TENANT_WORKLOAD_IDENTITY_BINDING_CREATED("tenant.workload_identity.binding.created")`

190 

191 - `TENANT_WORKLOAD_IDENTITY_PRINCIPAL_PROVISIONED("tenant.workload_identity.principal.provisioned")`

192 

193 - `TENANT_ADMIN_API_KEY_CREATED("tenant.admin_api_key.created")`

194 

195 - `TENANT_ADMIN_API_KEY_UPDATED("tenant.admin_api_key.updated")`

196 

197 - `TENANT_ADMIN_API_KEY_DELETED("tenant.admin_api_key.deleted")`

198 

199 - `TENANT_PROJECT_API_KEY_CREATED("tenant.project_api_key.created")`

200 

201 - `TENANT_CHATGPT_ACCESS_TOKEN_REVOKED("tenant.chatgpt_access_token.revoked")`

202 

203 - `TENANT_MIGRATION_COMPLETED("tenant.migration.completed")`

204 

205 - `TENANT_SSO_MIGRATED("tenant.sso.migrated")`

206 

207 - `TENANT_DOMAINS_MIGRATED("tenant.domains.migrated")`

208 

209 - `TENANT_SSO_CONNECTION_CREATED("tenant.sso_connection.created")`

210 

211 - `TENANT_SSO_CONNECTION_UPDATED("tenant.sso_connection.updated")`

212 

213 - `TENANT_SSO_CONNECTION_DELETED("tenant.sso_connection.deleted")`

214 

215 - `TENANT_SSO_CONNECTION_SETUP_STARTED("tenant.sso_connection.setup.started")`

216 

217 - `TENANT_POLICY_CREATED("tenant.policy.created")`

218 

219 - `TENANT_POLICY_UPDATED("tenant.policy.updated")`

220 

221 - `TENANT_POLICY_DELETED("tenant.policy.deleted")`

222 

223 - `TENANT_POLICY_ATTACHED("tenant.policy.attached")`

224 

225 - `TENANT_POLICY_DETACHED("tenant.policy.detached")`

226 

227 - `TENANT_PRINCIPAL_AUTHENTICATION_POLICY_RESOLVED("tenant.principal_authentication_policy.resolved")`

228 

229 - `TENANT_SCIM_SETUP_STARTED("tenant.scim.setup.started")`

230 

231 - `TENANT_SCIM_DELETION_REQUESTED("tenant.scim.deletion.requested")`

232 

233 - `TENANT_SCIM_DIRECTORY_CREATED("tenant.scim.directory.created")`

234 

235 - `TENANT_PRODUCT_ACCESS_POLICY_UPDATED("tenant.product_access_policy.updated")`

236 

237 - `TENANT_RESOURCE_SHARE_GRANT_CREATED("tenant.resource_share_grant.created")`

238 

239 - `TENANT_RESOURCE_SHARE_GRANT_UPDATED("tenant.resource_share_grant.updated")`

240 

241 - `TENANT_RESOURCE_SHARE_GRANT_ACCEPTED("tenant.resource_share_grant.accepted")`

242 

243 - `TENANT_RESOURCE_SHARE_GRANT_DECLINED("tenant.resource_share_grant.declined")`

244 

245 - `TENANT_RESOURCE_SHARE_GRANT_REVOKED("tenant.resource_share_grant.revoked")`

246 

247 - `TENANT_RESOURCE_SHARE_GRANT_DELETED("tenant.resource_share_grant.deleted")`

248 

249 - `TENANT_SERVICE_ACCOUNT_UPDATED("tenant.service_account.updated")`

250 

251 - `TENANT_SERVICE_ACCOUNT_DELETED("tenant.service_account.deleted")`

252 

253 - `TENANT_SERVICE_ACCOUNT_TOKEN_REVOKED("tenant.service_account.token.revoked")`

254 

255 - `TENANT_BILLING_OVERAGE_LIMIT_UPDATED("tenant.billing.overage_limit.updated")`

256 

257 - `TENANT_BILLING_ALERTS_UPDATED("tenant.billing.alerts.updated")`

258 

259 - `TENANT_BILLING_INFO_UPDATED("tenant.billing.info.updated")`

260 

261 - `TENANT_USAGE_LIMIT_WORKSPACE_UPDATED("tenant.usage_limit.workspace.updated")`

262 

263 - `TENANT_USAGE_LIMIT_GROUP_UPDATED("tenant.usage_limit.group.updated")`

264 

265 - `TENANT_USAGE_LIMIT_USER_UPDATED("tenant.usage_limit.user.updated")`

266 

267 - `TENANT_USAGE_LIMIT_INCREASE_REQUEST_UPDATED("tenant.usage_limit.increase_request.updated")`

268 

269 - `TENANT_USAGE_LIMIT_INCREASE_REQUEST_RESOLVED("tenant.usage_limit.increase_request.resolved")`

270 

271 - `TENANT_GROUP_CREATED("tenant.group.created")`

272 

273 - `TENANT_GROUP_UPDATED("tenant.group.updated")`

274 

275 - `TENANT_GROUP_DELETED("tenant.group.deleted")`

276 

277 - `TENANT_GROUP_MEMBER_ADDED("tenant.group.member.added")`

278 

279 - `TENANT_GROUP_MEMBER_REMOVED("tenant.group.member.removed")`

280 

281 - `TENANT_MIGRATION_ROLLOUT_STATUS_UPDATED("tenant.migration_rollout.status.updated")`

282 

283 - `TENANT_MIGRATION_ROLLOUT_TIER_UPDATED("tenant.migration_rollout.tier.updated")`

284 

285 - `TENANT_ROLE_METADATA_UPDATED("tenant.role.metadata.updated")`

286 

287 - `TENANT_CUSTOM_ROLE_CREATED("tenant.custom_role.created")`

288 

289 - `TENANT_CUSTOM_ROLE_UPDATED("tenant.custom_role.updated")`

290 

291 - `TENANT_CUSTOM_ROLE_DELETED("tenant.custom_role.deleted")`

292 

293 - `TENANT_ROLE_ASSIGNMENT_CREATED("tenant.role_assignment.created")`

294 

295 - `TENANT_ROLE_ASSIGNMENT_DELETED("tenant.role_assignment.deleted")`

296 

297 - `TENANT_RESOURCE_ROLE_ASSIGNMENT_CREATED("tenant.resource_role_assignment.created")`

298 

299 - `TENANT_RESOURCE_ROLE_ASSIGNMENT_DELETED("tenant.resource_role_assignment.deleted")`

300 

301 - `TENANT_RESOURCE_ACCESS_UPDATED("tenant.resource_access.updated")`

302 

303 - `TENANT_RESOURCE_ACCESS_DELETED("tenant.resource_access.deleted")`

304 

305 - `TENANT_SESSION_POLICY_CREATED("tenant.session_policy.created")`

306 

307 - `TENANT_SESSION_POLICY_UPDATED("tenant.session_policy.updated")`

308 

309 - `TENANT_SESSION_POLICY_DELETED("tenant.session_policy.deleted")`

310 

311 - `TENANT_SESSION_REVOCATION_STARTED("tenant.session_revocation.started")`

312 

313 - `TENANT_THIRD_PARTY_APP_POLICY_UPDATED("tenant.third_party_app_policy.updated")`

314 

315 - `TENANT_USER_ADDED("tenant.user.added")`

316 

317 - `TENANT_USER_UPDATED("tenant.user.updated")`

318 

319 - `TENANT_USER_REMOVED("tenant.user.removed")`

320 

321 - `TENANT_USER_LOOKED_UP("tenant.user.looked_up")`

322 

323 - `TENANT_USER_INVITED("tenant.user.invited")`

324 

325 - `TENANT_MEMBERSHIP_REVOKED("tenant.membership.revoked")`

326 

327 - `TENANT_API_ORGANIZATION_INVITE_UPSERTED("tenant.api_organization_invite.upserted")`

328 

329 - `TENANT_API_ORGANIZATION_INVITE_DELETED("tenant.api_organization_invite.deleted")`

330 

331 - `TENANT_CHATGPT_WORKSPACE_INVITE_UPSERTED("tenant.chatgpt_workspace_invite.upserted")`

332 

333 - `TENANT_MEMBERSHIP_ACCEPTED("tenant.membership.accepted")`

334 

335 - `TENANT_MEMBERSHIP_DECLINED("tenant.membership.declined")`

336 

337 - `TENANT_WORKSPACE_INVITE_EMAIL_SETTINGS_UPDATED("tenant.workspace_invite_email_settings.updated")`

338 

171 - `Optional<Long> limit`339 - `Optional<Long> limit`

172 340 

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


320 488 

321 - `USER_DELETED("user.deleted")`489 - `USER_DELETED("user.deleted")`

322 490 

491 - `TENANT_METADATA_UPDATED("tenant.metadata.updated")`

492 

493 - `TENANT_MICROSOFT_ENTRA_MAPPING_UPSERTED("tenant.microsoft_entra_mapping.upserted")`

494 

495 - `TENANT_MICROSOFT_ENTRA_MAPPING_DELETED("tenant.microsoft_entra_mapping.deleted")`

496 

497 - `TENANT_WORKLOAD_IDENTITY_PROVIDER_CREATED("tenant.workload_identity.provider.created")`

498 

499 - `TENANT_WORKLOAD_IDENTITY_PROVIDER_UPDATED("tenant.workload_identity.provider.updated")`

500 

501 - `TENANT_WORKLOAD_IDENTITY_PROVIDER_ARCHIVED("tenant.workload_identity.provider.archived")`

502 

503 - `TENANT_WORKLOAD_IDENTITY_MAPPING_CREATED("tenant.workload_identity.mapping.created")`

504 

505 - `TENANT_WORKLOAD_IDENTITY_MAPPING_UPDATED("tenant.workload_identity.mapping.updated")`

506 

507 - `TENANT_WORKLOAD_IDENTITY_MAPPING_ARCHIVED("tenant.workload_identity.mapping.archived")`

508 

509 - `TENANT_WORKLOAD_IDENTITY_BINDING_CREATED("tenant.workload_identity.binding.created")`

510 

511 - `TENANT_WORKLOAD_IDENTITY_PRINCIPAL_PROVISIONED("tenant.workload_identity.principal.provisioned")`

512 

513 - `TENANT_ADMIN_API_KEY_CREATED("tenant.admin_api_key.created")`

514 

515 - `TENANT_ADMIN_API_KEY_UPDATED("tenant.admin_api_key.updated")`

516 

517 - `TENANT_ADMIN_API_KEY_DELETED("tenant.admin_api_key.deleted")`

518 

519 - `TENANT_PROJECT_API_KEY_CREATED("tenant.project_api_key.created")`

520 

521 - `TENANT_CHATGPT_ACCESS_TOKEN_REVOKED("tenant.chatgpt_access_token.revoked")`

522 

523 - `TENANT_MIGRATION_COMPLETED("tenant.migration.completed")`

524 

525 - `TENANT_SSO_MIGRATED("tenant.sso.migrated")`

526 

527 - `TENANT_DOMAINS_MIGRATED("tenant.domains.migrated")`

528 

529 - `TENANT_SSO_CONNECTION_CREATED("tenant.sso_connection.created")`

530 

531 - `TENANT_SSO_CONNECTION_UPDATED("tenant.sso_connection.updated")`

532 

533 - `TENANT_SSO_CONNECTION_DELETED("tenant.sso_connection.deleted")`

534 

535 - `TENANT_SSO_CONNECTION_SETUP_STARTED("tenant.sso_connection.setup.started")`

536 

537 - `TENANT_POLICY_CREATED("tenant.policy.created")`

538 

539 - `TENANT_POLICY_UPDATED("tenant.policy.updated")`

540 

541 - `TENANT_POLICY_DELETED("tenant.policy.deleted")`

542 

543 - `TENANT_POLICY_ATTACHED("tenant.policy.attached")`

544 

545 - `TENANT_POLICY_DETACHED("tenant.policy.detached")`

546 

547 - `TENANT_PRINCIPAL_AUTHENTICATION_POLICY_RESOLVED("tenant.principal_authentication_policy.resolved")`

548 

549 - `TENANT_SCIM_SETUP_STARTED("tenant.scim.setup.started")`

550 

551 - `TENANT_SCIM_DELETION_REQUESTED("tenant.scim.deletion.requested")`

552 

553 - `TENANT_SCIM_DIRECTORY_CREATED("tenant.scim.directory.created")`

554 

555 - `TENANT_PRODUCT_ACCESS_POLICY_UPDATED("tenant.product_access_policy.updated")`

556 

557 - `TENANT_RESOURCE_SHARE_GRANT_CREATED("tenant.resource_share_grant.created")`

558 

559 - `TENANT_RESOURCE_SHARE_GRANT_UPDATED("tenant.resource_share_grant.updated")`

560 

561 - `TENANT_RESOURCE_SHARE_GRANT_ACCEPTED("tenant.resource_share_grant.accepted")`

562 

563 - `TENANT_RESOURCE_SHARE_GRANT_DECLINED("tenant.resource_share_grant.declined")`

564 

565 - `TENANT_RESOURCE_SHARE_GRANT_REVOKED("tenant.resource_share_grant.revoked")`

566 

567 - `TENANT_RESOURCE_SHARE_GRANT_DELETED("tenant.resource_share_grant.deleted")`

568 

569 - `TENANT_SERVICE_ACCOUNT_UPDATED("tenant.service_account.updated")`

570 

571 - `TENANT_SERVICE_ACCOUNT_DELETED("tenant.service_account.deleted")`

572 

573 - `TENANT_SERVICE_ACCOUNT_TOKEN_REVOKED("tenant.service_account.token.revoked")`

574 

575 - `TENANT_BILLING_OVERAGE_LIMIT_UPDATED("tenant.billing.overage_limit.updated")`

576 

577 - `TENANT_BILLING_ALERTS_UPDATED("tenant.billing.alerts.updated")`

578 

579 - `TENANT_BILLING_INFO_UPDATED("tenant.billing.info.updated")`

580 

581 - `TENANT_USAGE_LIMIT_WORKSPACE_UPDATED("tenant.usage_limit.workspace.updated")`

582 

583 - `TENANT_USAGE_LIMIT_GROUP_UPDATED("tenant.usage_limit.group.updated")`

584 

585 - `TENANT_USAGE_LIMIT_USER_UPDATED("tenant.usage_limit.user.updated")`

586 

587 - `TENANT_USAGE_LIMIT_INCREASE_REQUEST_UPDATED("tenant.usage_limit.increase_request.updated")`

588 

589 - `TENANT_USAGE_LIMIT_INCREASE_REQUEST_RESOLVED("tenant.usage_limit.increase_request.resolved")`

590 

591 - `TENANT_GROUP_CREATED("tenant.group.created")`

592 

593 - `TENANT_GROUP_UPDATED("tenant.group.updated")`

594 

595 - `TENANT_GROUP_DELETED("tenant.group.deleted")`

596 

597 - `TENANT_GROUP_MEMBER_ADDED("tenant.group.member.added")`

598 

599 - `TENANT_GROUP_MEMBER_REMOVED("tenant.group.member.removed")`

600 

601 - `TENANT_MIGRATION_ROLLOUT_STATUS_UPDATED("tenant.migration_rollout.status.updated")`

602 

603 - `TENANT_MIGRATION_ROLLOUT_TIER_UPDATED("tenant.migration_rollout.tier.updated")`

604 

605 - `TENANT_ROLE_METADATA_UPDATED("tenant.role.metadata.updated")`

606 

607 - `TENANT_CUSTOM_ROLE_CREATED("tenant.custom_role.created")`

608 

609 - `TENANT_CUSTOM_ROLE_UPDATED("tenant.custom_role.updated")`

610 

611 - `TENANT_CUSTOM_ROLE_DELETED("tenant.custom_role.deleted")`

612 

613 - `TENANT_ROLE_ASSIGNMENT_CREATED("tenant.role_assignment.created")`

614 

615 - `TENANT_ROLE_ASSIGNMENT_DELETED("tenant.role_assignment.deleted")`

616 

617 - `TENANT_RESOURCE_ROLE_ASSIGNMENT_CREATED("tenant.resource_role_assignment.created")`

618 

619 - `TENANT_RESOURCE_ROLE_ASSIGNMENT_DELETED("tenant.resource_role_assignment.deleted")`

620 

621 - `TENANT_RESOURCE_ACCESS_UPDATED("tenant.resource_access.updated")`

622 

623 - `TENANT_RESOURCE_ACCESS_DELETED("tenant.resource_access.deleted")`

624 

625 - `TENANT_SESSION_POLICY_CREATED("tenant.session_policy.created")`

626 

627 - `TENANT_SESSION_POLICY_UPDATED("tenant.session_policy.updated")`

628 

629 - `TENANT_SESSION_POLICY_DELETED("tenant.session_policy.deleted")`

630 

631 - `TENANT_SESSION_REVOCATION_STARTED("tenant.session_revocation.started")`

632 

633 - `TENANT_THIRD_PARTY_APP_POLICY_UPDATED("tenant.third_party_app_policy.updated")`

634 

635 - `TENANT_USER_ADDED("tenant.user.added")`

636 

637 - `TENANT_USER_UPDATED("tenant.user.updated")`

638 

639 - `TENANT_USER_REMOVED("tenant.user.removed")`

640 

641 - `TENANT_USER_LOOKED_UP("tenant.user.looked_up")`

642 

643 - `TENANT_USER_INVITED("tenant.user.invited")`

644 

645 - `TENANT_MEMBERSHIP_REVOKED("tenant.membership.revoked")`

646 

647 - `TENANT_API_ORGANIZATION_INVITE_UPSERTED("tenant.api_organization_invite.upserted")`

648 

649 - `TENANT_API_ORGANIZATION_INVITE_DELETED("tenant.api_organization_invite.deleted")`

650 

651 - `TENANT_CHATGPT_WORKSPACE_INVITE_UPSERTED("tenant.chatgpt_workspace_invite.upserted")`

652 

653 - `TENANT_MEMBERSHIP_ACCEPTED("tenant.membership.accepted")`

654 

655 - `TENANT_MEMBERSHIP_DECLINED("tenant.membership.declined")`

656 

657 - `TENANT_WORKSPACE_INVITE_EMAIL_SETTINGS_UPDATED("tenant.workspace_invite_email_settings.updated")`

658 

323 - `Optional<Actor> actor`659 - `Optional<Actor> actor`

324 660 

325 The actor who performed the audit logged action.661 The actor who performed the audit logged action.

Details

4 4 

5**post** `/organization/projects/{project_id}/service_accounts`5**post** `/organization/projects/{project_id}/service_accounts`

6 6 

7Creates a new service account in the project. This also returns an unredacted API key for the service account.7Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

8 8 

9### Parameters9### Parameters

10 10 


16 16 

17 The name of the service account being created.17 The name of the service account being created.

18 18 

19 - `Optional<Boolean> createServiceAccountOnly`

20 

21 Create the service account without default roles or an API key.

22 

19### Returns23### Returns

20 24 

21- `class ServiceAccountCreateResponse:`25- `class ServiceAccountCreateResponse:`


46 50 

47 - `ORGANIZATION_PROJECT_SERVICE_ACCOUNT("organization.project.service_account")`51 - `ORGANIZATION_PROJECT_SERVICE_ACCOUNT("organization.project.service_account")`

48 52 

49 - `JsonValue; role "member"constant`53 - `Role role`

50 54 

51 Service accounts can only have one role of type `member`55 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

52 56 

53 - `MEMBER("member")`57 - `MEMBER("member")`

54 58 

59 - `NONE("none")`

60 

55### Example61### Example

56 62 

57```java63```java

Details

1## Create project service account API key

2 

3`ApiKeyCreateResponse admin().organization().projects().serviceAccounts().apiKeys().create(ApiKeyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

4 

5**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

6 

7Creates an API key for a service account in the project.

8 

9### Parameters

10 

11- `ApiKeyCreateParams params`

12 

13 - `String projectId`

14 

15 - `Optional<String> serviceAccountId`

16 

17 - `Optional<String> name`

18 

19 API key name.

20 

21 - `Optional<List<String>> scopes`

22 

23 API key scopes.

24 

25### Returns

26 

27- `class ApiKeyCreateResponse:`

28 

29 - `String id`

30 

31 - `long createdAt`

32 

33 - `String name`

34 

35 - `JsonValue; object_ "organization.project.service_account.api_key"constant`

36 

37 The object type, which is always `organization.project.service_account.api_key`

38 

39 - `ORGANIZATION_PROJECT_SERVICE_ACCOUNT_API_KEY("organization.project.service_account.api_key")`

40 

41 - `String value`

42 

43### Example

44 

45```java

46package com.openai.example;

47 

48import com.openai.client.OpenAIClient;

49import com.openai.client.okhttp.OpenAIOkHttpClient;

50import com.openai.models.admin.organization.projects.serviceaccounts.apikeys.ApiKeyCreateParams;

51import com.openai.models.admin.organization.projects.serviceaccounts.apikeys.ApiKeyCreateResponse;

52 

53public final class Main {

54 private Main() {}

55 

56 public static void main(String[] args) {

57 OpenAIClient client = OpenAIOkHttpClient.fromEnv();

58 

59 ApiKeyCreateParams params = ApiKeyCreateParams.builder()

60 .projectId("project_id")

61 .serviceAccountId("service_account_id")

62 .build();

63 ApiKeyCreateResponse apiKey = client.admin().organization().projects().serviceAccounts().apiKeys().create(params);

64 }

65}

66```

67 

68#### Response

69 

70```json

71{

72 "id": "id",

73 "created_at": 0,

74 "name": "name",

75 "object": "organization.project.service_account.api_key",

76 "value": "value"

77}

78```

Details

88 88 

89 - `long inputTokens`89 - `long inputTokens`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `long numModelRequests`93 - `long numModelRequests`

94 94 


100 100 

101 - `long outputTokens`101 - `long outputTokens`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `Optional<String> apiKeyId`105 - `Optional<String> apiKeyId`

106 106 


112 112 

113 - `Optional<Long> inputAudioTokens`113 - `Optional<Long> inputAudioTokens`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `Optional<Long> inputCacheWriteTokens`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `Optional<Long> inputCachedAudioTokens`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `Optional<Long> inputCachedImageTokens`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `Optional<Long> inputCachedTextTokens`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `Optional<Long> inputCachedTokens`133 - `Optional<Long> inputCachedTokens`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `Optional<Long> inputImageTokens`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `Optional<Long> inputTextTokens`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `Optional<Long> inputUncachedTokens`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Optional<String> model`149 - `Optional<String> model`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `Optional<Long> outputImageTokens`

158 

159 The aggregated number of image output tokens used.

160 

161 - `Optional<Long> outputTextTokens`

162 

163 The aggregated number of text output tokens used.

164 

129 - `Optional<String> projectId`165 - `Optional<String> projectId`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


489 "api_key_id": "api_key_id",525 "api_key_id": "api_key_id",

490 "batch": true,526 "batch": true,

491 "input_audio_tokens": 0,527 "input_audio_tokens": 0,

528 "input_cache_write_tokens": 0,

529 "input_cached_audio_tokens": 0,

530 "input_cached_image_tokens": 0,

531 "input_cached_text_tokens": 0,

492 "input_cached_tokens": 0,532 "input_cached_tokens": 0,

533 "input_image_tokens": 0,

534 "input_text_tokens": 0,

535 "input_uncached_tokens": 0,

493 "model": "model",536 "model": "model",

494 "output_audio_tokens": 0,537 "output_audio_tokens": 0,

538 "output_image_tokens": 0,

539 "output_text_tokens": 0,

495 "project_id": "project_id",540 "project_id": "project_id",

496 "service_tier": "service_tier",541 "service_tier": "service_tier",

497 "user_id": "user_id"542 "user_id": "user_id"

Details

88 88 

89 - `long inputTokens`89 - `long inputTokens`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `long numModelRequests`93 - `long numModelRequests`

94 94 


100 100 

101 - `long outputTokens`101 - `long outputTokens`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `Optional<String> apiKeyId`105 - `Optional<String> apiKeyId`

106 106 


112 112 

113 - `Optional<Long> inputAudioTokens`113 - `Optional<Long> inputAudioTokens`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `Optional<Long> inputCacheWriteTokens`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `Optional<Long> inputCachedAudioTokens`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `Optional<Long> inputCachedImageTokens`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `Optional<Long> inputCachedTextTokens`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `Optional<Long> inputCachedTokens`133 - `Optional<Long> inputCachedTokens`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `Optional<Long> inputImageTokens`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `Optional<Long> inputTextTokens`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `Optional<Long> inputUncachedTokens`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Optional<String> model`149 - `Optional<String> model`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `Optional<Long> outputImageTokens`

158 

159 The aggregated number of image output tokens used.

160 

161 - `Optional<Long> outputTextTokens`

162 

163 The aggregated number of text output tokens used.

164 

129 - `Optional<String> projectId`165 - `Optional<String> projectId`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


489 "api_key_id": "api_key_id",525 "api_key_id": "api_key_id",

490 "batch": true,526 "batch": true,

491 "input_audio_tokens": 0,527 "input_audio_tokens": 0,

528 "input_cache_write_tokens": 0,

529 "input_cached_audio_tokens": 0,

530 "input_cached_image_tokens": 0,

531 "input_cached_text_tokens": 0,

492 "input_cached_tokens": 0,532 "input_cached_tokens": 0,

533 "input_image_tokens": 0,

534 "input_text_tokens": 0,

535 "input_uncached_tokens": 0,

493 "model": "model",536 "model": "model",

494 "output_audio_tokens": 0,537 "output_audio_tokens": 0,

538 "output_image_tokens": 0,

539 "output_text_tokens": 0,

495 "project_id": "project_id",540 "project_id": "project_id",

496 "service_tier": "service_tier",541 "service_tier": "service_tier",

497 "user_id": "user_id"542 "user_id": "user_id"

Details

70 70 

71 - `long inputTokens`71 - `long inputTokens`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `long numModelRequests`75 - `long numModelRequests`

76 76 


82 82 

83 - `long outputTokens`83 - `long outputTokens`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `Optional<String> apiKeyId`87 - `Optional<String> apiKeyId`

88 88 


94 94 

95 - `Optional<Long> inputAudioTokens`95 - `Optional<Long> inputAudioTokens`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `Optional<Long> inputCacheWriteTokens`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `Optional<Long> inputCachedAudioTokens`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `Optional<Long> inputCachedImageTokens`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `Optional<Long> inputCachedTextTokens`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `Optional<Long> inputCachedTokens`115 - `Optional<Long> inputCachedTokens`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `Optional<Long> inputImageTokens`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `Optional<Long> inputTextTokens`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `Optional<Long> inputUncachedTokens`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `Optional<String> model`131 - `Optional<String> model`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `Optional<Long> outputImageTokens`

140 

141 The aggregated number of image output tokens used.

142 

143 - `Optional<Long> outputTextTokens`

144 

145 The aggregated number of text output tokens used.

146 

111 - `Optional<String> projectId`147 - `Optional<String> projectId`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


471 "api_key_id": "api_key_id",507 "api_key_id": "api_key_id",

472 "batch": true,508 "batch": true,

473 "input_audio_tokens": 0,509 "input_audio_tokens": 0,

510 "input_cache_write_tokens": 0,

511 "input_cached_audio_tokens": 0,

512 "input_cached_image_tokens": 0,

513 "input_cached_text_tokens": 0,

474 "input_cached_tokens": 0,514 "input_cached_tokens": 0,

515 "input_image_tokens": 0,

516 "input_text_tokens": 0,

517 "input_uncached_tokens": 0,

475 "model": "model",518 "model": "model",

476 "output_audio_tokens": 0,519 "output_audio_tokens": 0,

520 "output_image_tokens": 0,

521 "output_text_tokens": 0,

477 "project_id": "project_id",522 "project_id": "project_id",

478 "service_tier": "service_tier",523 "service_tier": "service_tier",

479 "user_id": "user_id"524 "user_id": "user_id"

Details

96 96 

97 - `long inputTokens`97 - `long inputTokens`

98 98 

99 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.99 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

100 100 

101 - `long numModelRequests`101 - `long numModelRequests`

102 102 


108 108 

109 - `long outputTokens`109 - `long outputTokens`

110 110 

111 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.111 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

112 112 

113 - `Optional<String> apiKeyId`113 - `Optional<String> apiKeyId`

114 114 


120 120 

121 - `Optional<Long> inputAudioTokens`121 - `Optional<Long> inputAudioTokens`

122 122 

123 The aggregated number of audio input tokens used, including cached tokens.123 The aggregated number of uncached audio input tokens used.

124 

125 - `Optional<Long> inputCacheWriteTokens`

126 

127 The aggregated number of input tokens written to the cache.

128 

129 - `Optional<Long> inputCachedAudioTokens`

130 

131 The aggregated number of cached audio input tokens used.

132 

133 - `Optional<Long> inputCachedImageTokens`

134 

135 The aggregated number of cached image input tokens used.

136 

137 - `Optional<Long> inputCachedTextTokens`

138 

139 The aggregated number of cached text input tokens used.

124 140 

125 - `Optional<Long> inputCachedTokens`141 - `Optional<Long> inputCachedTokens`

126 142 

127 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.143 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

144 

145 - `Optional<Long> inputImageTokens`

146 

147 The aggregated number of uncached image input tokens used.

148 

149 - `Optional<Long> inputTextTokens`

150 

151 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

152 

153 - `Optional<Long> inputUncachedTokens`

154 

155 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

128 156 

129 - `Optional<String> model`157 - `Optional<String> model`

130 158 


134 162 

135 The aggregated number of audio output tokens used.163 The aggregated number of audio output tokens used.

136 164 

165 - `Optional<Long> outputImageTokens`

166 

167 The aggregated number of image output tokens used.

168 

169 - `Optional<Long> outputTextTokens`

170 

171 The aggregated number of text output tokens used.

172 

137 - `Optional<String> projectId`173 - `Optional<String> projectId`

138 174 

139 When `group_by=project_id`, this field provides the project ID of the grouped usage result.175 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


497 "api_key_id": "api_key_id",533 "api_key_id": "api_key_id",

498 "batch": true,534 "batch": true,

499 "input_audio_tokens": 0,535 "input_audio_tokens": 0,

536 "input_cache_write_tokens": 0,

537 "input_cached_audio_tokens": 0,

538 "input_cached_image_tokens": 0,

539 "input_cached_text_tokens": 0,

500 "input_cached_tokens": 0,540 "input_cached_tokens": 0,

541 "input_image_tokens": 0,

542 "input_text_tokens": 0,

543 "input_uncached_tokens": 0,

501 "model": "model",544 "model": "model",

502 "output_audio_tokens": 0,545 "output_audio_tokens": 0,

546 "output_image_tokens": 0,

547 "output_text_tokens": 0,

503 "project_id": "project_id",548 "project_id": "project_id",

504 "service_tier": "service_tier",549 "service_tier": "service_tier",

505 "user_id": "user_id"550 "user_id": "user_id"

Details

70 70 

71 - `long inputTokens`71 - `long inputTokens`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `long numModelRequests`75 - `long numModelRequests`

76 76 


82 82 

83 - `long outputTokens`83 - `long outputTokens`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `Optional<String> apiKeyId`87 - `Optional<String> apiKeyId`

88 88 


94 94 

95 - `Optional<Long> inputAudioTokens`95 - `Optional<Long> inputAudioTokens`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `Optional<Long> inputCacheWriteTokens`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `Optional<Long> inputCachedAudioTokens`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `Optional<Long> inputCachedImageTokens`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `Optional<Long> inputCachedTextTokens`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `Optional<Long> inputCachedTokens`115 - `Optional<Long> inputCachedTokens`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `Optional<Long> inputImageTokens`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `Optional<Long> inputTextTokens`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `Optional<Long> inputUncachedTokens`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `Optional<String> model`131 - `Optional<String> model`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `Optional<Long> outputImageTokens`

140 

141 The aggregated number of image output tokens used.

142 

143 - `Optional<Long> outputTextTokens`

144 

145 The aggregated number of text output tokens used.

146 

111 - `Optional<String> projectId`147 - `Optional<String> projectId`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


471 "api_key_id": "api_key_id",507 "api_key_id": "api_key_id",

472 "batch": true,508 "batch": true,

473 "input_audio_tokens": 0,509 "input_audio_tokens": 0,

510 "input_cache_write_tokens": 0,

511 "input_cached_audio_tokens": 0,

512 "input_cached_image_tokens": 0,

513 "input_cached_text_tokens": 0,

474 "input_cached_tokens": 0,514 "input_cached_tokens": 0,

515 "input_image_tokens": 0,

516 "input_text_tokens": 0,

517 "input_uncached_tokens": 0,

475 "model": "model",518 "model": "model",

476 "output_audio_tokens": 0,519 "output_audio_tokens": 0,

520 "output_image_tokens": 0,

521 "output_text_tokens": 0,

477 "project_id": "project_id",522 "project_id": "project_id",

478 "service_tier": "service_tier",523 "service_tier": "service_tier",

479 "user_id": "user_id"524 "user_id": "user_id"

Details

88 88 

89 - `long inputTokens`89 - `long inputTokens`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `long numModelRequests`93 - `long numModelRequests`

94 94 


100 100 

101 - `long outputTokens`101 - `long outputTokens`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `Optional<String> apiKeyId`105 - `Optional<String> apiKeyId`

106 106 


112 112 

113 - `Optional<Long> inputAudioTokens`113 - `Optional<Long> inputAudioTokens`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `Optional<Long> inputCacheWriteTokens`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `Optional<Long> inputCachedAudioTokens`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `Optional<Long> inputCachedImageTokens`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `Optional<Long> inputCachedTextTokens`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `Optional<Long> inputCachedTokens`133 - `Optional<Long> inputCachedTokens`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `Optional<Long> inputImageTokens`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `Optional<Long> inputTextTokens`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `Optional<Long> inputUncachedTokens`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Optional<String> model`149 - `Optional<String> model`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `Optional<Long> outputImageTokens`

158 

159 The aggregated number of image output tokens used.

160 

161 - `Optional<Long> outputTextTokens`

162 

163 The aggregated number of text output tokens used.

164 

129 - `Optional<String> projectId`165 - `Optional<String> projectId`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


489 "api_key_id": "api_key_id",525 "api_key_id": "api_key_id",

490 "batch": true,526 "batch": true,

491 "input_audio_tokens": 0,527 "input_audio_tokens": 0,

528 "input_cache_write_tokens": 0,

529 "input_cached_audio_tokens": 0,

530 "input_cached_image_tokens": 0,

531 "input_cached_text_tokens": 0,

492 "input_cached_tokens": 0,532 "input_cached_tokens": 0,

533 "input_image_tokens": 0,

534 "input_text_tokens": 0,

535 "input_uncached_tokens": 0,

493 "model": "model",536 "model": "model",

494 "output_audio_tokens": 0,537 "output_audio_tokens": 0,

538 "output_image_tokens": 0,

539 "output_text_tokens": 0,

495 "project_id": "project_id",540 "project_id": "project_id",

496 "service_tier": "service_tier",541 "service_tier": "service_tier",

497 "user_id": "user_id"542 "user_id": "user_id"

Details

88 88 

89 - `long inputTokens`89 - `long inputTokens`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `long numModelRequests`93 - `long numModelRequests`

94 94 


100 100 

101 - `long outputTokens`101 - `long outputTokens`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `Optional<String> apiKeyId`105 - `Optional<String> apiKeyId`

106 106 


112 112 

113 - `Optional<Long> inputAudioTokens`113 - `Optional<Long> inputAudioTokens`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `Optional<Long> inputCacheWriteTokens`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `Optional<Long> inputCachedAudioTokens`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `Optional<Long> inputCachedImageTokens`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `Optional<Long> inputCachedTextTokens`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `Optional<Long> inputCachedTokens`133 - `Optional<Long> inputCachedTokens`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `Optional<Long> inputImageTokens`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `Optional<Long> inputTextTokens`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `Optional<Long> inputUncachedTokens`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Optional<String> model`149 - `Optional<String> model`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `Optional<Long> outputImageTokens`

158 

159 The aggregated number of image output tokens used.

160 

161 - `Optional<Long> outputTextTokens`

162 

163 The aggregated number of text output tokens used.

164 

129 - `Optional<String> projectId`165 - `Optional<String> projectId`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


489 "api_key_id": "api_key_id",525 "api_key_id": "api_key_id",

490 "batch": true,526 "batch": true,

491 "input_audio_tokens": 0,527 "input_audio_tokens": 0,

528 "input_cache_write_tokens": 0,

529 "input_cached_audio_tokens": 0,

530 "input_cached_image_tokens": 0,

531 "input_cached_text_tokens": 0,

492 "input_cached_tokens": 0,532 "input_cached_tokens": 0,

533 "input_image_tokens": 0,

534 "input_text_tokens": 0,

535 "input_uncached_tokens": 0,

493 "model": "model",536 "model": "model",

494 "output_audio_tokens": 0,537 "output_audio_tokens": 0,

538 "output_image_tokens": 0,

539 "output_text_tokens": 0,

495 "project_id": "project_id",540 "project_id": "project_id",

496 "service_tier": "service_tier",541 "service_tier": "service_tier",

497 "user_id": "user_id"542 "user_id": "user_id"

Details

116 116 

117 - `long inputTokens`117 - `long inputTokens`

118 118 

119 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.119 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

120 120 

121 - `long numModelRequests`121 - `long numModelRequests`

122 122 


128 128 

129 - `long outputTokens`129 - `long outputTokens`

130 130 

131 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.131 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

132 132 

133 - `Optional<String> apiKeyId`133 - `Optional<String> apiKeyId`

134 134 


140 140 

141 - `Optional<Long> inputAudioTokens`141 - `Optional<Long> inputAudioTokens`

142 142 

143 The aggregated number of audio input tokens used, including cached tokens.143 The aggregated number of uncached audio input tokens used.

144 

145 - `Optional<Long> inputCacheWriteTokens`

146 

147 The aggregated number of input tokens written to the cache.

148 

149 - `Optional<Long> inputCachedAudioTokens`

150 

151 The aggregated number of cached audio input tokens used.

152 

153 - `Optional<Long> inputCachedImageTokens`

154 

155 The aggregated number of cached image input tokens used.

156 

157 - `Optional<Long> inputCachedTextTokens`

158 

159 The aggregated number of cached text input tokens used.

144 160 

145 - `Optional<Long> inputCachedTokens`161 - `Optional<Long> inputCachedTokens`

146 162 

147 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.163 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

164 

165 - `Optional<Long> inputImageTokens`

166 

167 The aggregated number of uncached image input tokens used.

168 

169 - `Optional<Long> inputTextTokens`

170 

171 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

172 

173 - `Optional<Long> inputUncachedTokens`

174 

175 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

148 176 

149 - `Optional<String> model`177 - `Optional<String> model`

150 178 


154 182 

155 The aggregated number of audio output tokens used.183 The aggregated number of audio output tokens used.

156 184 

185 - `Optional<Long> outputImageTokens`

186 

187 The aggregated number of image output tokens used.

188 

189 - `Optional<Long> outputTextTokens`

190 

191 The aggregated number of text output tokens used.

192 

157 - `Optional<String> projectId`193 - `Optional<String> projectId`

158 194 

159 When `group_by=project_id`, this field provides the project ID of the grouped usage result.195 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


517 "api_key_id": "api_key_id",553 "api_key_id": "api_key_id",

518 "batch": true,554 "batch": true,

519 "input_audio_tokens": 0,555 "input_audio_tokens": 0,

556 "input_cache_write_tokens": 0,

557 "input_cached_audio_tokens": 0,

558 "input_cached_image_tokens": 0,

559 "input_cached_text_tokens": 0,

520 "input_cached_tokens": 0,560 "input_cached_tokens": 0,

561 "input_image_tokens": 0,

562 "input_text_tokens": 0,

563 "input_uncached_tokens": 0,

521 "model": "model",564 "model": "model",

522 "output_audio_tokens": 0,565 "output_audio_tokens": 0,

566 "output_image_tokens": 0,

567 "output_text_tokens": 0,

523 "project_id": "project_id",568 "project_id": "project_id",

524 "service_tier": "service_tier",569 "service_tier": "service_tier",

525 "user_id": "user_id"570 "user_id": "user_id"

Details

88 88 

89 - `long inputTokens`89 - `long inputTokens`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `long numModelRequests`93 - `long numModelRequests`

94 94 


100 100 

101 - `long outputTokens`101 - `long outputTokens`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `Optional<String> apiKeyId`105 - `Optional<String> apiKeyId`

106 106 


112 112 

113 - `Optional<Long> inputAudioTokens`113 - `Optional<Long> inputAudioTokens`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `Optional<Long> inputCacheWriteTokens`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `Optional<Long> inputCachedAudioTokens`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `Optional<Long> inputCachedImageTokens`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `Optional<Long> inputCachedTextTokens`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `Optional<Long> inputCachedTokens`133 - `Optional<Long> inputCachedTokens`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `Optional<Long> inputImageTokens`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `Optional<Long> inputTextTokens`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `Optional<Long> inputUncachedTokens`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `Optional<String> model`149 - `Optional<String> model`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `Optional<Long> outputImageTokens`

158 

159 The aggregated number of image output tokens used.

160 

161 - `Optional<Long> outputTextTokens`

162 

163 The aggregated number of text output tokens used.

164 

129 - `Optional<String> projectId`165 - `Optional<String> projectId`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


489 "api_key_id": "api_key_id",525 "api_key_id": "api_key_id",

490 "batch": true,526 "batch": true,

491 "input_audio_tokens": 0,527 "input_audio_tokens": 0,

528 "input_cache_write_tokens": 0,

529 "input_cached_audio_tokens": 0,

530 "input_cached_image_tokens": 0,

531 "input_cached_text_tokens": 0,

492 "input_cached_tokens": 0,532 "input_cached_tokens": 0,

533 "input_image_tokens": 0,

534 "input_text_tokens": 0,

535 "input_uncached_tokens": 0,

493 "model": "model",536 "model": "model",

494 "output_audio_tokens": 0,537 "output_audio_tokens": 0,

538 "output_image_tokens": 0,

539 "output_text_tokens": 0,

495 "project_id": "project_id",540 "project_id": "project_id",

496 "service_tier": "service_tier",541 "service_tier": "service_tier",

497 "user_id": "user_id"542 "user_id": "user_id"

Details

70 70 

71 - `long inputTokens`71 - `long inputTokens`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `long numModelRequests`75 - `long numModelRequests`

76 76 


82 82 

83 - `long outputTokens`83 - `long outputTokens`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `Optional<String> apiKeyId`87 - `Optional<String> apiKeyId`

88 88 


94 94 

95 - `Optional<Long> inputAudioTokens`95 - `Optional<Long> inputAudioTokens`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `Optional<Long> inputCacheWriteTokens`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `Optional<Long> inputCachedAudioTokens`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `Optional<Long> inputCachedImageTokens`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `Optional<Long> inputCachedTextTokens`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `Optional<Long> inputCachedTokens`115 - `Optional<Long> inputCachedTokens`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `Optional<Long> inputImageTokens`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `Optional<Long> inputTextTokens`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `Optional<Long> inputUncachedTokens`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `Optional<String> model`131 - `Optional<String> model`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `Optional<Long> outputImageTokens`

140 

141 The aggregated number of image output tokens used.

142 

143 - `Optional<Long> outputTextTokens`

144 

145 The aggregated number of text output tokens used.

146 

111 - `Optional<String> projectId`147 - `Optional<String> projectId`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


471 "api_key_id": "api_key_id",507 "api_key_id": "api_key_id",

472 "batch": true,508 "batch": true,

473 "input_audio_tokens": 0,509 "input_audio_tokens": 0,

510 "input_cache_write_tokens": 0,

511 "input_cached_audio_tokens": 0,

512 "input_cached_image_tokens": 0,

513 "input_cached_text_tokens": 0,

474 "input_cached_tokens": 0,514 "input_cached_tokens": 0,

515 "input_image_tokens": 0,

516 "input_text_tokens": 0,

517 "input_uncached_tokens": 0,

475 "model": "model",518 "model": "model",

476 "output_audio_tokens": 0,519 "output_audio_tokens": 0,

520 "output_image_tokens": 0,

521 "output_text_tokens": 0,

477 "project_id": "project_id",522 "project_id": "project_id",

478 "service_tier": "service_tier",523 "service_tier": "service_tier",

479 "user_id": "user_id"524 "user_id": "user_id"

Details

100 100 

101 - `long inputTokens`101 - `long inputTokens`

102 102 

103 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `long numModelRequests`105 - `long numModelRequests`

106 106 


112 112 

113 - `long outputTokens`113 - `long outputTokens`

114 114 

115 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 116 

117 - `Optional<String> apiKeyId`117 - `Optional<String> apiKeyId`

118 118 


124 124 

125 - `Optional<Long> inputAudioTokens`125 - `Optional<Long> inputAudioTokens`

126 126 

127 The aggregated number of audio input tokens used, including cached tokens.127 The aggregated number of uncached audio input tokens used.

128 

129 - `Optional<Long> inputCacheWriteTokens`

130 

131 The aggregated number of input tokens written to the cache.

132 

133 - `Optional<Long> inputCachedAudioTokens`

134 

135 The aggregated number of cached audio input tokens used.

136 

137 - `Optional<Long> inputCachedImageTokens`

138 

139 The aggregated number of cached image input tokens used.

140 

141 - `Optional<Long> inputCachedTextTokens`

142 

143 The aggregated number of cached text input tokens used.

128 144 

129 - `Optional<Long> inputCachedTokens`145 - `Optional<Long> inputCachedTokens`

130 146 

131 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.147 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

148 

149 - `Optional<Long> inputImageTokens`

150 

151 The aggregated number of uncached image input tokens used.

152 

153 - `Optional<Long> inputTextTokens`

154 

155 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

156 

157 - `Optional<Long> inputUncachedTokens`

158 

159 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

132 160 

133 - `Optional<String> model`161 - `Optional<String> model`

134 162 


138 166 

139 The aggregated number of audio output tokens used.167 The aggregated number of audio output tokens used.

140 168 

169 - `Optional<Long> outputImageTokens`

170 

171 The aggregated number of image output tokens used.

172 

173 - `Optional<Long> outputTextTokens`

174 

175 The aggregated number of text output tokens used.

176 

141 - `Optional<String> projectId`177 - `Optional<String> projectId`

142 178 

143 When `group_by=project_id`, this field provides the project ID of the grouped usage result.179 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


501 "api_key_id": "api_key_id",537 "api_key_id": "api_key_id",

502 "batch": true,538 "batch": true,

503 "input_audio_tokens": 0,539 "input_audio_tokens": 0,

540 "input_cache_write_tokens": 0,

541 "input_cached_audio_tokens": 0,

542 "input_cached_image_tokens": 0,

543 "input_cached_text_tokens": 0,

504 "input_cached_tokens": 0,544 "input_cached_tokens": 0,

545 "input_image_tokens": 0,

546 "input_text_tokens": 0,

547 "input_uncached_tokens": 0,

505 "model": "model",548 "model": "model",

506 "output_audio_tokens": 0,549 "output_audio_tokens": 0,

550 "output_image_tokens": 0,

551 "output_text_tokens": 0,

507 "project_id": "project_id",552 "project_id": "project_id",

508 "service_tier": "service_tier",553 "service_tier": "service_tier",

509 "user_id": "user_id"554 "user_id": "user_id"

Details

1394 1394 

1395 - `OUTPUT_TEXT("output_text")`1395 - `OUTPUT_TEXT("output_text")`

1396 1396 

1397 - `Optional<Annotations> annotations`1397 - `Optional<List<Annotation>> annotations`

1398 1398 

1399 Citations associated with the text content.1399 Citations associated with the text content.

1400 1400 

1401 - `List<BetaFileCitationParam>`1401 - `class FileCitation:`

1402 1402 

1403 - `String fileId`1403 - `String fileId`

1404 1404 


1418 1418 

1419 - `FILE_CITATION("file_citation")`1419 - `FILE_CITATION("file_citation")`

1420 1420 

1421 - `List<BetaUrlCitationParam>`1421 - `class UrlCitation:`

1422 1422 

1423 - `long endIndex`1423 - `long endIndex`

1424 1424 


1442 1442 

1443 The URL of the cited resource.1443 The URL of the cited resource.

1444 1444 

1445 - `List<BetaContainerFileCitationParam>`1445 - `class ContainerFileCitation:`

1446 1446 

1447 - `String containerId`1447 - `String containerId`

1448 1448 


2787 2787 

2788 - `Optional<String> encryptedContent`2788 - `Optional<String> encryptedContent`

2789 2789 

2790 The encrypted content of the reasoning item - populated when a response is2790 The encrypted content of the reasoning item. This is populated by default

2791 generated with `reasoning.encrypted_content` in the `include` parameter.2791 for reasoning items returned by `POST /v1/responses` and WebSocket

2792 `response.create` requests.

2792 2793 

2793 - `Optional<Status> status`2794 - `Optional<Status> status`

2794 2795 

Details

1508 1508 

1509 - `OUTPUT_TEXT("output_text")`1509 - `OUTPUT_TEXT("output_text")`

1510 1510 

1511 - `Optional<Annotations> annotations`1511 - `Optional<List<Annotation>> annotations`

1512 1512 

1513 Citations associated with the text content.1513 Citations associated with the text content.

1514 1514 

1515 - `List<BetaFileCitationParam>`1515 - `class FileCitation:`

1516 1516 

1517 - `String fileId`1517 - `String fileId`

1518 1518 


1532 1532 

1533 - `FILE_CITATION("file_citation")`1533 - `FILE_CITATION("file_citation")`

1534 1534 

1535 - `List<BetaUrlCitationParam>`1535 - `class UrlCitation:`

1536 1536 

1537 - `long endIndex`1537 - `long endIndex`

1538 1538 


1556 1556 

1557 The URL of the cited resource.1557 The URL of the cited resource.

1558 1558 

1559 - `List<BetaContainerFileCitationParam>`1559 - `class ContainerFileCitation:`

1560 1560 

1561 - `String containerId`1561 - `String containerId`

1562 1562 


2901 2901 

2902 - `Optional<String> encryptedContent`2902 - `Optional<String> encryptedContent`

2903 2903 

2904 The encrypted content of the reasoning item - populated when a response is2904 The encrypted content of the reasoning item. This is populated by default

2905 generated with `reasoning.encrypted_content` in the `include` parameter.2905 for reasoning items returned by `POST /v1/responses` and WebSocket

2906 `response.create` requests.

2906 2907 

2907 - `Optional<Status> status`2908 - `Optional<Status> status`

2908 2909 


5242 5243 

5243 - `Optional<String> encryptedContent`5244 - `Optional<String> encryptedContent`

5244 5245 

5245 The encrypted content of the reasoning item - populated when a response is5246 The encrypted content of the reasoning item. This is populated by default

5246 generated with `reasoning.encrypted_content` in the `include` parameter.5247 for reasoning items returned by `POST /v1/responses` and WebSocket

5248 `response.create` requests.

5247 5249 

5248 - `Optional<Status> status`5250 - `Optional<Status> status`

5249 5251 

Details

1386 1386 

1387 - `OUTPUT_TEXT("output_text")`1387 - `OUTPUT_TEXT("output_text")`

1388 1388 

1389 - `Optional<Annotations> annotations`1389 - `Optional<List<Annotation>> annotations`

1390 1390 

1391 Citations associated with the text content.1391 Citations associated with the text content.

1392 1392 

1393 - `List<BetaFileCitationParam>`1393 - `class FileCitation:`

1394 1394 

1395 - `String fileId`1395 - `String fileId`

1396 1396 


1410 1410 

1411 - `FILE_CITATION("file_citation")`1411 - `FILE_CITATION("file_citation")`

1412 1412 

1413 - `List<BetaUrlCitationParam>`1413 - `class UrlCitation:`

1414 1414 

1415 - `long endIndex`1415 - `long endIndex`

1416 1416 


1434 1434 

1435 The URL of the cited resource.1435 The URL of the cited resource.

1436 1436 

1437 - `List<BetaContainerFileCitationParam>`1437 - `class ContainerFileCitation:`

1438 1438 

1439 - `String containerId`1439 - `String containerId`

1440 1440 


2779 2779 

2780 - `Optional<String> encryptedContent`2780 - `Optional<String> encryptedContent`

2781 2781 

2782 The encrypted content of the reasoning item - populated when a response is2782 The encrypted content of the reasoning item. This is populated by default

2783 generated with `reasoning.encrypted_content` in the `include` parameter.2783 for reasoning items returned by `POST /v1/responses` and WebSocket

2784 `response.create` requests.

2784 2785 

2785 - `Optional<Status> status`2786 - `Optional<Status> status`

2786 2787 


5905 5906 

5906 - `OUTPUT_TEXT("output_text")`5907 - `OUTPUT_TEXT("output_text")`

5907 5908 

5908 - `Optional<Annotations> annotations`5909 - `Optional<List<Annotation>> annotations`

5909 5910 

5910 Citations associated with the text content.5911 Citations associated with the text content.

5911 5912 

5912 - `List<BetaFileCitationParam>`5913 - `class FileCitation:`

5913 5914 

5914 - `String fileId`5915 - `String fileId`

5915 5916 


5929 5930 

5930 - `FILE_CITATION("file_citation")`5931 - `FILE_CITATION("file_citation")`

5931 5932 

5932 - `List<BetaUrlCitationParam>`5933 - `class UrlCitation:`

5933 5934 

5934 - `long endIndex`5935 - `long endIndex`

5935 5936 


5953 5954 

5954 The URL of the cited resource.5955 The URL of the cited resource.

5955 5956 

5956 - `List<BetaContainerFileCitationParam>`5957 - `class ContainerFileCitation:`

5957 5958 

5958 - `String containerId`5959 - `String containerId`

5959 5960 


7298 7299 

7299 - `Optional<String> encryptedContent`7300 - `Optional<String> encryptedContent`

7300 7301 

7301 The encrypted content of the reasoning item - populated when a response is7302 The encrypted content of the reasoning item. This is populated by default

7302 generated with `reasoning.encrypted_content` in the `include` parameter.7303 for reasoning items returned by `POST /v1/responses` and WebSocket

7304 `response.create` requests.

7303 7305 

7304 - `Optional<Status> status`7306 - `Optional<Status> status`

7305 7307 

Details

1427 1427 

1428 - `OUTPUT_TEXT("output_text")`1428 - `OUTPUT_TEXT("output_text")`

1429 1429 

1430 - `Optional<Annotations> annotations`1430 - `Optional<List<Annotation>> annotations`

1431 1431 

1432 Citations associated with the text content.1432 Citations associated with the text content.

1433 1433 

1434 - `List<BetaFileCitationParam>`1434 - `class FileCitation:`

1435 1435 

1436 - `String fileId`1436 - `String fileId`

1437 1437 


1451 1451 

1452 - `FILE_CITATION("file_citation")`1452 - `FILE_CITATION("file_citation")`

1453 1453 

1454 - `List<BetaUrlCitationParam>`1454 - `class UrlCitation:`

1455 1455 

1456 - `long endIndex`1456 - `long endIndex`

1457 1457 


1475 1475 

1476 The URL of the cited resource.1476 The URL of the cited resource.

1477 1477 

1478 - `List<BetaContainerFileCitationParam>`1478 - `class ContainerFileCitation:`

1479 1479 

1480 - `String containerId`1480 - `String containerId`

1481 1481 


2820 2820 

2821 - `Optional<String> encryptedContent`2821 - `Optional<String> encryptedContent`

2822 2822 

2823 The encrypted content of the reasoning item - populated when a response is2823 The encrypted content of the reasoning item. This is populated by default

2824 generated with `reasoning.encrypted_content` in the `include` parameter.2824 for reasoning items returned by `POST /v1/responses` and WebSocket

2825 `response.create` requests.

2825 2826 

2826 - `Optional<Status> status`2827 - `Optional<Status> status`

2827 2828 

Details

2602 2602 

2603 - `Optional<String> encryptedContent`2603 - `Optional<String> encryptedContent`

2604 2604 

2605 The encrypted content of the reasoning item - populated when a response is2605 The encrypted content of the reasoning item. This is populated by default

2606 generated with `reasoning.encrypted_content` in the `include` parameter.2606 for reasoning items returned by `POST /v1/responses` and WebSocket

2607 `response.create` requests.

2607 2608 

2608 - `Optional<Status> status`2609 - `Optional<Status> status`

2609 2610 

Details

1329 1329 

1330 - `OUTPUT_TEXT("output_text")`1330 - `OUTPUT_TEXT("output_text")`

1331 1331 

1332 - `Optional<Annotations> annotations`1332 - `Optional<List<Annotation>> annotations`

1333 1333 

1334 Citations associated with the text content.1334 Citations associated with the text content.

1335 1335 

1336 - `List<BetaFileCitationParam>`1336 - `class FileCitation:`

1337 1337 

1338 - `String fileId`1338 - `String fileId`

1339 1339 


1353 1353 

1354 - `FILE_CITATION("file_citation")`1354 - `FILE_CITATION("file_citation")`

1355 1355 

1356 - `List<BetaUrlCitationParam>`1356 - `class UrlCitation:`

1357 1357 

1358 - `long endIndex`1358 - `long endIndex`

1359 1359 


1377 1377 

1378 The URL of the cited resource.1378 The URL of the cited resource.

1379 1379 

1380 - `List<BetaContainerFileCitationParam>`1380 - `class ContainerFileCitation:`

1381 1381 

1382 - `String containerId`1382 - `String containerId`

1383 1383 


2722 2722 

2723 - `Optional<String> encryptedContent`2723 - `Optional<String> encryptedContent`

2724 2724 

2725 The encrypted content of the reasoning item - populated when a response is2725 The encrypted content of the reasoning item. This is populated by default

2726 generated with `reasoning.encrypted_content` in the `include` parameter.2726 for reasoning items returned by `POST /v1/responses` and WebSocket

2727 `response.create` requests.

2727 2728 

2728 - `Optional<Status> status`2729 - `Optional<Status> status`

2729 2730 

Details

2491 2491 

2492 - `Optional<String> encryptedContent`2492 - `Optional<String> encryptedContent`

2493 2493 

2494 The encrypted content of the reasoning item - populated when a response is2494 The encrypted content of the reasoning item. This is populated by default

2495 generated with `reasoning.encrypted_content` in the `include` parameter.2495 for reasoning items returned by `POST /v1/responses` and WebSocket

2496 `response.create` requests.

2496 2497 

2497 - `Optional<Status> status`2498 - `Optional<Status> status`

2498 2499 

Details

2514 2514 

2515 - `Optional<String> encryptedContent`2515 - `Optional<String> encryptedContent`

2516 2516 

2517 The encrypted content of the reasoning item - populated when a response is2517 The encrypted content of the reasoning item. This is populated by default

2518 generated with `reasoning.encrypted_content` in the `include` parameter.2518 for reasoning items returned by `POST /v1/responses` and WebSocket

2519 `response.create` requests.

2519 2520 

2520 - `Optional<Status> status`2521 - `Optional<Status> status`

2521 2522 


5781 5782 

5782 - `Optional<String> encryptedContent`5783 - `Optional<String> encryptedContent`

5783 5784 

5784 The encrypted content of the reasoning item - populated when a response is5785 The encrypted content of the reasoning item. This is populated by default

5785 generated with `reasoning.encrypted_content` in the `include` parameter.5786 for reasoning items returned by `POST /v1/responses` and WebSocket

5787 `response.create` requests.

5786 5788 

5787 - `Optional<Status> status`5789 - `Optional<Status> status`

5788 5790 

Details

2468 2468 

2469 - `Optional<String> encryptedContent`2469 - `Optional<String> encryptedContent`

2470 2470 

2471 The encrypted content of the reasoning item - populated when a response is2471 The encrypted content of the reasoning item. This is populated by default

2472 generated with `reasoning.encrypted_content` in the `include` parameter.2472 for reasoning items returned by `POST /v1/responses` and WebSocket

2473 `response.create` requests.

2473 2474 

2474 - `Optional<Status> status`2475 - `Optional<Status> status`

2475 2476 

Details

2443 2443 

2444 - `Optional<String> encryptedContent`2444 - `Optional<String> encryptedContent`

2445 2445 

2446 The encrypted content of the reasoning item - populated when a response is2446 The encrypted content of the reasoning item. This is populated by default

2447 generated with `reasoning.encrypted_content` in the `include` parameter.2447 for reasoning items returned by `POST /v1/responses` and WebSocket

2448 `response.create` requests.

2448 2449 

2449 - `Optional<Status> status`2450 - `Optional<Status> status`

2450 2451 

Details

2577 2577 

2578 - `Optional<String> encryptedContent`2578 - `Optional<String> encryptedContent`

2579 2579 

2580 The encrypted content of the reasoning item - populated when a response is2580 The encrypted content of the reasoning item. This is populated by default

2581 generated with `reasoning.encrypted_content` in the `include` parameter.2581 for reasoning items returned by `POST /v1/responses` and WebSocket

2582 `response.create` requests.

2582 2583 

2583 - `Optional<Status> status`2584 - `Optional<Status> status`

2584 2585 

Details

2691 2691 

2692 - `Optional<String> encryptedContent`2692 - `Optional<String> encryptedContent`

2693 2693 

2694 The encrypted content of the reasoning item - populated when a response is2694 The encrypted content of the reasoning item. This is populated by default

2695 generated with `reasoning.encrypted_content` in the `include` parameter.2695 for reasoning items returned by `POST /v1/responses` and WebSocket

2696 `response.create` requests.

2696 2697 

2697 - `Optional<Status> status`2698 - `Optional<Status> status`

2698 2699 


4739 4740 

4740 - `Optional<String> encryptedContent`4741 - `Optional<String> encryptedContent`

4741 4742 

4742 The encrypted content of the reasoning item - populated when a response is4743 The encrypted content of the reasoning item. This is populated by default

4743 generated with `reasoning.encrypted_content` in the `include` parameter.4744 for reasoning items returned by `POST /v1/responses` and WebSocket

4745 `response.create` requests.

4744 4746 

4745 - `Optional<Status> status`4747 - `Optional<Status> status`

4746 4748 

Details

2569 2569 

2570 - `Optional<String> encryptedContent`2570 - `Optional<String> encryptedContent`

2571 2571 

2572 The encrypted content of the reasoning item - populated when a response is2572 The encrypted content of the reasoning item. This is populated by default

2573 generated with `reasoning.encrypted_content` in the `include` parameter.2573 for reasoning items returned by `POST /v1/responses` and WebSocket

2574 `response.create` requests.

2574 2575 

2575 - `Optional<Status> status`2576 - `Optional<Status> status`

2576 2577 


6453 6454 

6454 - `Optional<String> encryptedContent`6455 - `Optional<String> encryptedContent`

6455 6456 

6456 The encrypted content of the reasoning item - populated when a response is6457 The encrypted content of the reasoning item. This is populated by default

6457 generated with `reasoning.encrypted_content` in the `include` parameter.6458 for reasoning items returned by `POST /v1/responses` and WebSocket

6459 `response.create` requests.

6458 6460 

6459 - `Optional<Status> status`6461 - `Optional<Status> status`

6460 6462 

Details

2610 2610 

2611 - `Optional<String> encryptedContent`2611 - `Optional<String> encryptedContent`

2612 2612 

2613 The encrypted content of the reasoning item - populated when a response is2613 The encrypted content of the reasoning item. This is populated by default

2614 generated with `reasoning.encrypted_content` in the `include` parameter.2614 for reasoning items returned by `POST /v1/responses` and WebSocket

2615 `response.create` requests.

2615 2616 

2616 - `Optional<Status> status`2617 - `Optional<Status> status`

2617 2618 

Details

2382 2382 

2383 - `Optional<String> encryptedContent`2383 - `Optional<String> encryptedContent`

2384 2384 

2385 The encrypted content of the reasoning item - populated when a response is2385 The encrypted content of the reasoning item. This is populated by default

2386 generated with `reasoning.encrypted_content` in the `include` parameter.2386 for reasoning items returned by `POST /v1/responses` and WebSocket

2387 `response.create` requests.

2387 2388 

2388 - `Optional<Status> status`2389 - `Optional<Status> status`

2389 2390 

Details

2512 2512 

2513 - `Optional<String> encryptedContent`2513 - `Optional<String> encryptedContent`

2514 2514 

2515 The encrypted content of the reasoning item - populated when a response is2515 The encrypted content of the reasoning item. This is populated by default

2516 generated with `reasoning.encrypted_content` in the `include` parameter.2516 for reasoning items returned by `POST /v1/responses` and WebSocket

2517 `response.create` requests.

2517 2518 

2518 - `Optional<Status> status`2519 - `Optional<Status> status`

2519 2520 

Details

44 44 

45 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.45 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.

46 46 

47- `event_types: Optional[List[Literal["api_key.created", "api_key.updated", "api_key.deleted", 56 more]]]`47- `event_types: Optional[List[Literal["api_key.created", "api_key.updated", "api_key.deleted", 140 more]]]`

48 48 

49 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).49 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).

50 50 


166 166 

167 - `"user.deleted"`167 - `"user.deleted"`

168 168 

169 - `"tenant.metadata.updated"`

170 

171 - `"tenant.microsoft_entra_mapping.upserted"`

172 

173 - `"tenant.microsoft_entra_mapping.deleted"`

174 

175 - `"tenant.workload_identity.provider.created"`

176 

177 - `"tenant.workload_identity.provider.updated"`

178 

179 - `"tenant.workload_identity.provider.archived"`

180 

181 - `"tenant.workload_identity.mapping.created"`

182 

183 - `"tenant.workload_identity.mapping.updated"`

184 

185 - `"tenant.workload_identity.mapping.archived"`

186 

187 - `"tenant.workload_identity.binding.created"`

188 

189 - `"tenant.workload_identity.principal.provisioned"`

190 

191 - `"tenant.admin_api_key.created"`

192 

193 - `"tenant.admin_api_key.updated"`

194 

195 - `"tenant.admin_api_key.deleted"`

196 

197 - `"tenant.project_api_key.created"`

198 

199 - `"tenant.chatgpt_access_token.revoked"`

200 

201 - `"tenant.migration.completed"`

202 

203 - `"tenant.sso.migrated"`

204 

205 - `"tenant.domains.migrated"`

206 

207 - `"tenant.sso_connection.created"`

208 

209 - `"tenant.sso_connection.updated"`

210 

211 - `"tenant.sso_connection.deleted"`

212 

213 - `"tenant.sso_connection.setup.started"`

214 

215 - `"tenant.policy.created"`

216 

217 - `"tenant.policy.updated"`

218 

219 - `"tenant.policy.deleted"`

220 

221 - `"tenant.policy.attached"`

222 

223 - `"tenant.policy.detached"`

224 

225 - `"tenant.principal_authentication_policy.resolved"`

226 

227 - `"tenant.scim.setup.started"`

228 

229 - `"tenant.scim.deletion.requested"`

230 

231 - `"tenant.scim.directory.created"`

232 

233 - `"tenant.product_access_policy.updated"`

234 

235 - `"tenant.resource_share_grant.created"`

236 

237 - `"tenant.resource_share_grant.updated"`

238 

239 - `"tenant.resource_share_grant.accepted"`

240 

241 - `"tenant.resource_share_grant.declined"`

242 

243 - `"tenant.resource_share_grant.revoked"`

244 

245 - `"tenant.resource_share_grant.deleted"`

246 

247 - `"tenant.service_account.updated"`

248 

249 - `"tenant.service_account.deleted"`

250 

251 - `"tenant.service_account.token.revoked"`

252 

253 - `"tenant.billing.overage_limit.updated"`

254 

255 - `"tenant.billing.alerts.updated"`

256 

257 - `"tenant.billing.info.updated"`

258 

259 - `"tenant.usage_limit.workspace.updated"`

260 

261 - `"tenant.usage_limit.group.updated"`

262 

263 - `"tenant.usage_limit.user.updated"`

264 

265 - `"tenant.usage_limit.increase_request.updated"`

266 

267 - `"tenant.usage_limit.increase_request.resolved"`

268 

269 - `"tenant.group.created"`

270 

271 - `"tenant.group.updated"`

272 

273 - `"tenant.group.deleted"`

274 

275 - `"tenant.group.member.added"`

276 

277 - `"tenant.group.member.removed"`

278 

279 - `"tenant.migration_rollout.status.updated"`

280 

281 - `"tenant.migration_rollout.tier.updated"`

282 

283 - `"tenant.role.metadata.updated"`

284 

285 - `"tenant.custom_role.created"`

286 

287 - `"tenant.custom_role.updated"`

288 

289 - `"tenant.custom_role.deleted"`

290 

291 - `"tenant.role_assignment.created"`

292 

293 - `"tenant.role_assignment.deleted"`

294 

295 - `"tenant.resource_role_assignment.created"`

296 

297 - `"tenant.resource_role_assignment.deleted"`

298 

299 - `"tenant.resource_access.updated"`

300 

301 - `"tenant.resource_access.deleted"`

302 

303 - `"tenant.session_policy.created"`

304 

305 - `"tenant.session_policy.updated"`

306 

307 - `"tenant.session_policy.deleted"`

308 

309 - `"tenant.session_revocation.started"`

310 

311 - `"tenant.third_party_app_policy.updated"`

312 

313 - `"tenant.user.added"`

314 

315 - `"tenant.user.updated"`

316 

317 - `"tenant.user.removed"`

318 

319 - `"tenant.user.looked_up"`

320 

321 - `"tenant.user.invited"`

322 

323 - `"tenant.membership.revoked"`

324 

325 - `"tenant.api_organization_invite.upserted"`

326 

327 - `"tenant.api_organization_invite.deleted"`

328 

329 - `"tenant.chatgpt_workspace_invite.upserted"`

330 

331 - `"tenant.membership.accepted"`

332 

333 - `"tenant.membership.declined"`

334 

335 - `"tenant.workspace_invite_email_settings.updated"`

336 

169- `limit: Optional[int]`337- `limit: Optional[int]`

170 338 

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


196 364 

197 The Unix timestamp (in seconds) of the event.365 The Unix timestamp (in seconds) of the event.

198 366 

199 - `type: Literal["api_key.created", "api_key.updated", "api_key.deleted", 56 more]`367 - `type: Literal["api_key.created", "api_key.updated", "api_key.deleted", 140 more]`

200 368 

201 The event type.369 The event type.

202 370 


318 486 

319 - `"user.deleted"`487 - `"user.deleted"`

320 488 

489 - `"tenant.metadata.updated"`

490 

491 - `"tenant.microsoft_entra_mapping.upserted"`

492 

493 - `"tenant.microsoft_entra_mapping.deleted"`

494 

495 - `"tenant.workload_identity.provider.created"`

496 

497 - `"tenant.workload_identity.provider.updated"`

498 

499 - `"tenant.workload_identity.provider.archived"`

500 

501 - `"tenant.workload_identity.mapping.created"`

502 

503 - `"tenant.workload_identity.mapping.updated"`

504 

505 - `"tenant.workload_identity.mapping.archived"`

506 

507 - `"tenant.workload_identity.binding.created"`

508 

509 - `"tenant.workload_identity.principal.provisioned"`

510 

511 - `"tenant.admin_api_key.created"`

512 

513 - `"tenant.admin_api_key.updated"`

514 

515 - `"tenant.admin_api_key.deleted"`

516 

517 - `"tenant.project_api_key.created"`

518 

519 - `"tenant.chatgpt_access_token.revoked"`

520 

521 - `"tenant.migration.completed"`

522 

523 - `"tenant.sso.migrated"`

524 

525 - `"tenant.domains.migrated"`

526 

527 - `"tenant.sso_connection.created"`

528 

529 - `"tenant.sso_connection.updated"`

530 

531 - `"tenant.sso_connection.deleted"`

532 

533 - `"tenant.sso_connection.setup.started"`

534 

535 - `"tenant.policy.created"`

536 

537 - `"tenant.policy.updated"`

538 

539 - `"tenant.policy.deleted"`

540 

541 - `"tenant.policy.attached"`

542 

543 - `"tenant.policy.detached"`

544 

545 - `"tenant.principal_authentication_policy.resolved"`

546 

547 - `"tenant.scim.setup.started"`

548 

549 - `"tenant.scim.deletion.requested"`

550 

551 - `"tenant.scim.directory.created"`

552 

553 - `"tenant.product_access_policy.updated"`

554 

555 - `"tenant.resource_share_grant.created"`

556 

557 - `"tenant.resource_share_grant.updated"`

558 

559 - `"tenant.resource_share_grant.accepted"`

560 

561 - `"tenant.resource_share_grant.declined"`

562 

563 - `"tenant.resource_share_grant.revoked"`

564 

565 - `"tenant.resource_share_grant.deleted"`

566 

567 - `"tenant.service_account.updated"`

568 

569 - `"tenant.service_account.deleted"`

570 

571 - `"tenant.service_account.token.revoked"`

572 

573 - `"tenant.billing.overage_limit.updated"`

574 

575 - `"tenant.billing.alerts.updated"`

576 

577 - `"tenant.billing.info.updated"`

578 

579 - `"tenant.usage_limit.workspace.updated"`

580 

581 - `"tenant.usage_limit.group.updated"`

582 

583 - `"tenant.usage_limit.user.updated"`

584 

585 - `"tenant.usage_limit.increase_request.updated"`

586 

587 - `"tenant.usage_limit.increase_request.resolved"`

588 

589 - `"tenant.group.created"`

590 

591 - `"tenant.group.updated"`

592 

593 - `"tenant.group.deleted"`

594 

595 - `"tenant.group.member.added"`

596 

597 - `"tenant.group.member.removed"`

598 

599 - `"tenant.migration_rollout.status.updated"`

600 

601 - `"tenant.migration_rollout.tier.updated"`

602 

603 - `"tenant.role.metadata.updated"`

604 

605 - `"tenant.custom_role.created"`

606 

607 - `"tenant.custom_role.updated"`

608 

609 - `"tenant.custom_role.deleted"`

610 

611 - `"tenant.role_assignment.created"`

612 

613 - `"tenant.role_assignment.deleted"`

614 

615 - `"tenant.resource_role_assignment.created"`

616 

617 - `"tenant.resource_role_assignment.deleted"`

618 

619 - `"tenant.resource_access.updated"`

620 

621 - `"tenant.resource_access.deleted"`

622 

623 - `"tenant.session_policy.created"`

624 

625 - `"tenant.session_policy.updated"`

626 

627 - `"tenant.session_policy.deleted"`

628 

629 - `"tenant.session_revocation.started"`

630 

631 - `"tenant.third_party_app_policy.updated"`

632 

633 - `"tenant.user.added"`

634 

635 - `"tenant.user.updated"`

636 

637 - `"tenant.user.removed"`

638 

639 - `"tenant.user.looked_up"`

640 

641 - `"tenant.user.invited"`

642 

643 - `"tenant.membership.revoked"`

644 

645 - `"tenant.api_organization_invite.upserted"`

646 

647 - `"tenant.api_organization_invite.deleted"`

648 

649 - `"tenant.chatgpt_workspace_invite.upserted"`

650 

651 - `"tenant.membership.accepted"`

652 

653 - `"tenant.membership.declined"`

654 

655 - `"tenant.workspace_invite_email_settings.updated"`

656 

321 - `actor: Optional[Actor]`657 - `actor: Optional[Actor]`

322 658 

323 The actor who performed the audit logged action.659 The actor who performed the audit logged action.

Details

4 4 

5**post** `/organization/projects/{project_id}/service_accounts`5**post** `/organization/projects/{project_id}/service_accounts`

6 6 

7Creates a new service account in the project. This also returns an unredacted API key for the service account.7Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

8 8 

9### Parameters9### Parameters

10 10 


14 14 

15 The name of the service account being created.15 The name of the service account being created.

16 16 

17- `create_service_account_only: Optional[bool]`

18 

19 Create the service account without default roles or an API key.

20 

17### Returns21### Returns

18 22 

19- `class ServiceAccountCreateResponse: …`23- `class ServiceAccountCreateResponse: …`


44 48 

45 - `"organization.project.service_account"`49 - `"organization.project.service_account"`

46 50 

47 - `role: Literal["member"]`51 - `role: Literal["member", "none"]`

48 52 

49 Service accounts can only have one role of type `member`53 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

50 54 

51 - `"member"`55 - `"member"`

52 56 

57 - `"none"`

58 

53### Example59### Example

54 60 

55```python61```python

Details

42 42 

43 - `"organization.project.service_account"`43 - `"organization.project.service_account"`

44 44 

45 - `role: Literal["owner", "member"]`45 - `role: Literal["owner", "member", "none"]`

46 46 

47 `owner` or `member`47 `owner`, `member`, or `none`

48 48 

49 - `"owner"`49 - `"owner"`

50 50 

51 - `"member"`51 - `"member"`

52 52 

53 - `"none"`

54 

53### Example55### Example

54 56 

55```python57```python

Details

36 36 

37 - `"organization.project.service_account"`37 - `"organization.project.service_account"`

38 38 

39 - `role: Literal["owner", "member"]`39 - `role: Literal["owner", "member", "none"]`

40 40 

41 `owner` or `member`41 `owner`, `member`, or `none`

42 42 

43 - `"owner"`43 - `"owner"`

44 44 

45 - `"member"`45 - `"member"`

46 46 

47 - `"none"`

48 

47### Example49### Example

48 50 

49```python51```python

Details

48 48 

49 - `"organization.project.service_account"`49 - `"organization.project.service_account"`

50 50 

51 - `role: Literal["owner", "member"]`51 - `role: Literal["owner", "member", "none"]`

52 52 

53 `owner` or `member`53 `owner`, `member`, or `none`

54 54 

55 - `"owner"`55 - `"owner"`

56 56 

57 - `"member"`57 - `"member"`

58 58 

59 - `"none"`

60 

59### Example61### Example

60 62 

61```python63```python

Details

1## Create project service account API key

2 

3`admin.organization.projects.service_accounts.api_keys.create(strservice_account_id, APIKeyCreateParams**kwargs) -> APIKeyCreateResponse`

4 

5**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

6 

7Creates an API key for a service account in the project.

8 

9### Parameters

10 

11- `project_id: str`

12 

13- `service_account_id: str`

14 

15- `name: Optional[str]`

16 

17 API key name.

18 

19- `scopes: Optional[Sequence[str]]`

20 

21 API key scopes.

22 

23### Returns

24 

25- `class APIKeyCreateResponse: …`

26 

27 - `id: str`

28 

29 - `created_at: int`

30 

31 - `name: str`

32 

33 - `object: Literal["organization.project.service_account.api_key"]`

34 

35 The object type, which is always `organization.project.service_account.api_key`

36 

37 - `"organization.project.service_account.api_key"`

38 

39 - `value: str`

40 

41### Example

42 

43```python

44import os

45from openai import OpenAI

46 

47client = OpenAI(

48 admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"), # This is the default and can be omitted

49)

50api_key = client.admin.organization.projects.service_accounts.api_keys.create(

51 service_account_id="service_account_id",

52 project_id="project_id",

53)

54print(api_key.id)

55```

56 

57#### Response

58 

59```json

60{

61 "id": "id",

62 "created_at": 0,

63 "name": "name",

64 "object": "organization.project.service_account.api_key",

65 "value": "value"

66}

67```

Details

86 86 

87 - `input_tokens: int`87 - `input_tokens: int`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: int`91 - `num_model_requests: int`

92 92 


98 98 

99 - `output_tokens: int`99 - `output_tokens: int`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: Optional[str]`103 - `api_key_id: Optional[str]`

104 104 


110 110 

111 - `input_audio_tokens: Optional[int]`111 - `input_audio_tokens: Optional[int]`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Optional[int]`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Optional[int]`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Optional[int]`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Optional[int]`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Optional[int]`131 - `input_cached_tokens: Optional[int]`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Optional[int]`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Optional[int]`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Optional[int]`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: Optional[str]`147 - `model: Optional[str]`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Optional[int]`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Optional[int]`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: Optional[str]`163 - `project_id: Optional[str]`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


478 "api_key_id": "api_key_id",514 "api_key_id": "api_key_id",

479 "batch": true,515 "batch": true,

480 "input_audio_tokens": 0,516 "input_audio_tokens": 0,

517 "input_cache_write_tokens": 0,

518 "input_cached_audio_tokens": 0,

519 "input_cached_image_tokens": 0,

520 "input_cached_text_tokens": 0,

481 "input_cached_tokens": 0,521 "input_cached_tokens": 0,

522 "input_image_tokens": 0,

523 "input_text_tokens": 0,

524 "input_uncached_tokens": 0,

482 "model": "model",525 "model": "model",

483 "output_audio_tokens": 0,526 "output_audio_tokens": 0,

527 "output_image_tokens": 0,

528 "output_text_tokens": 0,

484 "project_id": "project_id",529 "project_id": "project_id",

485 "service_tier": "service_tier",530 "service_tier": "service_tier",

486 "user_id": "user_id"531 "user_id": "user_id"

Details

86 86 

87 - `input_tokens: int`87 - `input_tokens: int`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: int`91 - `num_model_requests: int`

92 92 


98 98 

99 - `output_tokens: int`99 - `output_tokens: int`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: Optional[str]`103 - `api_key_id: Optional[str]`

104 104 


110 110 

111 - `input_audio_tokens: Optional[int]`111 - `input_audio_tokens: Optional[int]`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Optional[int]`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Optional[int]`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Optional[int]`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Optional[int]`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Optional[int]`131 - `input_cached_tokens: Optional[int]`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Optional[int]`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Optional[int]`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Optional[int]`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: Optional[str]`147 - `model: Optional[str]`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Optional[int]`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Optional[int]`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: Optional[str]`163 - `project_id: Optional[str]`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


478 "api_key_id": "api_key_id",514 "api_key_id": "api_key_id",

479 "batch": true,515 "batch": true,

480 "input_audio_tokens": 0,516 "input_audio_tokens": 0,

517 "input_cache_write_tokens": 0,

518 "input_cached_audio_tokens": 0,

519 "input_cached_image_tokens": 0,

520 "input_cached_text_tokens": 0,

481 "input_cached_tokens": 0,521 "input_cached_tokens": 0,

522 "input_image_tokens": 0,

523 "input_text_tokens": 0,

524 "input_uncached_tokens": 0,

482 "model": "model",525 "model": "model",

483 "output_audio_tokens": 0,526 "output_audio_tokens": 0,

527 "output_image_tokens": 0,

528 "output_text_tokens": 0,

484 "project_id": "project_id",529 "project_id": "project_id",

485 "service_tier": "service_tier",530 "service_tier": "service_tier",

486 "user_id": "user_id"531 "user_id": "user_id"

Details

68 68 

69 - `input_tokens: int`69 - `input_tokens: int`

70 70 

71 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `num_model_requests: int`73 - `num_model_requests: int`

74 74 


80 80 

81 - `output_tokens: int`81 - `output_tokens: int`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: Optional[str]`85 - `api_key_id: Optional[str]`

86 86 


92 92 

93 - `input_audio_tokens: Optional[int]`93 - `input_audio_tokens: Optional[int]`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: Optional[int]`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: Optional[int]`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: Optional[int]`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: Optional[int]`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: Optional[int]`113 - `input_cached_tokens: Optional[int]`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: Optional[int]`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: Optional[int]`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: Optional[int]`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: Optional[str]`129 - `model: Optional[str]`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: Optional[int]`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: Optional[int]`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: Optional[str]`145 - `project_id: Optional[str]`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


460 "api_key_id": "api_key_id",496 "api_key_id": "api_key_id",

461 "batch": true,497 "batch": true,

462 "input_audio_tokens": 0,498 "input_audio_tokens": 0,

499 "input_cache_write_tokens": 0,

500 "input_cached_audio_tokens": 0,

501 "input_cached_image_tokens": 0,

502 "input_cached_text_tokens": 0,

463 "input_cached_tokens": 0,503 "input_cached_tokens": 0,

504 "input_image_tokens": 0,

505 "input_text_tokens": 0,

506 "input_uncached_tokens": 0,

464 "model": "model",507 "model": "model",

465 "output_audio_tokens": 0,508 "output_audio_tokens": 0,

509 "output_image_tokens": 0,

510 "output_text_tokens": 0,

466 "project_id": "project_id",511 "project_id": "project_id",

467 "service_tier": "service_tier",512 "service_tier": "service_tier",

468 "user_id": "user_id"513 "user_id": "user_id"

Details

94 94 

95 - `input_tokens: int`95 - `input_tokens: int`

96 96 

97 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `num_model_requests: int`99 - `num_model_requests: int`

100 100 


106 106 

107 - `output_tokens: int`107 - `output_tokens: int`

108 108 

109 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.109 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

110 110 

111 - `api_key_id: Optional[str]`111 - `api_key_id: Optional[str]`

112 112 


118 118 

119 - `input_audio_tokens: Optional[int]`119 - `input_audio_tokens: Optional[int]`

120 120 

121 The aggregated number of audio input tokens used, including cached tokens.121 The aggregated number of uncached audio input tokens used.

122 

123 - `input_cache_write_tokens: Optional[int]`

124 

125 The aggregated number of input tokens written to the cache.

126 

127 - `input_cached_audio_tokens: Optional[int]`

128 

129 The aggregated number of cached audio input tokens used.

130 

131 - `input_cached_image_tokens: Optional[int]`

132 

133 The aggregated number of cached image input tokens used.

134 

135 - `input_cached_text_tokens: Optional[int]`

136 

137 The aggregated number of cached text input tokens used.

122 138 

123 - `input_cached_tokens: Optional[int]`139 - `input_cached_tokens: Optional[int]`

124 140 

125 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.141 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

142 

143 - `input_image_tokens: Optional[int]`

144 

145 The aggregated number of uncached image input tokens used.

146 

147 - `input_text_tokens: Optional[int]`

148 

149 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

150 

151 - `input_uncached_tokens: Optional[int]`

152 

153 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

126 154 

127 - `model: Optional[str]`155 - `model: Optional[str]`

128 156 


132 160 

133 The aggregated number of audio output tokens used.161 The aggregated number of audio output tokens used.

134 162 

163 - `output_image_tokens: Optional[int]`

164 

165 The aggregated number of image output tokens used.

166 

167 - `output_text_tokens: Optional[int]`

168 

169 The aggregated number of text output tokens used.

170 

135 - `project_id: Optional[str]`171 - `project_id: Optional[str]`

136 172 

137 When `group_by=project_id`, this field provides the project ID of the grouped usage result.173 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


486 "api_key_id": "api_key_id",522 "api_key_id": "api_key_id",

487 "batch": true,523 "batch": true,

488 "input_audio_tokens": 0,524 "input_audio_tokens": 0,

525 "input_cache_write_tokens": 0,

526 "input_cached_audio_tokens": 0,

527 "input_cached_image_tokens": 0,

528 "input_cached_text_tokens": 0,

489 "input_cached_tokens": 0,529 "input_cached_tokens": 0,

530 "input_image_tokens": 0,

531 "input_text_tokens": 0,

532 "input_uncached_tokens": 0,

490 "model": "model",533 "model": "model",

491 "output_audio_tokens": 0,534 "output_audio_tokens": 0,

535 "output_image_tokens": 0,

536 "output_text_tokens": 0,

492 "project_id": "project_id",537 "project_id": "project_id",

493 "service_tier": "service_tier",538 "service_tier": "service_tier",

494 "user_id": "user_id"539 "user_id": "user_id"

Details

68 68 

69 - `input_tokens: int`69 - `input_tokens: int`

70 70 

71 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `num_model_requests: int`73 - `num_model_requests: int`

74 74 


80 80 

81 - `output_tokens: int`81 - `output_tokens: int`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: Optional[str]`85 - `api_key_id: Optional[str]`

86 86 


92 92 

93 - `input_audio_tokens: Optional[int]`93 - `input_audio_tokens: Optional[int]`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: Optional[int]`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: Optional[int]`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: Optional[int]`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: Optional[int]`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: Optional[int]`113 - `input_cached_tokens: Optional[int]`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: Optional[int]`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: Optional[int]`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: Optional[int]`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: Optional[str]`129 - `model: Optional[str]`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: Optional[int]`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: Optional[int]`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: Optional[str]`145 - `project_id: Optional[str]`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


460 "api_key_id": "api_key_id",496 "api_key_id": "api_key_id",

461 "batch": true,497 "batch": true,

462 "input_audio_tokens": 0,498 "input_audio_tokens": 0,

499 "input_cache_write_tokens": 0,

500 "input_cached_audio_tokens": 0,

501 "input_cached_image_tokens": 0,

502 "input_cached_text_tokens": 0,

463 "input_cached_tokens": 0,503 "input_cached_tokens": 0,

504 "input_image_tokens": 0,

505 "input_text_tokens": 0,

506 "input_uncached_tokens": 0,

464 "model": "model",507 "model": "model",

465 "output_audio_tokens": 0,508 "output_audio_tokens": 0,

509 "output_image_tokens": 0,

510 "output_text_tokens": 0,

466 "project_id": "project_id",511 "project_id": "project_id",

467 "service_tier": "service_tier",512 "service_tier": "service_tier",

468 "user_id": "user_id"513 "user_id": "user_id"

Details

86 86 

87 - `input_tokens: int`87 - `input_tokens: int`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: int`91 - `num_model_requests: int`

92 92 


98 98 

99 - `output_tokens: int`99 - `output_tokens: int`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: Optional[str]`103 - `api_key_id: Optional[str]`

104 104 


110 110 

111 - `input_audio_tokens: Optional[int]`111 - `input_audio_tokens: Optional[int]`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Optional[int]`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Optional[int]`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Optional[int]`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Optional[int]`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Optional[int]`131 - `input_cached_tokens: Optional[int]`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Optional[int]`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Optional[int]`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Optional[int]`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: Optional[str]`147 - `model: Optional[str]`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Optional[int]`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Optional[int]`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: Optional[str]`163 - `project_id: Optional[str]`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


478 "api_key_id": "api_key_id",514 "api_key_id": "api_key_id",

479 "batch": true,515 "batch": true,

480 "input_audio_tokens": 0,516 "input_audio_tokens": 0,

517 "input_cache_write_tokens": 0,

518 "input_cached_audio_tokens": 0,

519 "input_cached_image_tokens": 0,

520 "input_cached_text_tokens": 0,

481 "input_cached_tokens": 0,521 "input_cached_tokens": 0,

522 "input_image_tokens": 0,

523 "input_text_tokens": 0,

524 "input_uncached_tokens": 0,

482 "model": "model",525 "model": "model",

483 "output_audio_tokens": 0,526 "output_audio_tokens": 0,

527 "output_image_tokens": 0,

528 "output_text_tokens": 0,

484 "project_id": "project_id",529 "project_id": "project_id",

485 "service_tier": "service_tier",530 "service_tier": "service_tier",

486 "user_id": "user_id"531 "user_id": "user_id"

Details

86 86 

87 - `input_tokens: int`87 - `input_tokens: int`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: int`91 - `num_model_requests: int`

92 92 


98 98 

99 - `output_tokens: int`99 - `output_tokens: int`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: Optional[str]`103 - `api_key_id: Optional[str]`

104 104 


110 110 

111 - `input_audio_tokens: Optional[int]`111 - `input_audio_tokens: Optional[int]`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Optional[int]`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Optional[int]`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Optional[int]`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Optional[int]`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Optional[int]`131 - `input_cached_tokens: Optional[int]`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Optional[int]`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Optional[int]`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Optional[int]`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: Optional[str]`147 - `model: Optional[str]`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Optional[int]`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Optional[int]`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: Optional[str]`163 - `project_id: Optional[str]`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


478 "api_key_id": "api_key_id",514 "api_key_id": "api_key_id",

479 "batch": true,515 "batch": true,

480 "input_audio_tokens": 0,516 "input_audio_tokens": 0,

517 "input_cache_write_tokens": 0,

518 "input_cached_audio_tokens": 0,

519 "input_cached_image_tokens": 0,

520 "input_cached_text_tokens": 0,

481 "input_cached_tokens": 0,521 "input_cached_tokens": 0,

522 "input_image_tokens": 0,

523 "input_text_tokens": 0,

524 "input_uncached_tokens": 0,

482 "model": "model",525 "model": "model",

483 "output_audio_tokens": 0,526 "output_audio_tokens": 0,

527 "output_image_tokens": 0,

528 "output_text_tokens": 0,

484 "project_id": "project_id",529 "project_id": "project_id",

485 "service_tier": "service_tier",530 "service_tier": "service_tier",

486 "user_id": "user_id"531 "user_id": "user_id"

Details

114 114 

115 - `input_tokens: int`115 - `input_tokens: int`

116 116 

117 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 118 

119 - `num_model_requests: int`119 - `num_model_requests: int`

120 120 


126 126 

127 - `output_tokens: int`127 - `output_tokens: int`

128 128 

129 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 130 

131 - `api_key_id: Optional[str]`131 - `api_key_id: Optional[str]`

132 132 


138 138 

139 - `input_audio_tokens: Optional[int]`139 - `input_audio_tokens: Optional[int]`

140 140 

141 The aggregated number of audio input tokens used, including cached tokens.141 The aggregated number of uncached audio input tokens used.

142 

143 - `input_cache_write_tokens: Optional[int]`

144 

145 The aggregated number of input tokens written to the cache.

146 

147 - `input_cached_audio_tokens: Optional[int]`

148 

149 The aggregated number of cached audio input tokens used.

150 

151 - `input_cached_image_tokens: Optional[int]`

152 

153 The aggregated number of cached image input tokens used.

154 

155 - `input_cached_text_tokens: Optional[int]`

156 

157 The aggregated number of cached text input tokens used.

142 158 

143 - `input_cached_tokens: Optional[int]`159 - `input_cached_tokens: Optional[int]`

144 160 

145 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.161 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

162 

163 - `input_image_tokens: Optional[int]`

164 

165 The aggregated number of uncached image input tokens used.

166 

167 - `input_text_tokens: Optional[int]`

168 

169 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

170 

171 - `input_uncached_tokens: Optional[int]`

172 

173 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

146 174 

147 - `model: Optional[str]`175 - `model: Optional[str]`

148 176 


152 180 

153 The aggregated number of audio output tokens used.181 The aggregated number of audio output tokens used.

154 182 

183 - `output_image_tokens: Optional[int]`

184 

185 The aggregated number of image output tokens used.

186 

187 - `output_text_tokens: Optional[int]`

188 

189 The aggregated number of text output tokens used.

190 

155 - `project_id: Optional[str]`191 - `project_id: Optional[str]`

156 192 

157 When `group_by=project_id`, this field provides the project ID of the grouped usage result.193 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


506 "api_key_id": "api_key_id",542 "api_key_id": "api_key_id",

507 "batch": true,543 "batch": true,

508 "input_audio_tokens": 0,544 "input_audio_tokens": 0,

545 "input_cache_write_tokens": 0,

546 "input_cached_audio_tokens": 0,

547 "input_cached_image_tokens": 0,

548 "input_cached_text_tokens": 0,

509 "input_cached_tokens": 0,549 "input_cached_tokens": 0,

550 "input_image_tokens": 0,

551 "input_text_tokens": 0,

552 "input_uncached_tokens": 0,

510 "model": "model",553 "model": "model",

511 "output_audio_tokens": 0,554 "output_audio_tokens": 0,

555 "output_image_tokens": 0,

556 "output_text_tokens": 0,

512 "project_id": "project_id",557 "project_id": "project_id",

513 "service_tier": "service_tier",558 "service_tier": "service_tier",

514 "user_id": "user_id"559 "user_id": "user_id"

Details

86 86 

87 - `input_tokens: int`87 - `input_tokens: int`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: int`91 - `num_model_requests: int`

92 92 


98 98 

99 - `output_tokens: int`99 - `output_tokens: int`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: Optional[str]`103 - `api_key_id: Optional[str]`

104 104 


110 110 

111 - `input_audio_tokens: Optional[int]`111 - `input_audio_tokens: Optional[int]`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Optional[int]`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Optional[int]`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Optional[int]`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Optional[int]`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Optional[int]`131 - `input_cached_tokens: Optional[int]`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Optional[int]`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Optional[int]`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Optional[int]`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: Optional[str]`147 - `model: Optional[str]`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Optional[int]`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Optional[int]`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: Optional[str]`163 - `project_id: Optional[str]`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


478 "api_key_id": "api_key_id",514 "api_key_id": "api_key_id",

479 "batch": true,515 "batch": true,

480 "input_audio_tokens": 0,516 "input_audio_tokens": 0,

517 "input_cache_write_tokens": 0,

518 "input_cached_audio_tokens": 0,

519 "input_cached_image_tokens": 0,

520 "input_cached_text_tokens": 0,

481 "input_cached_tokens": 0,521 "input_cached_tokens": 0,

522 "input_image_tokens": 0,

523 "input_text_tokens": 0,

524 "input_uncached_tokens": 0,

482 "model": "model",525 "model": "model",

483 "output_audio_tokens": 0,526 "output_audio_tokens": 0,

527 "output_image_tokens": 0,

528 "output_text_tokens": 0,

484 "project_id": "project_id",529 "project_id": "project_id",

485 "service_tier": "service_tier",530 "service_tier": "service_tier",

486 "user_id": "user_id"531 "user_id": "user_id"

Details

68 68 

69 - `input_tokens: int`69 - `input_tokens: int`

70 70 

71 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `num_model_requests: int`73 - `num_model_requests: int`

74 74 


80 80 

81 - `output_tokens: int`81 - `output_tokens: int`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: Optional[str]`85 - `api_key_id: Optional[str]`

86 86 


92 92 

93 - `input_audio_tokens: Optional[int]`93 - `input_audio_tokens: Optional[int]`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: Optional[int]`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: Optional[int]`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: Optional[int]`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: Optional[int]`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: Optional[int]`113 - `input_cached_tokens: Optional[int]`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: Optional[int]`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: Optional[int]`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: Optional[int]`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: Optional[str]`129 - `model: Optional[str]`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: Optional[int]`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: Optional[int]`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: Optional[str]`145 - `project_id: Optional[str]`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


460 "api_key_id": "api_key_id",496 "api_key_id": "api_key_id",

461 "batch": true,497 "batch": true,

462 "input_audio_tokens": 0,498 "input_audio_tokens": 0,

499 "input_cache_write_tokens": 0,

500 "input_cached_audio_tokens": 0,

501 "input_cached_image_tokens": 0,

502 "input_cached_text_tokens": 0,

463 "input_cached_tokens": 0,503 "input_cached_tokens": 0,

504 "input_image_tokens": 0,

505 "input_text_tokens": 0,

506 "input_uncached_tokens": 0,

464 "model": "model",507 "model": "model",

465 "output_audio_tokens": 0,508 "output_audio_tokens": 0,

509 "output_image_tokens": 0,

510 "output_text_tokens": 0,

466 "project_id": "project_id",511 "project_id": "project_id",

467 "service_tier": "service_tier",512 "service_tier": "service_tier",

468 "user_id": "user_id"513 "user_id": "user_id"

Details

98 98 

99 - `input_tokens: int`99 - `input_tokens: int`

100 100 

101 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `num_model_requests: int`103 - `num_model_requests: int`

104 104 


110 110 

111 - `output_tokens: int`111 - `output_tokens: int`

112 112 

113 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.113 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

114 114 

115 - `api_key_id: Optional[str]`115 - `api_key_id: Optional[str]`

116 116 


122 122 

123 - `input_audio_tokens: Optional[int]`123 - `input_audio_tokens: Optional[int]`

124 124 

125 The aggregated number of audio input tokens used, including cached tokens.125 The aggregated number of uncached audio input tokens used.

126 

127 - `input_cache_write_tokens: Optional[int]`

128 

129 The aggregated number of input tokens written to the cache.

130 

131 - `input_cached_audio_tokens: Optional[int]`

132 

133 The aggregated number of cached audio input tokens used.

134 

135 - `input_cached_image_tokens: Optional[int]`

136 

137 The aggregated number of cached image input tokens used.

138 

139 - `input_cached_text_tokens: Optional[int]`

140 

141 The aggregated number of cached text input tokens used.

126 142 

127 - `input_cached_tokens: Optional[int]`143 - `input_cached_tokens: Optional[int]`

128 144 

129 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.145 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

146 

147 - `input_image_tokens: Optional[int]`

148 

149 The aggregated number of uncached image input tokens used.

150 

151 - `input_text_tokens: Optional[int]`

152 

153 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

154 

155 - `input_uncached_tokens: Optional[int]`

156 

157 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

130 158 

131 - `model: Optional[str]`159 - `model: Optional[str]`

132 160 


136 164 

137 The aggregated number of audio output tokens used.165 The aggregated number of audio output tokens used.

138 166 

167 - `output_image_tokens: Optional[int]`

168 

169 The aggregated number of image output tokens used.

170 

171 - `output_text_tokens: Optional[int]`

172 

173 The aggregated number of text output tokens used.

174 

139 - `project_id: Optional[str]`175 - `project_id: Optional[str]`

140 176 

141 When `group_by=project_id`, this field provides the project ID of the grouped usage result.177 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


490 "api_key_id": "api_key_id",526 "api_key_id": "api_key_id",

491 "batch": true,527 "batch": true,

492 "input_audio_tokens": 0,528 "input_audio_tokens": 0,

529 "input_cache_write_tokens": 0,

530 "input_cached_audio_tokens": 0,

531 "input_cached_image_tokens": 0,

532 "input_cached_text_tokens": 0,

493 "input_cached_tokens": 0,533 "input_cached_tokens": 0,

534 "input_image_tokens": 0,

535 "input_text_tokens": 0,

536 "input_uncached_tokens": 0,

494 "model": "model",537 "model": "model",

495 "output_audio_tokens": 0,538 "output_audio_tokens": 0,

539 "output_image_tokens": 0,

540 "output_text_tokens": 0,

496 "project_id": "project_id",541 "project_id": "project_id",

497 "service_tier": "service_tier",542 "service_tier": "service_tier",

498 "user_id": "user_id"543 "user_id": "user_id"

Details

1448 1448 

1449 - `"output_text"`1449 - `"output_text"`

1450 1450 

1451 - `annotations: Optional[Union[List[MultiAgentCallOutputOutputAnnotationsUnionMember0], List[MultiAgentCallOutputOutputAnnotationsUnionMember1], List[MultiAgentCallOutputOutputAnnotationsUnionMember2], null]]`1451 - `annotations: Optional[List[MultiAgentCallOutputOutputAnnotation]]`

1452 1452 

1453 Citations associated with the text content.1453 Citations associated with the text content.

1454 1454 

1455 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember0]`1455 - `class MultiAgentCallOutputOutputAnnotationFileCitation: …`

1456 1456 

1457 - `file_id: str`1457 - `file_id: str`

1458 1458 


1472 1472 

1473 - `"file_citation"`1473 - `"file_citation"`

1474 1474 

1475 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember1]`1475 - `class MultiAgentCallOutputOutputAnnotationURLCitation: …`

1476 1476 

1477 - `end_index: int`1477 - `end_index: int`

1478 1478 


1496 1496 

1497 The URL of the cited resource.1497 The URL of the cited resource.

1498 1498 

1499 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember2]`1499 - `class MultiAgentCallOutputOutputAnnotationContainerFileCitation: …`

1500 1500 

1501 - `container_id: str`1501 - `container_id: str`

1502 1502 


2877 2877 

2878 - `encrypted_content: Optional[str]`2878 - `encrypted_content: Optional[str]`

2879 2879 

2880 The encrypted content of the reasoning item - populated when a response is2880 The encrypted content of the reasoning item. This is populated by default

2881 generated with `reasoning.encrypted_content` in the `include` parameter.2881 for reasoning items returned by `POST /v1/responses` and WebSocket

2882 `response.create` requests.

2882 2883 

2883 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2884 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2884 2885 

Details

1562 1562 

1563 - `"output_text"`1563 - `"output_text"`

1564 1564 

1565 - `annotations: Optional[Union[List[MultiAgentCallOutputOutputAnnotationsUnionMember0], List[MultiAgentCallOutputOutputAnnotationsUnionMember1], List[MultiAgentCallOutputOutputAnnotationsUnionMember2], null]]`1565 - `annotations: Optional[List[MultiAgentCallOutputOutputAnnotation]]`

1566 1566 

1567 Citations associated with the text content.1567 Citations associated with the text content.

1568 1568 

1569 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember0]`1569 - `class MultiAgentCallOutputOutputAnnotationFileCitation: …`

1570 1570 

1571 - `file_id: str`1571 - `file_id: str`

1572 1572 


1586 1586 

1587 - `"file_citation"`1587 - `"file_citation"`

1588 1588 

1589 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember1]`1589 - `class MultiAgentCallOutputOutputAnnotationURLCitation: …`

1590 1590 

1591 - `end_index: int`1591 - `end_index: int`

1592 1592 


1610 1610 

1611 The URL of the cited resource.1611 The URL of the cited resource.

1612 1612 

1613 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember2]`1613 - `class MultiAgentCallOutputOutputAnnotationContainerFileCitation: …`

1614 1614 

1615 - `container_id: str`1615 - `container_id: str`

1616 1616 


2991 2991 

2992 - `encrypted_content: Optional[str]`2992 - `encrypted_content: Optional[str]`

2993 2993 

2994 The encrypted content of the reasoning item - populated when a response is2994 The encrypted content of the reasoning item. This is populated by default

2995 generated with `reasoning.encrypted_content` in the `include` parameter.2995 for reasoning items returned by `POST /v1/responses` and WebSocket

2996 `response.create` requests.

2996 2997 

2997 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2998 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2998 2999 


5408 5409 

5409 - `encrypted_content: Optional[str]`5410 - `encrypted_content: Optional[str]`

5410 5411 

5411 The encrypted content of the reasoning item - populated when a response is5412 The encrypted content of the reasoning item. This is populated by default

5412 generated with `reasoning.encrypted_content` in the `include` parameter.5413 for reasoning items returned by `POST /v1/responses` and WebSocket

5414 `response.create` requests.

5413 5415 

5414 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`5416 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

5415 5417 

Details

1435 1435 

1436 - `"output_text"`1436 - `"output_text"`

1437 1437 

1438 - `annotations: Optional[Union[List[MultiAgentCallOutputOutputAnnotationsUnionMember0], List[MultiAgentCallOutputOutputAnnotationsUnionMember1], List[MultiAgentCallOutputOutputAnnotationsUnionMember2], null]]`1438 - `annotations: Optional[List[MultiAgentCallOutputOutputAnnotation]]`

1439 1439 

1440 Citations associated with the text content.1440 Citations associated with the text content.

1441 1441 

1442 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember0]`1442 - `class MultiAgentCallOutputOutputAnnotationFileCitation: …`

1443 1443 

1444 - `file_id: str`1444 - `file_id: str`

1445 1445 


1459 1459 

1460 - `"file_citation"`1460 - `"file_citation"`

1461 1461 

1462 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember1]`1462 - `class MultiAgentCallOutputOutputAnnotationURLCitation: …`

1463 1463 

1464 - `end_index: int`1464 - `end_index: int`

1465 1465 


1483 1483 

1484 The URL of the cited resource.1484 The URL of the cited resource.

1485 1485 

1486 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember2]`1486 - `class MultiAgentCallOutputOutputAnnotationContainerFileCitation: …`

1487 1487 

1488 - `container_id: str`1488 - `container_id: str`

1489 1489 


2864 2864 

2865 - `encrypted_content: Optional[str]`2865 - `encrypted_content: Optional[str]`

2866 2866 

2867 The encrypted content of the reasoning item - populated when a response is2867 The encrypted content of the reasoning item. This is populated by default

2868 generated with `reasoning.encrypted_content` in the `include` parameter.2868 for reasoning items returned by `POST /v1/responses` and WebSocket

2869 `response.create` requests.

2869 2870 

2870 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2871 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2871 2872 


6221 6222 

6222 - `"output_text"`6223 - `"output_text"`

6223 6224 

6224 - `annotations: Optional[Union[List[MultiAgentCallOutputOutputAnnotationsUnionMember0], List[MultiAgentCallOutputOutputAnnotationsUnionMember1], List[MultiAgentCallOutputOutputAnnotationsUnionMember2], null]]`6225 - `annotations: Optional[List[MultiAgentCallOutputOutputAnnotation]]`

6225 6226 

6226 Citations associated with the text content.6227 Citations associated with the text content.

6227 6228 

6228 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember0]`6229 - `class MultiAgentCallOutputOutputAnnotationFileCitation: …`

6229 6230 

6230 - `file_id: str`6231 - `file_id: str`

6231 6232 


6245 6246 

6246 - `"file_citation"`6247 - `"file_citation"`

6247 6248 

6248 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember1]`6249 - `class MultiAgentCallOutputOutputAnnotationURLCitation: …`

6249 6250 

6250 - `end_index: int`6251 - `end_index: int`

6251 6252 


6269 6270 

6270 The URL of the cited resource.6271 The URL of the cited resource.

6271 6272 

6272 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember2]`6273 - `class MultiAgentCallOutputOutputAnnotationContainerFileCitation: …`

6273 6274 

6274 - `container_id: str`6275 - `container_id: str`

6275 6276 


7650 7651 

7651 - `encrypted_content: Optional[str]`7652 - `encrypted_content: Optional[str]`

7652 7653 

7653 The encrypted content of the reasoning item - populated when a response is7654 The encrypted content of the reasoning item. This is populated by default

7654 generated with `reasoning.encrypted_content` in the `include` parameter.7655 for reasoning items returned by `POST /v1/responses` and WebSocket

7656 `response.create` requests.

7655 7657 

7656 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`7658 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

7657 7659 

Details

1490 1490 

1491 - `"output_text"`1491 - `"output_text"`

1492 1492 

1493 - `annotations: Optional[Union[List[MultiAgentCallOutputOutputAnnotationsUnionMember0], List[MultiAgentCallOutputOutputAnnotationsUnionMember1], List[MultiAgentCallOutputOutputAnnotationsUnionMember2], null]]`1493 - `annotations: Optional[List[MultiAgentCallOutputOutputAnnotation]]`

1494 1494 

1495 Citations associated with the text content.1495 Citations associated with the text content.

1496 1496 

1497 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember0]`1497 - `class MultiAgentCallOutputOutputAnnotationFileCitation: …`

1498 1498 

1499 - `file_id: str`1499 - `file_id: str`

1500 1500 


1514 1514 

1515 - `"file_citation"`1515 - `"file_citation"`

1516 1516 

1517 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember1]`1517 - `class MultiAgentCallOutputOutputAnnotationURLCitation: …`

1518 1518 

1519 - `end_index: int`1519 - `end_index: int`

1520 1520 


1538 1538 

1539 The URL of the cited resource.1539 The URL of the cited resource.

1540 1540 

1541 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember2]`1541 - `class MultiAgentCallOutputOutputAnnotationContainerFileCitation: …`

1542 1542 

1543 - `container_id: str`1543 - `container_id: str`

1544 1544 


2919 2919 

2920 - `encrypted_content: Optional[str]`2920 - `encrypted_content: Optional[str]`

2921 2921 

2922 The encrypted content of the reasoning item - populated when a response is2922 The encrypted content of the reasoning item. This is populated by default

2923 generated with `reasoning.encrypted_content` in the `include` parameter.2923 for reasoning items returned by `POST /v1/responses` and WebSocket

2924 `response.create` requests.

2924 2925 

2925 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2926 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2926 2927 

Details

2676 2676 

2677 - `encrypted_content: Optional[str]`2677 - `encrypted_content: Optional[str]`

2678 2678 

2679 The encrypted content of the reasoning item - populated when a response is2679 The encrypted content of the reasoning item. This is populated by default

2680 generated with `reasoning.encrypted_content` in the `include` parameter.2680 for reasoning items returned by `POST /v1/responses` and WebSocket

2681 `response.create` requests.

2681 2682 

2682 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2683 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2683 2684 

Details

1379 1379 

1380 - `"output_text"`1380 - `"output_text"`

1381 1381 

1382 - `annotations: Optional[Union[List[MultiAgentCallOutputOutputAnnotationsUnionMember0], List[MultiAgentCallOutputOutputAnnotationsUnionMember1], List[MultiAgentCallOutputOutputAnnotationsUnionMember2], null]]`1382 - `annotations: Optional[List[MultiAgentCallOutputOutputAnnotation]]`

1383 1383 

1384 Citations associated with the text content.1384 Citations associated with the text content.

1385 1385 

1386 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember0]`1386 - `class MultiAgentCallOutputOutputAnnotationFileCitation: …`

1387 1387 

1388 - `file_id: str`1388 - `file_id: str`

1389 1389 


1403 1403 

1404 - `"file_citation"`1404 - `"file_citation"`

1405 1405 

1406 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember1]`1406 - `class MultiAgentCallOutputOutputAnnotationURLCitation: …`

1407 1407 

1408 - `end_index: int`1408 - `end_index: int`

1409 1409 


1427 1427 

1428 The URL of the cited resource.1428 The URL of the cited resource.

1429 1429 

1430 - `List[MultiAgentCallOutputOutputAnnotationsUnionMember2]`1430 - `class MultiAgentCallOutputOutputAnnotationContainerFileCitation: …`

1431 1431 

1432 - `container_id: str`1432 - `container_id: str`

1433 1433 


2808 2808 

2809 - `encrypted_content: Optional[str]`2809 - `encrypted_content: Optional[str]`

2810 2810 

2811 The encrypted content of the reasoning item - populated when a response is2811 The encrypted content of the reasoning item. This is populated by default

2812 generated with `reasoning.encrypted_content` in the `include` parameter.2812 for reasoning items returned by `POST /v1/responses` and WebSocket

2813 `response.create` requests.

2813 2814 

2814 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2815 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2815 2816 

Details

2561 2561 

2562 - `encrypted_content: Optional[str]`2562 - `encrypted_content: Optional[str]`

2563 2563 

2564 The encrypted content of the reasoning item - populated when a response is2564 The encrypted content of the reasoning item. This is populated by default

2565 generated with `reasoning.encrypted_content` in the `include` parameter.2565 for reasoning items returned by `POST /v1/responses` and WebSocket

2566 `response.create` requests.

2566 2567 

2567 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2568 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2568 2569 

Details

2563 2563 

2564 - `encrypted_content: Optional[str]`2564 - `encrypted_content: Optional[str]`

2565 2565 

2566 The encrypted content of the reasoning item - populated when a response is2566 The encrypted content of the reasoning item. This is populated by default

2567 generated with `reasoning.encrypted_content` in the `include` parameter.2567 for reasoning items returned by `POST /v1/responses` and WebSocket

2568 `response.create` requests.

2568 2569 

2569 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2570 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2570 2571 


5949 5950 

5950 - `encrypted_content: Optional[str]`5951 - `encrypted_content: Optional[str]`

5951 5952 

5952 The encrypted content of the reasoning item - populated when a response is5953 The encrypted content of the reasoning item. This is populated by default

5953 generated with `reasoning.encrypted_content` in the `include` parameter.5954 for reasoning items returned by `POST /v1/responses` and WebSocket

5955 `response.create` requests.

5954 5956 

5955 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`5957 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

5956 5958 

Details

2532 2532 

2533 - `encrypted_content: Optional[str]`2533 - `encrypted_content: Optional[str]`

2534 2534 

2535 The encrypted content of the reasoning item - populated when a response is2535 The encrypted content of the reasoning item. This is populated by default

2536 generated with `reasoning.encrypted_content` in the `include` parameter.2536 for reasoning items returned by `POST /v1/responses` and WebSocket

2537 `response.create` requests.

2537 2538 

2538 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2539 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2539 2540 

Details

2507 2507 

2508 - `encrypted_content: Optional[str]`2508 - `encrypted_content: Optional[str]`

2509 2509 

2510 The encrypted content of the reasoning item - populated when a response is2510 The encrypted content of the reasoning item. This is populated by default

2511 generated with `reasoning.encrypted_content` in the `include` parameter.2511 for reasoning items returned by `POST /v1/responses` and WebSocket

2512 `response.create` requests.

2512 2513 

2513 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2514 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2514 2515 

Details

2653 2653 

2654 - `encrypted_content: Optional[str]`2654 - `encrypted_content: Optional[str]`

2655 2655 

2656 The encrypted content of the reasoning item - populated when a response is2656 The encrypted content of the reasoning item. This is populated by default

2657 generated with `reasoning.encrypted_content` in the `include` parameter.2657 for reasoning items returned by `POST /v1/responses` and WebSocket

2658 `response.create` requests.

2658 2659 

2659 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2660 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2660 2661 

Details

2771 2771 

2772 - `encrypted_content: Optional[str]`2772 - `encrypted_content: Optional[str]`

2773 2773 

2774 The encrypted content of the reasoning item - populated when a response is2774 The encrypted content of the reasoning item. This is populated by default

2775 generated with `reasoning.encrypted_content` in the `include` parameter.2775 for reasoning items returned by `POST /v1/responses` and WebSocket

2776 `response.create` requests.

2776 2777 

2777 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2778 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2778 2779 


4877 4878 

4878 - `encrypted_content: Optional[str]`4879 - `encrypted_content: Optional[str]`

4879 4880 

4880 The encrypted content of the reasoning item - populated when a response is4881 The encrypted content of the reasoning item. This is populated by default

4881 generated with `reasoning.encrypted_content` in the `include` parameter.4882 for reasoning items returned by `POST /v1/responses` and WebSocket

4883 `response.create` requests.

4882 4884 

4883 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`4885 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

4884 4886 

Details

2644 2644 

2645 - `encrypted_content: Optional[str]`2645 - `encrypted_content: Optional[str]`

2646 2646 

2647 The encrypted content of the reasoning item - populated when a response is2647 The encrypted content of the reasoning item. This is populated by default

2648 generated with `reasoning.encrypted_content` in the `include` parameter.2648 for reasoning items returned by `POST /v1/responses` and WebSocket

2649 `response.create` requests.

2649 2650 

2650 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2651 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2651 2652 


7038 7039 

7039 - `encrypted_content: Optional[str]`7040 - `encrypted_content: Optional[str]`

7040 7041 

7041 The encrypted content of the reasoning item - populated when a response is7042 The encrypted content of the reasoning item. This is populated by default

7042 generated with `reasoning.encrypted_content` in the `include` parameter.7043 for reasoning items returned by `POST /v1/responses` and WebSocket

7044 `response.create` requests.

7043 7045 

7044 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`7046 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

7045 7047 

Details

2695 2695 

2696 - `encrypted_content: Optional[str]`2696 - `encrypted_content: Optional[str]`

2697 2697 

2698 The encrypted content of the reasoning item - populated when a response is2698 The encrypted content of the reasoning item. This is populated by default

2699 generated with `reasoning.encrypted_content` in the `include` parameter.2699 for reasoning items returned by `POST /v1/responses` and WebSocket

2700 `response.create` requests.

2700 2701 

2701 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2702 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2702 2703 

Details

2444 2444 

2445 - `encrypted_content: Optional[str]`2445 - `encrypted_content: Optional[str]`

2446 2446 

2447 The encrypted content of the reasoning item - populated when a response is2447 The encrypted content of the reasoning item. This is populated by default

2448 generated with `reasoning.encrypted_content` in the `include` parameter.2448 for reasoning items returned by `POST /v1/responses` and WebSocket

2449 `response.create` requests.

2449 2450 

2450 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2451 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2451 2452 

Details

2588 2588 

2589 - `encrypted_content: Optional[str]`2589 - `encrypted_content: Optional[str]`

2590 2590 

2591 The encrypted content of the reasoning item - populated when a response is2591 The encrypted content of the reasoning item. This is populated by default

2592 generated with `reasoning.encrypted_content` in the `include` parameter.2592 for reasoning items returned by `POST /v1/responses` and WebSocket

2593 `response.create` requests.

2593 2594 

2594 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`2595 - `status: Optional[Literal["in_progress", "completed", "incomplete"]]`

2595 2596 

Details

42 42 

43 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.43 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.

44 44 

45- `event_types: optional array of "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`45- `event_types: optional array of "api_key.created" or "api_key.updated" or "api_key.deleted" or 140 more`

46 46 

47 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](/docs/api-reference/audit-logs/object).47 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](/docs/api-reference/audit-logs/object).

48 48 


164 164 

165 - `"user.deleted"`165 - `"user.deleted"`

166 166 

167 - `"tenant.metadata.updated"`

168 

169 - `"tenant.microsoft_entra_mapping.upserted"`

170 

171 - `"tenant.microsoft_entra_mapping.deleted"`

172 

173 - `"tenant.workload_identity.provider.created"`

174 

175 - `"tenant.workload_identity.provider.updated"`

176 

177 - `"tenant.workload_identity.provider.archived"`

178 

179 - `"tenant.workload_identity.mapping.created"`

180 

181 - `"tenant.workload_identity.mapping.updated"`

182 

183 - `"tenant.workload_identity.mapping.archived"`

184 

185 - `"tenant.workload_identity.binding.created"`

186 

187 - `"tenant.workload_identity.principal.provisioned"`

188 

189 - `"tenant.admin_api_key.created"`

190 

191 - `"tenant.admin_api_key.updated"`

192 

193 - `"tenant.admin_api_key.deleted"`

194 

195 - `"tenant.project_api_key.created"`

196 

197 - `"tenant.chatgpt_access_token.revoked"`

198 

199 - `"tenant.migration.completed"`

200 

201 - `"tenant.sso.migrated"`

202 

203 - `"tenant.domains.migrated"`

204 

205 - `"tenant.sso_connection.created"`

206 

207 - `"tenant.sso_connection.updated"`

208 

209 - `"tenant.sso_connection.deleted"`

210 

211 - `"tenant.sso_connection.setup.started"`

212 

213 - `"tenant.policy.created"`

214 

215 - `"tenant.policy.updated"`

216 

217 - `"tenant.policy.deleted"`

218 

219 - `"tenant.policy.attached"`

220 

221 - `"tenant.policy.detached"`

222 

223 - `"tenant.principal_authentication_policy.resolved"`

224 

225 - `"tenant.scim.setup.started"`

226 

227 - `"tenant.scim.deletion.requested"`

228 

229 - `"tenant.scim.directory.created"`

230 

231 - `"tenant.product_access_policy.updated"`

232 

233 - `"tenant.resource_share_grant.created"`

234 

235 - `"tenant.resource_share_grant.updated"`

236 

237 - `"tenant.resource_share_grant.accepted"`

238 

239 - `"tenant.resource_share_grant.declined"`

240 

241 - `"tenant.resource_share_grant.revoked"`

242 

243 - `"tenant.resource_share_grant.deleted"`

244 

245 - `"tenant.service_account.updated"`

246 

247 - `"tenant.service_account.deleted"`

248 

249 - `"tenant.service_account.token.revoked"`

250 

251 - `"tenant.billing.overage_limit.updated"`

252 

253 - `"tenant.billing.alerts.updated"`

254 

255 - `"tenant.billing.info.updated"`

256 

257 - `"tenant.usage_limit.workspace.updated"`

258 

259 - `"tenant.usage_limit.group.updated"`

260 

261 - `"tenant.usage_limit.user.updated"`

262 

263 - `"tenant.usage_limit.increase_request.updated"`

264 

265 - `"tenant.usage_limit.increase_request.resolved"`

266 

267 - `"tenant.group.created"`

268 

269 - `"tenant.group.updated"`

270 

271 - `"tenant.group.deleted"`

272 

273 - `"tenant.group.member.added"`

274 

275 - `"tenant.group.member.removed"`

276 

277 - `"tenant.migration_rollout.status.updated"`

278 

279 - `"tenant.migration_rollout.tier.updated"`

280 

281 - `"tenant.role.metadata.updated"`

282 

283 - `"tenant.custom_role.created"`

284 

285 - `"tenant.custom_role.updated"`

286 

287 - `"tenant.custom_role.deleted"`

288 

289 - `"tenant.role_assignment.created"`

290 

291 - `"tenant.role_assignment.deleted"`

292 

293 - `"tenant.resource_role_assignment.created"`

294 

295 - `"tenant.resource_role_assignment.deleted"`

296 

297 - `"tenant.resource_access.updated"`

298 

299 - `"tenant.resource_access.deleted"`

300 

301 - `"tenant.session_policy.created"`

302 

303 - `"tenant.session_policy.updated"`

304 

305 - `"tenant.session_policy.deleted"`

306 

307 - `"tenant.session_revocation.started"`

308 

309 - `"tenant.third_party_app_policy.updated"`

310 

311 - `"tenant.user.added"`

312 

313 - `"tenant.user.updated"`

314 

315 - `"tenant.user.removed"`

316 

317 - `"tenant.user.looked_up"`

318 

319 - `"tenant.user.invited"`

320 

321 - `"tenant.membership.revoked"`

322 

323 - `"tenant.api_organization_invite.upserted"`

324 

325 - `"tenant.api_organization_invite.deleted"`

326 

327 - `"tenant.chatgpt_workspace_invite.upserted"`

328 

329 - `"tenant.membership.accepted"`

330 

331 - `"tenant.membership.declined"`

332 

333 - `"tenant.workspace_invite_email_settings.updated"`

334 

167- `limit: optional number`335- `limit: optional number`

168 336 

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


192 360 

193 The Unix timestamp (in seconds) of the event.361 The Unix timestamp (in seconds) of the event.

194 362 

195 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 56 more`363 - `type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 140 more`

196 364 

197 The event type.365 The event type.

198 366 


314 482 

315 - `"user.deleted"`483 - `"user.deleted"`

316 484 

485 - `"tenant.metadata.updated"`

486 

487 - `"tenant.microsoft_entra_mapping.upserted"`

488 

489 - `"tenant.microsoft_entra_mapping.deleted"`

490 

491 - `"tenant.workload_identity.provider.created"`

492 

493 - `"tenant.workload_identity.provider.updated"`

494 

495 - `"tenant.workload_identity.provider.archived"`

496 

497 - `"tenant.workload_identity.mapping.created"`

498 

499 - `"tenant.workload_identity.mapping.updated"`

500 

501 - `"tenant.workload_identity.mapping.archived"`

502 

503 - `"tenant.workload_identity.binding.created"`

504 

505 - `"tenant.workload_identity.principal.provisioned"`

506 

507 - `"tenant.admin_api_key.created"`

508 

509 - `"tenant.admin_api_key.updated"`

510 

511 - `"tenant.admin_api_key.deleted"`

512 

513 - `"tenant.project_api_key.created"`

514 

515 - `"tenant.chatgpt_access_token.revoked"`

516 

517 - `"tenant.migration.completed"`

518 

519 - `"tenant.sso.migrated"`

520 

521 - `"tenant.domains.migrated"`

522 

523 - `"tenant.sso_connection.created"`

524 

525 - `"tenant.sso_connection.updated"`

526 

527 - `"tenant.sso_connection.deleted"`

528 

529 - `"tenant.sso_connection.setup.started"`

530 

531 - `"tenant.policy.created"`

532 

533 - `"tenant.policy.updated"`

534 

535 - `"tenant.policy.deleted"`

536 

537 - `"tenant.policy.attached"`

538 

539 - `"tenant.policy.detached"`

540 

541 - `"tenant.principal_authentication_policy.resolved"`

542 

543 - `"tenant.scim.setup.started"`

544 

545 - `"tenant.scim.deletion.requested"`

546 

547 - `"tenant.scim.directory.created"`

548 

549 - `"tenant.product_access_policy.updated"`

550 

551 - `"tenant.resource_share_grant.created"`

552 

553 - `"tenant.resource_share_grant.updated"`

554 

555 - `"tenant.resource_share_grant.accepted"`

556 

557 - `"tenant.resource_share_grant.declined"`

558 

559 - `"tenant.resource_share_grant.revoked"`

560 

561 - `"tenant.resource_share_grant.deleted"`

562 

563 - `"tenant.service_account.updated"`

564 

565 - `"tenant.service_account.deleted"`

566 

567 - `"tenant.service_account.token.revoked"`

568 

569 - `"tenant.billing.overage_limit.updated"`

570 

571 - `"tenant.billing.alerts.updated"`

572 

573 - `"tenant.billing.info.updated"`

574 

575 - `"tenant.usage_limit.workspace.updated"`

576 

577 - `"tenant.usage_limit.group.updated"`

578 

579 - `"tenant.usage_limit.user.updated"`

580 

581 - `"tenant.usage_limit.increase_request.updated"`

582 

583 - `"tenant.usage_limit.increase_request.resolved"`

584 

585 - `"tenant.group.created"`

586 

587 - `"tenant.group.updated"`

588 

589 - `"tenant.group.deleted"`

590 

591 - `"tenant.group.member.added"`

592 

593 - `"tenant.group.member.removed"`

594 

595 - `"tenant.migration_rollout.status.updated"`

596 

597 - `"tenant.migration_rollout.tier.updated"`

598 

599 - `"tenant.role.metadata.updated"`

600 

601 - `"tenant.custom_role.created"`

602 

603 - `"tenant.custom_role.updated"`

604 

605 - `"tenant.custom_role.deleted"`

606 

607 - `"tenant.role_assignment.created"`

608 

609 - `"tenant.role_assignment.deleted"`

610 

611 - `"tenant.resource_role_assignment.created"`

612 

613 - `"tenant.resource_role_assignment.deleted"`

614 

615 - `"tenant.resource_access.updated"`

616 

617 - `"tenant.resource_access.deleted"`

618 

619 - `"tenant.session_policy.created"`

620 

621 - `"tenant.session_policy.updated"`

622 

623 - `"tenant.session_policy.deleted"`

624 

625 - `"tenant.session_revocation.started"`

626 

627 - `"tenant.third_party_app_policy.updated"`

628 

629 - `"tenant.user.added"`

630 

631 - `"tenant.user.updated"`

632 

633 - `"tenant.user.removed"`

634 

635 - `"tenant.user.looked_up"`

636 

637 - `"tenant.user.invited"`

638 

639 - `"tenant.membership.revoked"`

640 

641 - `"tenant.api_organization_invite.upserted"`

642 

643 - `"tenant.api_organization_invite.deleted"`

644 

645 - `"tenant.chatgpt_workspace_invite.upserted"`

646 

647 - `"tenant.membership.accepted"`

648 

649 - `"tenant.membership.declined"`

650 

651 - `"tenant.workspace_invite_email_settings.updated"`

652 

317 - `actor: optional object { api_key, session, type }`653 - `actor: optional object { api_key, session, type }`

318 654 

319 The actor who performed the audit logged action.655 The actor who performed the audit logged action.

Details

2 2 

3**post** `/organization/projects/{project_id}/service_accounts`3**post** `/organization/projects/{project_id}/service_accounts`

4 4 

5Creates a new service account in the project. This also returns an unredacted API key for the service account.5Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

6 6 

7### Path Parameters7### Path Parameters

8 8 


14 14 

15 The name of the service account being created.15 The name of the service account being created.

16 16 

17- `create_service_account_only: optional boolean`

18 

19 Create the service account without default roles or an API key.

20 

17### Returns21### Returns

18 22 

19- `id: string`23- `id: string`


42 46 

43 - `"organization.project.service_account"`47 - `"organization.project.service_account"`

44 48 

45- `role: "member"`49- `role: "member" or "none"`

46 50 

47 Service accounts can only have one role of type `member`51 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

48 52 

49 - `"member"`53 - `"member"`

50 54 

55 - `"none"`

56 

51### Example57### Example

52 58 

53```http59```http

Details

40 40 

41 - `"organization.project.service_account"`41 - `"organization.project.service_account"`

42 42 

43 - `role: "owner" or "member"`43 - `role: "owner" or "member" or "none"`

44 44 

45 `owner` or `member`45 `owner`, `member`, or `none`

46 46 

47 - `"owner"`47 - `"owner"`

48 48 

49 - `"member"`49 - `"member"`

50 50 

51 - `"none"`

52 

51- `has_more: boolean`53- `has_more: boolean`

52 54 

53- `object: "list"`55- `object: "list"`

Details

34 34 

35 - `"organization.project.service_account"`35 - `"organization.project.service_account"`

36 36 

37 - `role: "owner" or "member"`37 - `role: "owner" or "member" or "none"`

38 38 

39 `owner` or `member`39 `owner`, `member`, or `none`

40 40 

41 - `"owner"`41 - `"owner"`

42 42 

43 - `"member"`43 - `"member"`

44 44 

45 - `"none"`

46 

45### Example47### Example

46 48 

47```http49```http

Details

48 48 

49 - `"organization.project.service_account"`49 - `"organization.project.service_account"`

50 50 

51 - `role: "owner" or "member"`51 - `role: "owner" or "member" or "none"`

52 52 

53 `owner` or `member`53 `owner`, `member`, or `none`

54 54 

55 - `"owner"`55 - `"owner"`

56 56 

57 - `"member"`57 - `"member"`

58 58 

59 - `"none"`

60 

59### Example61### Example

60 62 

61```http63```http

Details

1## Create project service account API key

2 

3**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

4 

5Creates an API key for a service account in the project.

6 

7### Path Parameters

8 

9- `project_id: string`

10 

11- `service_account_id: string`

12 

13### Body Parameters

14 

15- `name: optional string`

16 

17 API key name.

18 

19- `scopes: optional array of string`

20 

21 API key scopes.

22 

23### Returns

24 

25- `id: string`

26 

27- `created_at: number`

28 

29- `name: string`

30 

31- `object: "organization.project.service_account.api_key"`

32 

33 The object type, which is always `organization.project.service_account.api_key`

34 

35 - `"organization.project.service_account.api_key"`

36 

37- `value: string`

38 

39### Example

40 

41```http

42curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID/api_keys \

43 -X POST \

44 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

45```

46 

47#### Response

48 

49```json

50{

51 "id": "id",

52 "created_at": 0,

53 "name": "name",

54 "object": "organization.project.service_account.api_key",

55 "value": "value"

56}

57```

58 

59### Example

60 

61```http

62curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/service_accounts/svc_acct_abc/api_keys \

63 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

64 -H "Content-Type: application/json" \

65 -d '{

66 "name": "Production App",

67 "scopes": ["api.responses.write"]

68 }'

69```

70 

71#### Response

72 

73```json

74{

75 "object": "organization.project.service_account.api_key",

76 "value": "sk-abcdefghijklmnop123",

77 "name": "Production App",

78 "created_at": 1711471533,

79 "id": "key_abc"

80}

81```

Details

74 74 

75 - `"bucket"`75 - `"bucket"`

76 76 

77 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`77 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

78 78 

79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

80 80 

81 The aggregated completions usage details of the specific time bucket.81 The aggregated completions usage details of the specific time bucket.

82 82 

83 - `input_tokens: number`83 - `input_tokens: number`

84 84 

85 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `num_model_requests: number`87 - `num_model_requests: number`

88 88 


94 94 

95 - `output_tokens: number`95 - `output_tokens: number`

96 96 

97 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `api_key_id: optional string`99 - `api_key_id: optional string`

100 100 


106 106 

107 - `input_audio_tokens: optional number`107 - `input_audio_tokens: optional number`

108 108 

109 The aggregated number of audio input tokens used, including cached tokens.109 The aggregated number of uncached audio input tokens used.

110 

111 - `input_cache_write_tokens: optional number`

112 

113 The aggregated number of input tokens written to the cache.

114 

115 - `input_cached_audio_tokens: optional number`

116 

117 The aggregated number of cached audio input tokens used.

118 

119 - `input_cached_image_tokens: optional number`

120 

121 The aggregated number of cached image input tokens used.

122 

123 - `input_cached_text_tokens: optional number`

124 

125 The aggregated number of cached text input tokens used.

110 126 

111 - `input_cached_tokens: optional number`127 - `input_cached_tokens: optional number`

112 128 

113 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 

131 - `input_image_tokens: optional number`

132 

133 The aggregated number of uncached image input tokens used.

134 

135 - `input_text_tokens: optional number`

136 

137 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

138 

139 - `input_uncached_tokens: optional number`

140 

141 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

114 142 

115 - `model: optional string`143 - `model: optional string`

116 144 


120 148 

121 The aggregated number of audio output tokens used.149 The aggregated number of audio output tokens used.

122 150 

151 - `output_image_tokens: optional number`

152 

153 The aggregated number of image output tokens used.

154 

155 - `output_text_tokens: optional number`

156 

157 The aggregated number of text output tokens used.

158 

123 - `project_id: optional string`159 - `project_id: optional string`

124 160 

125 When `group_by=project_id`, this field provides the project ID of the grouped usage result.161 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


466 "api_key_id": "api_key_id",502 "api_key_id": "api_key_id",

467 "batch": true,503 "batch": true,

468 "input_audio_tokens": 0,504 "input_audio_tokens": 0,

505 "input_cache_write_tokens": 0,

506 "input_cached_audio_tokens": 0,

507 "input_cached_image_tokens": 0,

508 "input_cached_text_tokens": 0,

469 "input_cached_tokens": 0,509 "input_cached_tokens": 0,

510 "input_image_tokens": 0,

511 "input_text_tokens": 0,

512 "input_uncached_tokens": 0,

470 "model": "model",513 "model": "model",

471 "output_audio_tokens": 0,514 "output_audio_tokens": 0,

515 "output_image_tokens": 0,

516 "output_text_tokens": 0,

472 "project_id": "project_id",517 "project_id": "project_id",

473 "service_tier": "service_tier",518 "service_tier": "service_tier",

474 "user_id": "user_id"519 "user_id": "user_id"

Details

74 74 

75 - `"bucket"`75 - `"bucket"`

76 76 

77 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`77 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

78 78 

79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

80 80 

81 The aggregated completions usage details of the specific time bucket.81 The aggregated completions usage details of the specific time bucket.

82 82 

83 - `input_tokens: number`83 - `input_tokens: number`

84 84 

85 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `num_model_requests: number`87 - `num_model_requests: number`

88 88 


94 94 

95 - `output_tokens: number`95 - `output_tokens: number`

96 96 

97 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `api_key_id: optional string`99 - `api_key_id: optional string`

100 100 


106 106 

107 - `input_audio_tokens: optional number`107 - `input_audio_tokens: optional number`

108 108 

109 The aggregated number of audio input tokens used, including cached tokens.109 The aggregated number of uncached audio input tokens used.

110 

111 - `input_cache_write_tokens: optional number`

112 

113 The aggregated number of input tokens written to the cache.

114 

115 - `input_cached_audio_tokens: optional number`

116 

117 The aggregated number of cached audio input tokens used.

118 

119 - `input_cached_image_tokens: optional number`

120 

121 The aggregated number of cached image input tokens used.

122 

123 - `input_cached_text_tokens: optional number`

124 

125 The aggregated number of cached text input tokens used.

110 126 

111 - `input_cached_tokens: optional number`127 - `input_cached_tokens: optional number`

112 128 

113 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 

131 - `input_image_tokens: optional number`

132 

133 The aggregated number of uncached image input tokens used.

134 

135 - `input_text_tokens: optional number`

136 

137 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

138 

139 - `input_uncached_tokens: optional number`

140 

141 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

114 142 

115 - `model: optional string`143 - `model: optional string`

116 144 


120 148 

121 The aggregated number of audio output tokens used.149 The aggregated number of audio output tokens used.

122 150 

151 - `output_image_tokens: optional number`

152 

153 The aggregated number of image output tokens used.

154 

155 - `output_text_tokens: optional number`

156 

157 The aggregated number of text output tokens used.

158 

123 - `project_id: optional string`159 - `project_id: optional string`

124 160 

125 When `group_by=project_id`, this field provides the project ID of the grouped usage result.161 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


466 "api_key_id": "api_key_id",502 "api_key_id": "api_key_id",

467 "batch": true,503 "batch": true,

468 "input_audio_tokens": 0,504 "input_audio_tokens": 0,

505 "input_cache_write_tokens": 0,

506 "input_cached_audio_tokens": 0,

507 "input_cached_image_tokens": 0,

508 "input_cached_text_tokens": 0,

469 "input_cached_tokens": 0,509 "input_cached_tokens": 0,

510 "input_image_tokens": 0,

511 "input_text_tokens": 0,

512 "input_uncached_tokens": 0,

470 "model": "model",513 "model": "model",

471 "output_audio_tokens": 0,514 "output_audio_tokens": 0,

515 "output_image_tokens": 0,

516 "output_text_tokens": 0,

472 "project_id": "project_id",517 "project_id": "project_id",

473 "service_tier": "service_tier",518 "service_tier": "service_tier",

474 "user_id": "user_id"519 "user_id": "user_id"

Details

56 56 

57 - `"bucket"`57 - `"bucket"`

58 58 

59 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`59 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

60 60 

61 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`61 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

62 62 

63 The aggregated completions usage details of the specific time bucket.63 The aggregated completions usage details of the specific time bucket.

64 64 

65 - `input_tokens: number`65 - `input_tokens: number`

66 66 

67 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.67 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

68 68 

69 - `num_model_requests: number`69 - `num_model_requests: number`

70 70 


76 76 

77 - `output_tokens: number`77 - `output_tokens: number`

78 78 

79 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.79 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

80 80 

81 - `api_key_id: optional string`81 - `api_key_id: optional string`

82 82 


88 88 

89 - `input_audio_tokens: optional number`89 - `input_audio_tokens: optional number`

90 90 

91 The aggregated number of audio input tokens used, including cached tokens.91 The aggregated number of uncached audio input tokens used.

92 

93 - `input_cache_write_tokens: optional number`

94 

95 The aggregated number of input tokens written to the cache.

96 

97 - `input_cached_audio_tokens: optional number`

98 

99 The aggregated number of cached audio input tokens used.

100 

101 - `input_cached_image_tokens: optional number`

102 

103 The aggregated number of cached image input tokens used.

104 

105 - `input_cached_text_tokens: optional number`

106 

107 The aggregated number of cached text input tokens used.

92 108 

93 - `input_cached_tokens: optional number`109 - `input_cached_tokens: optional number`

94 110 

95 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.111 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

112 

113 - `input_image_tokens: optional number`

114 

115 The aggregated number of uncached image input tokens used.

116 

117 - `input_text_tokens: optional number`

118 

119 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

120 

121 - `input_uncached_tokens: optional number`

122 

123 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

96 124 

97 - `model: optional string`125 - `model: optional string`

98 126 


102 130 

103 The aggregated number of audio output tokens used.131 The aggregated number of audio output tokens used.

104 132 

133 - `output_image_tokens: optional number`

134 

135 The aggregated number of image output tokens used.

136 

137 - `output_text_tokens: optional number`

138 

139 The aggregated number of text output tokens used.

140 

105 - `project_id: optional string`141 - `project_id: optional string`

106 142 

107 When `group_by=project_id`, this field provides the project ID of the grouped usage result.143 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


448 "api_key_id": "api_key_id",484 "api_key_id": "api_key_id",

449 "batch": true,485 "batch": true,

450 "input_audio_tokens": 0,486 "input_audio_tokens": 0,

487 "input_cache_write_tokens": 0,

488 "input_cached_audio_tokens": 0,

489 "input_cached_image_tokens": 0,

490 "input_cached_text_tokens": 0,

451 "input_cached_tokens": 0,491 "input_cached_tokens": 0,

492 "input_image_tokens": 0,

493 "input_text_tokens": 0,

494 "input_uncached_tokens": 0,

452 "model": "model",495 "model": "model",

453 "output_audio_tokens": 0,496 "output_audio_tokens": 0,

497 "output_image_tokens": 0,

498 "output_text_tokens": 0,

454 "project_id": "project_id",499 "project_id": "project_id",

455 "service_tier": "service_tier",500 "service_tier": "service_tier",

456 "user_id": "user_id"501 "user_id": "user_id"

Details

82 82 

83 - `"bucket"`83 - `"bucket"`

84 84 

85 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`85 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

86 86 

87 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`87 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

88 88 

89 The aggregated completions usage details of the specific time bucket.89 The aggregated completions usage details of the specific time bucket.

90 90 

91 - `input_tokens: number`91 - `input_tokens: number`

92 92 

93 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.93 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

94 94 

95 - `num_model_requests: number`95 - `num_model_requests: number`

96 96 


102 102 

103 - `output_tokens: number`103 - `output_tokens: number`

104 104 

105 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.105 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

106 106 

107 - `api_key_id: optional string`107 - `api_key_id: optional string`

108 108 


114 114 

115 - `input_audio_tokens: optional number`115 - `input_audio_tokens: optional number`

116 116 

117 The aggregated number of audio input tokens used, including cached tokens.117 The aggregated number of uncached audio input tokens used.

118 

119 - `input_cache_write_tokens: optional number`

120 

121 The aggregated number of input tokens written to the cache.

122 

123 - `input_cached_audio_tokens: optional number`

124 

125 The aggregated number of cached audio input tokens used.

126 

127 - `input_cached_image_tokens: optional number`

128 

129 The aggregated number of cached image input tokens used.

130 

131 - `input_cached_text_tokens: optional number`

132 

133 The aggregated number of cached text input tokens used.

118 134 

119 - `input_cached_tokens: optional number`135 - `input_cached_tokens: optional number`

120 136 

121 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.137 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

138 

139 - `input_image_tokens: optional number`

140 

141 The aggregated number of uncached image input tokens used.

142 

143 - `input_text_tokens: optional number`

144 

145 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

146 

147 - `input_uncached_tokens: optional number`

148 

149 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

122 150 

123 - `model: optional string`151 - `model: optional string`

124 152 


128 156 

129 The aggregated number of audio output tokens used.157 The aggregated number of audio output tokens used.

130 158 

159 - `output_image_tokens: optional number`

160 

161 The aggregated number of image output tokens used.

162 

163 - `output_text_tokens: optional number`

164 

165 The aggregated number of text output tokens used.

166 

131 - `project_id: optional string`167 - `project_id: optional string`

132 168 

133 When `group_by=project_id`, this field provides the project ID of the grouped usage result.169 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


474 "api_key_id": "api_key_id",510 "api_key_id": "api_key_id",

475 "batch": true,511 "batch": true,

476 "input_audio_tokens": 0,512 "input_audio_tokens": 0,

513 "input_cache_write_tokens": 0,

514 "input_cached_audio_tokens": 0,

515 "input_cached_image_tokens": 0,

516 "input_cached_text_tokens": 0,

477 "input_cached_tokens": 0,517 "input_cached_tokens": 0,

518 "input_image_tokens": 0,

519 "input_text_tokens": 0,

520 "input_uncached_tokens": 0,

478 "model": "model",521 "model": "model",

479 "output_audio_tokens": 0,522 "output_audio_tokens": 0,

523 "output_image_tokens": 0,

524 "output_text_tokens": 0,

480 "project_id": "project_id",525 "project_id": "project_id",

481 "service_tier": "service_tier",526 "service_tier": "service_tier",

482 "user_id": "user_id"527 "user_id": "user_id"


513 {558 {

514 "object": "organization.usage.completions.result",559 "object": "organization.usage.completions.result",

515 "input_tokens": 1000,560 "input_tokens": 1000,

561 "input_cached_tokens": 400,

562 "input_cache_write_tokens": 100,

563 "input_uncached_tokens": 500,

516 "output_tokens": 500,564 "output_tokens": 500,

517 "input_cached_tokens": 800,565 "input_text_tokens": 400,

518 "input_audio_tokens": 0,566 "output_text_tokens": 400,

519 "output_audio_tokens": 0,567 "input_cached_text_tokens": 300,

568 "input_audio_tokens": 50,

569 "input_cached_audio_tokens": 50,

570 "output_audio_tokens": 50,

571 "input_image_tokens": 50,

572 "input_cached_image_tokens": 50,

573 "output_image_tokens": 50,

520 "num_model_requests": 5,574 "num_model_requests": 5,

521 "project_id": null,575 "project_id": null,

522 "user_id": null,576 "user_id": null,

Details

56 56 

57 - `"bucket"`57 - `"bucket"`

58 58 

59 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`59 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

60 60 

61 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`61 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

62 62 

63 The aggregated completions usage details of the specific time bucket.63 The aggregated completions usage details of the specific time bucket.

64 64 

65 - `input_tokens: number`65 - `input_tokens: number`

66 66 

67 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.67 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

68 68 

69 - `num_model_requests: number`69 - `num_model_requests: number`

70 70 


76 76 

77 - `output_tokens: number`77 - `output_tokens: number`

78 78 

79 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.79 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

80 80 

81 - `api_key_id: optional string`81 - `api_key_id: optional string`

82 82 


88 88 

89 - `input_audio_tokens: optional number`89 - `input_audio_tokens: optional number`

90 90 

91 The aggregated number of audio input tokens used, including cached tokens.91 The aggregated number of uncached audio input tokens used.

92 

93 - `input_cache_write_tokens: optional number`

94 

95 The aggregated number of input tokens written to the cache.

96 

97 - `input_cached_audio_tokens: optional number`

98 

99 The aggregated number of cached audio input tokens used.

100 

101 - `input_cached_image_tokens: optional number`

102 

103 The aggregated number of cached image input tokens used.

104 

105 - `input_cached_text_tokens: optional number`

106 

107 The aggregated number of cached text input tokens used.

92 108 

93 - `input_cached_tokens: optional number`109 - `input_cached_tokens: optional number`

94 110 

95 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.111 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

112 

113 - `input_image_tokens: optional number`

114 

115 The aggregated number of uncached image input tokens used.

116 

117 - `input_text_tokens: optional number`

118 

119 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

120 

121 - `input_uncached_tokens: optional number`

122 

123 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

96 124 

97 - `model: optional string`125 - `model: optional string`

98 126 


102 130 

103 The aggregated number of audio output tokens used.131 The aggregated number of audio output tokens used.

104 132 

133 - `output_image_tokens: optional number`

134 

135 The aggregated number of image output tokens used.

136 

137 - `output_text_tokens: optional number`

138 

139 The aggregated number of text output tokens used.

140 

105 - `project_id: optional string`141 - `project_id: optional string`

106 142 

107 When `group_by=project_id`, this field provides the project ID of the grouped usage result.143 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


448 "api_key_id": "api_key_id",484 "api_key_id": "api_key_id",

449 "batch": true,485 "batch": true,

450 "input_audio_tokens": 0,486 "input_audio_tokens": 0,

487 "input_cache_write_tokens": 0,

488 "input_cached_audio_tokens": 0,

489 "input_cached_image_tokens": 0,

490 "input_cached_text_tokens": 0,

451 "input_cached_tokens": 0,491 "input_cached_tokens": 0,

492 "input_image_tokens": 0,

493 "input_text_tokens": 0,

494 "input_uncached_tokens": 0,

452 "model": "model",495 "model": "model",

453 "output_audio_tokens": 0,496 "output_audio_tokens": 0,

497 "output_image_tokens": 0,

498 "output_text_tokens": 0,

454 "project_id": "project_id",499 "project_id": "project_id",

455 "service_tier": "service_tier",500 "service_tier": "service_tier",

456 "user_id": "user_id"501 "user_id": "user_id"

Details

74 74 

75 - `"bucket"`75 - `"bucket"`

76 76 

77 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`77 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

78 78 

79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

80 80 

81 The aggregated completions usage details of the specific time bucket.81 The aggregated completions usage details of the specific time bucket.

82 82 

83 - `input_tokens: number`83 - `input_tokens: number`

84 84 

85 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `num_model_requests: number`87 - `num_model_requests: number`

88 88 


94 94 

95 - `output_tokens: number`95 - `output_tokens: number`

96 96 

97 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `api_key_id: optional string`99 - `api_key_id: optional string`

100 100 


106 106 

107 - `input_audio_tokens: optional number`107 - `input_audio_tokens: optional number`

108 108 

109 The aggregated number of audio input tokens used, including cached tokens.109 The aggregated number of uncached audio input tokens used.

110 

111 - `input_cache_write_tokens: optional number`

112 

113 The aggregated number of input tokens written to the cache.

114 

115 - `input_cached_audio_tokens: optional number`

116 

117 The aggregated number of cached audio input tokens used.

118 

119 - `input_cached_image_tokens: optional number`

120 

121 The aggregated number of cached image input tokens used.

122 

123 - `input_cached_text_tokens: optional number`

124 

125 The aggregated number of cached text input tokens used.

110 126 

111 - `input_cached_tokens: optional number`127 - `input_cached_tokens: optional number`

112 128 

113 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 

131 - `input_image_tokens: optional number`

132 

133 The aggregated number of uncached image input tokens used.

134 

135 - `input_text_tokens: optional number`

136 

137 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

138 

139 - `input_uncached_tokens: optional number`

140 

141 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

114 142 

115 - `model: optional string`143 - `model: optional string`

116 144 


120 148 

121 The aggregated number of audio output tokens used.149 The aggregated number of audio output tokens used.

122 150 

151 - `output_image_tokens: optional number`

152 

153 The aggregated number of image output tokens used.

154 

155 - `output_text_tokens: optional number`

156 

157 The aggregated number of text output tokens used.

158 

123 - `project_id: optional string`159 - `project_id: optional string`

124 160 

125 When `group_by=project_id`, this field provides the project ID of the grouped usage result.161 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


466 "api_key_id": "api_key_id",502 "api_key_id": "api_key_id",

467 "batch": true,503 "batch": true,

468 "input_audio_tokens": 0,504 "input_audio_tokens": 0,

505 "input_cache_write_tokens": 0,

506 "input_cached_audio_tokens": 0,

507 "input_cached_image_tokens": 0,

508 "input_cached_text_tokens": 0,

469 "input_cached_tokens": 0,509 "input_cached_tokens": 0,

510 "input_image_tokens": 0,

511 "input_text_tokens": 0,

512 "input_uncached_tokens": 0,

470 "model": "model",513 "model": "model",

471 "output_audio_tokens": 0,514 "output_audio_tokens": 0,

515 "output_image_tokens": 0,

516 "output_text_tokens": 0,

472 "project_id": "project_id",517 "project_id": "project_id",

473 "service_tier": "service_tier",518 "service_tier": "service_tier",

474 "user_id": "user_id"519 "user_id": "user_id"

Details

74 74 

75 - `"bucket"`75 - `"bucket"`

76 76 

77 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`77 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

78 78 

79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

80 80 

81 The aggregated completions usage details of the specific time bucket.81 The aggregated completions usage details of the specific time bucket.

82 82 

83 - `input_tokens: number`83 - `input_tokens: number`

84 84 

85 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `num_model_requests: number`87 - `num_model_requests: number`

88 88 


94 94 

95 - `output_tokens: number`95 - `output_tokens: number`

96 96 

97 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `api_key_id: optional string`99 - `api_key_id: optional string`

100 100 


106 106 

107 - `input_audio_tokens: optional number`107 - `input_audio_tokens: optional number`

108 108 

109 The aggregated number of audio input tokens used, including cached tokens.109 The aggregated number of uncached audio input tokens used.

110 

111 - `input_cache_write_tokens: optional number`

112 

113 The aggregated number of input tokens written to the cache.

114 

115 - `input_cached_audio_tokens: optional number`

116 

117 The aggregated number of cached audio input tokens used.

118 

119 - `input_cached_image_tokens: optional number`

120 

121 The aggregated number of cached image input tokens used.

122 

123 - `input_cached_text_tokens: optional number`

124 

125 The aggregated number of cached text input tokens used.

110 126 

111 - `input_cached_tokens: optional number`127 - `input_cached_tokens: optional number`

112 128 

113 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 

131 - `input_image_tokens: optional number`

132 

133 The aggregated number of uncached image input tokens used.

134 

135 - `input_text_tokens: optional number`

136 

137 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

138 

139 - `input_uncached_tokens: optional number`

140 

141 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

114 142 

115 - `model: optional string`143 - `model: optional string`

116 144 


120 148 

121 The aggregated number of audio output tokens used.149 The aggregated number of audio output tokens used.

122 150 

151 - `output_image_tokens: optional number`

152 

153 The aggregated number of image output tokens used.

154 

155 - `output_text_tokens: optional number`

156 

157 The aggregated number of text output tokens used.

158 

123 - `project_id: optional string`159 - `project_id: optional string`

124 160 

125 When `group_by=project_id`, this field provides the project ID of the grouped usage result.161 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


466 "api_key_id": "api_key_id",502 "api_key_id": "api_key_id",

467 "batch": true,503 "batch": true,

468 "input_audio_tokens": 0,504 "input_audio_tokens": 0,

505 "input_cache_write_tokens": 0,

506 "input_cached_audio_tokens": 0,

507 "input_cached_image_tokens": 0,

508 "input_cached_text_tokens": 0,

469 "input_cached_tokens": 0,509 "input_cached_tokens": 0,

510 "input_image_tokens": 0,

511 "input_text_tokens": 0,

512 "input_uncached_tokens": 0,

470 "model": "model",513 "model": "model",

471 "output_audio_tokens": 0,514 "output_audio_tokens": 0,

515 "output_image_tokens": 0,

516 "output_text_tokens": 0,

472 "project_id": "project_id",517 "project_id": "project_id",

473 "service_tier": "service_tier",518 "service_tier": "service_tier",

474 "user_id": "user_id"519 "user_id": "user_id"

Details

102 102 

103 - `"bucket"`103 - `"bucket"`

104 104 

105 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`105 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

106 106 

107 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`107 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

108 108 

109 The aggregated completions usage details of the specific time bucket.109 The aggregated completions usage details of the specific time bucket.

110 110 

111 - `input_tokens: number`111 - `input_tokens: number`

112 112 

113 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.113 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

114 114 

115 - `num_model_requests: number`115 - `num_model_requests: number`

116 116 


122 122 

123 - `output_tokens: number`123 - `output_tokens: number`

124 124 

125 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.125 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

126 126 

127 - `api_key_id: optional string`127 - `api_key_id: optional string`

128 128 


134 134 

135 - `input_audio_tokens: optional number`135 - `input_audio_tokens: optional number`

136 136 

137 The aggregated number of audio input tokens used, including cached tokens.137 The aggregated number of uncached audio input tokens used.

138 

139 - `input_cache_write_tokens: optional number`

140 

141 The aggregated number of input tokens written to the cache.

142 

143 - `input_cached_audio_tokens: optional number`

144 

145 The aggregated number of cached audio input tokens used.

146 

147 - `input_cached_image_tokens: optional number`

148 

149 The aggregated number of cached image input tokens used.

150 

151 - `input_cached_text_tokens: optional number`

152 

153 The aggregated number of cached text input tokens used.

138 154 

139 - `input_cached_tokens: optional number`155 - `input_cached_tokens: optional number`

140 156 

141 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.157 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

158 

159 - `input_image_tokens: optional number`

160 

161 The aggregated number of uncached image input tokens used.

162 

163 - `input_text_tokens: optional number`

164 

165 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

166 

167 - `input_uncached_tokens: optional number`

168 

169 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

142 170 

143 - `model: optional string`171 - `model: optional string`

144 172 


148 176 

149 The aggregated number of audio output tokens used.177 The aggregated number of audio output tokens used.

150 178 

179 - `output_image_tokens: optional number`

180 

181 The aggregated number of image output tokens used.

182 

183 - `output_text_tokens: optional number`

184 

185 The aggregated number of text output tokens used.

186 

151 - `project_id: optional string`187 - `project_id: optional string`

152 188 

153 When `group_by=project_id`, this field provides the project ID of the grouped usage result.189 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


494 "api_key_id": "api_key_id",530 "api_key_id": "api_key_id",

495 "batch": true,531 "batch": true,

496 "input_audio_tokens": 0,532 "input_audio_tokens": 0,

533 "input_cache_write_tokens": 0,

534 "input_cached_audio_tokens": 0,

535 "input_cached_image_tokens": 0,

536 "input_cached_text_tokens": 0,

497 "input_cached_tokens": 0,537 "input_cached_tokens": 0,

538 "input_image_tokens": 0,

539 "input_text_tokens": 0,

540 "input_uncached_tokens": 0,

498 "model": "model",541 "model": "model",

499 "output_audio_tokens": 0,542 "output_audio_tokens": 0,

543 "output_image_tokens": 0,

544 "output_text_tokens": 0,

500 "project_id": "project_id",545 "project_id": "project_id",

501 "service_tier": "service_tier",546 "service_tier": "service_tier",

502 "user_id": "user_id"547 "user_id": "user_id"

Details

74 74 

75 - `"bucket"`75 - `"bucket"`

76 76 

77 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`77 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

78 78 

79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`79 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

80 80 

81 The aggregated completions usage details of the specific time bucket.81 The aggregated completions usage details of the specific time bucket.

82 82 

83 - `input_tokens: number`83 - `input_tokens: number`

84 84 

85 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `num_model_requests: number`87 - `num_model_requests: number`

88 88 


94 94 

95 - `output_tokens: number`95 - `output_tokens: number`

96 96 

97 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `api_key_id: optional string`99 - `api_key_id: optional string`

100 100 


106 106 

107 - `input_audio_tokens: optional number`107 - `input_audio_tokens: optional number`

108 108 

109 The aggregated number of audio input tokens used, including cached tokens.109 The aggregated number of uncached audio input tokens used.

110 

111 - `input_cache_write_tokens: optional number`

112 

113 The aggregated number of input tokens written to the cache.

114 

115 - `input_cached_audio_tokens: optional number`

116 

117 The aggregated number of cached audio input tokens used.

118 

119 - `input_cached_image_tokens: optional number`

120 

121 The aggregated number of cached image input tokens used.

122 

123 - `input_cached_text_tokens: optional number`

124 

125 The aggregated number of cached text input tokens used.

110 126 

111 - `input_cached_tokens: optional number`127 - `input_cached_tokens: optional number`

112 128 

113 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 

131 - `input_image_tokens: optional number`

132 

133 The aggregated number of uncached image input tokens used.

134 

135 - `input_text_tokens: optional number`

136 

137 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

138 

139 - `input_uncached_tokens: optional number`

140 

141 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

114 142 

115 - `model: optional string`143 - `model: optional string`

116 144 


120 148 

121 The aggregated number of audio output tokens used.149 The aggregated number of audio output tokens used.

122 150 

151 - `output_image_tokens: optional number`

152 

153 The aggregated number of image output tokens used.

154 

155 - `output_text_tokens: optional number`

156 

157 The aggregated number of text output tokens used.

158 

123 - `project_id: optional string`159 - `project_id: optional string`

124 160 

125 When `group_by=project_id`, this field provides the project ID of the grouped usage result.161 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


466 "api_key_id": "api_key_id",502 "api_key_id": "api_key_id",

467 "batch": true,503 "batch": true,

468 "input_audio_tokens": 0,504 "input_audio_tokens": 0,

505 "input_cache_write_tokens": 0,

506 "input_cached_audio_tokens": 0,

507 "input_cached_image_tokens": 0,

508 "input_cached_text_tokens": 0,

469 "input_cached_tokens": 0,509 "input_cached_tokens": 0,

510 "input_image_tokens": 0,

511 "input_text_tokens": 0,

512 "input_uncached_tokens": 0,

470 "model": "model",513 "model": "model",

471 "output_audio_tokens": 0,514 "output_audio_tokens": 0,

515 "output_image_tokens": 0,

516 "output_text_tokens": 0,

472 "project_id": "project_id",517 "project_id": "project_id",

473 "service_tier": "service_tier",518 "service_tier": "service_tier",

474 "user_id": "user_id"519 "user_id": "user_id"

Details

56 56 

57 - `"bucket"`57 - `"bucket"`

58 58 

59 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`59 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

60 60 

61 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`61 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

62 62 

63 The aggregated completions usage details of the specific time bucket.63 The aggregated completions usage details of the specific time bucket.

64 64 

65 - `input_tokens: number`65 - `input_tokens: number`

66 66 

67 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.67 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

68 68 

69 - `num_model_requests: number`69 - `num_model_requests: number`

70 70 


76 76 

77 - `output_tokens: number`77 - `output_tokens: number`

78 78 

79 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.79 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

80 80 

81 - `api_key_id: optional string`81 - `api_key_id: optional string`

82 82 


88 88 

89 - `input_audio_tokens: optional number`89 - `input_audio_tokens: optional number`

90 90 

91 The aggregated number of audio input tokens used, including cached tokens.91 The aggregated number of uncached audio input tokens used.

92 

93 - `input_cache_write_tokens: optional number`

94 

95 The aggregated number of input tokens written to the cache.

96 

97 - `input_cached_audio_tokens: optional number`

98 

99 The aggregated number of cached audio input tokens used.

100 

101 - `input_cached_image_tokens: optional number`

102 

103 The aggregated number of cached image input tokens used.

104 

105 - `input_cached_text_tokens: optional number`

106 

107 The aggregated number of cached text input tokens used.

92 108 

93 - `input_cached_tokens: optional number`109 - `input_cached_tokens: optional number`

94 110 

95 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.111 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

112 

113 - `input_image_tokens: optional number`

114 

115 The aggregated number of uncached image input tokens used.

116 

117 - `input_text_tokens: optional number`

118 

119 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

120 

121 - `input_uncached_tokens: optional number`

122 

123 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

96 124 

97 - `model: optional string`125 - `model: optional string`

98 126 


102 130 

103 The aggregated number of audio output tokens used.131 The aggregated number of audio output tokens used.

104 132 

133 - `output_image_tokens: optional number`

134 

135 The aggregated number of image output tokens used.

136 

137 - `output_text_tokens: optional number`

138 

139 The aggregated number of text output tokens used.

140 

105 - `project_id: optional string`141 - `project_id: optional string`

106 142 

107 When `group_by=project_id`, this field provides the project ID of the grouped usage result.143 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


448 "api_key_id": "api_key_id",484 "api_key_id": "api_key_id",

449 "batch": true,485 "batch": true,

450 "input_audio_tokens": 0,486 "input_audio_tokens": 0,

487 "input_cache_write_tokens": 0,

488 "input_cached_audio_tokens": 0,

489 "input_cached_image_tokens": 0,

490 "input_cached_text_tokens": 0,

451 "input_cached_tokens": 0,491 "input_cached_tokens": 0,

492 "input_image_tokens": 0,

493 "input_text_tokens": 0,

494 "input_uncached_tokens": 0,

452 "model": "model",495 "model": "model",

453 "output_audio_tokens": 0,496 "output_audio_tokens": 0,

497 "output_image_tokens": 0,

498 "output_text_tokens": 0,

454 "project_id": "project_id",499 "project_id": "project_id",

455 "service_tier": "service_tier",500 "service_tier": "service_tier",

456 "user_id": "user_id"501 "user_id": "user_id"

Details

86 86 

87 - `"bucket"`87 - `"bucket"`

88 88 

89 - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`89 - `results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more`

90 90 

91 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`91 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more }`

92 92 

93 The aggregated completions usage details of the specific time bucket.93 The aggregated completions usage details of the specific time bucket.

94 94 

95 - `input_tokens: number`95 - `input_tokens: number`

96 96 

97 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `num_model_requests: number`99 - `num_model_requests: number`

100 100 


106 106 

107 - `output_tokens: number`107 - `output_tokens: number`

108 108 

109 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.109 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

110 110 

111 - `api_key_id: optional string`111 - `api_key_id: optional string`

112 112 


118 118 

119 - `input_audio_tokens: optional number`119 - `input_audio_tokens: optional number`

120 120 

121 The aggregated number of audio input tokens used, including cached tokens.121 The aggregated number of uncached audio input tokens used.

122 

123 - `input_cache_write_tokens: optional number`

124 

125 The aggregated number of input tokens written to the cache.

126 

127 - `input_cached_audio_tokens: optional number`

128 

129 The aggregated number of cached audio input tokens used.

130 

131 - `input_cached_image_tokens: optional number`

132 

133 The aggregated number of cached image input tokens used.

134 

135 - `input_cached_text_tokens: optional number`

136 

137 The aggregated number of cached text input tokens used.

122 138 

123 - `input_cached_tokens: optional number`139 - `input_cached_tokens: optional number`

124 140 

125 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.141 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

142 

143 - `input_image_tokens: optional number`

144 

145 The aggregated number of uncached image input tokens used.

146 

147 - `input_text_tokens: optional number`

148 

149 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

150 

151 - `input_uncached_tokens: optional number`

152 

153 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

126 154 

127 - `model: optional string`155 - `model: optional string`

128 156 


132 160 

133 The aggregated number of audio output tokens used.161 The aggregated number of audio output tokens used.

134 162 

163 - `output_image_tokens: optional number`

164 

165 The aggregated number of image output tokens used.

166 

167 - `output_text_tokens: optional number`

168 

169 The aggregated number of text output tokens used.

170 

135 - `project_id: optional string`171 - `project_id: optional string`

136 172 

137 When `group_by=project_id`, this field provides the project ID of the grouped usage result.173 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


478 "api_key_id": "api_key_id",514 "api_key_id": "api_key_id",

479 "batch": true,515 "batch": true,

480 "input_audio_tokens": 0,516 "input_audio_tokens": 0,

517 "input_cache_write_tokens": 0,

518 "input_cached_audio_tokens": 0,

519 "input_cached_image_tokens": 0,

520 "input_cached_text_tokens": 0,

481 "input_cached_tokens": 0,521 "input_cached_tokens": 0,

522 "input_image_tokens": 0,

523 "input_text_tokens": 0,

524 "input_uncached_tokens": 0,

482 "model": "model",525 "model": "model",

483 "output_audio_tokens": 0,526 "output_audio_tokens": 0,

527 "output_image_tokens": 0,

528 "output_text_tokens": 0,

484 "project_id": "project_id",529 "project_id": "project_id",

485 "service_tier": "service_tier",530 "service_tier": "service_tier",

486 "user_id": "user_id"531 "user_id": "user_id"

Details

74 74 

75 - `errors: optional object { data, object }`75 - `errors: optional object { data, object }`

76 76 

77 - `data: optional array of object { code, line, message, param }`77 - `data: optional array of BatchError`

78 78 

79 - `code: optional string`79 - `code: optional string`

80 80 


136 136 

137 The ID of the file containing the outputs of successfully executed requests.137 The ID of the file containing the outputs of successfully executed requests.

138 138 

139 - `request_counts: optional object { completed, failed, total }`139 - `request_counts: optional BatchRequestCounts`

140 140 

141 The request counts for different statuses within the batch.141 The request counts for different statuses within the batch.

142 142 

Details

129 129 

130 - `errors: optional object { data, object }`130 - `errors: optional object { data, object }`

131 131 

132 - `data: optional array of object { code, line, message, param }`132 - `data: optional array of BatchError`

133 133 

134 - `code: optional string`134 - `code: optional string`

135 135 


191 191 

192 The ID of the file containing the outputs of successfully executed requests.192 The ID of the file containing the outputs of successfully executed requests.

193 193 

194 - `request_counts: optional object { completed, failed, total }`194 - `request_counts: optional BatchRequestCounts`

195 195 

196 The request counts for different statuses within the batch.196 The request counts for different statuses within the batch.

197 197 

Details

80 80 

81 - `errors: optional object { data, object }`81 - `errors: optional object { data, object }`

82 82 

83 - `data: optional array of object { code, line, message, param }`83 - `data: optional array of BatchError`

84 84 

85 - `code: optional string`85 - `code: optional string`

86 86 


142 142 

143 The ID of the file containing the outputs of successfully executed requests.143 The ID of the file containing the outputs of successfully executed requests.

144 144 

145 - `request_counts: optional object { completed, failed, total }`145 - `request_counts: optional BatchRequestCounts`

146 146 

147 The request counts for different statuses within the batch.147 The request counts for different statuses within the batch.

148 148 

Details

74 74 

75 - `errors: optional object { data, object }`75 - `errors: optional object { data, object }`

76 76 

77 - `data: optional array of object { code, line, message, param }`77 - `data: optional array of BatchError`

78 78 

79 - `code: optional string`79 - `code: optional string`

80 80 


136 136 

137 The ID of the file containing the outputs of successfully executed requests.137 The ID of the file containing the outputs of successfully executed requests.

138 138 

139 - `request_counts: optional object { completed, failed, total }`139 - `request_counts: optional BatchRequestCounts`

140 140 

141 The request counts for different statuses within the batch.141 The request counts for different statuses within the batch.

142 142 

Details

1441 1441 

1442 - `"output_text"`1442 - `"output_text"`

1443 1443 

1444 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1444 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1445 1445 

1446 Citations associated with the text content.1446 Citations associated with the text content.

1447 1447 

1448 - `array of object { file_id, filename, index, type }`1448 - `FileCitation object { file_id, filename, index, type }`

1449 1449 

1450 - `file_id: string`1450 - `file_id: string`

1451 1451 


1465 1465 

1466 - `"file_citation"`1466 - `"file_citation"`

1467 1467 

1468 - `array of object { end_index, start_index, title, 2 more }`1468 - `URLCitation object { end_index, start_index, title, 2 more }`

1469 1469 

1470 - `end_index: number`1470 - `end_index: number`

1471 1471 


1489 1489 

1490 The URL of the cited resource.1490 The URL of the cited resource.

1491 1491 

1492 - `array of object { container_id, end_index, file_id, 3 more }`1492 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

1493 1493 

1494 - `container_id: string`1494 - `container_id: string`

1495 1495 


3840 3840 

3841 - `encrypted_content: optional string`3841 - `encrypted_content: optional string`

3842 3842 

3843 The encrypted content of the reasoning item - populated when a response is3843 The encrypted content of the reasoning item. This is populated by default

3844 generated with `reasoning.encrypted_content` in the `include` parameter.3844 for reasoning items returned by `POST /v1/responses` and WebSocket

3845 `response.create` requests.

3845 3846 

3846 - `status: optional "in_progress" or "completed" or "incomplete"`3847 - `status: optional "in_progress" or "completed" or "incomplete"`

3847 3848 


5879 5880 

5880 - `encrypted_content: optional string`5881 - `encrypted_content: optional string`

5881 5882 

5882 The encrypted content of the reasoning item - populated when a response is5883 The encrypted content of the reasoning item. This is populated by default

5883 generated with `reasoning.encrypted_content` in the `include` parameter.5884 for reasoning items returned by `POST /v1/responses` and WebSocket

5885 `response.create` requests.

5884 5886 

5885 - `status: optional "in_progress" or "completed" or "incomplete"`5887 - `status: optional "in_progress" or "completed" or "incomplete"`

5886 5888 

Details

1559 1559 

1560 - `"output_text"`1560 - `"output_text"`

1561 1561 

1562 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1562 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1563 1563 

1564 Citations associated with the text content.1564 Citations associated with the text content.

1565 1565 

1566 - `array of object { file_id, filename, index, type }`1566 - `FileCitation object { file_id, filename, index, type }`

1567 1567 

1568 - `file_id: string`1568 - `file_id: string`

1569 1569 


1583 1583 

1584 - `"file_citation"`1584 - `"file_citation"`

1585 1585 

1586 - `array of object { end_index, start_index, title, 2 more }`1586 - `URLCitation object { end_index, start_index, title, 2 more }`

1587 1587 

1588 - `end_index: number`1588 - `end_index: number`

1589 1589 


1607 1607 

1608 The URL of the cited resource.1608 The URL of the cited resource.

1609 1609 

1610 - `array of object { container_id, end_index, file_id, 3 more }`1610 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

1611 1611 

1612 - `container_id: string`1612 - `container_id: string`

1613 1613 


3958 3958 

3959 - `encrypted_content: optional string`3959 - `encrypted_content: optional string`

3960 3960 

3961 The encrypted content of the reasoning item - populated when a response is3961 The encrypted content of the reasoning item. This is populated by default

3962 generated with `reasoning.encrypted_content` in the `include` parameter.3962 for reasoning items returned by `POST /v1/responses` and WebSocket

3963 `response.create` requests.

3963 3964 

3964 - `status: optional "in_progress" or "completed" or "incomplete"`3965 - `status: optional "in_progress" or "completed" or "incomplete"`

3965 3966 


8863 8864 

8864 - `encrypted_content: optional string`8865 - `encrypted_content: optional string`

8865 8866 

8866 The encrypted content of the reasoning item - populated when a response is8867 The encrypted content of the reasoning item. This is populated by default

8867 generated with `reasoning.encrypted_content` in the `include` parameter.8868 for reasoning items returned by `POST /v1/responses` and WebSocket

8869 `response.create` requests.

8868 8870 

8869 - `status: optional "in_progress" or "completed" or "incomplete"`8871 - `status: optional "in_progress" or "completed" or "incomplete"`

8870 8872 

Details

1435 1435 

1436 - `"output_text"`1436 - `"output_text"`

1437 1437 

1438 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1438 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1439 1439 

1440 Citations associated with the text content.1440 Citations associated with the text content.

1441 1441 

1442 - `array of object { file_id, filename, index, type }`1442 - `FileCitation object { file_id, filename, index, type }`

1443 1443 

1444 - `file_id: string`1444 - `file_id: string`

1445 1445 


1459 1459 

1460 - `"file_citation"`1460 - `"file_citation"`

1461 1461 

1462 - `array of object { end_index, start_index, title, 2 more }`1462 - `URLCitation object { end_index, start_index, title, 2 more }`

1463 1463 

1464 - `end_index: number`1464 - `end_index: number`

1465 1465 


1483 1483 

1484 The URL of the cited resource.1484 The URL of the cited resource.

1485 1485 

1486 - `array of object { container_id, end_index, file_id, 3 more }`1486 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

1487 1487 

1488 - `container_id: string`1488 - `container_id: string`

1489 1489 


3834 3834 

3835 - `encrypted_content: optional string`3835 - `encrypted_content: optional string`

3836 3836 

3837 The encrypted content of the reasoning item - populated when a response is3837 The encrypted content of the reasoning item. This is populated by default

3838 generated with `reasoning.encrypted_content` in the `include` parameter.3838 for reasoning items returned by `POST /v1/responses` and WebSocket

3839 `response.create` requests.

3839 3840 

3840 - `status: optional "in_progress" or "completed" or "incomplete"`3841 - `status: optional "in_progress" or "completed" or "incomplete"`

3841 3842 


8112 8113 

8113 - `"output_text"`8114 - `"output_text"`

8114 8115 

8115 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`8116 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

8116 8117 

8117 Citations associated with the text content.8118 Citations associated with the text content.

8118 8119 

8119 - `array of object { file_id, filename, index, type }`8120 - `FileCitation object { file_id, filename, index, type }`

8120 8121 

8121 - `file_id: string`8122 - `file_id: string`

8122 8123 


8136 8137 

8137 - `"file_citation"`8138 - `"file_citation"`

8138 8139 

8139 - `array of object { end_index, start_index, title, 2 more }`8140 - `URLCitation object { end_index, start_index, title, 2 more }`

8140 8141 

8141 - `end_index: number`8142 - `end_index: number`

8142 8143 


8160 8161 

8161 The URL of the cited resource.8162 The URL of the cited resource.

8162 8163 

8163 - `array of object { container_id, end_index, file_id, 3 more }`8164 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

8164 8165 

8165 - `container_id: string`8166 - `container_id: string`

8166 8167 


10511 10512 

10512 - `encrypted_content: optional string`10513 - `encrypted_content: optional string`

10513 10514 

10514 The encrypted content of the reasoning item - populated when a response is10515 The encrypted content of the reasoning item. This is populated by default

10515 generated with `reasoning.encrypted_content` in the `include` parameter.10516 for reasoning items returned by `POST /v1/responses` and WebSocket

10517 `response.create` requests.

10516 10518 

10517 - `status: optional "in_progress" or "completed" or "incomplete"`10519 - `status: optional "in_progress" or "completed" or "incomplete"`

10518 10520 


12550 12552 

12551 - `encrypted_content: optional string`12553 - `encrypted_content: optional string`

12552 12554 

12553 The encrypted content of the reasoning item - populated when a response is12555 The encrypted content of the reasoning item. This is populated by default

12554 generated with `reasoning.encrypted_content` in the `include` parameter.12556 for reasoning items returned by `POST /v1/responses` and WebSocket

12557 `response.create` requests.

12555 12558 

12556 - `status: optional "in_progress" or "completed" or "incomplete"`12559 - `status: optional "in_progress" or "completed" or "incomplete"`

12557 12560 

Details

1485 1485 

1486 - `"output_text"`1486 - `"output_text"`

1487 1487 

1488 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1488 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1489 1489 

1490 Citations associated with the text content.1490 Citations associated with the text content.

1491 1491 

1492 - `array of object { file_id, filename, index, type }`1492 - `FileCitation object { file_id, filename, index, type }`

1493 1493 

1494 - `file_id: string`1494 - `file_id: string`

1495 1495 


1509 1509 

1510 - `"file_citation"`1510 - `"file_citation"`

1511 1511 

1512 - `array of object { end_index, start_index, title, 2 more }`1512 - `URLCitation object { end_index, start_index, title, 2 more }`

1513 1513 

1514 - `end_index: number`1514 - `end_index: number`

1515 1515 


1533 1533 

1534 The URL of the cited resource.1534 The URL of the cited resource.

1535 1535 

1536 - `array of object { container_id, end_index, file_id, 3 more }`1536 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

1537 1537 

1538 - `container_id: string`1538 - `container_id: string`

1539 1539 


3884 3884 

3885 - `encrypted_content: optional string`3885 - `encrypted_content: optional string`

3886 3886 

3887 The encrypted content of the reasoning item - populated when a response is3887 The encrypted content of the reasoning item. This is populated by default

3888 generated with `reasoning.encrypted_content` in the `include` parameter.3888 for reasoning items returned by `POST /v1/responses` and WebSocket

3889 `response.create` requests.

3889 3890 

3890 - `status: optional "in_progress" or "completed" or "incomplete"`3891 - `status: optional "in_progress" or "completed" or "incomplete"`

3891 3892 


5923 5924 

5924 - `encrypted_content: optional string`5925 - `encrypted_content: optional string`

5925 5926 

5926 The encrypted content of the reasoning item - populated when a response is5927 The encrypted content of the reasoning item. This is populated by default

5927 generated with `reasoning.encrypted_content` in the `include` parameter.5928 for reasoning items returned by `POST /v1/responses` and WebSocket

5929 `response.create` requests.

5928 5930 

5929 - `status: optional "in_progress" or "completed" or "incomplete"`5931 - `status: optional "in_progress" or "completed" or "incomplete"`

5930 5932 

Details

3699 3699 

3700 - `encrypted_content: optional string`3700 - `encrypted_content: optional string`

3701 3701 

3702 The encrypted content of the reasoning item - populated when a response is3702 The encrypted content of the reasoning item. This is populated by default

3703 generated with `reasoning.encrypted_content` in the `include` parameter.3703 for reasoning items returned by `POST /v1/responses` and WebSocket

3704 `response.create` requests.

3704 3705 

3705 - `status: optional "in_progress" or "completed" or "incomplete"`3706 - `status: optional "in_progress" or "completed" or "incomplete"`

3706 3707 

Details

1376 1376 

1377 - `"output_text"`1377 - `"output_text"`

1378 1378 

1379 - `annotations: optional array of object { file_id, filename, index, type } or array of object { end_index, start_index, title, 2 more } or array of object { container_id, end_index, file_id, 3 more }`1379 - `annotations: optional array of object { file_id, filename, index, type } or object { end_index, start_index, title, 2 more } or object { container_id, end_index, file_id, 3 more }`

1380 1380 

1381 Citations associated with the text content.1381 Citations associated with the text content.

1382 1382 

1383 - `array of object { file_id, filename, index, type }`1383 - `FileCitation object { file_id, filename, index, type }`

1384 1384 

1385 - `file_id: string`1385 - `file_id: string`

1386 1386 


1400 1400 

1401 - `"file_citation"`1401 - `"file_citation"`

1402 1402 

1403 - `array of object { end_index, start_index, title, 2 more }`1403 - `URLCitation object { end_index, start_index, title, 2 more }`

1404 1404 

1405 - `end_index: number`1405 - `end_index: number`

1406 1406 


1424 1424 

1425 The URL of the cited resource.1425 The URL of the cited resource.

1426 1426 

1427 - `array of object { container_id, end_index, file_id, 3 more }`1427 - `ContainerFileCitation object { container_id, end_index, file_id, 3 more }`

1428 1428 

1429 - `container_id: string`1429 - `container_id: string`

1430 1430 


3775 3775 

3776 - `encrypted_content: optional string`3776 - `encrypted_content: optional string`

3777 3777 

3778 The encrypted content of the reasoning item - populated when a response is3778 The encrypted content of the reasoning item. This is populated by default

3779 generated with `reasoning.encrypted_content` in the `include` parameter.3779 for reasoning items returned by `POST /v1/responses` and WebSocket

3780 `response.create` requests.

3780 3781 

3781 - `status: optional "in_progress" or "completed" or "incomplete"`3782 - `status: optional "in_progress" or "completed" or "incomplete"`

3782 3783 

Details

3155 3155 

3156 - `encrypted_content: optional string`3156 - `encrypted_content: optional string`

3157 3157 

3158 The encrypted content of the reasoning item - populated when a response is3158 The encrypted content of the reasoning item. This is populated by default

3159 generated with `reasoning.encrypted_content` in the `include` parameter.3159 for reasoning items returned by `POST /v1/responses` and WebSocket

3160 `response.create` requests.

3160 3161 

3161 - `status: optional "in_progress" or "completed" or "incomplete"`3162 - `status: optional "in_progress" or "completed" or "incomplete"`

3162 3163 

Details

3182 3182 

3183 - `encrypted_content: optional string`3183 - `encrypted_content: optional string`

3184 3184 

3185 The encrypted content of the reasoning item - populated when a response is3185 The encrypted content of the reasoning item. This is populated by default

3186 generated with `reasoning.encrypted_content` in the `include` parameter.3186 for reasoning items returned by `POST /v1/responses` and WebSocket

3187 `response.create` requests.

3187 3188 

3188 - `status: optional "in_progress" or "completed" or "incomplete"`3189 - `status: optional "in_progress" or "completed" or "incomplete"`

3189 3190 


7187 7188 

7188 - `encrypted_content: optional string`7189 - `encrypted_content: optional string`

7189 7190 

7190 The encrypted content of the reasoning item - populated when a response is7191 The encrypted content of the reasoning item. This is populated by default

7191 generated with `reasoning.encrypted_content` in the `include` parameter.7192 for reasoning items returned by `POST /v1/responses` and WebSocket

7193 `response.create` requests.

7192 7194 

7193 - `status: optional "in_progress" or "completed" or "incomplete"`7195 - `status: optional "in_progress" or "completed" or "incomplete"`

7194 7196 

Details

3176 3176 

3177 - `encrypted_content: optional string`3177 - `encrypted_content: optional string`

3178 3178 

3179 The encrypted content of the reasoning item - populated when a response is3179 The encrypted content of the reasoning item. This is populated by default

3180 generated with `reasoning.encrypted_content` in the `include` parameter.3180 for reasoning items returned by `POST /v1/responses` and WebSocket

3181 `response.create` requests.

3181 3182 

3182 - `status: optional "in_progress" or "completed" or "incomplete"`3183 - `status: optional "in_progress" or "completed" or "incomplete"`

3183 3184 

Details

3147 3147 

3148 - `encrypted_content: optional string`3148 - `encrypted_content: optional string`

3149 3149 

3150 The encrypted content of the reasoning item - populated when a response is3150 The encrypted content of the reasoning item. This is populated by default

3151 generated with `reasoning.encrypted_content` in the `include` parameter.3151 for reasoning items returned by `POST /v1/responses` and WebSocket

3152 `response.create` requests.

3152 3153 

3153 - `status: optional "in_progress" or "completed" or "incomplete"`3154 - `status: optional "in_progress" or "completed" or "incomplete"`

3154 3155 

Details

3247 3247 

3248 - `encrypted_content: optional string`3248 - `encrypted_content: optional string`

3249 3249 

3250 The encrypted content of the reasoning item - populated when a response is3250 The encrypted content of the reasoning item. This is populated by default

3251 generated with `reasoning.encrypted_content` in the `include` parameter.3251 for reasoning items returned by `POST /v1/responses` and WebSocket

3252 `response.create` requests.

3252 3253 

3253 - `status: optional "in_progress" or "completed" or "incomplete"`3254 - `status: optional "in_progress" or "completed" or "incomplete"`

3254 3255 


4827 4828 

4828 - `encrypted_content: optional string`4829 - `encrypted_content: optional string`

4829 4830 

4830 The encrypted content of the reasoning item - populated when a response is4831 The encrypted content of the reasoning item. This is populated by default

4831 generated with `reasoning.encrypted_content` in the `include` parameter.4832 for reasoning items returned by `POST /v1/responses` and WebSocket

4833 `response.create` requests.

4832 4834 

4833 - `status: optional "in_progress" or "completed" or "incomplete"`4835 - `status: optional "in_progress" or "completed" or "incomplete"`

4834 4836 

Details

3365 3365 

3366 - `encrypted_content: optional string`3366 - `encrypted_content: optional string`

3367 3367 

3368 The encrypted content of the reasoning item - populated when a response is3368 The encrypted content of the reasoning item. This is populated by default

3369 generated with `reasoning.encrypted_content` in the `include` parameter.3369 for reasoning items returned by `POST /v1/responses` and WebSocket

3370 `response.create` requests.

3370 3371 

3371 - `status: optional "in_progress" or "completed" or "incomplete"`3372 - `status: optional "in_progress" or "completed" or "incomplete"`

3372 3373 


7483 7484 

7484 - `encrypted_content: optional string`7485 - `encrypted_content: optional string`

7485 7486 

7486 The encrypted content of the reasoning item - populated when a response is7487 The encrypted content of the reasoning item. This is populated by default

7487 generated with `reasoning.encrypted_content` in the `include` parameter.7488 for reasoning items returned by `POST /v1/responses` and WebSocket

7489 `response.create` requests.

7488 7490 

7489 - `status: optional "in_progress" or "completed" or "incomplete"`7491 - `status: optional "in_progress" or "completed" or "incomplete"`

7490 7492 

Details

3241 3241 

3242 - `encrypted_content: optional string`3242 - `encrypted_content: optional string`

3243 3243 

3244 The encrypted content of the reasoning item - populated when a response is3244 The encrypted content of the reasoning item. This is populated by default

3245 generated with `reasoning.encrypted_content` in the `include` parameter.3245 for reasoning items returned by `POST /v1/responses` and WebSocket

3246 `response.create` requests.

3246 3247 

3247 - `status: optional "in_progress" or "completed" or "incomplete"`3248 - `status: optional "in_progress" or "completed" or "incomplete"`

3248 3249 


8983 8984 

8984 - `encrypted_content: optional string`8985 - `encrypted_content: optional string`

8985 8986 

8986 The encrypted content of the reasoning item - populated when a response is8987 The encrypted content of the reasoning item. This is populated by default

8987 generated with `reasoning.encrypted_content` in the `include` parameter.8988 for reasoning items returned by `POST /v1/responses` and WebSocket

8989 `response.create` requests.

8988 8990 

8989 - `status: optional "in_progress" or "completed" or "incomplete"`8991 - `status: optional "in_progress" or "completed" or "incomplete"`

8990 8992 


10563 10565 

10564 - `encrypted_content: optional string`10566 - `encrypted_content: optional string`

10565 10567 

10566 The encrypted content of the reasoning item - populated when a response is10568 The encrypted content of the reasoning item. This is populated by default

10567 generated with `reasoning.encrypted_content` in the `include` parameter.10569 for reasoning items returned by `POST /v1/responses` and WebSocket

10570 `response.create` requests.

10568 10571 

10569 - `status: optional "in_progress" or "completed" or "incomplete"`10572 - `status: optional "in_progress" or "completed" or "incomplete"`

10570 10573 

Details

3291 3291 

3292 - `encrypted_content: optional string`3292 - `encrypted_content: optional string`

3293 3293 

3294 The encrypted content of the reasoning item - populated when a response is3294 The encrypted content of the reasoning item. This is populated by default

3295 generated with `reasoning.encrypted_content` in the `include` parameter.3295 for reasoning items returned by `POST /v1/responses` and WebSocket

3296 `response.create` requests.

3296 3297 

3297 - `status: optional "in_progress" or "completed" or "incomplete"`3298 - `status: optional "in_progress" or "completed" or "incomplete"`

3298 3299 


4871 4872 

4872 - `encrypted_content: optional string`4873 - `encrypted_content: optional string`

4873 4874 

4874 The encrypted content of the reasoning item - populated when a response is4875 The encrypted content of the reasoning item. This is populated by default

4875 generated with `reasoning.encrypted_content` in the `include` parameter.4876 for reasoning items returned by `POST /v1/responses` and WebSocket

4877 `response.create` requests.

4876 4878 

4877 - `status: optional "in_progress" or "completed" or "incomplete"`4879 - `status: optional "in_progress" or "completed" or "incomplete"`

4878 4880 

Details

3090 3090 

3091 - `encrypted_content: optional string`3091 - `encrypted_content: optional string`

3092 3092 

3093 The encrypted content of the reasoning item - populated when a response is3093 The encrypted content of the reasoning item. This is populated by default

3094 generated with `reasoning.encrypted_content` in the `include` parameter.3094 for reasoning items returned by `POST /v1/responses` and WebSocket

3095 `response.create` requests.

3095 3096 

3096 - `status: optional "in_progress" or "completed" or "incomplete"`3097 - `status: optional "in_progress" or "completed" or "incomplete"`

3097 3098 

Details

3182 3182 

3183 - `encrypted_content: optional string`3183 - `encrypted_content: optional string`

3184 3184 

3185 The encrypted content of the reasoning item - populated when a response is3185 The encrypted content of the reasoning item. This is populated by default

3186 generated with `reasoning.encrypted_content` in the `include` parameter.3186 for reasoning items returned by `POST /v1/responses` and WebSocket

3187 `response.create` requests.

3187 3188 

3188 - `status: optional "in_progress" or "completed" or "incomplete"`3189 - `status: optional "in_progress" or "completed" or "incomplete"`

3189 3190 

Details

44 44 

45 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.45 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.

46 46 

47- `event_types: Array[:"api_key.created" | :"api_key.updated" | :"api_key.deleted" | 56 more]`47- `event_types: Array[:"api_key.created" | :"api_key.updated" | :"api_key.deleted" | 140 more]`

48 48 

49 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).49 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).

50 50 


166 166 

167 - `:"user.deleted"`167 - `:"user.deleted"`

168 168 

169 - `:"tenant.metadata.updated"`

170 

171 - `:"tenant.microsoft_entra_mapping.upserted"`

172 

173 - `:"tenant.microsoft_entra_mapping.deleted"`

174 

175 - `:"tenant.workload_identity.provider.created"`

176 

177 - `:"tenant.workload_identity.provider.updated"`

178 

179 - `:"tenant.workload_identity.provider.archived"`

180 

181 - `:"tenant.workload_identity.mapping.created"`

182 

183 - `:"tenant.workload_identity.mapping.updated"`

184 

185 - `:"tenant.workload_identity.mapping.archived"`

186 

187 - `:"tenant.workload_identity.binding.created"`

188 

189 - `:"tenant.workload_identity.principal.provisioned"`

190 

191 - `:"tenant.admin_api_key.created"`

192 

193 - `:"tenant.admin_api_key.updated"`

194 

195 - `:"tenant.admin_api_key.deleted"`

196 

197 - `:"tenant.project_api_key.created"`

198 

199 - `:"tenant.chatgpt_access_token.revoked"`

200 

201 - `:"tenant.migration.completed"`

202 

203 - `:"tenant.sso.migrated"`

204 

205 - `:"tenant.domains.migrated"`

206 

207 - `:"tenant.sso_connection.created"`

208 

209 - `:"tenant.sso_connection.updated"`

210 

211 - `:"tenant.sso_connection.deleted"`

212 

213 - `:"tenant.sso_connection.setup.started"`

214 

215 - `:"tenant.policy.created"`

216 

217 - `:"tenant.policy.updated"`

218 

219 - `:"tenant.policy.deleted"`

220 

221 - `:"tenant.policy.attached"`

222 

223 - `:"tenant.policy.detached"`

224 

225 - `:"tenant.principal_authentication_policy.resolved"`

226 

227 - `:"tenant.scim.setup.started"`

228 

229 - `:"tenant.scim.deletion.requested"`

230 

231 - `:"tenant.scim.directory.created"`

232 

233 - `:"tenant.product_access_policy.updated"`

234 

235 - `:"tenant.resource_share_grant.created"`

236 

237 - `:"tenant.resource_share_grant.updated"`

238 

239 - `:"tenant.resource_share_grant.accepted"`

240 

241 - `:"tenant.resource_share_grant.declined"`

242 

243 - `:"tenant.resource_share_grant.revoked"`

244 

245 - `:"tenant.resource_share_grant.deleted"`

246 

247 - `:"tenant.service_account.updated"`

248 

249 - `:"tenant.service_account.deleted"`

250 

251 - `:"tenant.service_account.token.revoked"`

252 

253 - `:"tenant.billing.overage_limit.updated"`

254 

255 - `:"tenant.billing.alerts.updated"`

256 

257 - `:"tenant.billing.info.updated"`

258 

259 - `:"tenant.usage_limit.workspace.updated"`

260 

261 - `:"tenant.usage_limit.group.updated"`

262 

263 - `:"tenant.usage_limit.user.updated"`

264 

265 - `:"tenant.usage_limit.increase_request.updated"`

266 

267 - `:"tenant.usage_limit.increase_request.resolved"`

268 

269 - `:"tenant.group.created"`

270 

271 - `:"tenant.group.updated"`

272 

273 - `:"tenant.group.deleted"`

274 

275 - `:"tenant.group.member.added"`

276 

277 - `:"tenant.group.member.removed"`

278 

279 - `:"tenant.migration_rollout.status.updated"`

280 

281 - `:"tenant.migration_rollout.tier.updated"`

282 

283 - `:"tenant.role.metadata.updated"`

284 

285 - `:"tenant.custom_role.created"`

286 

287 - `:"tenant.custom_role.updated"`

288 

289 - `:"tenant.custom_role.deleted"`

290 

291 - `:"tenant.role_assignment.created"`

292 

293 - `:"tenant.role_assignment.deleted"`

294 

295 - `:"tenant.resource_role_assignment.created"`

296 

297 - `:"tenant.resource_role_assignment.deleted"`

298 

299 - `:"tenant.resource_access.updated"`

300 

301 - `:"tenant.resource_access.deleted"`

302 

303 - `:"tenant.session_policy.created"`

304 

305 - `:"tenant.session_policy.updated"`

306 

307 - `:"tenant.session_policy.deleted"`

308 

309 - `:"tenant.session_revocation.started"`

310 

311 - `:"tenant.third_party_app_policy.updated"`

312 

313 - `:"tenant.user.added"`

314 

315 - `:"tenant.user.updated"`

316 

317 - `:"tenant.user.removed"`

318 

319 - `:"tenant.user.looked_up"`

320 

321 - `:"tenant.user.invited"`

322 

323 - `:"tenant.membership.revoked"`

324 

325 - `:"tenant.api_organization_invite.upserted"`

326 

327 - `:"tenant.api_organization_invite.deleted"`

328 

329 - `:"tenant.chatgpt_workspace_invite.upserted"`

330 

331 - `:"tenant.membership.accepted"`

332 

333 - `:"tenant.membership.declined"`

334 

335 - `:"tenant.workspace_invite_email_settings.updated"`

336 

169- `limit: Integer`337- `limit: Integer`

170 338 

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


196 364 

197 The Unix timestamp (in seconds) of the event.365 The Unix timestamp (in seconds) of the event.

198 366 

199 - `type: :"api_key.created" | :"api_key.updated" | :"api_key.deleted" | 56 more`367 - `type: :"api_key.created" | :"api_key.updated" | :"api_key.deleted" | 140 more`

200 368 

201 The event type.369 The event type.

202 370 


318 486 

319 - `:"user.deleted"`487 - `:"user.deleted"`

320 488 

489 - `:"tenant.metadata.updated"`

490 

491 - `:"tenant.microsoft_entra_mapping.upserted"`

492 

493 - `:"tenant.microsoft_entra_mapping.deleted"`

494 

495 - `:"tenant.workload_identity.provider.created"`

496 

497 - `:"tenant.workload_identity.provider.updated"`

498 

499 - `:"tenant.workload_identity.provider.archived"`

500 

501 - `:"tenant.workload_identity.mapping.created"`

502 

503 - `:"tenant.workload_identity.mapping.updated"`

504 

505 - `:"tenant.workload_identity.mapping.archived"`

506 

507 - `:"tenant.workload_identity.binding.created"`

508 

509 - `:"tenant.workload_identity.principal.provisioned"`

510 

511 - `:"tenant.admin_api_key.created"`

512 

513 - `:"tenant.admin_api_key.updated"`

514 

515 - `:"tenant.admin_api_key.deleted"`

516 

517 - `:"tenant.project_api_key.created"`

518 

519 - `:"tenant.chatgpt_access_token.revoked"`

520 

521 - `:"tenant.migration.completed"`

522 

523 - `:"tenant.sso.migrated"`

524 

525 - `:"tenant.domains.migrated"`

526 

527 - `:"tenant.sso_connection.created"`

528 

529 - `:"tenant.sso_connection.updated"`

530 

531 - `:"tenant.sso_connection.deleted"`

532 

533 - `:"tenant.sso_connection.setup.started"`

534 

535 - `:"tenant.policy.created"`

536 

537 - `:"tenant.policy.updated"`

538 

539 - `:"tenant.policy.deleted"`

540 

541 - `:"tenant.policy.attached"`

542 

543 - `:"tenant.policy.detached"`

544 

545 - `:"tenant.principal_authentication_policy.resolved"`

546 

547 - `:"tenant.scim.setup.started"`

548 

549 - `:"tenant.scim.deletion.requested"`

550 

551 - `:"tenant.scim.directory.created"`

552 

553 - `:"tenant.product_access_policy.updated"`

554 

555 - `:"tenant.resource_share_grant.created"`

556 

557 - `:"tenant.resource_share_grant.updated"`

558 

559 - `:"tenant.resource_share_grant.accepted"`

560 

561 - `:"tenant.resource_share_grant.declined"`

562 

563 - `:"tenant.resource_share_grant.revoked"`

564 

565 - `:"tenant.resource_share_grant.deleted"`

566 

567 - `:"tenant.service_account.updated"`

568 

569 - `:"tenant.service_account.deleted"`

570 

571 - `:"tenant.service_account.token.revoked"`

572 

573 - `:"tenant.billing.overage_limit.updated"`

574 

575 - `:"tenant.billing.alerts.updated"`

576 

577 - `:"tenant.billing.info.updated"`

578 

579 - `:"tenant.usage_limit.workspace.updated"`

580 

581 - `:"tenant.usage_limit.group.updated"`

582 

583 - `:"tenant.usage_limit.user.updated"`

584 

585 - `:"tenant.usage_limit.increase_request.updated"`

586 

587 - `:"tenant.usage_limit.increase_request.resolved"`

588 

589 - `:"tenant.group.created"`

590 

591 - `:"tenant.group.updated"`

592 

593 - `:"tenant.group.deleted"`

594 

595 - `:"tenant.group.member.added"`

596 

597 - `:"tenant.group.member.removed"`

598 

599 - `:"tenant.migration_rollout.status.updated"`

600 

601 - `:"tenant.migration_rollout.tier.updated"`

602 

603 - `:"tenant.role.metadata.updated"`

604 

605 - `:"tenant.custom_role.created"`

606 

607 - `:"tenant.custom_role.updated"`

608 

609 - `:"tenant.custom_role.deleted"`

610 

611 - `:"tenant.role_assignment.created"`

612 

613 - `:"tenant.role_assignment.deleted"`

614 

615 - `:"tenant.resource_role_assignment.created"`

616 

617 - `:"tenant.resource_role_assignment.deleted"`

618 

619 - `:"tenant.resource_access.updated"`

620 

621 - `:"tenant.resource_access.deleted"`

622 

623 - `:"tenant.session_policy.created"`

624 

625 - `:"tenant.session_policy.updated"`

626 

627 - `:"tenant.session_policy.deleted"`

628 

629 - `:"tenant.session_revocation.started"`

630 

631 - `:"tenant.third_party_app_policy.updated"`

632 

633 - `:"tenant.user.added"`

634 

635 - `:"tenant.user.updated"`

636 

637 - `:"tenant.user.removed"`

638 

639 - `:"tenant.user.looked_up"`

640 

641 - `:"tenant.user.invited"`

642 

643 - `:"tenant.membership.revoked"`

644 

645 - `:"tenant.api_organization_invite.upserted"`

646 

647 - `:"tenant.api_organization_invite.deleted"`

648 

649 - `:"tenant.chatgpt_workspace_invite.upserted"`

650 

651 - `:"tenant.membership.accepted"`

652 

653 - `:"tenant.membership.declined"`

654 

655 - `:"tenant.workspace_invite_email_settings.updated"`

656 

321 - `actor: Actor{ api_key, session, type}`657 - `actor: Actor{ api_key, session, type}`

322 658 

323 The actor who performed the audit logged action.659 The actor who performed the audit logged action.

Details

4 4 

5**post** `/organization/projects/{project_id}/service_accounts`5**post** `/organization/projects/{project_id}/service_accounts`

6 6 

7Creates a new service account in the project. This also returns an unredacted API key for the service account.7Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

8 8 

9### Parameters9### Parameters

10 10 


14 14 

15 The name of the service account being created.15 The name of the service account being created.

16 16 

17- `create_service_account_only: bool`

18 

19 Create the service account without default roles or an API key.

20 

17### Returns21### Returns

18 22 

19- `class ServiceAccountCreateResponse`23- `class ServiceAccountCreateResponse`


44 48 

45 - `:"organization.project.service_account"`49 - `:"organization.project.service_account"`

46 50 

47 - `role: :member`51 - `role: :member | :none`

48 52 

49 Service accounts can only have one role of type `member`53 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

50 54 

51 - `:member`55 - `:member`

52 56 

57 - `:none`

58 

53### Example59### Example

54 60 

55```ruby61```ruby

Details

42 42 

43 - `:"organization.project.service_account"`43 - `:"organization.project.service_account"`

44 44 

45 - `role: :owner | :member`45 - `role: :owner | :member | :none`

46 46 

47 `owner` or `member`47 `owner`, `member`, or `none`

48 48 

49 - `:owner`49 - `:owner`

50 50 

51 - `:member`51 - `:member`

52 52 

53 - `:none`

54 

53### Example55### Example

54 56 

55```ruby57```ruby

Details

36 36 

37 - `:"organization.project.service_account"`37 - `:"organization.project.service_account"`

38 38 

39 - `role: :owner | :member`39 - `role: :owner | :member | :none`

40 40 

41 `owner` or `member`41 `owner`, `member`, or `none`

42 42 

43 - `:owner`43 - `:owner`

44 44 

45 - `:member`45 - `:member`

46 46 

47 - `:none`

48 

47### Example49### Example

48 50 

49```ruby51```ruby

Details

48 48 

49 - `:"organization.project.service_account"`49 - `:"organization.project.service_account"`

50 50 

51 - `role: :owner | :member`51 - `role: :owner | :member | :none`

52 52 

53 `owner` or `member`53 `owner`, `member`, or `none`

54 54 

55 - `:owner`55 - `:owner`

56 56 

57 - `:member`57 - `:member`

58 58 

59 - `:none`

60 

59### Example61### Example

60 62 

61```ruby63```ruby

Details

1## Create project service account API key

2 

3`admin.organization.projects.service_accounts.api_keys.create(service_account_id, **kwargs) -> APIKeyCreateResponse`

4 

5**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

6 

7Creates an API key for a service account in the project.

8 

9### Parameters

10 

11- `project_id: String`

12 

13- `service_account_id: String`

14 

15- `name: String`

16 

17 API key name.

18 

19- `scopes: Array[String]`

20 

21 API key scopes.

22 

23### Returns

24 

25- `class APIKeyCreateResponse`

26 

27 - `id: String`

28 

29 - `created_at: Integer`

30 

31 - `name: String`

32 

33 - `object: :"organization.project.service_account.api_key"`

34 

35 The object type, which is always `organization.project.service_account.api_key`

36 

37 - `:"organization.project.service_account.api_key"`

38 

39 - `value: String`

40 

41### Example

42 

43```ruby

44require "openai"

45 

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

47 

48api_key = openai.admin.organization.projects.service_accounts.api_keys.create(

49 "service_account_id",

50 project_id: "project_id"

51)

52 

53puts(api_key)

54```

55 

56#### Response

57 

58```json

59{

60 "id": "id",

61 "created_at": 0,

62 "name": "name",

63 "object": "organization.project.service_account.api_key",

64 "value": "value"

65}

66```

Details

78 78 

79 - `:bucket`79 - `:bucket`

80 80 

81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

82 82 

83 - `class OrganizationUsageCompletionsResult`83 - `class OrganizationUsageCompletionsResult`

84 84 


86 86 

87 - `input_tokens: Integer`87 - `input_tokens: Integer`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: Integer`91 - `num_model_requests: Integer`

92 92 


98 98 

99 - `output_tokens: Integer`99 - `output_tokens: Integer`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: String`103 - `api_key_id: String`

104 104 


110 110 

111 - `input_audio_tokens: Integer`111 - `input_audio_tokens: Integer`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Integer`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Integer`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Integer`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Integer`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Integer`131 - `input_cached_tokens: Integer`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Integer`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Integer`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Integer`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: String`147 - `model: String`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Integer`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Integer`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: String`163 - `project_id: String`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


475 "api_key_id": "api_key_id",511 "api_key_id": "api_key_id",

476 "batch": true,512 "batch": true,

477 "input_audio_tokens": 0,513 "input_audio_tokens": 0,

514 "input_cache_write_tokens": 0,

515 "input_cached_audio_tokens": 0,

516 "input_cached_image_tokens": 0,

517 "input_cached_text_tokens": 0,

478 "input_cached_tokens": 0,518 "input_cached_tokens": 0,

519 "input_image_tokens": 0,

520 "input_text_tokens": 0,

521 "input_uncached_tokens": 0,

479 "model": "model",522 "model": "model",

480 "output_audio_tokens": 0,523 "output_audio_tokens": 0,

524 "output_image_tokens": 0,

525 "output_text_tokens": 0,

481 "project_id": "project_id",526 "project_id": "project_id",

482 "service_tier": "service_tier",527 "service_tier": "service_tier",

483 "user_id": "user_id"528 "user_id": "user_id"

Details

78 78 

79 - `:bucket`79 - `:bucket`

80 80 

81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

82 82 

83 - `class OrganizationUsageCompletionsResult`83 - `class OrganizationUsageCompletionsResult`

84 84 


86 86 

87 - `input_tokens: Integer`87 - `input_tokens: Integer`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: Integer`91 - `num_model_requests: Integer`

92 92 


98 98 

99 - `output_tokens: Integer`99 - `output_tokens: Integer`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: String`103 - `api_key_id: String`

104 104 


110 110 

111 - `input_audio_tokens: Integer`111 - `input_audio_tokens: Integer`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Integer`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Integer`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Integer`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Integer`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Integer`131 - `input_cached_tokens: Integer`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Integer`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Integer`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Integer`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: String`147 - `model: String`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Integer`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Integer`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: String`163 - `project_id: String`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


475 "api_key_id": "api_key_id",511 "api_key_id": "api_key_id",

476 "batch": true,512 "batch": true,

477 "input_audio_tokens": 0,513 "input_audio_tokens": 0,

514 "input_cache_write_tokens": 0,

515 "input_cached_audio_tokens": 0,

516 "input_cached_image_tokens": 0,

517 "input_cached_text_tokens": 0,

478 "input_cached_tokens": 0,518 "input_cached_tokens": 0,

519 "input_image_tokens": 0,

520 "input_text_tokens": 0,

521 "input_uncached_tokens": 0,

479 "model": "model",522 "model": "model",

480 "output_audio_tokens": 0,523 "output_audio_tokens": 0,

524 "output_image_tokens": 0,

525 "output_text_tokens": 0,

481 "project_id": "project_id",526 "project_id": "project_id",

482 "service_tier": "service_tier",527 "service_tier": "service_tier",

483 "user_id": "user_id"528 "user_id": "user_id"

Details

60 60 

61 - `:bucket`61 - `:bucket`

62 62 

63 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`63 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

64 64 

65 - `class OrganizationUsageCompletionsResult`65 - `class OrganizationUsageCompletionsResult`

66 66 


68 68 

69 - `input_tokens: Integer`69 - `input_tokens: Integer`

70 70 

71 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `num_model_requests: Integer`73 - `num_model_requests: Integer`

74 74 


80 80 

81 - `output_tokens: Integer`81 - `output_tokens: Integer`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: String`85 - `api_key_id: String`

86 86 


92 92 

93 - `input_audio_tokens: Integer`93 - `input_audio_tokens: Integer`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: Integer`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: Integer`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: Integer`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: Integer`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: Integer`113 - `input_cached_tokens: Integer`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: Integer`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: Integer`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: Integer`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: String`129 - `model: String`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: Integer`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: Integer`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: String`145 - `project_id: String`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


457 "api_key_id": "api_key_id",493 "api_key_id": "api_key_id",

458 "batch": true,494 "batch": true,

459 "input_audio_tokens": 0,495 "input_audio_tokens": 0,

496 "input_cache_write_tokens": 0,

497 "input_cached_audio_tokens": 0,

498 "input_cached_image_tokens": 0,

499 "input_cached_text_tokens": 0,

460 "input_cached_tokens": 0,500 "input_cached_tokens": 0,

501 "input_image_tokens": 0,

502 "input_text_tokens": 0,

503 "input_uncached_tokens": 0,

461 "model": "model",504 "model": "model",

462 "output_audio_tokens": 0,505 "output_audio_tokens": 0,

506 "output_image_tokens": 0,

507 "output_text_tokens": 0,

463 "project_id": "project_id",508 "project_id": "project_id",

464 "service_tier": "service_tier",509 "service_tier": "service_tier",

465 "user_id": "user_id"510 "user_id": "user_id"

Details

86 86 

87 - `:bucket`87 - `:bucket`

88 88 

89 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`89 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

90 90 

91 - `class OrganizationUsageCompletionsResult`91 - `class OrganizationUsageCompletionsResult`

92 92 


94 94 

95 - `input_tokens: Integer`95 - `input_tokens: Integer`

96 96 

97 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.97 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

98 98 

99 - `num_model_requests: Integer`99 - `num_model_requests: Integer`

100 100 


106 106 

107 - `output_tokens: Integer`107 - `output_tokens: Integer`

108 108 

109 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.109 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

110 110 

111 - `api_key_id: String`111 - `api_key_id: String`

112 112 


118 118 

119 - `input_audio_tokens: Integer`119 - `input_audio_tokens: Integer`

120 120 

121 The aggregated number of audio input tokens used, including cached tokens.121 The aggregated number of uncached audio input tokens used.

122 

123 - `input_cache_write_tokens: Integer`

124 

125 The aggregated number of input tokens written to the cache.

126 

127 - `input_cached_audio_tokens: Integer`

128 

129 The aggregated number of cached audio input tokens used.

130 

131 - `input_cached_image_tokens: Integer`

132 

133 The aggregated number of cached image input tokens used.

134 

135 - `input_cached_text_tokens: Integer`

136 

137 The aggregated number of cached text input tokens used.

122 138 

123 - `input_cached_tokens: Integer`139 - `input_cached_tokens: Integer`

124 140 

125 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.141 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

142 

143 - `input_image_tokens: Integer`

144 

145 The aggregated number of uncached image input tokens used.

146 

147 - `input_text_tokens: Integer`

148 

149 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

150 

151 - `input_uncached_tokens: Integer`

152 

153 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

126 154 

127 - `model: String`155 - `model: String`

128 156 


132 160 

133 The aggregated number of audio output tokens used.161 The aggregated number of audio output tokens used.

134 162 

163 - `output_image_tokens: Integer`

164 

165 The aggregated number of image output tokens used.

166 

167 - `output_text_tokens: Integer`

168 

169 The aggregated number of text output tokens used.

170 

135 - `project_id: String`171 - `project_id: String`

136 172 

137 When `group_by=project_id`, this field provides the project ID of the grouped usage result.173 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


483 "api_key_id": "api_key_id",519 "api_key_id": "api_key_id",

484 "batch": true,520 "batch": true,

485 "input_audio_tokens": 0,521 "input_audio_tokens": 0,

522 "input_cache_write_tokens": 0,

523 "input_cached_audio_tokens": 0,

524 "input_cached_image_tokens": 0,

525 "input_cached_text_tokens": 0,

486 "input_cached_tokens": 0,526 "input_cached_tokens": 0,

527 "input_image_tokens": 0,

528 "input_text_tokens": 0,

529 "input_uncached_tokens": 0,

487 "model": "model",530 "model": "model",

488 "output_audio_tokens": 0,531 "output_audio_tokens": 0,

532 "output_image_tokens": 0,

533 "output_text_tokens": 0,

489 "project_id": "project_id",534 "project_id": "project_id",

490 "service_tier": "service_tier",535 "service_tier": "service_tier",

491 "user_id": "user_id"536 "user_id": "user_id"

Details

60 60 

61 - `:bucket`61 - `:bucket`

62 62 

63 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`63 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

64 64 

65 - `class OrganizationUsageCompletionsResult`65 - `class OrganizationUsageCompletionsResult`

66 66 


68 68 

69 - `input_tokens: Integer`69 - `input_tokens: Integer`

70 70 

71 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `num_model_requests: Integer`73 - `num_model_requests: Integer`

74 74 


80 80 

81 - `output_tokens: Integer`81 - `output_tokens: Integer`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: String`85 - `api_key_id: String`

86 86 


92 92 

93 - `input_audio_tokens: Integer`93 - `input_audio_tokens: Integer`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: Integer`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: Integer`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: Integer`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: Integer`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: Integer`113 - `input_cached_tokens: Integer`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: Integer`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: Integer`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: Integer`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: String`129 - `model: String`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: Integer`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: Integer`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: String`145 - `project_id: String`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


457 "api_key_id": "api_key_id",493 "api_key_id": "api_key_id",

458 "batch": true,494 "batch": true,

459 "input_audio_tokens": 0,495 "input_audio_tokens": 0,

496 "input_cache_write_tokens": 0,

497 "input_cached_audio_tokens": 0,

498 "input_cached_image_tokens": 0,

499 "input_cached_text_tokens": 0,

460 "input_cached_tokens": 0,500 "input_cached_tokens": 0,

501 "input_image_tokens": 0,

502 "input_text_tokens": 0,

503 "input_uncached_tokens": 0,

461 "model": "model",504 "model": "model",

462 "output_audio_tokens": 0,505 "output_audio_tokens": 0,

506 "output_image_tokens": 0,

507 "output_text_tokens": 0,

463 "project_id": "project_id",508 "project_id": "project_id",

464 "service_tier": "service_tier",509 "service_tier": "service_tier",

465 "user_id": "user_id"510 "user_id": "user_id"

Details

78 78 

79 - `:bucket`79 - `:bucket`

80 80 

81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

82 82 

83 - `class OrganizationUsageCompletionsResult`83 - `class OrganizationUsageCompletionsResult`

84 84 


86 86 

87 - `input_tokens: Integer`87 - `input_tokens: Integer`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: Integer`91 - `num_model_requests: Integer`

92 92 


98 98 

99 - `output_tokens: Integer`99 - `output_tokens: Integer`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: String`103 - `api_key_id: String`

104 104 


110 110 

111 - `input_audio_tokens: Integer`111 - `input_audio_tokens: Integer`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Integer`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Integer`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Integer`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Integer`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Integer`131 - `input_cached_tokens: Integer`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Integer`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Integer`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Integer`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: String`147 - `model: String`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Integer`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Integer`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: String`163 - `project_id: String`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


475 "api_key_id": "api_key_id",511 "api_key_id": "api_key_id",

476 "batch": true,512 "batch": true,

477 "input_audio_tokens": 0,513 "input_audio_tokens": 0,

514 "input_cache_write_tokens": 0,

515 "input_cached_audio_tokens": 0,

516 "input_cached_image_tokens": 0,

517 "input_cached_text_tokens": 0,

478 "input_cached_tokens": 0,518 "input_cached_tokens": 0,

519 "input_image_tokens": 0,

520 "input_text_tokens": 0,

521 "input_uncached_tokens": 0,

479 "model": "model",522 "model": "model",

480 "output_audio_tokens": 0,523 "output_audio_tokens": 0,

524 "output_image_tokens": 0,

525 "output_text_tokens": 0,

481 "project_id": "project_id",526 "project_id": "project_id",

482 "service_tier": "service_tier",527 "service_tier": "service_tier",

483 "user_id": "user_id"528 "user_id": "user_id"

Details

78 78 

79 - `:bucket`79 - `:bucket`

80 80 

81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

82 82 

83 - `class OrganizationUsageCompletionsResult`83 - `class OrganizationUsageCompletionsResult`

84 84 


86 86 

87 - `input_tokens: Integer`87 - `input_tokens: Integer`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: Integer`91 - `num_model_requests: Integer`

92 92 


98 98 

99 - `output_tokens: Integer`99 - `output_tokens: Integer`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: String`103 - `api_key_id: String`

104 104 


110 110 

111 - `input_audio_tokens: Integer`111 - `input_audio_tokens: Integer`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Integer`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Integer`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Integer`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Integer`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Integer`131 - `input_cached_tokens: Integer`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Integer`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Integer`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Integer`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: String`147 - `model: String`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Integer`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Integer`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: String`163 - `project_id: String`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


475 "api_key_id": "api_key_id",511 "api_key_id": "api_key_id",

476 "batch": true,512 "batch": true,

477 "input_audio_tokens": 0,513 "input_audio_tokens": 0,

514 "input_cache_write_tokens": 0,

515 "input_cached_audio_tokens": 0,

516 "input_cached_image_tokens": 0,

517 "input_cached_text_tokens": 0,

478 "input_cached_tokens": 0,518 "input_cached_tokens": 0,

519 "input_image_tokens": 0,

520 "input_text_tokens": 0,

521 "input_uncached_tokens": 0,

479 "model": "model",522 "model": "model",

480 "output_audio_tokens": 0,523 "output_audio_tokens": 0,

524 "output_image_tokens": 0,

525 "output_text_tokens": 0,

481 "project_id": "project_id",526 "project_id": "project_id",

482 "service_tier": "service_tier",527 "service_tier": "service_tier",

483 "user_id": "user_id"528 "user_id": "user_id"

Details

106 106 

107 - `:bucket`107 - `:bucket`

108 108 

109 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`109 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

110 110 

111 - `class OrganizationUsageCompletionsResult`111 - `class OrganizationUsageCompletionsResult`

112 112 


114 114 

115 - `input_tokens: Integer`115 - `input_tokens: Integer`

116 116 

117 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 118 

119 - `num_model_requests: Integer`119 - `num_model_requests: Integer`

120 120 


126 126 

127 - `output_tokens: Integer`127 - `output_tokens: Integer`

128 128 

129 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.129 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

130 130 

131 - `api_key_id: String`131 - `api_key_id: String`

132 132 


138 138 

139 - `input_audio_tokens: Integer`139 - `input_audio_tokens: Integer`

140 140 

141 The aggregated number of audio input tokens used, including cached tokens.141 The aggregated number of uncached audio input tokens used.

142 

143 - `input_cache_write_tokens: Integer`

144 

145 The aggregated number of input tokens written to the cache.

146 

147 - `input_cached_audio_tokens: Integer`

148 

149 The aggregated number of cached audio input tokens used.

150 

151 - `input_cached_image_tokens: Integer`

152 

153 The aggregated number of cached image input tokens used.

154 

155 - `input_cached_text_tokens: Integer`

156 

157 The aggregated number of cached text input tokens used.

142 158 

143 - `input_cached_tokens: Integer`159 - `input_cached_tokens: Integer`

144 160 

145 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.161 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

162 

163 - `input_image_tokens: Integer`

164 

165 The aggregated number of uncached image input tokens used.

166 

167 - `input_text_tokens: Integer`

168 

169 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

170 

171 - `input_uncached_tokens: Integer`

172 

173 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

146 174 

147 - `model: String`175 - `model: String`

148 176 


152 180 

153 The aggregated number of audio output tokens used.181 The aggregated number of audio output tokens used.

154 182 

183 - `output_image_tokens: Integer`

184 

185 The aggregated number of image output tokens used.

186 

187 - `output_text_tokens: Integer`

188 

189 The aggregated number of text output tokens used.

190 

155 - `project_id: String`191 - `project_id: String`

156 192 

157 When `group_by=project_id`, this field provides the project ID of the grouped usage result.193 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


503 "api_key_id": "api_key_id",539 "api_key_id": "api_key_id",

504 "batch": true,540 "batch": true,

505 "input_audio_tokens": 0,541 "input_audio_tokens": 0,

542 "input_cache_write_tokens": 0,

543 "input_cached_audio_tokens": 0,

544 "input_cached_image_tokens": 0,

545 "input_cached_text_tokens": 0,

506 "input_cached_tokens": 0,546 "input_cached_tokens": 0,

547 "input_image_tokens": 0,

548 "input_text_tokens": 0,

549 "input_uncached_tokens": 0,

507 "model": "model",550 "model": "model",

508 "output_audio_tokens": 0,551 "output_audio_tokens": 0,

552 "output_image_tokens": 0,

553 "output_text_tokens": 0,

509 "project_id": "project_id",554 "project_id": "project_id",

510 "service_tier": "service_tier",555 "service_tier": "service_tier",

511 "user_id": "user_id"556 "user_id": "user_id"

Details

78 78 

79 - `:bucket`79 - `:bucket`

80 80 

81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`81 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

82 82 

83 - `class OrganizationUsageCompletionsResult`83 - `class OrganizationUsageCompletionsResult`

84 84 


86 86 

87 - `input_tokens: Integer`87 - `input_tokens: Integer`

88 88 

89 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.89 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

90 90 

91 - `num_model_requests: Integer`91 - `num_model_requests: Integer`

92 92 


98 98 

99 - `output_tokens: Integer`99 - `output_tokens: Integer`

100 100 

101 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `api_key_id: String`103 - `api_key_id: String`

104 104 


110 110 

111 - `input_audio_tokens: Integer`111 - `input_audio_tokens: Integer`

112 112 

113 The aggregated number of audio input tokens used, including cached tokens.113 The aggregated number of uncached audio input tokens used.

114 

115 - `input_cache_write_tokens: Integer`

116 

117 The aggregated number of input tokens written to the cache.

118 

119 - `input_cached_audio_tokens: Integer`

120 

121 The aggregated number of cached audio input tokens used.

122 

123 - `input_cached_image_tokens: Integer`

124 

125 The aggregated number of cached image input tokens used.

126 

127 - `input_cached_text_tokens: Integer`

128 

129 The aggregated number of cached text input tokens used.

114 130 

115 - `input_cached_tokens: Integer`131 - `input_cached_tokens: Integer`

116 132 

117 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.133 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

134 

135 - `input_image_tokens: Integer`

136 

137 The aggregated number of uncached image input tokens used.

138 

139 - `input_text_tokens: Integer`

140 

141 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

142 

143 - `input_uncached_tokens: Integer`

144 

145 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

118 146 

119 - `model: String`147 - `model: String`

120 148 


124 152 

125 The aggregated number of audio output tokens used.153 The aggregated number of audio output tokens used.

126 154 

155 - `output_image_tokens: Integer`

156 

157 The aggregated number of image output tokens used.

158 

159 - `output_text_tokens: Integer`

160 

161 The aggregated number of text output tokens used.

162 

127 - `project_id: String`163 - `project_id: String`

128 164 

129 When `group_by=project_id`, this field provides the project ID of the grouped usage result.165 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


475 "api_key_id": "api_key_id",511 "api_key_id": "api_key_id",

476 "batch": true,512 "batch": true,

477 "input_audio_tokens": 0,513 "input_audio_tokens": 0,

514 "input_cache_write_tokens": 0,

515 "input_cached_audio_tokens": 0,

516 "input_cached_image_tokens": 0,

517 "input_cached_text_tokens": 0,

478 "input_cached_tokens": 0,518 "input_cached_tokens": 0,

519 "input_image_tokens": 0,

520 "input_text_tokens": 0,

521 "input_uncached_tokens": 0,

479 "model": "model",522 "model": "model",

480 "output_audio_tokens": 0,523 "output_audio_tokens": 0,

524 "output_image_tokens": 0,

525 "output_text_tokens": 0,

481 "project_id": "project_id",526 "project_id": "project_id",

482 "service_tier": "service_tier",527 "service_tier": "service_tier",

483 "user_id": "user_id"528 "user_id": "user_id"

Details

60 60 

61 - `:bucket`61 - `:bucket`

62 62 

63 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`63 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

64 64 

65 - `class OrganizationUsageCompletionsResult`65 - `class OrganizationUsageCompletionsResult`

66 66 


68 68 

69 - `input_tokens: Integer`69 - `input_tokens: Integer`

70 70 

71 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.71 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

72 72 

73 - `num_model_requests: Integer`73 - `num_model_requests: Integer`

74 74 


80 80 

81 - `output_tokens: Integer`81 - `output_tokens: Integer`

82 82 

83 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.83 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

84 84 

85 - `api_key_id: String`85 - `api_key_id: String`

86 86 


92 92 

93 - `input_audio_tokens: Integer`93 - `input_audio_tokens: Integer`

94 94 

95 The aggregated number of audio input tokens used, including cached tokens.95 The aggregated number of uncached audio input tokens used.

96 

97 - `input_cache_write_tokens: Integer`

98 

99 The aggregated number of input tokens written to the cache.

100 

101 - `input_cached_audio_tokens: Integer`

102 

103 The aggregated number of cached audio input tokens used.

104 

105 - `input_cached_image_tokens: Integer`

106 

107 The aggregated number of cached image input tokens used.

108 

109 - `input_cached_text_tokens: Integer`

110 

111 The aggregated number of cached text input tokens used.

96 112 

97 - `input_cached_tokens: Integer`113 - `input_cached_tokens: Integer`

98 114 

99 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 

117 - `input_image_tokens: Integer`

118 

119 The aggregated number of uncached image input tokens used.

120 

121 - `input_text_tokens: Integer`

122 

123 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

124 

125 - `input_uncached_tokens: Integer`

126 

127 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

100 128 

101 - `model: String`129 - `model: String`

102 130 


106 134 

107 The aggregated number of audio output tokens used.135 The aggregated number of audio output tokens used.

108 136 

137 - `output_image_tokens: Integer`

138 

139 The aggregated number of image output tokens used.

140 

141 - `output_text_tokens: Integer`

142 

143 The aggregated number of text output tokens used.

144 

109 - `project_id: String`145 - `project_id: String`

110 146 

111 When `group_by=project_id`, this field provides the project ID of the grouped usage result.147 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


457 "api_key_id": "api_key_id",493 "api_key_id": "api_key_id",

458 "batch": true,494 "batch": true,

459 "input_audio_tokens": 0,495 "input_audio_tokens": 0,

496 "input_cache_write_tokens": 0,

497 "input_cached_audio_tokens": 0,

498 "input_cached_image_tokens": 0,

499 "input_cached_text_tokens": 0,

460 "input_cached_tokens": 0,500 "input_cached_tokens": 0,

501 "input_image_tokens": 0,

502 "input_text_tokens": 0,

503 "input_uncached_tokens": 0,

461 "model": "model",504 "model": "model",

462 "output_audio_tokens": 0,505 "output_audio_tokens": 0,

506 "output_image_tokens": 0,

507 "output_text_tokens": 0,

463 "project_id": "project_id",508 "project_id": "project_id",

464 "service_tier": "service_tier",509 "service_tier": "service_tier",

465 "user_id": "user_id"510 "user_id": "user_id"

Details

90 90 

91 - `:bucket`91 - `:bucket`

92 92 

93 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 10 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`93 - `results: Array[OrganizationUsageCompletionsResult{ input_tokens, num_model_requests, object, 19 more} | OrganizationUsageEmbeddingsResult{ input_tokens, num_model_requests, object, 4 more} | OrganizationUsageModerationsResult{ input_tokens, num_model_requests, object, 4 more} | 8 more]`

94 94 

95 - `class OrganizationUsageCompletionsResult`95 - `class OrganizationUsageCompletionsResult`

96 96 


98 98 

99 - `input_tokens: Integer`99 - `input_tokens: Integer`

100 100 

101 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.101 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

102 102 

103 - `num_model_requests: Integer`103 - `num_model_requests: Integer`

104 104 


110 110 

111 - `output_tokens: Integer`111 - `output_tokens: Integer`

112 112 

113 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.113 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

114 114 

115 - `api_key_id: String`115 - `api_key_id: String`

116 116 


122 122 

123 - `input_audio_tokens: Integer`123 - `input_audio_tokens: Integer`

124 124 

125 The aggregated number of audio input tokens used, including cached tokens.125 The aggregated number of uncached audio input tokens used.

126 

127 - `input_cache_write_tokens: Integer`

128 

129 The aggregated number of input tokens written to the cache.

130 

131 - `input_cached_audio_tokens: Integer`

132 

133 The aggregated number of cached audio input tokens used.

134 

135 - `input_cached_image_tokens: Integer`

136 

137 The aggregated number of cached image input tokens used.

138 

139 - `input_cached_text_tokens: Integer`

140 

141 The aggregated number of cached text input tokens used.

126 142 

127 - `input_cached_tokens: Integer`143 - `input_cached_tokens: Integer`

128 144 

129 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.145 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

146 

147 - `input_image_tokens: Integer`

148 

149 The aggregated number of uncached image input tokens used.

150 

151 - `input_text_tokens: Integer`

152 

153 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

154 

155 - `input_uncached_tokens: Integer`

156 

157 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

130 158 

131 - `model: String`159 - `model: String`

132 160 


136 164 

137 The aggregated number of audio output tokens used.165 The aggregated number of audio output tokens used.

138 166 

167 - `output_image_tokens: Integer`

168 

169 The aggregated number of image output tokens used.

170 

171 - `output_text_tokens: Integer`

172 

173 The aggregated number of text output tokens used.

174 

139 - `project_id: String`175 - `project_id: String`

140 176 

141 When `group_by=project_id`, this field provides the project ID of the grouped usage result.177 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


487 "api_key_id": "api_key_id",523 "api_key_id": "api_key_id",

488 "batch": true,524 "batch": true,

489 "input_audio_tokens": 0,525 "input_audio_tokens": 0,

526 "input_cache_write_tokens": 0,

527 "input_cached_audio_tokens": 0,

528 "input_cached_image_tokens": 0,

529 "input_cached_text_tokens": 0,

490 "input_cached_tokens": 0,530 "input_cached_tokens": 0,

531 "input_image_tokens": 0,

532 "input_text_tokens": 0,

533 "input_uncached_tokens": 0,

491 "model": "model",534 "model": "model",

492 "output_audio_tokens": 0,535 "output_audio_tokens": 0,

536 "output_image_tokens": 0,

537 "output_text_tokens": 0,

493 "project_id": "project_id",538 "project_id": "project_id",

494 "service_tier": "service_tier",539 "service_tier": "service_tier",

495 "user_id": "user_id"540 "user_id": "user_id"

Details

1441 1441 

1442 - `:output_text`1442 - `:output_text`

1443 1443 

1444 - `annotations: Array[UnionMember0{ file_id, filename, index, type}] | Array[UnionMember1{ end_index, start_index, title, 2 more}] | Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1444 - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more}]`

1445 1445 

1446 Citations associated with the text content.1446 Citations associated with the text content.

1447 1447 

1448 - `UnionMember0 = Array[UnionMember0{ file_id, filename, index, type}]`1448 - `class FileCitation`

1449 1449 

1450 - `file_id: String`1450 - `file_id: String`

1451 1451 


1465 1465 

1466 - `:file_citation`1466 - `:file_citation`

1467 1467 

1468 - `UnionMember1 = Array[UnionMember1{ end_index, start_index, title, 2 more}]`1468 - `class URLCitation`

1469 1469 

1470 - `end_index: Integer`1470 - `end_index: Integer`

1471 1471 


1489 1489 

1490 The URL of the cited resource.1490 The URL of the cited resource.

1491 1491 

1492 - `UnionMember2 = Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1492 - `class ContainerFileCitation`

1493 1493 

1494 - `container_id: String`1494 - `container_id: String`

1495 1495 


2870 2870 

2871 - `encrypted_content: String`2871 - `encrypted_content: String`

2872 2872 

2873 The encrypted content of the reasoning item - populated when a response is2873 The encrypted content of the reasoning item. This is populated by default

2874 generated with `reasoning.encrypted_content` in the `include` parameter.2874 for reasoning items returned by `POST /v1/responses` and WebSocket

2875 `response.create` requests.

2875 2876 

2876 - `status: :in_progress | :completed | :incomplete`2877 - `status: :in_progress | :completed | :incomplete`

2877 2878 

Details

1555 1555 

1556 - `:output_text`1556 - `:output_text`

1557 1557 

1558 - `annotations: Array[UnionMember0{ file_id, filename, index, type}] | Array[UnionMember1{ end_index, start_index, title, 2 more}] | Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1558 - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more}]`

1559 1559 

1560 Citations associated with the text content.1560 Citations associated with the text content.

1561 1561 

1562 - `UnionMember0 = Array[UnionMember0{ file_id, filename, index, type}]`1562 - `class FileCitation`

1563 1563 

1564 - `file_id: String`1564 - `file_id: String`

1565 1565 


1579 1579 

1580 - `:file_citation`1580 - `:file_citation`

1581 1581 

1582 - `UnionMember1 = Array[UnionMember1{ end_index, start_index, title, 2 more}]`1582 - `class URLCitation`

1583 1583 

1584 - `end_index: Integer`1584 - `end_index: Integer`

1585 1585 


1603 1603 

1604 The URL of the cited resource.1604 The URL of the cited resource.

1605 1605 

1606 - `UnionMember2 = Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1606 - `class ContainerFileCitation`

1607 1607 

1608 - `container_id: String`1608 - `container_id: String`

1609 1609 


2984 2984 

2985 - `encrypted_content: String`2985 - `encrypted_content: String`

2986 2986 

2987 The encrypted content of the reasoning item - populated when a response is2987 The encrypted content of the reasoning item. This is populated by default

2988 generated with `reasoning.encrypted_content` in the `include` parameter.2988 for reasoning items returned by `POST /v1/responses` and WebSocket

2989 `response.create` requests.

2989 2990 

2990 - `status: :in_progress | :completed | :incomplete`2991 - `status: :in_progress | :completed | :incomplete`

2991 2992 


5401 5402 

5402 - `encrypted_content: String`5403 - `encrypted_content: String`

5403 5404 

5404 The encrypted content of the reasoning item - populated when a response is5405 The encrypted content of the reasoning item. This is populated by default

5405 generated with `reasoning.encrypted_content` in the `include` parameter.5406 for reasoning items returned by `POST /v1/responses` and WebSocket

5407 `response.create` requests.

5406 5408 

5407 - `status: :in_progress | :completed | :incomplete`5409 - `status: :in_progress | :completed | :incomplete`

5408 5410 

Details

1431 1431 

1432 - `:output_text`1432 - `:output_text`

1433 1433 

1434 - `annotations: Array[UnionMember0{ file_id, filename, index, type}] | Array[UnionMember1{ end_index, start_index, title, 2 more}] | Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1434 - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more}]`

1435 1435 

1436 Citations associated with the text content.1436 Citations associated with the text content.

1437 1437 

1438 - `UnionMember0 = Array[UnionMember0{ file_id, filename, index, type}]`1438 - `class FileCitation`

1439 1439 

1440 - `file_id: String`1440 - `file_id: String`

1441 1441 


1455 1455 

1456 - `:file_citation`1456 - `:file_citation`

1457 1457 

1458 - `UnionMember1 = Array[UnionMember1{ end_index, start_index, title, 2 more}]`1458 - `class URLCitation`

1459 1459 

1460 - `end_index: Integer`1460 - `end_index: Integer`

1461 1461 


1479 1479 

1480 The URL of the cited resource.1480 The URL of the cited resource.

1481 1481 

1482 - `UnionMember2 = Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1482 - `class ContainerFileCitation`

1483 1483 

1484 - `container_id: String`1484 - `container_id: String`

1485 1485 


2860 2860 

2861 - `encrypted_content: String`2861 - `encrypted_content: String`

2862 2862 

2863 The encrypted content of the reasoning item - populated when a response is2863 The encrypted content of the reasoning item. This is populated by default

2864 generated with `reasoning.encrypted_content` in the `include` parameter.2864 for reasoning items returned by `POST /v1/responses` and WebSocket

2865 `response.create` requests.

2865 2866 

2866 - `status: :in_progress | :completed | :incomplete`2867 - `status: :in_progress | :completed | :incomplete`

2867 2868 


6217 6218 

6218 - `:output_text`6219 - `:output_text`

6219 6220 

6220 - `annotations: Array[UnionMember0{ file_id, filename, index, type}] | Array[UnionMember1{ end_index, start_index, title, 2 more}] | Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`6221 - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more}]`

6221 6222 

6222 Citations associated with the text content.6223 Citations associated with the text content.

6223 6224 

6224 - `UnionMember0 = Array[UnionMember0{ file_id, filename, index, type}]`6225 - `class FileCitation`

6225 6226 

6226 - `file_id: String`6227 - `file_id: String`

6227 6228 


6241 6242 

6242 - `:file_citation`6243 - `:file_citation`

6243 6244 

6244 - `UnionMember1 = Array[UnionMember1{ end_index, start_index, title, 2 more}]`6245 - `class URLCitation`

6245 6246 

6246 - `end_index: Integer`6247 - `end_index: Integer`

6247 6248 


6265 6266 

6266 The URL of the cited resource.6267 The URL of the cited resource.

6267 6268 

6268 - `UnionMember2 = Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`6269 - `class ContainerFileCitation`

6269 6270 

6270 - `container_id: String`6271 - `container_id: String`

6271 6272 


7646 7647 

7647 - `encrypted_content: String`7648 - `encrypted_content: String`

7648 7649 

7649 The encrypted content of the reasoning item - populated when a response is7650 The encrypted content of the reasoning item. This is populated by default

7650 generated with `reasoning.encrypted_content` in the `include` parameter.7651 for reasoning items returned by `POST /v1/responses` and WebSocket

7652 `response.create` requests.

7651 7653 

7652 - `status: :in_progress | :completed | :incomplete`7654 - `status: :in_progress | :completed | :incomplete`

7653 7655 

Details

1481 1481 

1482 - `:output_text`1482 - `:output_text`

1483 1483 

1484 - `annotations: Array[UnionMember0{ file_id, filename, index, type}] | Array[UnionMember1{ end_index, start_index, title, 2 more}] | Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1484 - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more}]`

1485 1485 

1486 Citations associated with the text content.1486 Citations associated with the text content.

1487 1487 

1488 - `UnionMember0 = Array[UnionMember0{ file_id, filename, index, type}]`1488 - `class FileCitation`

1489 1489 

1490 - `file_id: String`1490 - `file_id: String`

1491 1491 


1505 1505 

1506 - `:file_citation`1506 - `:file_citation`

1507 1507 

1508 - `UnionMember1 = Array[UnionMember1{ end_index, start_index, title, 2 more}]`1508 - `class URLCitation`

1509 1509 

1510 - `end_index: Integer`1510 - `end_index: Integer`

1511 1511 


1529 1529 

1530 The URL of the cited resource.1530 The URL of the cited resource.

1531 1531 

1532 - `UnionMember2 = Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1532 - `class ContainerFileCitation`

1533 1533 

1534 - `container_id: String`1534 - `container_id: String`

1535 1535 


2910 2910 

2911 - `encrypted_content: String`2911 - `encrypted_content: String`

2912 2912 

2913 The encrypted content of the reasoning item - populated when a response is2913 The encrypted content of the reasoning item. This is populated by default

2914 generated with `reasoning.encrypted_content` in the `include` parameter.2914 for reasoning items returned by `POST /v1/responses` and WebSocket

2915 `response.create` requests.

2915 2916 

2916 - `status: :in_progress | :completed | :incomplete`2917 - `status: :in_progress | :completed | :incomplete`

2917 2918 

Details

2676 2676 

2677 - `encrypted_content: String`2677 - `encrypted_content: String`

2678 2678 

2679 The encrypted content of the reasoning item - populated when a response is2679 The encrypted content of the reasoning item. This is populated by default

2680 generated with `reasoning.encrypted_content` in the `include` parameter.2680 for reasoning items returned by `POST /v1/responses` and WebSocket

2681 `response.create` requests.

2681 2682 

2682 - `status: :in_progress | :completed | :incomplete`2683 - `status: :in_progress | :completed | :incomplete`

2683 2684 

Details

1372 1372 

1373 - `:output_text`1373 - `:output_text`

1374 1374 

1375 - `annotations: Array[UnionMember0{ file_id, filename, index, type}] | Array[UnionMember1{ end_index, start_index, title, 2 more}] | Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1375 - `annotations: Array[FileCitation{ file_id, filename, index, type} | URLCitation{ end_index, start_index, title, 2 more} | ContainerFileCitation{ container_id, end_index, file_id, 3 more}]`

1376 1376 

1377 Citations associated with the text content.1377 Citations associated with the text content.

1378 1378 

1379 - `UnionMember0 = Array[UnionMember0{ file_id, filename, index, type}]`1379 - `class FileCitation`

1380 1380 

1381 - `file_id: String`1381 - `file_id: String`

1382 1382 


1396 1396 

1397 - `:file_citation`1397 - `:file_citation`

1398 1398 

1399 - `UnionMember1 = Array[UnionMember1{ end_index, start_index, title, 2 more}]`1399 - `class URLCitation`

1400 1400 

1401 - `end_index: Integer`1401 - `end_index: Integer`

1402 1402 


1420 1420 

1421 The URL of the cited resource.1421 The URL of the cited resource.

1422 1422 

1423 - `UnionMember2 = Array[UnionMember2{ container_id, end_index, file_id, 3 more}]`1423 - `class ContainerFileCitation`

1424 1424 

1425 - `container_id: String`1425 - `container_id: String`

1426 1426 


2801 2801 

2802 - `encrypted_content: String`2802 - `encrypted_content: String`

2803 2803 

2804 The encrypted content of the reasoning item - populated when a response is2804 The encrypted content of the reasoning item. This is populated by default

2805 generated with `reasoning.encrypted_content` in the `include` parameter.2805 for reasoning items returned by `POST /v1/responses` and WebSocket

2806 `response.create` requests.

2806 2807 

2807 - `status: :in_progress | :completed | :incomplete`2808 - `status: :in_progress | :completed | :incomplete`

2808 2809 

Details

2554 2554 

2555 - `encrypted_content: String`2555 - `encrypted_content: String`

2556 2556 

2557 The encrypted content of the reasoning item - populated when a response is2557 The encrypted content of the reasoning item. This is populated by default

2558 generated with `reasoning.encrypted_content` in the `include` parameter.2558 for reasoning items returned by `POST /v1/responses` and WebSocket

2559 `response.create` requests.

2559 2560 

2560 - `status: :in_progress | :completed | :incomplete`2561 - `status: :in_progress | :completed | :incomplete`

2561 2562 

Details

2556 2556 

2557 - `encrypted_content: String`2557 - `encrypted_content: String`

2558 2558 

2559 The encrypted content of the reasoning item - populated when a response is2559 The encrypted content of the reasoning item. This is populated by default

2560 generated with `reasoning.encrypted_content` in the `include` parameter.2560 for reasoning items returned by `POST /v1/responses` and WebSocket

2561 `response.create` requests.

2561 2562 

2562 - `status: :in_progress | :completed | :incomplete`2563 - `status: :in_progress | :completed | :incomplete`

2563 2564 


5942 5943 

5943 - `encrypted_content: String`5944 - `encrypted_content: String`

5944 5945 

5945 The encrypted content of the reasoning item - populated when a response is5946 The encrypted content of the reasoning item. This is populated by default

5946 generated with `reasoning.encrypted_content` in the `include` parameter.5947 for reasoning items returned by `POST /v1/responses` and WebSocket

5948 `response.create` requests.

5947 5949 

5948 - `status: :in_progress | :completed | :incomplete`5950 - `status: :in_progress | :completed | :incomplete`

5949 5951 

Details

2532 2532 

2533 - `encrypted_content: String`2533 - `encrypted_content: String`

2534 2534 

2535 The encrypted content of the reasoning item - populated when a response is2535 The encrypted content of the reasoning item. This is populated by default

2536 generated with `reasoning.encrypted_content` in the `include` parameter.2536 for reasoning items returned by `POST /v1/responses` and WebSocket

2537 `response.create` requests.

2537 2538 

2538 - `status: :in_progress | :completed | :incomplete`2539 - `status: :in_progress | :completed | :incomplete`

2539 2540 

Details

2507 2507 

2508 - `encrypted_content: String`2508 - `encrypted_content: String`

2509 2509 

2510 The encrypted content of the reasoning item - populated when a response is2510 The encrypted content of the reasoning item. This is populated by default

2511 generated with `reasoning.encrypted_content` in the `include` parameter.2511 for reasoning items returned by `POST /v1/responses` and WebSocket

2512 `response.create` requests.

2512 2513 

2513 - `status: :in_progress | :completed | :incomplete`2514 - `status: :in_progress | :completed | :incomplete`

2514 2515 

Details

2646 2646 

2647 - `encrypted_content: String`2647 - `encrypted_content: String`

2648 2648 

2649 The encrypted content of the reasoning item - populated when a response is2649 The encrypted content of the reasoning item. This is populated by default

2650 generated with `reasoning.encrypted_content` in the `include` parameter.2650 for reasoning items returned by `POST /v1/responses` and WebSocket

2651 `response.create` requests.

2651 2652 

2652 - `status: :in_progress | :completed | :incomplete`2653 - `status: :in_progress | :completed | :incomplete`

2653 2654 

Details

2764 2764 

2765 - `encrypted_content: String`2765 - `encrypted_content: String`

2766 2766 

2767 The encrypted content of the reasoning item - populated when a response is2767 The encrypted content of the reasoning item. This is populated by default

2768 generated with `reasoning.encrypted_content` in the `include` parameter.2768 for reasoning items returned by `POST /v1/responses` and WebSocket

2769 `response.create` requests.

2769 2770 

2770 - `status: :in_progress | :completed | :incomplete`2771 - `status: :in_progress | :completed | :incomplete`

2771 2772 


4870 4871 

4871 - `encrypted_content: String`4872 - `encrypted_content: String`

4872 4873 

4873 The encrypted content of the reasoning item - populated when a response is4874 The encrypted content of the reasoning item. This is populated by default

4874 generated with `reasoning.encrypted_content` in the `include` parameter.4875 for reasoning items returned by `POST /v1/responses` and WebSocket

4876 `response.create` requests.

4875 4877 

4876 - `status: :in_progress | :completed | :incomplete`4878 - `status: :in_progress | :completed | :incomplete`

4877 4879 

Details

2640 2640 

2641 - `encrypted_content: String`2641 - `encrypted_content: String`

2642 2642 

2643 The encrypted content of the reasoning item - populated when a response is2643 The encrypted content of the reasoning item. This is populated by default

2644 generated with `reasoning.encrypted_content` in the `include` parameter.2644 for reasoning items returned by `POST /v1/responses` and WebSocket

2645 `response.create` requests.

2645 2646 

2646 - `status: :in_progress | :completed | :incomplete`2647 - `status: :in_progress | :completed | :incomplete`

2647 2648 


7034 7035 

7035 - `encrypted_content: String`7036 - `encrypted_content: String`

7036 7037 

7037 The encrypted content of the reasoning item - populated when a response is7038 The encrypted content of the reasoning item. This is populated by default

7038 generated with `reasoning.encrypted_content` in the `include` parameter.7039 for reasoning items returned by `POST /v1/responses` and WebSocket

7040 `response.create` requests.

7039 7041 

7040 - `status: :in_progress | :completed | :incomplete`7042 - `status: :in_progress | :completed | :incomplete`

7041 7043 

Details

2686 2686 

2687 - `encrypted_content: String`2687 - `encrypted_content: String`

2688 2688 

2689 The encrypted content of the reasoning item - populated when a response is2689 The encrypted content of the reasoning item. This is populated by default

2690 generated with `reasoning.encrypted_content` in the `include` parameter.2690 for reasoning items returned by `POST /v1/responses` and WebSocket

2691 `response.create` requests.

2691 2692 

2692 - `status: :in_progress | :completed | :incomplete`2693 - `status: :in_progress | :completed | :incomplete`

2693 2694 

Details

2444 2444 

2445 - `encrypted_content: String`2445 - `encrypted_content: String`

2446 2446 

2447 The encrypted content of the reasoning item - populated when a response is2447 The encrypted content of the reasoning item. This is populated by default

2448 generated with `reasoning.encrypted_content` in the `include` parameter.2448 for reasoning items returned by `POST /v1/responses` and WebSocket

2449 `response.create` requests.

2449 2450 

2450 - `status: :in_progress | :completed | :incomplete`2451 - `status: :in_progress | :completed | :incomplete`

2451 2452 

Details

2581 2581 

2582 - `encrypted_content: String`2582 - `encrypted_content: String`

2583 2583 

2584 The encrypted content of the reasoning item - populated when a response is2584 The encrypted content of the reasoning item. This is populated by default

2585 generated with `reasoning.encrypted_content` in the `include` parameter.2585 for reasoning items returned by `POST /v1/responses` and WebSocket

2586 `response.create` requests.

2586 2587 

2587 - `status: :in_progress | :completed | :incomplete`2588 - `status: :in_progress | :completed | :incomplete`

2588 2589 

Details

46 46 

47 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.47 Return only events whose `effective_at` (Unix seconds) is less than or equal to this value.

48 48 

49 - `event_types?: Array<"api_key.created" | "api_key.updated" | "api_key.deleted" | 56 more>`49 - `event_types?: Array<"api_key.created" | "api_key.updated" | "api_key.deleted" | 140 more>`

50 50 

51 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).51 Return only events with a `type` in one of these values. For example, `project.created`. For all options, see the documentation for the [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).

52 52 


168 168 

169 - `"user.deleted"`169 - `"user.deleted"`

170 170 

171 - `"tenant.metadata.updated"`

172 

173 - `"tenant.microsoft_entra_mapping.upserted"`

174 

175 - `"tenant.microsoft_entra_mapping.deleted"`

176 

177 - `"tenant.workload_identity.provider.created"`

178 

179 - `"tenant.workload_identity.provider.updated"`

180 

181 - `"tenant.workload_identity.provider.archived"`

182 

183 - `"tenant.workload_identity.mapping.created"`

184 

185 - `"tenant.workload_identity.mapping.updated"`

186 

187 - `"tenant.workload_identity.mapping.archived"`

188 

189 - `"tenant.workload_identity.binding.created"`

190 

191 - `"tenant.workload_identity.principal.provisioned"`

192 

193 - `"tenant.admin_api_key.created"`

194 

195 - `"tenant.admin_api_key.updated"`

196 

197 - `"tenant.admin_api_key.deleted"`

198 

199 - `"tenant.project_api_key.created"`

200 

201 - `"tenant.chatgpt_access_token.revoked"`

202 

203 - `"tenant.migration.completed"`

204 

205 - `"tenant.sso.migrated"`

206 

207 - `"tenant.domains.migrated"`

208 

209 - `"tenant.sso_connection.created"`

210 

211 - `"tenant.sso_connection.updated"`

212 

213 - `"tenant.sso_connection.deleted"`

214 

215 - `"tenant.sso_connection.setup.started"`

216 

217 - `"tenant.policy.created"`

218 

219 - `"tenant.policy.updated"`

220 

221 - `"tenant.policy.deleted"`

222 

223 - `"tenant.policy.attached"`

224 

225 - `"tenant.policy.detached"`

226 

227 - `"tenant.principal_authentication_policy.resolved"`

228 

229 - `"tenant.scim.setup.started"`

230 

231 - `"tenant.scim.deletion.requested"`

232 

233 - `"tenant.scim.directory.created"`

234 

235 - `"tenant.product_access_policy.updated"`

236 

237 - `"tenant.resource_share_grant.created"`

238 

239 - `"tenant.resource_share_grant.updated"`

240 

241 - `"tenant.resource_share_grant.accepted"`

242 

243 - `"tenant.resource_share_grant.declined"`

244 

245 - `"tenant.resource_share_grant.revoked"`

246 

247 - `"tenant.resource_share_grant.deleted"`

248 

249 - `"tenant.service_account.updated"`

250 

251 - `"tenant.service_account.deleted"`

252 

253 - `"tenant.service_account.token.revoked"`

254 

255 - `"tenant.billing.overage_limit.updated"`

256 

257 - `"tenant.billing.alerts.updated"`

258 

259 - `"tenant.billing.info.updated"`

260 

261 - `"tenant.usage_limit.workspace.updated"`

262 

263 - `"tenant.usage_limit.group.updated"`

264 

265 - `"tenant.usage_limit.user.updated"`

266 

267 - `"tenant.usage_limit.increase_request.updated"`

268 

269 - `"tenant.usage_limit.increase_request.resolved"`

270 

271 - `"tenant.group.created"`

272 

273 - `"tenant.group.updated"`

274 

275 - `"tenant.group.deleted"`

276 

277 - `"tenant.group.member.added"`

278 

279 - `"tenant.group.member.removed"`

280 

281 - `"tenant.migration_rollout.status.updated"`

282 

283 - `"tenant.migration_rollout.tier.updated"`

284 

285 - `"tenant.role.metadata.updated"`

286 

287 - `"tenant.custom_role.created"`

288 

289 - `"tenant.custom_role.updated"`

290 

291 - `"tenant.custom_role.deleted"`

292 

293 - `"tenant.role_assignment.created"`

294 

295 - `"tenant.role_assignment.deleted"`

296 

297 - `"tenant.resource_role_assignment.created"`

298 

299 - `"tenant.resource_role_assignment.deleted"`

300 

301 - `"tenant.resource_access.updated"`

302 

303 - `"tenant.resource_access.deleted"`

304 

305 - `"tenant.session_policy.created"`

306 

307 - `"tenant.session_policy.updated"`

308 

309 - `"tenant.session_policy.deleted"`

310 

311 - `"tenant.session_revocation.started"`

312 

313 - `"tenant.third_party_app_policy.updated"`

314 

315 - `"tenant.user.added"`

316 

317 - `"tenant.user.updated"`

318 

319 - `"tenant.user.removed"`

320 

321 - `"tenant.user.looked_up"`

322 

323 - `"tenant.user.invited"`

324 

325 - `"tenant.membership.revoked"`

326 

327 - `"tenant.api_organization_invite.upserted"`

328 

329 - `"tenant.api_organization_invite.deleted"`

330 

331 - `"tenant.chatgpt_workspace_invite.upserted"`

332 

333 - `"tenant.membership.accepted"`

334 

335 - `"tenant.membership.declined"`

336 

337 - `"tenant.workspace_invite_email_settings.updated"`

338 

171 - `limit?: number`339 - `limit?: number`

172 340 

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


198 366 

199 The Unix timestamp (in seconds) of the event.367 The Unix timestamp (in seconds) of the event.

200 368 

201 - `type: "api_key.created" | "api_key.updated" | "api_key.deleted" | 56 more`369 - `type: "api_key.created" | "api_key.updated" | "api_key.deleted" | 140 more`

202 370 

203 The event type.371 The event type.

204 372 


320 488 

321 - `"user.deleted"`489 - `"user.deleted"`

322 490 

491 - `"tenant.metadata.updated"`

492 

493 - `"tenant.microsoft_entra_mapping.upserted"`

494 

495 - `"tenant.microsoft_entra_mapping.deleted"`

496 

497 - `"tenant.workload_identity.provider.created"`

498 

499 - `"tenant.workload_identity.provider.updated"`

500 

501 - `"tenant.workload_identity.provider.archived"`

502 

503 - `"tenant.workload_identity.mapping.created"`

504 

505 - `"tenant.workload_identity.mapping.updated"`

506 

507 - `"tenant.workload_identity.mapping.archived"`

508 

509 - `"tenant.workload_identity.binding.created"`

510 

511 - `"tenant.workload_identity.principal.provisioned"`

512 

513 - `"tenant.admin_api_key.created"`

514 

515 - `"tenant.admin_api_key.updated"`

516 

517 - `"tenant.admin_api_key.deleted"`

518 

519 - `"tenant.project_api_key.created"`

520 

521 - `"tenant.chatgpt_access_token.revoked"`

522 

523 - `"tenant.migration.completed"`

524 

525 - `"tenant.sso.migrated"`

526 

527 - `"tenant.domains.migrated"`

528 

529 - `"tenant.sso_connection.created"`

530 

531 - `"tenant.sso_connection.updated"`

532 

533 - `"tenant.sso_connection.deleted"`

534 

535 - `"tenant.sso_connection.setup.started"`

536 

537 - `"tenant.policy.created"`

538 

539 - `"tenant.policy.updated"`

540 

541 - `"tenant.policy.deleted"`

542 

543 - `"tenant.policy.attached"`

544 

545 - `"tenant.policy.detached"`

546 

547 - `"tenant.principal_authentication_policy.resolved"`

548 

549 - `"tenant.scim.setup.started"`

550 

551 - `"tenant.scim.deletion.requested"`

552 

553 - `"tenant.scim.directory.created"`

554 

555 - `"tenant.product_access_policy.updated"`

556 

557 - `"tenant.resource_share_grant.created"`

558 

559 - `"tenant.resource_share_grant.updated"`

560 

561 - `"tenant.resource_share_grant.accepted"`

562 

563 - `"tenant.resource_share_grant.declined"`

564 

565 - `"tenant.resource_share_grant.revoked"`

566 

567 - `"tenant.resource_share_grant.deleted"`

568 

569 - `"tenant.service_account.updated"`

570 

571 - `"tenant.service_account.deleted"`

572 

573 - `"tenant.service_account.token.revoked"`

574 

575 - `"tenant.billing.overage_limit.updated"`

576 

577 - `"tenant.billing.alerts.updated"`

578 

579 - `"tenant.billing.info.updated"`

580 

581 - `"tenant.usage_limit.workspace.updated"`

582 

583 - `"tenant.usage_limit.group.updated"`

584 

585 - `"tenant.usage_limit.user.updated"`

586 

587 - `"tenant.usage_limit.increase_request.updated"`

588 

589 - `"tenant.usage_limit.increase_request.resolved"`

590 

591 - `"tenant.group.created"`

592 

593 - `"tenant.group.updated"`

594 

595 - `"tenant.group.deleted"`

596 

597 - `"tenant.group.member.added"`

598 

599 - `"tenant.group.member.removed"`

600 

601 - `"tenant.migration_rollout.status.updated"`

602 

603 - `"tenant.migration_rollout.tier.updated"`

604 

605 - `"tenant.role.metadata.updated"`

606 

607 - `"tenant.custom_role.created"`

608 

609 - `"tenant.custom_role.updated"`

610 

611 - `"tenant.custom_role.deleted"`

612 

613 - `"tenant.role_assignment.created"`

614 

615 - `"tenant.role_assignment.deleted"`

616 

617 - `"tenant.resource_role_assignment.created"`

618 

619 - `"tenant.resource_role_assignment.deleted"`

620 

621 - `"tenant.resource_access.updated"`

622 

623 - `"tenant.resource_access.deleted"`

624 

625 - `"tenant.session_policy.created"`

626 

627 - `"tenant.session_policy.updated"`

628 

629 - `"tenant.session_policy.deleted"`

630 

631 - `"tenant.session_revocation.started"`

632 

633 - `"tenant.third_party_app_policy.updated"`

634 

635 - `"tenant.user.added"`

636 

637 - `"tenant.user.updated"`

638 

639 - `"tenant.user.removed"`

640 

641 - `"tenant.user.looked_up"`

642 

643 - `"tenant.user.invited"`

644 

645 - `"tenant.membership.revoked"`

646 

647 - `"tenant.api_organization_invite.upserted"`

648 

649 - `"tenant.api_organization_invite.deleted"`

650 

651 - `"tenant.chatgpt_workspace_invite.upserted"`

652 

653 - `"tenant.membership.accepted"`

654 

655 - `"tenant.membership.declined"`

656 

657 - `"tenant.workspace_invite_email_settings.updated"`

658 

323 - `actor?: Actor | null`659 - `actor?: Actor | null`

324 660 

325 The actor who performed the audit logged action.661 The actor who performed the audit logged action.

Details

4 4 

5**post** `/organization/projects/{project_id}/service_accounts`5**post** `/organization/projects/{project_id}/service_accounts`

6 6 

7Creates a new service account in the project. This also returns an unredacted API key for the service account.7Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

8 8 

9### Parameters9### Parameters

10 10 


16 16 

17 The name of the service account being created.17 The name of the service account being created.

18 18 

19 - `create_service_account_only?: boolean | null`

20 

21 Create the service account without default roles or an API key.

22 

19### Returns23### Returns

20 24 

21- `ServiceAccountCreateResponse`25- `ServiceAccountCreateResponse`


46 50 

47 - `"organization.project.service_account"`51 - `"organization.project.service_account"`

48 52 

49 - `role: "member"`53 - `role: "member" | "none"`

50 54 

51 Service accounts can only have one role of type `member`55 Service accounts created with default project membership have role `member`. Accounts created with `create_service_account_only` have role `none`.

52 56 

53 - `"member"`57 - `"member"`

54 58 

59 - `"none"`

60 

55### Example61### Example

56 62 

57```typescript63```typescript

Details

44 44 

45 - `"organization.project.service_account"`45 - `"organization.project.service_account"`

46 46 

47 - `role: "owner" | "member"`47 - `role: "owner" | "member" | "none"`

48 48 

49 `owner` or `member`49 `owner`, `member`, or `none`

50 50 

51 - `"owner"`51 - `"owner"`

52 52 

53 - `"member"`53 - `"member"`

54 54 

55 - `"none"`

56 

55### Example57### Example

56 58 

57```typescript59```typescript

Details

40 40 

41 - `"organization.project.service_account"`41 - `"organization.project.service_account"`

42 42 

43 - `role: "owner" | "member"`43 - `role: "owner" | "member" | "none"`

44 44 

45 `owner` or `member`45 `owner`, `member`, or `none`

46 46 

47 - `"owner"`47 - `"owner"`

48 48 

49 - `"member"`49 - `"member"`

50 50 

51 - `"none"`

52 

51### Example53### Example

52 54 

53```typescript55```typescript

Details

52 52 

53 - `"organization.project.service_account"`53 - `"organization.project.service_account"`

54 54 

55 - `role: "owner" | "member"`55 - `role: "owner" | "member" | "none"`

56 56 

57 `owner` or `member`57 `owner`, `member`, or `none`

58 58 

59 - `"owner"`59 - `"owner"`

60 60 

61 - `"member"`61 - `"member"`

62 62 

63 - `"none"`

64 

63### Example65### Example

64 66 

65```typescript67```typescript

Details

1## Create project service account API key

2 

3`client.admin.organization.projects.serviceAccounts.apiKeys.create(stringserviceAccountID, APIKeyCreateParamsparams, RequestOptionsoptions?): APIKeyCreateResponse`

4 

5**post** `/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys`

6 

7Creates an API key for a service account in the project.

8 

9### Parameters

10 

11- `serviceAccountID: string`

12 

13- `params: APIKeyCreateParams`

14 

15 - `project_id: string`

16 

17 Path param: The ID of the project.

18 

19 - `name?: string`

20 

21 Body param: API key name.

22 

23 - `scopes?: Array<string>`

24 

25 Body param: API key scopes.

26 

27### Returns

28 

29- `APIKeyCreateResponse`

30 

31 - `id: string`

32 

33 - `created_at: number`

34 

35 - `name: string`

36 

37 - `object: "organization.project.service_account.api_key"`

38 

39 The object type, which is always `organization.project.service_account.api_key`

40 

41 - `"organization.project.service_account.api_key"`

42 

43 - `value: string`

44 

45### Example

46 

47```typescript

48import OpenAI from 'openai';

49 

50const client = new OpenAI({

51 adminAPIKey: process.env['OPENAI_ADMIN_KEY'], // This is the default and can be omitted

52});

53 

54const apiKey = await client.admin.organization.projects.serviceAccounts.apiKeys.create(

55 'service_account_id',

56 { project_id: 'project_id' },

57);

58 

59console.log(apiKey.id);

60```

61 

62#### Response

63 

64```json

65{

66 "id": "id",

67 "created_at": 0,

68 "name": "name",

69 "object": "organization.project.service_account.api_key",

70 "value": "value"

71}

72```

Details

88 88 

89 - `input_tokens: number`89 - `input_tokens: number`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `num_model_requests: number`93 - `num_model_requests: number`

94 94 


100 100 

101 - `output_tokens: number`101 - `output_tokens: number`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `api_key_id?: string | null`105 - `api_key_id?: string | null`

106 106 


112 112 

113 - `input_audio_tokens?: number`113 - `input_audio_tokens?: number`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `input_cache_write_tokens?: number`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `input_cached_audio_tokens?: number`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `input_cached_image_tokens?: number`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `input_cached_text_tokens?: number`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `input_cached_tokens?: number`133 - `input_cached_tokens?: number`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `input_image_tokens?: number`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `input_text_tokens?: number`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `input_uncached_tokens?: number`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `model?: string | null`149 - `model?: string | null`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `output_image_tokens?: number`

158 

159 The aggregated number of image output tokens used.

160 

161 - `output_text_tokens?: number`

162 

163 The aggregated number of text output tokens used.

164 

129 - `project_id?: string | null`165 - `project_id?: string | null`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


479 "api_key_id": "api_key_id",515 "api_key_id": "api_key_id",

480 "batch": true,516 "batch": true,

481 "input_audio_tokens": 0,517 "input_audio_tokens": 0,

518 "input_cache_write_tokens": 0,

519 "input_cached_audio_tokens": 0,

520 "input_cached_image_tokens": 0,

521 "input_cached_text_tokens": 0,

482 "input_cached_tokens": 0,522 "input_cached_tokens": 0,

523 "input_image_tokens": 0,

524 "input_text_tokens": 0,

525 "input_uncached_tokens": 0,

483 "model": "model",526 "model": "model",

484 "output_audio_tokens": 0,527 "output_audio_tokens": 0,

528 "output_image_tokens": 0,

529 "output_text_tokens": 0,

485 "project_id": "project_id",530 "project_id": "project_id",

486 "service_tier": "service_tier",531 "service_tier": "service_tier",

487 "user_id": "user_id"532 "user_id": "user_id"

Details

88 88 

89 - `input_tokens: number`89 - `input_tokens: number`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `num_model_requests: number`93 - `num_model_requests: number`

94 94 


100 100 

101 - `output_tokens: number`101 - `output_tokens: number`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `api_key_id?: string | null`105 - `api_key_id?: string | null`

106 106 


112 112 

113 - `input_audio_tokens?: number`113 - `input_audio_tokens?: number`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `input_cache_write_tokens?: number`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `input_cached_audio_tokens?: number`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `input_cached_image_tokens?: number`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `input_cached_text_tokens?: number`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `input_cached_tokens?: number`133 - `input_cached_tokens?: number`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `input_image_tokens?: number`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `input_text_tokens?: number`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `input_uncached_tokens?: number`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `model?: string | null`149 - `model?: string | null`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `output_image_tokens?: number`

158 

159 The aggregated number of image output tokens used.

160 

161 - `output_text_tokens?: number`

162 

163 The aggregated number of text output tokens used.

164 

129 - `project_id?: string | null`165 - `project_id?: string | null`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


479 "api_key_id": "api_key_id",515 "api_key_id": "api_key_id",

480 "batch": true,516 "batch": true,

481 "input_audio_tokens": 0,517 "input_audio_tokens": 0,

518 "input_cache_write_tokens": 0,

519 "input_cached_audio_tokens": 0,

520 "input_cached_image_tokens": 0,

521 "input_cached_text_tokens": 0,

482 "input_cached_tokens": 0,522 "input_cached_tokens": 0,

523 "input_image_tokens": 0,

524 "input_text_tokens": 0,

525 "input_uncached_tokens": 0,

483 "model": "model",526 "model": "model",

484 "output_audio_tokens": 0,527 "output_audio_tokens": 0,

528 "output_image_tokens": 0,

529 "output_text_tokens": 0,

485 "project_id": "project_id",530 "project_id": "project_id",

486 "service_tier": "service_tier",531 "service_tier": "service_tier",

487 "user_id": "user_id"532 "user_id": "user_id"

Details

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


82 82 

83 - `output_tokens: number`83 - `output_tokens: number`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `api_key_id?: string | null`87 - `api_key_id?: string | null`

88 88 


94 94 

95 - `input_audio_tokens?: number`95 - `input_audio_tokens?: number`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `input_cache_write_tokens?: number`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `input_cached_audio_tokens?: number`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `input_cached_image_tokens?: number`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `input_cached_text_tokens?: number`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `input_cached_tokens?: number`115 - `input_cached_tokens?: number`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `input_image_tokens?: number`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `input_text_tokens?: number`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `input_uncached_tokens?: number`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `model?: string | null`131 - `model?: string | null`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `output_image_tokens?: number`

140 

141 The aggregated number of image output tokens used.

142 

143 - `output_text_tokens?: number`

144 

145 The aggregated number of text output tokens used.

146 

111 - `project_id?: string | null`147 - `project_id?: string | null`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


461 "api_key_id": "api_key_id",497 "api_key_id": "api_key_id",

462 "batch": true,498 "batch": true,

463 "input_audio_tokens": 0,499 "input_audio_tokens": 0,

500 "input_cache_write_tokens": 0,

501 "input_cached_audio_tokens": 0,

502 "input_cached_image_tokens": 0,

503 "input_cached_text_tokens": 0,

464 "input_cached_tokens": 0,504 "input_cached_tokens": 0,

505 "input_image_tokens": 0,

506 "input_text_tokens": 0,

507 "input_uncached_tokens": 0,

465 "model": "model",508 "model": "model",

466 "output_audio_tokens": 0,509 "output_audio_tokens": 0,

510 "output_image_tokens": 0,

511 "output_text_tokens": 0,

467 "project_id": "project_id",512 "project_id": "project_id",

468 "service_tier": "service_tier",513 "service_tier": "service_tier",

469 "user_id": "user_id"514 "user_id": "user_id"

Details

96 96 

97 - `input_tokens: number`97 - `input_tokens: number`

98 98 

99 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.99 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

100 100 

101 - `num_model_requests: number`101 - `num_model_requests: number`

102 102 


108 108 

109 - `output_tokens: number`109 - `output_tokens: number`

110 110 

111 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.111 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

112 112 

113 - `api_key_id?: string | null`113 - `api_key_id?: string | null`

114 114 


120 120 

121 - `input_audio_tokens?: number`121 - `input_audio_tokens?: number`

122 122 

123 The aggregated number of audio input tokens used, including cached tokens.123 The aggregated number of uncached audio input tokens used.

124 

125 - `input_cache_write_tokens?: number`

126 

127 The aggregated number of input tokens written to the cache.

128 

129 - `input_cached_audio_tokens?: number`

130 

131 The aggregated number of cached audio input tokens used.

132 

133 - `input_cached_image_tokens?: number`

134 

135 The aggregated number of cached image input tokens used.

136 

137 - `input_cached_text_tokens?: number`

138 

139 The aggregated number of cached text input tokens used.

124 140 

125 - `input_cached_tokens?: number`141 - `input_cached_tokens?: number`

126 142 

127 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.143 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

144 

145 - `input_image_tokens?: number`

146 

147 The aggregated number of uncached image input tokens used.

148 

149 - `input_text_tokens?: number`

150 

151 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

152 

153 - `input_uncached_tokens?: number`

154 

155 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

128 156 

129 - `model?: string | null`157 - `model?: string | null`

130 158 


134 162 

135 The aggregated number of audio output tokens used.163 The aggregated number of audio output tokens used.

136 164 

165 - `output_image_tokens?: number`

166 

167 The aggregated number of image output tokens used.

168 

169 - `output_text_tokens?: number`

170 

171 The aggregated number of text output tokens used.

172 

137 - `project_id?: string | null`173 - `project_id?: string | null`

138 174 

139 When `group_by=project_id`, this field provides the project ID of the grouped usage result.175 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


487 "api_key_id": "api_key_id",523 "api_key_id": "api_key_id",

488 "batch": true,524 "batch": true,

489 "input_audio_tokens": 0,525 "input_audio_tokens": 0,

526 "input_cache_write_tokens": 0,

527 "input_cached_audio_tokens": 0,

528 "input_cached_image_tokens": 0,

529 "input_cached_text_tokens": 0,

490 "input_cached_tokens": 0,530 "input_cached_tokens": 0,

531 "input_image_tokens": 0,

532 "input_text_tokens": 0,

533 "input_uncached_tokens": 0,

491 "model": "model",534 "model": "model",

492 "output_audio_tokens": 0,535 "output_audio_tokens": 0,

536 "output_image_tokens": 0,

537 "output_text_tokens": 0,

493 "project_id": "project_id",538 "project_id": "project_id",

494 "service_tier": "service_tier",539 "service_tier": "service_tier",

495 "user_id": "user_id"540 "user_id": "user_id"

Details

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


82 82 

83 - `output_tokens: number`83 - `output_tokens: number`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `api_key_id?: string | null`87 - `api_key_id?: string | null`

88 88 


94 94 

95 - `input_audio_tokens?: number`95 - `input_audio_tokens?: number`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `input_cache_write_tokens?: number`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `input_cached_audio_tokens?: number`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `input_cached_image_tokens?: number`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `input_cached_text_tokens?: number`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `input_cached_tokens?: number`115 - `input_cached_tokens?: number`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `input_image_tokens?: number`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `input_text_tokens?: number`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `input_uncached_tokens?: number`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `model?: string | null`131 - `model?: string | null`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `output_image_tokens?: number`

140 

141 The aggregated number of image output tokens used.

142 

143 - `output_text_tokens?: number`

144 

145 The aggregated number of text output tokens used.

146 

111 - `project_id?: string | null`147 - `project_id?: string | null`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


461 "api_key_id": "api_key_id",497 "api_key_id": "api_key_id",

462 "batch": true,498 "batch": true,

463 "input_audio_tokens": 0,499 "input_audio_tokens": 0,

500 "input_cache_write_tokens": 0,

501 "input_cached_audio_tokens": 0,

502 "input_cached_image_tokens": 0,

503 "input_cached_text_tokens": 0,

464 "input_cached_tokens": 0,504 "input_cached_tokens": 0,

505 "input_image_tokens": 0,

506 "input_text_tokens": 0,

507 "input_uncached_tokens": 0,

465 "model": "model",508 "model": "model",

466 "output_audio_tokens": 0,509 "output_audio_tokens": 0,

510 "output_image_tokens": 0,

511 "output_text_tokens": 0,

467 "project_id": "project_id",512 "project_id": "project_id",

468 "service_tier": "service_tier",513 "service_tier": "service_tier",

469 "user_id": "user_id"514 "user_id": "user_id"

Details

88 88 

89 - `input_tokens: number`89 - `input_tokens: number`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `num_model_requests: number`93 - `num_model_requests: number`

94 94 


100 100 

101 - `output_tokens: number`101 - `output_tokens: number`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `api_key_id?: string | null`105 - `api_key_id?: string | null`

106 106 


112 112 

113 - `input_audio_tokens?: number`113 - `input_audio_tokens?: number`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `input_cache_write_tokens?: number`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `input_cached_audio_tokens?: number`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `input_cached_image_tokens?: number`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `input_cached_text_tokens?: number`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `input_cached_tokens?: number`133 - `input_cached_tokens?: number`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `input_image_tokens?: number`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `input_text_tokens?: number`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `input_uncached_tokens?: number`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `model?: string | null`149 - `model?: string | null`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `output_image_tokens?: number`

158 

159 The aggregated number of image output tokens used.

160 

161 - `output_text_tokens?: number`

162 

163 The aggregated number of text output tokens used.

164 

129 - `project_id?: string | null`165 - `project_id?: string | null`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


479 "api_key_id": "api_key_id",515 "api_key_id": "api_key_id",

480 "batch": true,516 "batch": true,

481 "input_audio_tokens": 0,517 "input_audio_tokens": 0,

518 "input_cache_write_tokens": 0,

519 "input_cached_audio_tokens": 0,

520 "input_cached_image_tokens": 0,

521 "input_cached_text_tokens": 0,

482 "input_cached_tokens": 0,522 "input_cached_tokens": 0,

523 "input_image_tokens": 0,

524 "input_text_tokens": 0,

525 "input_uncached_tokens": 0,

483 "model": "model",526 "model": "model",

484 "output_audio_tokens": 0,527 "output_audio_tokens": 0,

528 "output_image_tokens": 0,

529 "output_text_tokens": 0,

485 "project_id": "project_id",530 "project_id": "project_id",

486 "service_tier": "service_tier",531 "service_tier": "service_tier",

487 "user_id": "user_id"532 "user_id": "user_id"

Details

88 88 

89 - `input_tokens: number`89 - `input_tokens: number`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `num_model_requests: number`93 - `num_model_requests: number`

94 94 


100 100 

101 - `output_tokens: number`101 - `output_tokens: number`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `api_key_id?: string | null`105 - `api_key_id?: string | null`

106 106 


112 112 

113 - `input_audio_tokens?: number`113 - `input_audio_tokens?: number`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `input_cache_write_tokens?: number`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `input_cached_audio_tokens?: number`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `input_cached_image_tokens?: number`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `input_cached_text_tokens?: number`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `input_cached_tokens?: number`133 - `input_cached_tokens?: number`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `input_image_tokens?: number`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `input_text_tokens?: number`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `input_uncached_tokens?: number`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `model?: string | null`149 - `model?: string | null`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `output_image_tokens?: number`

158 

159 The aggregated number of image output tokens used.

160 

161 - `output_text_tokens?: number`

162 

163 The aggregated number of text output tokens used.

164 

129 - `project_id?: string | null`165 - `project_id?: string | null`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


479 "api_key_id": "api_key_id",515 "api_key_id": "api_key_id",

480 "batch": true,516 "batch": true,

481 "input_audio_tokens": 0,517 "input_audio_tokens": 0,

518 "input_cache_write_tokens": 0,

519 "input_cached_audio_tokens": 0,

520 "input_cached_image_tokens": 0,

521 "input_cached_text_tokens": 0,

482 "input_cached_tokens": 0,522 "input_cached_tokens": 0,

523 "input_image_tokens": 0,

524 "input_text_tokens": 0,

525 "input_uncached_tokens": 0,

483 "model": "model",526 "model": "model",

484 "output_audio_tokens": 0,527 "output_audio_tokens": 0,

528 "output_image_tokens": 0,

529 "output_text_tokens": 0,

485 "project_id": "project_id",530 "project_id": "project_id",

486 "service_tier": "service_tier",531 "service_tier": "service_tier",

487 "user_id": "user_id"532 "user_id": "user_id"

Details

116 116 

117 - `input_tokens: number`117 - `input_tokens: number`

118 118 

119 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.119 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

120 120 

121 - `num_model_requests: number`121 - `num_model_requests: number`

122 122 


128 128 

129 - `output_tokens: number`129 - `output_tokens: number`

130 130 

131 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.131 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

132 132 

133 - `api_key_id?: string | null`133 - `api_key_id?: string | null`

134 134 


140 140 

141 - `input_audio_tokens?: number`141 - `input_audio_tokens?: number`

142 142 

143 The aggregated number of audio input tokens used, including cached tokens.143 The aggregated number of uncached audio input tokens used.

144 

145 - `input_cache_write_tokens?: number`

146 

147 The aggregated number of input tokens written to the cache.

148 

149 - `input_cached_audio_tokens?: number`

150 

151 The aggregated number of cached audio input tokens used.

152 

153 - `input_cached_image_tokens?: number`

154 

155 The aggregated number of cached image input tokens used.

156 

157 - `input_cached_text_tokens?: number`

158 

159 The aggregated number of cached text input tokens used.

144 160 

145 - `input_cached_tokens?: number`161 - `input_cached_tokens?: number`

146 162 

147 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.163 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

164 

165 - `input_image_tokens?: number`

166 

167 The aggregated number of uncached image input tokens used.

168 

169 - `input_text_tokens?: number`

170 

171 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

172 

173 - `input_uncached_tokens?: number`

174 

175 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

148 176 

149 - `model?: string | null`177 - `model?: string | null`

150 178 


154 182 

155 The aggregated number of audio output tokens used.183 The aggregated number of audio output tokens used.

156 184 

185 - `output_image_tokens?: number`

186 

187 The aggregated number of image output tokens used.

188 

189 - `output_text_tokens?: number`

190 

191 The aggregated number of text output tokens used.

192 

157 - `project_id?: string | null`193 - `project_id?: string | null`

158 194 

159 When `group_by=project_id`, this field provides the project ID of the grouped usage result.195 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


507 "api_key_id": "api_key_id",543 "api_key_id": "api_key_id",

508 "batch": true,544 "batch": true,

509 "input_audio_tokens": 0,545 "input_audio_tokens": 0,

546 "input_cache_write_tokens": 0,

547 "input_cached_audio_tokens": 0,

548 "input_cached_image_tokens": 0,

549 "input_cached_text_tokens": 0,

510 "input_cached_tokens": 0,550 "input_cached_tokens": 0,

551 "input_image_tokens": 0,

552 "input_text_tokens": 0,

553 "input_uncached_tokens": 0,

511 "model": "model",554 "model": "model",

512 "output_audio_tokens": 0,555 "output_audio_tokens": 0,

556 "output_image_tokens": 0,

557 "output_text_tokens": 0,

513 "project_id": "project_id",558 "project_id": "project_id",

514 "service_tier": "service_tier",559 "service_tier": "service_tier",

515 "user_id": "user_id"560 "user_id": "user_id"

Details

88 88 

89 - `input_tokens: number`89 - `input_tokens: number`

90 90 

91 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.91 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

92 92 

93 - `num_model_requests: number`93 - `num_model_requests: number`

94 94 


100 100 

101 - `output_tokens: number`101 - `output_tokens: number`

102 102 

103 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `api_key_id?: string | null`105 - `api_key_id?: string | null`

106 106 


112 112 

113 - `input_audio_tokens?: number`113 - `input_audio_tokens?: number`

114 114 

115 The aggregated number of audio input tokens used, including cached tokens.115 The aggregated number of uncached audio input tokens used.

116 

117 - `input_cache_write_tokens?: number`

118 

119 The aggregated number of input tokens written to the cache.

120 

121 - `input_cached_audio_tokens?: number`

122 

123 The aggregated number of cached audio input tokens used.

124 

125 - `input_cached_image_tokens?: number`

126 

127 The aggregated number of cached image input tokens used.

128 

129 - `input_cached_text_tokens?: number`

130 

131 The aggregated number of cached text input tokens used.

116 132 

117 - `input_cached_tokens?: number`133 - `input_cached_tokens?: number`

118 134 

119 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.135 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

136 

137 - `input_image_tokens?: number`

138 

139 The aggregated number of uncached image input tokens used.

140 

141 - `input_text_tokens?: number`

142 

143 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

144 

145 - `input_uncached_tokens?: number`

146 

147 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

120 148 

121 - `model?: string | null`149 - `model?: string | null`

122 150 


126 154 

127 The aggregated number of audio output tokens used.155 The aggregated number of audio output tokens used.

128 156 

157 - `output_image_tokens?: number`

158 

159 The aggregated number of image output tokens used.

160 

161 - `output_text_tokens?: number`

162 

163 The aggregated number of text output tokens used.

164 

129 - `project_id?: string | null`165 - `project_id?: string | null`

130 166 

131 When `group_by=project_id`, this field provides the project ID of the grouped usage result.167 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


479 "api_key_id": "api_key_id",515 "api_key_id": "api_key_id",

480 "batch": true,516 "batch": true,

481 "input_audio_tokens": 0,517 "input_audio_tokens": 0,

518 "input_cache_write_tokens": 0,

519 "input_cached_audio_tokens": 0,

520 "input_cached_image_tokens": 0,

521 "input_cached_text_tokens": 0,

482 "input_cached_tokens": 0,522 "input_cached_tokens": 0,

523 "input_image_tokens": 0,

524 "input_text_tokens": 0,

525 "input_uncached_tokens": 0,

483 "model": "model",526 "model": "model",

484 "output_audio_tokens": 0,527 "output_audio_tokens": 0,

528 "output_image_tokens": 0,

529 "output_text_tokens": 0,

485 "project_id": "project_id",530 "project_id": "project_id",

486 "service_tier": "service_tier",531 "service_tier": "service_tier",

487 "user_id": "user_id"532 "user_id": "user_id"

Details

70 70 

71 - `input_tokens: number`71 - `input_tokens: number`

72 72 

73 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.73 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

74 74 

75 - `num_model_requests: number`75 - `num_model_requests: number`

76 76 


82 82 

83 - `output_tokens: number`83 - `output_tokens: number`

84 84 

85 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.85 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

86 86 

87 - `api_key_id?: string | null`87 - `api_key_id?: string | null`

88 88 


94 94 

95 - `input_audio_tokens?: number`95 - `input_audio_tokens?: number`

96 96 

97 The aggregated number of audio input tokens used, including cached tokens.97 The aggregated number of uncached audio input tokens used.

98 

99 - `input_cache_write_tokens?: number`

100 

101 The aggregated number of input tokens written to the cache.

102 

103 - `input_cached_audio_tokens?: number`

104 

105 The aggregated number of cached audio input tokens used.

106 

107 - `input_cached_image_tokens?: number`

108 

109 The aggregated number of cached image input tokens used.

110 

111 - `input_cached_text_tokens?: number`

112 

113 The aggregated number of cached text input tokens used.

98 114 

99 - `input_cached_tokens?: number`115 - `input_cached_tokens?: number`

100 116 

101 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.117 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

118 

119 - `input_image_tokens?: number`

120 

121 The aggregated number of uncached image input tokens used.

122 

123 - `input_text_tokens?: number`

124 

125 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

126 

127 - `input_uncached_tokens?: number`

128 

129 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

102 130 

103 - `model?: string | null`131 - `model?: string | null`

104 132 


108 136 

109 The aggregated number of audio output tokens used.137 The aggregated number of audio output tokens used.

110 138 

139 - `output_image_tokens?: number`

140 

141 The aggregated number of image output tokens used.

142 

143 - `output_text_tokens?: number`

144 

145 The aggregated number of text output tokens used.

146 

111 - `project_id?: string | null`147 - `project_id?: string | null`

112 148 

113 When `group_by=project_id`, this field provides the project ID of the grouped usage result.149 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


461 "api_key_id": "api_key_id",497 "api_key_id": "api_key_id",

462 "batch": true,498 "batch": true,

463 "input_audio_tokens": 0,499 "input_audio_tokens": 0,

500 "input_cache_write_tokens": 0,

501 "input_cached_audio_tokens": 0,

502 "input_cached_image_tokens": 0,

503 "input_cached_text_tokens": 0,

464 "input_cached_tokens": 0,504 "input_cached_tokens": 0,

505 "input_image_tokens": 0,

506 "input_text_tokens": 0,

507 "input_uncached_tokens": 0,

465 "model": "model",508 "model": "model",

466 "output_audio_tokens": 0,509 "output_audio_tokens": 0,

510 "output_image_tokens": 0,

511 "output_text_tokens": 0,

467 "project_id": "project_id",512 "project_id": "project_id",

468 "service_tier": "service_tier",513 "service_tier": "service_tier",

469 "user_id": "user_id"514 "user_id": "user_id"

Details

100 100 

101 - `input_tokens: number`101 - `input_tokens: number`

102 102 

103 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.103 The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

104 104 

105 - `num_model_requests: number`105 - `num_model_requests: number`

106 106 


112 112 

113 - `output_tokens: number`113 - `output_tokens: number`

114 114 

115 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.115 The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

116 116 

117 - `api_key_id?: string | null`117 - `api_key_id?: string | null`

118 118 


124 124 

125 - `input_audio_tokens?: number`125 - `input_audio_tokens?: number`

126 126 

127 The aggregated number of audio input tokens used, including cached tokens.127 The aggregated number of uncached audio input tokens used.

128 

129 - `input_cache_write_tokens?: number`

130 

131 The aggregated number of input tokens written to the cache.

132 

133 - `input_cached_audio_tokens?: number`

134 

135 The aggregated number of cached audio input tokens used.

136 

137 - `input_cached_image_tokens?: number`

138 

139 The aggregated number of cached image input tokens used.

140 

141 - `input_cached_text_tokens?: number`

142 

143 The aggregated number of cached text input tokens used.

128 144 

129 - `input_cached_tokens?: number`145 - `input_cached_tokens?: number`

130 146 

131 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.147 The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.

148 

149 - `input_image_tokens?: number`

150 

151 The aggregated number of uncached image input tokens used.

152 

153 - `input_text_tokens?: number`

154 

155 The aggregated number of uncached text input tokens used, excluding cache-write tokens.

156 

157 - `input_uncached_tokens?: number`

158 

159 The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.

132 160 

133 - `model?: string | null`161 - `model?: string | null`

134 162 


138 166 

139 The aggregated number of audio output tokens used.167 The aggregated number of audio output tokens used.

140 168 

169 - `output_image_tokens?: number`

170 

171 The aggregated number of image output tokens used.

172 

173 - `output_text_tokens?: number`

174 

175 The aggregated number of text output tokens used.

176 

141 - `project_id?: string | null`177 - `project_id?: string | null`

142 178 

143 When `group_by=project_id`, this field provides the project ID of the grouped usage result.179 When `group_by=project_id`, this field provides the project ID of the grouped usage result.


491 "api_key_id": "api_key_id",527 "api_key_id": "api_key_id",

492 "batch": true,528 "batch": true,

493 "input_audio_tokens": 0,529 "input_audio_tokens": 0,

530 "input_cache_write_tokens": 0,

531 "input_cached_audio_tokens": 0,

532 "input_cached_image_tokens": 0,

533 "input_cached_text_tokens": 0,

494 "input_cached_tokens": 0,534 "input_cached_tokens": 0,

535 "input_image_tokens": 0,

536 "input_text_tokens": 0,

537 "input_uncached_tokens": 0,

495 "model": "model",538 "model": "model",

496 "output_audio_tokens": 0,539 "output_audio_tokens": 0,

540 "output_image_tokens": 0,

541 "output_text_tokens": 0,

497 "project_id": "project_id",542 "project_id": "project_id",

498 "service_tier": "service_tier",543 "service_tier": "service_tier",

499 "user_id": "user_id"544 "user_id": "user_id"

Details

1435 1435 

1436 - `"output_text"`1436 - `"output_text"`

1437 1437 

1438 - `annotations?: Array<UnionMember0> | Array<UnionMember1> | Array<UnionMember2>`1438 - `annotations?: Array<FileCitation | URLCitation | ContainerFileCitation>`

1439 1439 

1440 Citations associated with the text content.1440 Citations associated with the text content.

1441 1441 

1442 - `Array<UnionMember0>`1442 - `FileCitation`

1443 1443 

1444 - `file_id: string`1444 - `file_id: string`

1445 1445 


1459 1459 

1460 - `"file_citation"`1460 - `"file_citation"`

1461 1461 

1462 - `Array<UnionMember1>`1462 - `URLCitation`

1463 1463 

1464 - `end_index: number`1464 - `end_index: number`

1465 1465 


1483 1483 

1484 The URL of the cited resource.1484 The URL of the cited resource.

1485 1485 

1486 - `Array<UnionMember2>`1486 - `ContainerFileCitation`

1487 1487 

1488 - `container_id: string`1488 - `container_id: string`

1489 1489 


2852 2852 

2853 - `encrypted_content?: string | null`2853 - `encrypted_content?: string | null`

2854 2854 

2855 The encrypted content of the reasoning item - populated when a response is2855 The encrypted content of the reasoning item. This is populated by default

2856 generated with `reasoning.encrypted_content` in the `include` parameter.2856 for reasoning items returned by `POST /v1/responses` and WebSocket

2857 `response.create` requests.

2857 2858 

2858 - `status?: "in_progress" | "completed" | "incomplete"`2859 - `status?: "in_progress" | "completed" | "incomplete"`

2859 2860 

Details

1547 1547 

1548 - `"output_text"`1548 - `"output_text"`

1549 1549 

1550 - `annotations?: Array<UnionMember0> | Array<UnionMember1> | Array<UnionMember2>`1550 - `annotations?: Array<FileCitation | URLCitation | ContainerFileCitation>`

1551 1551 

1552 Citations associated with the text content.1552 Citations associated with the text content.

1553 1553 

1554 - `Array<UnionMember0>`1554 - `FileCitation`

1555 1555 

1556 - `file_id: string`1556 - `file_id: string`

1557 1557 


1571 1571 

1572 - `"file_citation"`1572 - `"file_citation"`

1573 1573 

1574 - `Array<UnionMember1>`1574 - `URLCitation`

1575 1575 

1576 - `end_index: number`1576 - `end_index: number`

1577 1577 


1595 1595 

1596 The URL of the cited resource.1596 The URL of the cited resource.

1597 1597 

1598 - `Array<UnionMember2>`1598 - `ContainerFileCitation`

1599 1599 

1600 - `container_id: string`1600 - `container_id: string`

1601 1601 


2964 2964 

2965 - `encrypted_content?: string | null`2965 - `encrypted_content?: string | null`

2966 2966 

2967 The encrypted content of the reasoning item - populated when a response is2967 The encrypted content of the reasoning item. This is populated by default

2968 generated with `reasoning.encrypted_content` in the `include` parameter.2968 for reasoning items returned by `POST /v1/responses` and WebSocket

2969 `response.create` requests.

2969 2970 

2970 - `status?: "in_progress" | "completed" | "incomplete"`2971 - `status?: "in_progress" | "completed" | "incomplete"`

2971 2972 


5375 5376 

5376 - `encrypted_content?: string | null`5377 - `encrypted_content?: string | null`

5377 5378 

5378 The encrypted content of the reasoning item - populated when a response is5379 The encrypted content of the reasoning item. This is populated by default

5379 generated with `reasoning.encrypted_content` in the `include` parameter.5380 for reasoning items returned by `POST /v1/responses` and WebSocket

5381 `response.create` requests.

5380 5382 

5381 - `status?: "in_progress" | "completed" | "incomplete"`5383 - `status?: "in_progress" | "completed" | "incomplete"`

5382 5384 

Details

1426 1426 

1427 - `"output_text"`1427 - `"output_text"`

1428 1428 

1429 - `annotations?: Array<UnionMember0> | Array<UnionMember1> | Array<UnionMember2>`1429 - `annotations?: Array<FileCitation | URLCitation | ContainerFileCitation>`

1430 1430 

1431 Citations associated with the text content.1431 Citations associated with the text content.

1432 1432 

1433 - `Array<UnionMember0>`1433 - `FileCitation`

1434 1434 

1435 - `file_id: string`1435 - `file_id: string`

1436 1436 


1450 1450 

1451 - `"file_citation"`1451 - `"file_citation"`

1452 1452 

1453 - `Array<UnionMember1>`1453 - `URLCitation`

1454 1454 

1455 - `end_index: number`1455 - `end_index: number`

1456 1456 


1474 1474 

1475 The URL of the cited resource.1475 The URL of the cited resource.

1476 1476 

1477 - `Array<UnionMember2>`1477 - `ContainerFileCitation`

1478 1478 

1479 - `container_id: string`1479 - `container_id: string`

1480 1480 


2843 2843 

2844 - `encrypted_content?: string | null`2844 - `encrypted_content?: string | null`

2845 2845 

2846 The encrypted content of the reasoning item - populated when a response is2846 The encrypted content of the reasoning item. This is populated by default

2847 generated with `reasoning.encrypted_content` in the `include` parameter.2847 for reasoning items returned by `POST /v1/responses` and WebSocket

2848 `response.create` requests.

2848 2849 

2849 - `status?: "in_progress" | "completed" | "incomplete"`2850 - `status?: "in_progress" | "completed" | "incomplete"`

2850 2851 


6201 6202 

6202 - `"output_text"`6203 - `"output_text"`

6203 6204 

6204 - `annotations?: Array<UnionMember0> | Array<UnionMember1> | Array<UnionMember2>`6205 - `annotations?: Array<FileCitation | URLCitation | ContainerFileCitation>`

6205 6206 

6206 Citations associated with the text content.6207 Citations associated with the text content.

6207 6208 

6208 - `Array<UnionMember0>`6209 - `FileCitation`

6209 6210 

6210 - `file_id: string`6211 - `file_id: string`

6211 6212 


6225 6226 

6226 - `"file_citation"`6227 - `"file_citation"`

6227 6228 

6228 - `Array<UnionMember1>`6229 - `URLCitation`

6229 6230 

6230 - `end_index: number`6231 - `end_index: number`

6231 6232 


6249 6250 

6250 The URL of the cited resource.6251 The URL of the cited resource.

6251 6252 

6252 - `Array<UnionMember2>`6253 - `ContainerFileCitation`

6253 6254 

6254 - `container_id: string`6255 - `container_id: string`

6255 6256 


7618 7619 

7619 - `encrypted_content?: string | null`7620 - `encrypted_content?: string | null`

7620 7621 

7621 The encrypted content of the reasoning item - populated when a response is7622 The encrypted content of the reasoning item. This is populated by default

7622 generated with `reasoning.encrypted_content` in the `include` parameter.7623 for reasoning items returned by `POST /v1/responses` and WebSocket

7624 `response.create` requests.

7623 7625 

7624 - `status?: "in_progress" | "completed" | "incomplete"`7626 - `status?: "in_progress" | "completed" | "incomplete"`

7625 7627 

Details

1499 1499 

1500 - `"output_text"`1500 - `"output_text"`

1501 1501 

1502 - `annotations?: Array<UnionMember0> | Array<UnionMember1> | Array<UnionMember2>`1502 - `annotations?: Array<FileCitation | URLCitation | ContainerFileCitation>`

1503 1503 

1504 Citations associated with the text content.1504 Citations associated with the text content.

1505 1505 

1506 - `Array<UnionMember0>`1506 - `FileCitation`

1507 1507 

1508 - `file_id: string`1508 - `file_id: string`

1509 1509 


1523 1523 

1524 - `"file_citation"`1524 - `"file_citation"`

1525 1525 

1526 - `Array<UnionMember1>`1526 - `URLCitation`

1527 1527 

1528 - `end_index: number`1528 - `end_index: number`

1529 1529 


1547 1547 

1548 The URL of the cited resource.1548 The URL of the cited resource.

1549 1549 

1550 - `Array<UnionMember2>`1550 - `ContainerFileCitation`

1551 1551 

1552 - `container_id: string`1552 - `container_id: string`

1553 1553 


2916 2916 

2917 - `encrypted_content?: string | null`2917 - `encrypted_content?: string | null`

2918 2918 

2919 The encrypted content of the reasoning item - populated when a response is2919 The encrypted content of the reasoning item. This is populated by default

2920 generated with `reasoning.encrypted_content` in the `include` parameter.2920 for reasoning items returned by `POST /v1/responses` and WebSocket

2921 `response.create` requests.

2921 2922 

2922 - `status?: "in_progress" | "completed" | "incomplete"`2923 - `status?: "in_progress" | "completed" | "incomplete"`

2923 2924 

Details

2664 2664 

2665 - `encrypted_content?: string | null`2665 - `encrypted_content?: string | null`

2666 2666 

2667 The encrypted content of the reasoning item - populated when a response is2667 The encrypted content of the reasoning item. This is populated by default

2668 generated with `reasoning.encrypted_content` in the `include` parameter.2668 for reasoning items returned by `POST /v1/responses` and WebSocket

2669 `response.create` requests.

2669 2670 

2670 - `status?: "in_progress" | "completed" | "incomplete"`2671 - `status?: "in_progress" | "completed" | "incomplete"`

2671 2672 

Details

1364 1364 

1365 - `"output_text"`1365 - `"output_text"`

1366 1366 

1367 - `annotations?: Array<UnionMember0> | Array<UnionMember1> | Array<UnionMember2>`1367 - `annotations?: Array<FileCitation | URLCitation | ContainerFileCitation>`

1368 1368 

1369 Citations associated with the text content.1369 Citations associated with the text content.

1370 1370 

1371 - `Array<UnionMember0>`1371 - `FileCitation`

1372 1372 

1373 - `file_id: string`1373 - `file_id: string`

1374 1374 


1388 1388 

1389 - `"file_citation"`1389 - `"file_citation"`

1390 1390 

1391 - `Array<UnionMember1>`1391 - `URLCitation`

1392 1392 

1393 - `end_index: number`1393 - `end_index: number`

1394 1394 


1412 1412 

1413 The URL of the cited resource.1413 The URL of the cited resource.

1414 1414 

1415 - `Array<UnionMember2>`1415 - `ContainerFileCitation`

1416 1416 

1417 - `container_id: string`1417 - `container_id: string`

1418 1418 


2781 2781 

2782 - `encrypted_content?: string | null`2782 - `encrypted_content?: string | null`

2783 2783 

2784 The encrypted content of the reasoning item - populated when a response is2784 The encrypted content of the reasoning item. This is populated by default

2785 generated with `reasoning.encrypted_content` in the `include` parameter.2785 for reasoning items returned by `POST /v1/responses` and WebSocket

2786 `response.create` requests.

2786 2787 

2787 - `status?: "in_progress" | "completed" | "incomplete"`2788 - `status?: "in_progress" | "completed" | "incomplete"`

2788 2789 

Details

2540 2540 

2541 - `encrypted_content?: string | null`2541 - `encrypted_content?: string | null`

2542 2542 

2543 The encrypted content of the reasoning item - populated when a response is2543 The encrypted content of the reasoning item. This is populated by default

2544 generated with `reasoning.encrypted_content` in the `include` parameter.2544 for reasoning items returned by `POST /v1/responses` and WebSocket

2545 `response.create` requests.

2545 2546 

2546 - `status?: "in_progress" | "completed" | "incomplete"`2547 - `status?: "in_progress" | "completed" | "incomplete"`

2547 2548 

Details

2542 2542 

2543 - `encrypted_content?: string | null`2543 - `encrypted_content?: string | null`

2544 2544 

2545 The encrypted content of the reasoning item - populated when a response is2545 The encrypted content of the reasoning item. This is populated by default

2546 generated with `reasoning.encrypted_content` in the `include` parameter.2546 for reasoning items returned by `POST /v1/responses` and WebSocket

2547 `response.create` requests.

2547 2548 

2548 - `status?: "in_progress" | "completed" | "incomplete"`2549 - `status?: "in_progress" | "completed" | "incomplete"`

2549 2550 


5908 5909 

5909 - `encrypted_content?: string | null`5910 - `encrypted_content?: string | null`

5910 5911 

5911 The encrypted content of the reasoning item - populated when a response is5912 The encrypted content of the reasoning item. This is populated by default

5912 generated with `reasoning.encrypted_content` in the `include` parameter.5913 for reasoning items returned by `POST /v1/responses` and WebSocket

5914 `response.create` requests.

5913 5915 

5914 - `status?: "in_progress" | "completed" | "incomplete"`5916 - `status?: "in_progress" | "completed" | "incomplete"`

5915 5917 

Details

2518 2518 

2519 - `encrypted_content?: string | null`2519 - `encrypted_content?: string | null`

2520 2520 

2521 The encrypted content of the reasoning item - populated when a response is2521 The encrypted content of the reasoning item. This is populated by default

2522 generated with `reasoning.encrypted_content` in the `include` parameter.2522 for reasoning items returned by `POST /v1/responses` and WebSocket

2523 `response.create` requests.

2523 2524 

2524 - `status?: "in_progress" | "completed" | "incomplete"`2525 - `status?: "in_progress" | "completed" | "incomplete"`

2525 2526 

Details

2495 2495 

2496 - `encrypted_content?: string | null`2496 - `encrypted_content?: string | null`

2497 2497 

2498 The encrypted content of the reasoning item - populated when a response is2498 The encrypted content of the reasoning item. This is populated by default

2499 generated with `reasoning.encrypted_content` in the `include` parameter.2499 for reasoning items returned by `POST /v1/responses` and WebSocket

2500 `response.create` requests.

2500 2501 

2501 - `status?: "in_progress" | "completed" | "incomplete"`2502 - `status?: "in_progress" | "completed" | "incomplete"`

2502 2503 

Details

2624 2624 

2625 - `encrypted_content?: string | null`2625 - `encrypted_content?: string | null`

2626 2626 

2627 The encrypted content of the reasoning item - populated when a response is2627 The encrypted content of the reasoning item. This is populated by default

2628 generated with `reasoning.encrypted_content` in the `include` parameter.2628 for reasoning items returned by `POST /v1/responses` and WebSocket

2629 `response.create` requests.

2629 2630 

2630 - `status?: "in_progress" | "completed" | "incomplete"`2631 - `status?: "in_progress" | "completed" | "incomplete"`

2631 2632 

Details

2744 2744 

2745 - `encrypted_content?: string | null`2745 - `encrypted_content?: string | null`

2746 2746 

2747 The encrypted content of the reasoning item - populated when a response is2747 The encrypted content of the reasoning item. This is populated by default

2748 generated with `reasoning.encrypted_content` in the `include` parameter.2748 for reasoning items returned by `POST /v1/responses` and WebSocket

2749 `response.create` requests.

2749 2750 

2750 - `status?: "in_progress" | "completed" | "incomplete"`2751 - `status?: "in_progress" | "completed" | "incomplete"`

2751 2752 


4842 4843 

4843 - `encrypted_content?: string | null`4844 - `encrypted_content?: string | null`

4844 4845 

4845 The encrypted content of the reasoning item - populated when a response is4846 The encrypted content of the reasoning item. This is populated by default

4846 generated with `reasoning.encrypted_content` in the `include` parameter.4847 for reasoning items returned by `POST /v1/responses` and WebSocket

4848 `response.create` requests.

4847 4849 

4848 - `status?: "in_progress" | "completed" | "incomplete"`4850 - `status?: "in_progress" | "completed" | "incomplete"`

4849 4851 

Details

2623 2623 

2624 - `encrypted_content?: string | null`2624 - `encrypted_content?: string | null`

2625 2625 

2626 The encrypted content of the reasoning item - populated when a response is2626 The encrypted content of the reasoning item. This is populated by default

2627 generated with `reasoning.encrypted_content` in the `include` parameter.2627 for reasoning items returned by `POST /v1/responses` and WebSocket

2628 `response.create` requests.

2628 2629 

2629 - `status?: "in_progress" | "completed" | "incomplete"`2630 - `status?: "in_progress" | "completed" | "incomplete"`

2630 2631 


7009 7010 

7010 - `encrypted_content?: string | null`7011 - `encrypted_content?: string | null`

7011 7012 

7012 The encrypted content of the reasoning item - populated when a response is7013 The encrypted content of the reasoning item. This is populated by default

7013 generated with `reasoning.encrypted_content` in the `include` parameter.7014 for reasoning items returned by `POST /v1/responses` and WebSocket

7015 `response.create` requests.

7014 7016 

7015 - `status?: "in_progress" | "completed" | "incomplete"`7017 - `status?: "in_progress" | "completed" | "incomplete"`

7016 7018 

Details

2690 2690 

2691 - `encrypted_content?: string | null`2691 - `encrypted_content?: string | null`

2692 2692 

2693 The encrypted content of the reasoning item - populated when a response is2693 The encrypted content of the reasoning item. This is populated by default

2694 generated with `reasoning.encrypted_content` in the `include` parameter.2694 for reasoning items returned by `POST /v1/responses` and WebSocket

2695 `response.create` requests.

2695 2696 

2696 - `status?: "in_progress" | "completed" | "incomplete"`2697 - `status?: "in_progress" | "completed" | "incomplete"`

2697 2698 

Details

2430 2430 

2431 - `encrypted_content?: string | null`2431 - `encrypted_content?: string | null`

2432 2432 

2433 The encrypted content of the reasoning item - populated when a response is2433 The encrypted content of the reasoning item. This is populated by default

2434 generated with `reasoning.encrypted_content` in the `include` parameter.2434 for reasoning items returned by `POST /v1/responses` and WebSocket

2435 `response.create` requests.

2435 2436 

2436 - `status?: "in_progress" | "completed" | "incomplete"`2437 - `status?: "in_progress" | "completed" | "incomplete"`

2437 2438 

Details

2561 2561 

2562 - `encrypted_content?: string | null`2562 - `encrypted_content?: string | null`

2563 2563 

2564 The encrypted content of the reasoning item - populated when a response is2564 The encrypted content of the reasoning item. This is populated by default

2565 generated with `reasoning.encrypted_content` in the `include` parameter.2565 for reasoning items returned by `POST /v1/responses` and WebSocket

2566 `response.create` requests.

2566 2567 

2567 - `status?: "in_progress" | "completed" | "incomplete"`2568 - `status?: "in_progress" | "completed" | "incomplete"`

2568 2569