SpyBara
Go Premium

Reference 2026-04-30 06:13 UTC to 2026-05-02 05:57 UTC

32 files changed +1,247 −907. View all changes and history on the product overview
2026
Wed 27 06:42 Fri 22 06:33 Wed 20 06:35 Tue 19 06:34 Mon 18 22:01 Mon 11 18:00 Thu 7 21:57 Tue 5 23:00 Sat 2 05:57
Details

10 10 

11### Returns11### Returns

12 12 

13- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`13- `value: string`

14 

15 Represents an individual Admin API key in an org.

16 

17 - `id: string`

18 

19 The identifier, which can be referenced in API endpoints

20 

21 - `created_at: number`

22 

23 The Unix timestamp (in seconds) of when the API key was created

24 

25 - `last_used_at: number`

26 

27 The Unix timestamp (in seconds) of when the API key was last used

28 

29 - `name: string`

30 

31 The name of the API key

32 

33 - `object: string`

34 

35 The object type, which is always `organization.admin_api_key`

36 

37 - `owner: object { id, created_at, name, 3 more }`

38 

39 - `id: optional string`

40 

41 The identifier, which can be referenced in API endpoints

42 

43 - `created_at: optional number`

44 

45 The Unix timestamp (in seconds) of when the user was created

46 

47 - `name: optional string`

48 

49 The name of the user

50 

51 - `object: optional string`

52 

53 The object type, which is always organization.user

54 

55 - `role: optional string`

56 

57 Always `owner`

58 

59 - `type: optional string`

60 

61 Always `user`

62 

63 - `redacted_value: string`

64 

65 The redacted value of the API key

66 

67 - `value: optional string`

68 14 

69 The value of the API key. Only shown on create.15 The value of the API key. Only shown on create.

70 16 

85{31{

86 "id": "key_abc",32 "id": "key_abc",

87 "created_at": 1711471533,33 "created_at": 1711471533,

88 "last_used_at": 1711471534,

89 "name": "Administration Key",

90 "object": "organization.admin_api_key",34 "object": "organization.admin_api_key",

91 "owner": {35 "owner": {

92 "id": "sa_456",36 "id": "sa_456",

97 "type": "user"41 "type": "user"

98 },42 },

99 "redacted_value": "sk-admin...def",43 "redacted_value": "sk-admin...def",

44 "last_used_at": 1711471534,

45 "name": "Administration Key",

100 "value": "sk-admin-1234abcd"46 "value": "sk-admin-1234abcd"

101}47}

102```48```

Details

24 24 

25### Returns25### Returns

26 26 

27- `data: optional array of AdminAPIKey`27- `data: array of AdminAPIKey`

28 28 

29 - `id: string`29 - `id: string`

30 30 

34 34 

35 The Unix timestamp (in seconds) of when the API key was created35 The Unix timestamp (in seconds) of when the API key was created

36 36 

37 - `last_used_at: number`37 - `object: "organization.admin_api_key"`

38 

39 The Unix timestamp (in seconds) of when the API key was last used

40 

41 - `name: string`

42 

43 The name of the API key

44 

45 - `object: string`

46 38 

47 The object type, which is always `organization.admin_api_key`39 The object type, which is always `organization.admin_api_key`

48 40 

41 - `"organization.admin_api_key"`

42 

49 - `owner: object { id, created_at, name, 3 more }`43 - `owner: object { id, created_at, name, 3 more }`

50 44 

51 - `id: optional string`45 - `id: optional string`

76 70 

77 The redacted value of the API key71 The redacted value of the API key

78 72 

79 - `value: optional string`73 - `last_used_at: optional number`

80 74 

81 The value of the API key. Only shown on create.75 The Unix timestamp (in seconds) of when the API key was last used

82 76 

83- `first_id: optional string`77 - `name: optional string`

78 

79 The name of the API key

84 80 

85- `has_more: optional boolean`81- `has_more: boolean`

86 82 

87- `last_id: optional string`83- `object: "list"`

84 

85 - `"list"`

88 86 

89- `object: optional string`87- `first_id: optional string`

88 

89- `last_id: optional string`

90 90 

91### Example91### Example

92 92 

103 {103 {

104 "id": "key_abc",104 "id": "key_abc",

105 "created_at": 1711471533,105 "created_at": 1711471533,

106 "last_used_at": 1711471534,

107 "name": "Administration Key",

108 "object": "organization.admin_api_key",106 "object": "organization.admin_api_key",

109 "owner": {107 "owner": {

110 "id": "sa_456",108 "id": "sa_456",

115 "type": "user"113 "type": "user"

116 },114 },

117 "redacted_value": "sk-admin...def",115 "redacted_value": "sk-admin...def",

118 "value": "sk-admin-1234abcd"116 "last_used_at": 1711471534,

117 "name": "Administration Key"

119 }118 }

120 ],119 ],

121 "first_id": "key_abc",

122 "has_more": false,120 "has_more": false,

123 "last_id": "key_xyz",121 "object": "list",

124 "object": "list"122 "first_id": "key_abc",

123 "last_id": "key_xyz"

125}124}

126```125```

127 126 

Details

12 12 

13### Returns13### Returns

14 14 

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

16 16 

17 Represents an individual Admin API key in an org.17 Represents an individual Admin API key in an org.

18 18 

24 24 

25 The Unix timestamp (in seconds) of when the API key was created25 The Unix timestamp (in seconds) of when the API key was created

26 26 

27 - `last_used_at: number`27 - `object: "organization.admin_api_key"`

28 

29 The Unix timestamp (in seconds) of when the API key was last used

30 

31 - `name: string`

32 

33 The name of the API key

34 

35 - `object: string`

36 28 

37 The object type, which is always `organization.admin_api_key`29 The object type, which is always `organization.admin_api_key`

38 30 

31 - `"organization.admin_api_key"`

32 

39 - `owner: object { id, created_at, name, 3 more }`33 - `owner: object { id, created_at, name, 3 more }`

40 34 

41 - `id: optional string`35 - `id: optional string`

66 60 

67 The redacted value of the API key61 The redacted value of the API key

68 62 

69 - `value: optional string`63 - `last_used_at: optional number`

70 64 

71 The value of the API key. Only shown on create.65 The Unix timestamp (in seconds) of when the API key was last used

66 

67 - `name: optional string`

68 

69 The name of the API key

72 70 

73### Example71### Example

74 72 

83{81{

84 "id": "key_abc",82 "id": "key_abc",

85 "created_at": 1711471533,83 "created_at": 1711471533,

86 "last_used_at": 1711471534,

87 "name": "Administration Key",

88 "object": "organization.admin_api_key",84 "object": "organization.admin_api_key",

89 "owner": {85 "owner": {

90 "id": "sa_456",86 "id": "sa_456",

95 "type": "user"91 "type": "user"

96 },92 },

97 "redacted_value": "sk-admin...def",93 "redacted_value": "sk-admin...def",

98 "value": "sk-admin-1234abcd"94 "last_used_at": 1711471534,

95 "name": "Administration Key"

99}96}

100```97```

101 98 

Details

162 162 

163### Returns163### Returns

164 164 

165- `data: array of object { id, actor, effective_at, 49 more }`165- `data: array of object { id, effective_at, type, 49 more }`

166 166 

167 - `id: string`167 - `id: string`

168 168 

169 The ID of this log.169 The ID of this log.

170 170 

171 - `actor: object { api_key, session, type }`

172 

173 The actor who performed the audit logged action.

174 

175 - `api_key: optional object { id, service_account, type, user }`

176 

177 The API Key used to perform the audit logged action.

178 

179 - `id: optional string`

180 

181 The tracking id of the API key.

182 

183 - `service_account: optional object { id }`

184 

185 The service account that performed the audit logged action.

186 

187 - `id: optional string`

188 

189 The service account id.

190 

191 - `type: optional "user" or "service_account"`

192 

193 The type of API key. Can be either `user` or `service_account`.

194 

195 - `"user"`

196 

197 - `"service_account"`

198 

199 - `user: optional object { id, email }`

200 

201 The user who performed the audit logged action.

202 

203 - `id: optional string`

204 

205 The user id.

206 

207 - `email: optional string`

208 

209 The user email.

210 

211 - `session: optional object { ip_address, user }`

212 

213 The session in which the audit logged action was performed.

214 

215 - `ip_address: optional string`

216 

217 The IP address from which the action was performed.

218 

219 - `user: optional object { id, email }`

220 

221 The user who performed the audit logged action.

222 

223 - `id: optional string`

224 

225 The user id.

226 

227 - `email: optional string`

228 

229 The user email.

230 

231 - `type: optional "session" or "api_key"`

232 

233 The type of actor. Is either `session` or `api_key`.

234 

235 - `"session"`

236 

237 - `"api_key"`

238 

239 - `effective_at: number`171 - `effective_at: number`

240 172 

241 The Unix timestamp (in seconds) of the event.173 The Unix timestamp (in seconds) of the event.

346 278 

347 - `"user.deleted"`279 - `"user.deleted"`

348 280 

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

282 

283 The actor who performed the audit logged action.

284 

285 - `api_key: optional object { id, service_account, type, user }`

286 

287 The API Key used to perform the audit logged action.

288 

289 - `id: optional string`

290 

291 The tracking id of the API key.

292 

293 - `service_account: optional object { id }`

294 

295 The service account that performed the audit logged action.

296 

297 - `id: optional string`

298 

299 The service account id.

300 

301 - `type: optional "user" or "service_account"`

302 

303 The type of API key. Can be either `user` or `service_account`.

304 

305 - `"user"`

306 

307 - `"service_account"`

308 

309 - `user: optional object { id, email }`

310 

311 The user who performed the audit logged action.

312 

313 - `id: optional string`

314 

315 The user id.

316 

317 - `email: optional string`

318 

319 The user email.

320 

321 - `session: optional object { ip_address, user }`

322 

323 The session in which the audit logged action was performed.

324 

325 - `ip_address: optional string`

326 

327 The IP address from which the action was performed.

328 

329 - `user: optional object { id, email }`

330 

331 The user who performed the audit logged action.

332 

333 - `id: optional string`

334 

335 The user id.

336 

337 - `email: optional string`

338 

339 The user email.

340 

341 - `type: optional "session" or "api_key"`

342 

343 The type of actor. Is either `session` or `api_key`.

344 

345 - `"session"`

346 

347 - `"api_key"`

348 

349 - `"api_key.created": optional object { id, data }`349 - `"api_key.created": optional object { id, data }`

350 350 

351 The details for events with this `type`.351 The details for events with this `type`.

1050 1050 

1051 The role of the user. Is either `owner` or `member`.1051 The role of the user. Is either `owner` or `member`.

1052 1052 

1053- `first_id: string`

1054 

1055- `has_more: boolean`1053- `has_more: boolean`

1056 1054 

1057- `last_id: string`

1058 

1059- `object: "list"`1055- `object: "list"`

1060 1056 

1061 - `"list"`1057 - `"list"`

1062 1058 

1059- `first_id: optional string`

1060 

1061- `last_id: optional string`

1062 

1063### Example1063### Example

1064 1064 

1065```http1065```http

1074 "data": [1074 "data": [

1075 {1075 {

1076 "id": "id",1076 "id": "id",

1077 "effective_at": 0,

1078 "type": "api_key.created",

1077 "actor": {1079 "actor": {

1078 "api_key": {1080 "api_key": {

1079 "id": "id",1081 "id": "id",

1095 },1097 },

1096 "type": "session"1098 "type": "session"

1097 },1099 },

1098 "effective_at": 0,

1099 "type": "api_key.created",

1100 "api_key.created": {1100 "api_key.created": {

1101 "id": "id",1101 "id": "id",

1102 "data": {1102 "data": {

1365 }1365 }

1366 }1366 }

1367 ],1367 ],

1368 "first_id": "audit_log-defb456h8dks",

1369 "has_more": true,1368 "has_more": true,

1370 "last_id": "audit_log-hnbkd8s93s",1369 "object": "list",

1371 "object": "list"1370 "first_id": "audit_log-defb456h8dks",

1371 "last_id": "audit_log-hnbkd8s93s"

1372}1372}

1373```1373```

1374 1374 

Details

12 12 

13### Returns13### Returns

14 14 

15- `Group object { id, created_at, is_scim_managed, name }`15- `Group object { id, created_at, group_type, 2 more }`

16 16 

17 Details about an organization group.17 Details about an organization group.

18 18 

24 24 

25 Unix timestamp (in seconds) when the group was created.25 Unix timestamp (in seconds) when the group was created.

26 26 

27 - `group_type: string`

28 

29 The type of the group.

30 

27 - `is_scim_managed: boolean`31 - `is_scim_managed: boolean`

28 32 

29 Whether the group is managed through SCIM and controlled by your identity provider.33 Whether the group is managed through SCIM and controlled by your identity provider.

49{53{

50 "id": "id",54 "id": "id",

51 "created_at": 0,55 "created_at": 0,

56 "group_type": "group_type",

52 "is_scim_managed": true,57 "is_scim_managed": true,

53 "name": "name"58 "name": "name"

54}59}

Details

36 36 

37 Unix timestamp (in seconds) when the group was created.37 Unix timestamp (in seconds) when the group was created.

38 38 

39 - `group_type: string`

40 

41 The type of the group.

42 

39 - `is_scim_managed: boolean`43 - `is_scim_managed: boolean`

40 44 

41 Whether the group is managed through SCIM and controlled by your identity provider.45 Whether the group is managed through SCIM and controlled by your identity provider.

73 {77 {

74 "id": "id",78 "id": "id",

75 "created_at": 0,79 "created_at": 0,

80 "group_type": "group_type",

76 "is_scim_managed": true,81 "is_scim_managed": true,

77 "name": "name"82 "name": "name"

78 }83 }

Details

28 28 

29### Returns29### Returns

30 30 

31- `data: array of OrganizationUser`31- `data: array of OrganizationGroupUser`

32 32 

33 Users in the current page.33 Users in the current page.

34 34 

36 36 

37 The identifier, which can be referenced in API endpoints37 The identifier, which can be referenced in API endpoints

38 38 

39 - `added_at: number`

40 

41 The Unix timestamp (in seconds) of when the user was added.

42 

43 - `email: string`39 - `email: string`

44 40 

45 The email address of the user41 The email address of the user.

46 42 

47 - `name: string`43 - `name: string`

48 44 

49 The name of the user45 The name of the user.

50 

51 - `object: "organization.user"`

52 

53 The object type, which is always `organization.user`

54 

55 - `"organization.user"`

56 

57 - `role: "owner" or "reader"`

58 

59 `owner` or `reader`

60 

61 - `"owner"`

62 

63 - `"reader"`

64 46 

65- `has_more: boolean`47- `has_more: boolean`

66 48 

90 "data": [72 "data": [

91 {73 {

92 "id": "id",74 "id": "id",

93 "added_at": 0,

94 "email": "email",75 "email": "email",

95 "name": "name",76 "name": "name"

96 "object": "organization.user",

97 "role": "owner"

98 }77 }

99 ],78 ],

100 "has_more": true,79 "has_more": true,

118 "object": "list",97 "object": "list",

119 "data": [98 "data": [

120 {99 {

121 "object": "organization.user",

122 "id": "user_abc123",100 "id": "user_abc123",

123 "name": "Ada Lovelace",101 "name": "Ada Lovelace",

124 "email": "ada@example.com",102 "email": "ada@example.com"

125 "role": "owner",

126 "added_at": 1711471533

127 }103 }

128 ],104 ],

129 "has_more": false,105 "has_more": false,

Details

36 36 

37### Returns37### Returns

38 38 

39- `Invite object { id, email, expires_at, 6 more }`39- `Invite object { id, created_at, email, 6 more }`

40 40 

41 Represents an individual `invite` to the organization.41 Represents an individual `invite` to the organization.

42 42 

44 44 

45 The identifier, which can be referenced in API endpoints45 The identifier, which can be referenced in API endpoints

46 46 

47 - `created_at: number`

48 

49 The Unix timestamp (in seconds) of when the invite was sent.

50 

47 - `email: string`51 - `email: string`

48 52 

49 The email address of the individual to whom the invite was sent53 The email address of the individual to whom the invite was sent

50 54 

51 - `expires_at: number`55 - `object: "organization.invite"`

52 56 

53 The Unix timestamp (in seconds) of when the invite expires.57 The object type, which is always `organization.invite`

54 58 

55 - `invited_at: number`59 - `"organization.invite"`

56 60 

57 The Unix timestamp (in seconds) of when the invite was sent.61 - `projects: array of object { id, role }`

58 62 

59 - `object: "organization.invite"`63 The projects that were granted membership upon acceptance of the invite.

60 64 

61 The object type, which is always `organization.invite`65 - `id: string`

62 66 

63 - `"organization.invite"`67 Project's public ID

68 

69 - `role: "member" or "owner"`

70 

71 Project membership role

72 

73 - `"member"`

74 

75 - `"owner"`

64 76 

65 - `role: "owner" or "reader"`77 - `role: "owner" or "reader"`

66 78 

84 96 

85 The Unix timestamp (in seconds) of when the invite was accepted.97 The Unix timestamp (in seconds) of when the invite was accepted.

86 98 

87 - `projects: optional array of object { id, role }`99 - `expires_at: optional number`

88 

89 The projects that were granted membership upon acceptance of the invite.

90 

91 - `id: optional string`

92 

93 Project's public ID

94 

95 - `role: optional "member" or "owner"`

96 

97 Project membership role

98 

99 - `"member"`

100 100 

101 - `"owner"`101 The Unix timestamp (in seconds) of when the invite expires.

102 102 

103### Example103### Example

104 104 

117```json117```json

118{118{

119 "id": "id",119 "id": "id",

120 "created_at": 0,

120 "email": "email",121 "email": "email",

121 "expires_at": 0,

122 "invited_at": 0,

123 "object": "organization.invite",122 "object": "organization.invite",

124 "role": "owner",

125 "status": "accepted",

126 "accepted_at": 0,

127 "projects": [123 "projects": [

128 {124 {

129 "id": "id",125 "id": "id",

130 "role": "member"126 "role": "member"

131 }127 }

132 ]128 ],

129 "role": "owner",

130 "status": "accepted",

131 "accepted_at": 0,

132 "expires_at": 0

133}133}

134```134```

135 135 

164 "email": "anotheruser@example.com",164 "email": "anotheruser@example.com",

165 "role": "reader",165 "role": "reader",

166 "status": "pending",166 "status": "pending",

167 "invited_at": 1711471533,167 "created_at": 1711471533,

168 "expires_at": 1711471533,168 "expires_at": 1711471533,

169 "accepted_at": null,169 "accepted_at": null,

170 "projects": [170 "projects": [

Details

22 22 

23 The identifier, which can be referenced in API endpoints23 The identifier, which can be referenced in API endpoints

24 24 

25 - `created_at: number`

26 

27 The Unix timestamp (in seconds) of when the invite was sent.

28 

25 - `email: string`29 - `email: string`

26 30 

27 The email address of the individual to whom the invite was sent31 The email address of the individual to whom the invite was sent

28 32 

29 - `expires_at: number`33 - `object: "organization.invite"`

30 34 

31 The Unix timestamp (in seconds) of when the invite expires.35 The object type, which is always `organization.invite`

32 36 

33 - `invited_at: number`37 - `"organization.invite"`

34 38 

35 The Unix timestamp (in seconds) of when the invite was sent.39 - `projects: array of object { id, role }`

36 40 

37 - `object: "organization.invite"`41 The projects that were granted membership upon acceptance of the invite.

38 42 

39 The object type, which is always `organization.invite`43 - `id: string`

40 44 

41 - `"organization.invite"`45 Project's public ID

46 

47 - `role: "member" or "owner"`

48 

49 Project membership role

50 

51 - `"member"`

52 

53 - `"owner"`

42 54 

43 - `role: "owner" or "reader"`55 - `role: "owner" or "reader"`

44 56 

62 74 

63 The Unix timestamp (in seconds) of when the invite was accepted.75 The Unix timestamp (in seconds) of when the invite was accepted.

64 76 

65 - `projects: optional array of object { id, role }`77 - `expires_at: optional number`

66 

67 The projects that were granted membership upon acceptance of the invite.

68 

69 - `id: optional string`

70 

71 Project's public ID

72 

73 - `role: optional "member" or "owner"`

74 78 

75 Project membership role79 The Unix timestamp (in seconds) of when the invite expires.

76 80 

77 - `"member"`81- `has_more: boolean`

78 82 

79 - `"owner"`83 The `has_more` property is used for pagination to indicate there are additional results.

80 84 

81- `object: "list"`85- `object: "list"`

82 86 

88 92 

89 The first `invite_id` in the retrieved `list`93 The first `invite_id` in the retrieved `list`

90 94 

91- `has_more: optional boolean`

92 

93 The `has_more` property is used for pagination to indicate there are additional results.

94 

95- `last_id: optional string`95- `last_id: optional string`

96 96 

97 The last `invite_id` in the retrieved `list`97 The last `invite_id` in the retrieved `list`

110 "data": [110 "data": [

111 {111 {

112 "id": "id",112 "id": "id",

113 "created_at": 0,

113 "email": "email",114 "email": "email",

114 "expires_at": 0,

115 "invited_at": 0,

116 "object": "organization.invite",115 "object": "organization.invite",

117 "role": "owner",

118 "status": "accepted",

119 "accepted_at": 0,

120 "projects": [116 "projects": [

121 {117 {

122 "id": "id",118 "id": "id",

123 "role": "member"119 "role": "member"

124 }120 }

125 ]121 ],

122 "role": "owner",

123 "status": "accepted",

124 "accepted_at": 0,

125 "expires_at": 0

126 }126 }

127 ],127 ],

128 "has_more": true,

128 "object": "list",129 "object": "list",

129 "first_id": "first_id",130 "first_id": "first_id",

130 "has_more": true,

131 "last_id": "last_id"131 "last_id": "last_id"

132}132}

133```133```

152 "email": "user@example.com",152 "email": "user@example.com",

153 "role": "owner",153 "role": "owner",

154 "status": "accepted",154 "status": "accepted",

155 "invited_at": 1711471533,155 "created_at": 1711471533,

156 "expires_at": 1711471533,156 "expires_at": 1711471533,

157 "accepted_at": 1711471533157 "accepted_at": 1711471533

158 }158 }

Details

10 10 

11### Returns11### Returns

12 12 

13- `Invite object { id, email, expires_at, 6 more }`13- `Invite object { id, created_at, email, 6 more }`

14 14 

15 Represents an individual `invite` to the organization.15 Represents an individual `invite` to the organization.

16 16 

18 18 

19 The identifier, which can be referenced in API endpoints19 The identifier, which can be referenced in API endpoints

20 20 

21 - `created_at: number`

22 

23 The Unix timestamp (in seconds) of when the invite was sent.

24 

21 - `email: string`25 - `email: string`

22 26 

23 The email address of the individual to whom the invite was sent27 The email address of the individual to whom the invite was sent

24 28 

25 - `expires_at: number`29 - `object: "organization.invite"`

26 30 

27 The Unix timestamp (in seconds) of when the invite expires.31 The object type, which is always `organization.invite`

28 32 

29 - `invited_at: number`33 - `"organization.invite"`

30 34 

31 The Unix timestamp (in seconds) of when the invite was sent.35 - `projects: array of object { id, role }`

32 36 

33 - `object: "organization.invite"`37 The projects that were granted membership upon acceptance of the invite.

34 38 

35 The object type, which is always `organization.invite`39 - `id: string`

36 40 

37 - `"organization.invite"`41 Project's public ID

42 

43 - `role: "member" or "owner"`

44 

45 Project membership role

46 

47 - `"member"`

48 

49 - `"owner"`

38 50 

39 - `role: "owner" or "reader"`51 - `role: "owner" or "reader"`

40 52 

58 70 

59 The Unix timestamp (in seconds) of when the invite was accepted.71 The Unix timestamp (in seconds) of when the invite was accepted.

60 72 

61 - `projects: optional array of object { id, role }`73 - `expires_at: optional number`

62 

63 The projects that were granted membership upon acceptance of the invite.

64 

65 - `id: optional string`

66 

67 Project's public ID

68 

69 - `role: optional "member" or "owner"`

70 74 

71 Project membership role75 The Unix timestamp (in seconds) of when the invite expires.

72 

73 - `"member"`

74 

75 - `"owner"`

76 76 

77### Example77### Example

78 78 

86```json86```json

87{87{

88 "id": "id",88 "id": "id",

89 "created_at": 0,

89 "email": "email",90 "email": "email",

90 "expires_at": 0,

91 "invited_at": 0,

92 "object": "organization.invite",91 "object": "organization.invite",

93 "role": "owner",

94 "status": "accepted",

95 "accepted_at": 0,

96 "projects": [92 "projects": [

97 {93 {

98 "id": "id",94 "id": "id",

99 "role": "member"95 "role": "member"

100 }96 }

101 ]97 ],

98 "role": "owner",

99 "status": "accepted",

100 "accepted_at": 0,

101 "expires_at": 0

102}102}

103```103```

104 104 

119 "email": "user@example.com",119 "email": "user@example.com",

120 "role": "owner",120 "role": "owner",

121 "status": "accepted",121 "status": "accepted",

122 "invited_at": 1711471533,122 "created_at": 1711471533,

123 "expires_at": 1711471533,123 "expires_at": 1711471533,

124 "accepted_at": 1711471533124 "accepted_at": 1711471533

125}125}

Details

10 10 

11 The friendly name of the project, this name appears in reports.11 The friendly name of the project, this name appears in reports.

12 12 

13- `geography: optional "US" or "EU" or "JP" or 5 more`13- `external_key_id: optional string`

14 14 

15 Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.15 External key ID to associate with the project.

16 

17 - `"US"`

18 

19 - `"EU"`

20 

21 - `"JP"`

22 

23 - `"IN"`

24 

25 - `"KR"`

26 16 

27 - `"CA"`17- `geography: optional string`

28 18 

29 - `"AU"`19 Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.

30 

31 - `"SG"`

32 20 

33### Returns21### Returns

34 22 

35- `Project object { id, created_at, name, 3 more }`23- `Project object { id, created_at, object, 4 more }`

36 24 

37 Represents an individual project.25 Represents an individual project.

38 26 

44 32 

45 The Unix timestamp (in seconds) of when the project was created.33 The Unix timestamp (in seconds) of when the project was created.

46 34 

47 - `name: string`

48 

49 The name of the project. This appears in reporting.

50 

51 - `object: "organization.project"`35 - `object: "organization.project"`

52 36 

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

54 38 

55 - `"organization.project"`39 - `"organization.project"`

56 40 

57 - `status: "active" or "archived"`41 - `archived_at: optional number`

58 42 

59 `active` or `archived`43 The Unix timestamp (in seconds) of when the project was archived or `null`.

60 44 

61 - `"active"`45 - `external_key_id: optional string`

62 46 

63 - `"archived"`47 The external key associated with the project.

64 48 

65 - `archived_at: optional number`49 - `name: optional string`

66 50 

67 The Unix timestamp (in seconds) of when the project was archived or `null`.51 The name of the project. This appears in reporting.

52 

53 - `status: optional string`

54 

55 `active` or `archived`

68 56 

69### Example57### Example

70 58 

83{71{

84 "id": "id",72 "id": "id",

85 "created_at": 0,73 "created_at": 0,

86 "name": "name",

87 "object": "organization.project",74 "object": "organization.project",

88 "status": "active",75 "archived_at": 0,

89 "archived_at": 076 "external_key_id": "external_key_id",

77 "name": "name",

78 "status": "status"

90}79}

91```80```

92 81 

Details

30 30 

31 The Unix timestamp (in seconds) of when the project was created.31 The Unix timestamp (in seconds) of when the project was created.

32 32 

33 - `name: string`

34 

35 The name of the project. This appears in reporting.

36 

37 - `object: "organization.project"`33 - `object: "organization.project"`

38 34 

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

40 36 

41 - `"organization.project"`37 - `"organization.project"`

42 38 

43 - `status: "active" or "archived"`39 - `archived_at: optional number`

44 40 

45 `active` or `archived`41 The Unix timestamp (in seconds) of when the project was archived or `null`.

46 42 

47 - `"active"`43 - `external_key_id: optional string`

48 44 

49 - `"archived"`45 The external key associated with the project.

50 46 

51 - `archived_at: optional number`47 - `name: optional string`

52 48 

53 The Unix timestamp (in seconds) of when the project was archived or `null`.49 The name of the project. This appears in reporting.

54 50 

55- `first_id: string`51 - `status: optional string`

56 52 

57- `has_more: boolean`53 `active` or `archived`

58 54 

59- `last_id: string`55- `has_more: boolean`

60 56 

61- `object: "list"`57- `object: "list"`

62 58 

63 - `"list"`59 - `"list"`

64 60 

61- `first_id: optional string`

62 

63- `last_id: optional string`

64 

65### Example65### Example

66 66 

67```http67```http

77 {77 {

78 "id": "id",78 "id": "id",

79 "created_at": 0,79 "created_at": 0,

80 "name": "name",

81 "object": "organization.project",80 "object": "organization.project",

82 "status": "active",81 "archived_at": 0,

83 "archived_at": 082 "external_key_id": "external_key_id",

83 "name": "name",

84 "status": "status"

84 }85 }

85 ],86 ],

86 "first_id": "first_id",

87 "has_more": true,87 "has_more": true,

88 "last_id": "last_id",88 "object": "list",

89 "object": "list"89 "first_id": "first_id",

90 "last_id": "last_id"

90}91}

91```92```

92 93 

Details

10 10 

11### Returns11### Returns

12 12 

13- `Project object { id, created_at, name, 3 more }`13- `Project object { id, created_at, object, 4 more }`

14 14 

15 Represents an individual project.15 Represents an individual project.

16 16 

22 22 

23 The Unix timestamp (in seconds) of when the project was created.23 The Unix timestamp (in seconds) of when the project was created.

24 24 

25 - `name: string`

26 

27 The name of the project. This appears in reporting.

28 

29 - `object: "organization.project"`25 - `object: "organization.project"`

30 26 

31 The object type, which is always `organization.project`27 The object type, which is always `organization.project`

32 28 

33 - `"organization.project"`29 - `"organization.project"`

34 30 

35 - `status: "active" or "archived"`31 - `archived_at: optional number`

36 32 

37 `active` or `archived`33 The Unix timestamp (in seconds) of when the project was archived or `null`.

38 34 

39 - `"active"`35 - `external_key_id: optional string`

40 36 

41 - `"archived"`37 The external key associated with the project.

42 38 

43 - `archived_at: optional number`39 - `name: optional string`

44 40 

45 The Unix timestamp (in seconds) of when the project was archived or `null`.41 The name of the project. This appears in reporting.

42 

43 - `status: optional string`

44 

45 `active` or `archived`

46 46 

47### Example47### Example

48 48 

57{57{

58 "id": "id",58 "id": "id",

59 "created_at": 0,59 "created_at": 0,

60 "name": "name",

61 "object": "organization.project",60 "object": "organization.project",

62 "status": "active",61 "archived_at": 0,

63 "archived_at": 062 "external_key_id": "external_key_id",

63 "name": "name",

64 "status": "status"

64}65}

65```66```

66 67 

Details

10 10 

11### Body Parameters11### Body Parameters

12 12 

13- `name: string`13- `external_key_id: optional string`

14 

15 External key ID to associate with the project.

16 

17- `geography: optional string`

18 

19 Geography for the project.

20 

21- `name: optional string`

14 22 

15 The updated name of the project, this name appears in reports.23 The updated name of the project, this name appears in reports.

16 24 

17### Returns25### Returns

18 26 

19- `Project object { id, created_at, name, 3 more }`27- `Project object { id, created_at, object, 4 more }`

20 28 

21 Represents an individual project.29 Represents an individual project.

22 30 

28 36 

29 The Unix timestamp (in seconds) of when the project was created.37 The Unix timestamp (in seconds) of when the project was created.

30 38 

31 - `name: string`

32 

33 The name of the project. This appears in reporting.

34 

35 - `object: "organization.project"`39 - `object: "organization.project"`

36 40 

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

38 42 

39 - `"organization.project"`43 - `"organization.project"`

40 44 

41 - `status: "active" or "archived"`45 - `archived_at: optional number`

42 46 

43 `active` or `archived`47 The Unix timestamp (in seconds) of when the project was archived or `null`.

44 48 

45 - `"active"`49 - `external_key_id: optional string`

46 50 

47 - `"archived"`51 The external key associated with the project.

48 52 

49 - `archived_at: optional number`53 - `name: optional string`

50 54 

51 The Unix timestamp (in seconds) of when the project was archived or `null`.55 The name of the project. This appears in reporting.

56 

57 - `status: optional string`

58 

59 `active` or `archived`

52 60 

53### Example61### Example

54 62 

56curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \64curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \

57 -H 'Content-Type: application/json' \65 -H 'Content-Type: application/json' \

58 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \66 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

59 -d '{67 -d '{}'

60 "name": "name"

61 }'

62```68```

63 69 

64#### Response70#### Response

67{73{

68 "id": "id",74 "id": "id",

69 "created_at": 0,75 "created_at": 0,

70 "name": "name",

71 "object": "organization.project",76 "object": "organization.project",

72 "status": "active",77 "archived_at": 0,

73 "archived_at": 078 "external_key_id": "external_key_id",

79 "name": "name",

80 "status": "status"

74}81}

75```82```

76 83 

Details

1## Delete project API key1## Delete project API key

2 2 

3**delete** `/organization/projects/{project_id}/api_keys/{key_id}`3**delete** `/organization/projects/{project_id}/api_keys/{api_key_id}`

4 4 

5Deletes an API key from the project.5Deletes an API key from the project.

6 6 

11 11 

12- `project_id: string`12- `project_id: string`

13 13 

14- `key_id: string`14- `api_key_id: string`

15 15 

16### Returns16### Returns

17 17 

26### Example26### Example

27 27 

28```http28```http

29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \

30 -X DELETE \30 -X DELETE \

31 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"31 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

32```32```

Details

46 46 

47 - `owner: object { service_account, type, user }`47 - `owner: object { service_account, type, user }`

48 48 

49 - `service_account: optional ProjectServiceAccount`49 - `service_account: optional object { id, created_at, name, role }`

50 50 

51 Represents an individual service account in a project.51 The service account that owns a project API key.

52 52 

53 - `id: string`53 - `id: string`

54 54 

56 56 

57 - `created_at: number`57 - `created_at: number`

58 58 

59 The Unix timestamp (in seconds) of when the service account was created59 The Unix timestamp (in seconds) of when the service account was created.

60 60 

61 - `name: string`61 - `name: string`

62 62 

63 The name of the service account63 The name of the service account.

64 64 

65 - `object: "organization.project.service_account"`65 - `role: string`

66 66 

67 The object type, which is always `organization.project.service_account`67 The service account's project role.

68 

69 - `"organization.project.service_account"`

70 

71 - `role: "owner" or "member"`

72 

73 `owner` or `member`

74 

75 - `"owner"`

76 

77 - `"member"`

78 68 

79 - `type: optional "user" or "service_account"`69 - `type: optional "user" or "service_account"`

80 70 

84 74 

85 - `"service_account"`75 - `"service_account"`

86 76 

87 - `user: optional ProjectUser`77 - `user: optional object { id, created_at, email, 2 more }`

88 78 

89 Represents an individual user in a project.79 The user that owns a project API key.

90 80 

91 - `id: string`81 - `id: string`

92 82 

93 The identifier, which can be referenced in API endpoints83 The identifier, which can be referenced in API endpoints

94 84 

95 - `added_at: number`85 - `created_at: number`

96 86 

97 The Unix timestamp (in seconds) of when the project was added.87 The Unix timestamp (in seconds) of when the user was created.

98 88 

99 - `email: string`89 - `email: string`

100 90 

101 The email address of the user91 The email address of the user.

102 92 

103 - `name: string`93 - `name: string`

104 94 

105 The name of the user95 The name of the user.

106 

107 - `object: "organization.project.user"`

108 

109 The object type, which is always `organization.project.user`

110 

111 - `"organization.project.user"`

112 

113 - `role: "owner" or "member"`

114 96 

115 `owner` or `member`97 - `role: string`

116 98 

117 - `"owner"`99 The user's project role.

118 

119 - `"member"`

120 100 

121 - `redacted_value: string`101 - `redacted_value: string`

122 102 

123 The redacted value of the API key103 The redacted value of the API key

124 104 

125- `first_id: string`

126 

127- `has_more: boolean`105- `has_more: boolean`

128 106 

129- `last_id: string`

130 

131- `object: "list"`107- `object: "list"`

132 108 

133 - `"list"`109 - `"list"`

134 110 

111- `first_id: optional string`

112 

113- `last_id: optional string`

114 

135### Example115### Example

136 116 

137```http117```http

155 "id": "id",135 "id": "id",

156 "created_at": 0,136 "created_at": 0,

157 "name": "name",137 "name": "name",

158 "object": "organization.project.service_account",138 "role": "role"

159 "role": "owner"

160 },139 },

161 "type": "user",140 "type": "user",

162 "user": {141 "user": {

163 "id": "id",142 "id": "id",

164 "added_at": 0,143 "created_at": 0,

165 "email": "email",144 "email": "email",

166 "name": "name",145 "name": "name",

167 "object": "organization.project.user",146 "role": "role"

168 "role": "owner"

169 }147 }

170 },148 },

171 "redacted_value": "redacted_value"149 "redacted_value": "redacted_value"

172 }150 }

173 ],151 ],

174 "first_id": "first_id",

175 "has_more": true,152 "has_more": true,

176 "last_id": "last_id",153 "object": "list",

177 "object": "list"154 "first_id": "first_id",

155 "last_id": "last_id"

178}156}

179```157```

180 158 

202 "owner": {180 "owner": {

203 "type": "user",181 "type": "user",

204 "user": {182 "user": {

205 "object": "organization.project.user",

206 "id": "user_abc",183 "id": "user_abc",

207 "name": "First Last",184 "name": "First Last",

208 "email": "user@example.com",185 "email": "user@example.com",

209 "role": "owner",186 "role": "owner",

210 "added_at": 1711471533187 "created_at": 1711471533

211 }188 }

212 }189 }

213 }190 }

Details

1## Retrieve project API key1## Retrieve project API key

2 2 

3**get** `/organization/projects/{project_id}/api_keys/{key_id}`3**get** `/organization/projects/{project_id}/api_keys/{api_key_id}`

4 4 

5Retrieves an API key in the project.5Retrieves an API key in the project.

6 6 

8 8 

9- `project_id: string`9- `project_id: string`

10 10 

11- `key_id: string`11- `api_key_id: string`

12 12 

13### Returns13### Returns

14 14 

40 40 

41 - `owner: object { service_account, type, user }`41 - `owner: object { service_account, type, user }`

42 42 

43 - `service_account: optional ProjectServiceAccount`43 - `service_account: optional object { id, created_at, name, role }`

44 44 

45 Represents an individual service account in a project.45 The service account that owns a project API key.

46 46 

47 - `id: string`47 - `id: string`

48 48 

50 50 

51 - `created_at: number`51 - `created_at: number`

52 52 

53 The Unix timestamp (in seconds) of when the service account was created53 The Unix timestamp (in seconds) of when the service account was created.

54 54 

55 - `name: string`55 - `name: string`

56 56 

57 The name of the service account57 The name of the service account.

58 58 

59 - `object: "organization.project.service_account"`59 - `role: string`

60 60 

61 The object type, which is always `organization.project.service_account`61 The service account's project role.

62 

63 - `"organization.project.service_account"`

64 

65 - `role: "owner" or "member"`

66 

67 `owner` or `member`

68 

69 - `"owner"`

70 

71 - `"member"`

72 62 

73 - `type: optional "user" or "service_account"`63 - `type: optional "user" or "service_account"`

74 64 

78 68 

79 - `"service_account"`69 - `"service_account"`

80 70 

81 - `user: optional ProjectUser`71 - `user: optional object { id, created_at, email, 2 more }`

82 72 

83 Represents an individual user in a project.73 The user that owns a project API key.

84 74 

85 - `id: string`75 - `id: string`

86 76 

87 The identifier, which can be referenced in API endpoints77 The identifier, which can be referenced in API endpoints

88 78 

89 - `added_at: number`79 - `created_at: number`

90 80 

91 The Unix timestamp (in seconds) of when the project was added.81 The Unix timestamp (in seconds) of when the user was created.

92 82 

93 - `email: string`83 - `email: string`

94 84 

95 The email address of the user85 The email address of the user.

96 86 

97 - `name: string`87 - `name: string`

98 88 

99 The name of the user89 The name of the user.

100 90 

101 - `object: "organization.project.user"`91 - `role: string`

102 92 

103 The object type, which is always `organization.project.user`93 The user's project role.

104 

105 - `"organization.project.user"`

106 

107 - `role: "owner" or "member"`

108 

109 `owner` or `member`

110 

111 - `"owner"`

112 

113 - `"member"`

114 94 

115 - `redacted_value: string`95 - `redacted_value: string`

116 96 

119### Example99### Example

120 100 

121```http101```http

122curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \102curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \

123 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"103 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

124```104```

125 105 

137 "id": "id",117 "id": "id",

138 "created_at": 0,118 "created_at": 0,

139 "name": "name",119 "name": "name",

140 "object": "organization.project.service_account",120 "role": "role"

141 "role": "owner"

142 },121 },

143 "type": "user",122 "type": "user",

144 "user": {123 "user": {

145 "id": "id",124 "id": "id",

146 "added_at": 0,125 "created_at": 0,

147 "email": "email",126 "email": "email",

148 "name": "name",127 "name": "name",

149 "object": "organization.project.user",128 "role": "role"

150 "role": "owner"

151 }129 }

152 },130 },

153 "redacted_value": "redacted_value"131 "redacted_value": "redacted_value"

175 "owner": {153 "owner": {

176 "type": "user",154 "type": "user",

177 "user": {155 "user": {

178 "object": "organization.project.user",

179 "id": "user_abc",156 "id": "user_abc",

180 "name": "First Last",157 "name": "First Last",

181 "email": "user@example.com",158 "email": "user@example.com",

182 "role": "owner",159 "role": "owner",

183 "added_at": 1711471533160 "created_at": 1711471533

184 }161 }

185 }162 }

186}163}

Details

44 44 

45 Display name of the group.45 Display name of the group.

46 46 

47 - `group_type: string`

48 

49 The type of the group.

50 

47 - `object: "project.group"`51 - `object: "project.group"`

48 52 

49 Always `project.group`.53 Always `project.group`.

84 "created_at": 0,88 "created_at": 0,

85 "group_id": "group_id",89 "group_id": "group_id",

86 "group_name": "group_name",90 "group_name": "group_name",

91 "group_type": "group_type",

87 "object": "project.group",92 "object": "project.group",

88 "project_id": "project_id"93 "project_id": "project_id"

89 }94 }

Details

66 66 

67 The maximum requests per day. Only present for relevant models.67 The maximum requests per day. Only present for relevant models.

68 68 

69- `first_id: string`

70 

71- `has_more: boolean`69- `has_more: boolean`

72 70 

73- `last_id: string`

74 

75- `object: "list"`71- `object: "list"`

76 72 

77 - `"list"`73 - `"list"`

78 74 

75- `first_id: optional string`

76 

77- `last_id: optional string`

78 

79### Example79### Example

80 80 

81```http81```http

100 "max_requests_per_1_day": 0100 "max_requests_per_1_day": 0

101 }101 }

102 ],102 ],

103 "first_id": "first_id",

104 "has_more": true,103 "has_more": true,

105 "last_id": "last_id",104 "object": "list",

106 "object": "list"105 "first_id": "first_id",

106 "last_id": "last_id"

107}107}

108```108```

109 109 

Details

48 48 

49 - `"member"`49 - `"member"`

50 50 

51- `first_id: string`

52 

53- `has_more: boolean`51- `has_more: boolean`

54 52 

55- `last_id: string`

56 

57- `object: "list"`53- `object: "list"`

58 54 

59 - `"list"`55 - `"list"`

60 56 

57- `first_id: optional string`

58 

59- `last_id: optional string`

60 

61### Example61### Example

62 62 

63```http63```http

78 "role": "owner"78 "role": "owner"

79 }79 }

80 ],80 ],

81 "first_id": "first_id",

82 "has_more": true,81 "has_more": true,

83 "last_id": "last_id",82 "object": "list",

84 "object": "list"83 "first_id": "first_id",

84 "last_id": "last_id"

85}85}

86```86```

87 87 

Details

10 10 

11### Body Parameters11### Body Parameters

12 12 

13- `role: "owner" or "member"`13- `role: string`

14 14 

15 `owner` or `member`15 `owner` or `member`

16 16 

17 - `"owner"`17- `email: optional string`

18 18 

19 - `"member"`19 Email of the user to add.

20 20 

21- `user_id: string`21- `user_id: optional string`

22 22 

23 The ID of the user.23 The ID of the user.

24 24 

25### Returns25### Returns

26 26 

27- `ProjectUser object { id, added_at, email, 3 more }`27- `ProjectUser object { id, added_at, object, 3 more }`

28 28 

29 Represents an individual user in a project.29 Represents an individual user in a project.

30 30 

36 36 

37 The Unix timestamp (in seconds) of when the project was added.37 The Unix timestamp (in seconds) of when the project was added.

38 38 

39 - `email: string`

40 

41 The email address of the user

42 

43 - `name: string`

44 

45 The name of the user

46 

47 - `object: "organization.project.user"`39 - `object: "organization.project.user"`

48 40 

49 The object type, which is always `organization.project.user`41 The object type, which is always `organization.project.user`

50 42 

51 - `"organization.project.user"`43 - `"organization.project.user"`

52 44 

53 - `role: "owner" or "member"`45 - `role: string`

54 46 

55 `owner` or `member`47 `owner` or `member`

56 48 

57 - `"owner"`49 - `email: optional string`

58 50 

59 - `"member"`51 The email address of the user

52 

53 - `name: optional string`

54 

55 The name of the user

60 56 

61### Example57### Example

62 58 

65 -H 'Content-Type: application/json' \61 -H 'Content-Type: application/json' \

66 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \62 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

67 -d '{63 -d '{

68 "role": "owner",64 "role": "role"

69 "user_id": "user_id"

70 }'65 }'

71```66```

72 67 

76{71{

77 "id": "id",72 "id": "id",

78 "added_at": 0,73 "added_at": 0,

79 "email": "email",

80 "name": "name",

81 "object": "organization.project.user",74 "object": "organization.project.user",

82 "role": "owner"75 "role": "role",

76 "email": "email",

77 "name": "name"

83}78}

84```79```

85 80 

Details

30 30 

31 The Unix timestamp (in seconds) of when the project was added.31 The Unix timestamp (in seconds) of when the project was added.

32 32 

33 - `email: string`

34 

35 The email address of the user

36 

37 - `name: string`

38 

39 The name of the user

40 

41 - `object: "organization.project.user"`33 - `object: "organization.project.user"`

42 34 

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

44 36 

45 - `"organization.project.user"`37 - `"organization.project.user"`

46 38 

47 - `role: "owner" or "member"`39 - `role: string`

48 40 

49 `owner` or `member`41 `owner` or `member`

50 42 

51 - `"owner"`43 - `email: optional string`

52 44 

53 - `"member"`45 The email address of the user

54 46 

55- `first_id: string`47 - `name: optional string`

56 48 

57- `has_more: boolean`49 The name of the user

58 50 

59- `last_id: string`51- `has_more: boolean`

60 52 

61- `object: string`53- `object: string`

62 54 

55- `first_id: optional string`

56 

57- `last_id: optional string`

58 

63### Example59### Example

64 60 

65```http61```http

75 {71 {

76 "id": "id",72 "id": "id",

77 "added_at": 0,73 "added_at": 0,

78 "email": "email",

79 "name": "name",

80 "object": "organization.project.user",74 "object": "organization.project.user",

81 "role": "owner"75 "role": "role",

76 "email": "email",

77 "name": "name"

82 }78 }

83 ],79 ],

84 "first_id": "first_id",

85 "has_more": true,80 "has_more": true,

86 "last_id": "last_id",81 "object": "object",

87 "object": "object"82 "first_id": "first_id",

83 "last_id": "last_id"

88}84}

89```85```

90 86 

Details

12 12 

13### Returns13### Returns

14 14 

15- `ProjectUser object { id, added_at, email, 3 more }`15- `ProjectUser object { id, added_at, object, 3 more }`

16 16 

17 Represents an individual user in a project.17 Represents an individual user in a project.

18 18 

24 24 

25 The Unix timestamp (in seconds) of when the project was added.25 The Unix timestamp (in seconds) of when the project was added.

26 26 

27 - `email: string`

28 

29 The email address of the user

30 

31 - `name: string`

32 

33 The name of the user

34 

35 - `object: "organization.project.user"`27 - `object: "organization.project.user"`

36 28 

37 The object type, which is always `organization.project.user`29 The object type, which is always `organization.project.user`

38 30 

39 - `"organization.project.user"`31 - `"organization.project.user"`

40 32 

41 - `role: "owner" or "member"`33 - `role: string`

42 34 

43 `owner` or `member`35 `owner` or `member`

44 36 

45 - `"owner"`37 - `email: optional string`

46 38 

47 - `"member"`39 The email address of the user

40 

41 - `name: optional string`

42 

43 The name of the user

48 44 

49### Example45### Example

50 46 

59{55{

60 "id": "id",56 "id": "id",

61 "added_at": 0,57 "added_at": 0,

62 "email": "email",

63 "name": "name",

64 "object": "organization.project.user",58 "object": "organization.project.user",

65 "role": "owner"59 "role": "role",

60 "email": "email",

61 "name": "name"

66}62}

67```63```

68 64 

Details

12 12 

13### Body Parameters13### Body Parameters

14 14 

15- `role: "owner" or "member"`15- `role: optional string`

16 16 

17 `owner` or `member`17 `owner` or `member`

18 18 

19 - `"owner"`

20 

21 - `"member"`

22 

23### Returns19### Returns

24 20 

25- `ProjectUser object { id, added_at, email, 3 more }`21- `ProjectUser object { id, added_at, object, 3 more }`

26 22 

27 Represents an individual user in a project.23 Represents an individual user in a project.

28 24 

34 30 

35 The Unix timestamp (in seconds) of when the project was added.31 The Unix timestamp (in seconds) of when the project was added.

36 32 

37 - `email: string`

38 

39 The email address of the user

40 

41 - `name: string`

42 

43 The name of the user

44 

45 - `object: "organization.project.user"`33 - `object: "organization.project.user"`

46 34 

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

48 36 

49 - `"organization.project.user"`37 - `"organization.project.user"`

50 38 

51 - `role: "owner" or "member"`39 - `role: string`

52 40 

53 `owner` or `member`41 `owner` or `member`

54 42 

55 - `"owner"`43 - `email: optional string`

44 

45 The email address of the user

46 

47 - `name: optional string`

56 48 

57 - `"member"`49 The name of the user

58 50 

59### Example51### Example

60 52 

62curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \54curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \

63 -H 'Content-Type: application/json' \55 -H 'Content-Type: application/json' \

64 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \56 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

65 -d '{57 -d '{}'

66 "role": "owner"

67 }'

68```58```

69 59 

70#### Response60#### Response

73{63{

74 "id": "id",64 "id": "id",

75 "added_at": 0,65 "added_at": 0,

76 "email": "email",

77 "name": "name",

78 "object": "organization.project.user",66 "object": "organization.project.user",

79 "role": "owner"67 "role": "role",

68 "email": "email",

69 "name": "name"

80}70}

81```71```

82 72 

Details

70 70 

71 The Unix timestamp (in seconds) of when the user was added.71 The Unix timestamp (in seconds) of when the user was added.

72 72 

73 - `email: string`73 - `object: "organization.user"`

74 

75 The object type, which is always `organization.user`

76 

77 - `"organization.user"`

78 

79 - `api_key_last_used_at: optional number`

80 

81 The Unix timestamp (in seconds) of the user's last API key usage.

82 

83 - `created: optional number`

84 

85 The Unix timestamp (in seconds) of when the user was created.

86 

87 - `developer_persona: optional string`

88 

89 The developer persona metadata for the user.

90 

91 - `email: optional string`

74 92 

75 The email address of the user93 The email address of the user

76 94 

77 - `name: string`95 - `is_default: optional boolean`

96 

97 Whether this is the organization's default user.

98 

99 - `is_scale_tier_authorized_purchaser: optional boolean`

100 

101 Whether the user is an authorized purchaser for Scale Tier.

102 

103 - `is_scim_managed: optional boolean`

104 

105 Whether the user is managed through SCIM.

106 

107 - `is_service_account: optional boolean`

108 

109 Whether the user is a service account.

110 

111 - `name: optional string`

78 112 

79 The name of the user113 The name of the user

80 114 

81 - `object: "organization.user"`115 - `projects: optional object { data, object }`

82 116 

83 The object type, which is always `organization.user`117 Projects associated with the user, if included.

84 118 

85 - `"organization.user"`119 - `data: array of object { id, name, role }`

120 

121 - `id: optional string`

122 

123 - `name: optional string`

124 

125 - `role: optional string`

86 126 

87 - `role: "owner" or "reader"`127 - `object: "list"`

128 

129 - `"list"`

130 

131 - `role: optional string`

88 132 

89 `owner` or `reader`133 `owner` or `reader`

90 134 

91 - `"owner"`135 - `technical_level: optional string`

136 

137 The technical level metadata for the user.

138 

139 - `user: optional object { id, object, banned, 5 more }`

140 

141 Nested user details.

142 

143 - `id: string`

144 

145 - `object: "user"`

146 

147 - `"user"`

148 

149 - `banned: optional boolean`

150 

151 - `banned_at: optional number`

152 

153 - `email: optional string`

154 

155 - `enabled: optional boolean`

92 156 

93 - `"reader"`157 - `name: optional string`

158 

159 - `picture: optional string`

94 160 

95### Example161### Example

96 162 

122 "user": {188 "user": {

123 "id": "id",189 "id": "id",

124 "added_at": 0,190 "added_at": 0,

191 "object": "organization.user",

192 "api_key_last_used_at": 0,

193 "created": 0,

194 "developer_persona": "developer_persona",

125 "email": "email",195 "email": "email",

196 "is_default": true,

197 "is_scale_tier_authorized_purchaser": true,

198 "is_scim_managed": true,

199 "is_service_account": true,

126 "name": "name",200 "name": "name",

127 "object": "organization.user",201 "projects": {

128 "role": "owner"202 "data": [

203 {

204 "id": "id",

205 "name": "name",

206 "role": "role"

207 }

208 ],

209 "object": "list"

210 },

211 "role": "role",

212 "technical_level": "technical_level",

213 "user": {

214 "id": "id",

215 "object": "user",

216 "banned": true,

217 "banned_at": 0,

218 "email": "email",

219 "enabled": true,

220 "name": "name",

221 "picture": "picture"

222 }

129 }223 }

130}224}

131```225```

Details

68 68 

69### Returns69### Returns

70 70 

71- `data: array of object { end_time, object, result, start_time }`71- `data: array of object { end_time, object, results, start_time }`

72 72 

73 - `end_time: number`73 - `end_time: number`

74 74 

76 76 

77 - `"bucket"`77 - `"bucket"`

78 78 

79 - `result: 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 6 more`79 - `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 6 more`

80 80 

81 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`81 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

82 82 

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

84 84 

134 134 

135 When `group_by=user_id`, this field provides the user ID of the grouped usage result.135 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

136 136 

137 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`137 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

138 138 

139 The aggregated embeddings usage details of the specific time bucket.139 The aggregated embeddings usage details of the specific time bucket.

140 140 

166 166 

167 When `group_by=user_id`, this field provides the user ID of the grouped usage result.167 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

168 168 

169 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`169 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

170 170 

171 The aggregated moderations usage details of the specific time bucket.171 The aggregated moderations usage details of the specific time bucket.

172 172 

198 198 

199 When `group_by=user_id`, this field provides the user ID of the grouped usage result.199 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

200 200 

201 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`201 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

202 202 

203 The aggregated images usage details of the specific time bucket.203 The aggregated images usage details of the specific time bucket.

204 204 

238 238 

239 When `group_by=user_id`, this field provides the user ID of the grouped usage result.239 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

240 240 

241 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`241 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

242 242 

243 The aggregated audio speeches usage details of the specific time bucket.243 The aggregated audio speeches usage details of the specific time bucket.

244 244 

270 270 

271 When `group_by=user_id`, this field provides the user ID of the grouped usage result.271 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

272 272 

273 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`273 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

274 274 

275 The aggregated audio transcriptions usage details of the specific time bucket.275 The aggregated audio transcriptions usage details of the specific time bucket.

276 276 

302 302 

303 When `group_by=user_id`, this field provides the user ID of the grouped usage result.303 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

304 304 

305 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`305 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

306 306 

307 The aggregated vector stores usage details of the specific time bucket.307 The aggregated vector stores usage details of the specific time bucket.

308 308 

318 318 

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

320 320 

321 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`321 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

322 322 

323 The aggregated code interpreter sessions usage details of the specific time bucket.323 The aggregated code interpreter sessions usage details of the specific time bucket.

324 324 

325 - `object: "organization.usage.code_interpreter_sessions.result"`325 - `num_sessions: number`

326 326 

327 - `"organization.usage.code_interpreter_sessions.result"`327 The number of code interpreter sessions.

328 328 

329 - `num_sessions: optional number`329 - `object: "organization.usage.code_interpreter_sessions.result"`

330 330 

331 The number of code interpreter sessions.331 - `"organization.usage.code_interpreter_sessions.result"`

332 332 

333 - `project_id: optional string`333 - `project_id: optional string`

334 334 

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

336 336 

337 - `CostsResult object { object, amount, api_key_id, 2 more }`337 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

338 338 

339 The aggregated costs details of the specific time bucket.339 The aggregated costs details of the specific time bucket.

340 340 

391 {391 {

392 "end_time": 0,392 "end_time": 0,

393 "object": "bucket",393 "object": "bucket",

394 "result": [394 "results": [

395 {395 {

396 "input_tokens": 0,396 "input_tokens": 0,

397 "num_model_requests": 0,397 "num_model_requests": 0,

521 521 

522### Returns522### Returns

523 523 

524- `data: array of object { end_time, object, result, start_time }`524- `data: array of object { end_time, object, results, start_time }`

525 525 

526 - `end_time: number`526 - `end_time: number`

527 527 

529 529 

530 - `"bucket"`530 - `"bucket"`

531 531 

532 - `result: 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 6 more`532 - `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 6 more`

533 533 

534 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`534 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

535 535 

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

537 537 

587 587 

588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

589 589 

590 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`590 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

591 591 

592 The aggregated embeddings usage details of the specific time bucket.592 The aggregated embeddings usage details of the specific time bucket.

593 593 

619 619 

620 When `group_by=user_id`, this field provides the user ID of the grouped usage result.620 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

621 621 

622 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`622 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

623 623 

624 The aggregated moderations usage details of the specific time bucket.624 The aggregated moderations usage details of the specific time bucket.

625 625 

651 651 

652 When `group_by=user_id`, this field provides the user ID of the grouped usage result.652 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

653 653 

654 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`654 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

655 655 

656 The aggregated images usage details of the specific time bucket.656 The aggregated images usage details of the specific time bucket.

657 657 

691 691 

692 When `group_by=user_id`, this field provides the user ID of the grouped usage result.692 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

693 693 

694 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`694 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

695 695 

696 The aggregated audio speeches usage details of the specific time bucket.696 The aggregated audio speeches usage details of the specific time bucket.

697 697 

723 723 

724 When `group_by=user_id`, this field provides the user ID of the grouped usage result.724 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

725 725 

726 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`726 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

727 727 

728 The aggregated audio transcriptions usage details of the specific time bucket.728 The aggregated audio transcriptions usage details of the specific time bucket.

729 729 

755 755 

756 When `group_by=user_id`, this field provides the user ID of the grouped usage result.756 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

757 757 

758 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`758 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

759 759 

760 The aggregated vector stores usage details of the specific time bucket.760 The aggregated vector stores usage details of the specific time bucket.

761 761 

771 771 

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

773 773 

774 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`774 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

775 775 

776 The aggregated code interpreter sessions usage details of the specific time bucket.776 The aggregated code interpreter sessions usage details of the specific time bucket.

777 777 

778 - `object: "organization.usage.code_interpreter_sessions.result"`778 - `num_sessions: number`

779 779 

780 - `"organization.usage.code_interpreter_sessions.result"`780 The number of code interpreter sessions.

781 781 

782 - `num_sessions: optional number`782 - `object: "organization.usage.code_interpreter_sessions.result"`

783 783 

784 The number of code interpreter sessions.784 - `"organization.usage.code_interpreter_sessions.result"`

785 785 

786 - `project_id: optional string`786 - `project_id: optional string`

787 787 

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

789 789 

790 - `CostsResult object { object, amount, api_key_id, 2 more }`790 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

791 791 

792 The aggregated costs details of the specific time bucket.792 The aggregated costs details of the specific time bucket.

793 793 

844 {844 {

845 "end_time": 0,845 "end_time": 0,

846 "object": "bucket",846 "object": "bucket",

847 "result": [847 "results": [

848 {848 {

849 "input_tokens": 0,849 "input_tokens": 0,

850 "num_model_requests": 0,850 "num_model_requests": 0,

956 956 

957### Returns957### Returns

958 958 

959- `data: array of object { end_time, object, result, start_time }`959- `data: array of object { end_time, object, results, start_time }`

960 960 

961 - `end_time: number`961 - `end_time: number`

962 962 

964 964 

965 - `"bucket"`965 - `"bucket"`

966 966 

967 - `result: 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 6 more`967 - `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 6 more`

968 968 

969 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`969 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

970 970 

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

972 972 

1022 1022 

1023 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1023 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1024 1024 

1025 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`1025 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

1026 1026 

1027 The aggregated embeddings usage details of the specific time bucket.1027 The aggregated embeddings usage details of the specific time bucket.

1028 1028 

1054 1054 

1055 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1055 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1056 1056 

1057 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`1057 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

1058 1058 

1059 The aggregated moderations usage details of the specific time bucket.1059 The aggregated moderations usage details of the specific time bucket.

1060 1060 

1086 1086 

1087 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1087 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1088 1088 

1089 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`1089 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

1090 1090 

1091 The aggregated images usage details of the specific time bucket.1091 The aggregated images usage details of the specific time bucket.

1092 1092 

1126 1126 

1127 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1127 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1128 1128 

1129 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`1129 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

1130 1130 

1131 The aggregated audio speeches usage details of the specific time bucket.1131 The aggregated audio speeches usage details of the specific time bucket.

1132 1132 

1158 1158 

1159 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1159 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1160 1160 

1161 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`1161 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

1162 1162 

1163 The aggregated audio transcriptions usage details of the specific time bucket.1163 The aggregated audio transcriptions usage details of the specific time bucket.

1164 1164 

1190 1190 

1191 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1191 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1192 1192 

1193 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`1193 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

1194 1194 

1195 The aggregated vector stores usage details of the specific time bucket.1195 The aggregated vector stores usage details of the specific time bucket.

1196 1196 

1206 1206 

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

1208 1208 

1209 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`1209 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

1210 1210 

1211 The aggregated code interpreter sessions usage details of the specific time bucket.1211 The aggregated code interpreter sessions usage details of the specific time bucket.

1212 1212 

1213 - `object: "organization.usage.code_interpreter_sessions.result"`1213 - `num_sessions: number`

1214 1214 

1215 - `"organization.usage.code_interpreter_sessions.result"`1215 The number of code interpreter sessions.

1216 1216 

1217 - `num_sessions: optional number`1217 - `object: "organization.usage.code_interpreter_sessions.result"`

1218 1218 

1219 The number of code interpreter sessions.1219 - `"organization.usage.code_interpreter_sessions.result"`

1220 1220 

1221 - `project_id: optional string`1221 - `project_id: optional string`

1222 1222 

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

1224 1224 

1225 - `CostsResult object { object, amount, api_key_id, 2 more }`1225 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

1226 1226 

1227 The aggregated costs details of the specific time bucket.1227 The aggregated costs details of the specific time bucket.

1228 1228 

1279 {1279 {

1280 "end_time": 0,1280 "end_time": 0,

1281 "object": "bucket",1281 "object": "bucket",

1282 "result": [1282 "results": [

1283 {1283 {

1284 "input_tokens": 0,1284 "input_tokens": 0,

1285 "num_model_requests": 0,1285 "num_model_requests": 0,

1413 1413 

1414### Returns1414### Returns

1415 1415 

1416- `data: array of object { end_time, object, result, start_time }`1416- `data: array of object { end_time, object, results, start_time }`

1417 1417 

1418 - `end_time: number`1418 - `end_time: number`

1419 1419 

1421 1421 

1422 - `"bucket"`1422 - `"bucket"`

1423 1423 

1424 - `result: 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 6 more`1424 - `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 6 more`

1425 1425 

1426 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`1426 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

1427 1427 

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

1429 1429 

1479 1479 

1480 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1480 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1481 1481 

1482 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`1482 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

1483 1483 

1484 The aggregated embeddings usage details of the specific time bucket.1484 The aggregated embeddings usage details of the specific time bucket.

1485 1485 

1511 1511 

1512 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1512 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1513 1513 

1514 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`1514 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

1515 1515 

1516 The aggregated moderations usage details of the specific time bucket.1516 The aggregated moderations usage details of the specific time bucket.

1517 1517 

1543 1543 

1544 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1544 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1545 1545 

1546 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`1546 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

1547 1547 

1548 The aggregated images usage details of the specific time bucket.1548 The aggregated images usage details of the specific time bucket.

1549 1549 

1583 1583 

1584 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1584 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1585 1585 

1586 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`1586 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

1587 1587 

1588 The aggregated audio speeches usage details of the specific time bucket.1588 The aggregated audio speeches usage details of the specific time bucket.

1589 1589 

1615 1615 

1616 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1616 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1617 1617 

1618 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`1618 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

1619 1619 

1620 The aggregated audio transcriptions usage details of the specific time bucket.1620 The aggregated audio transcriptions usage details of the specific time bucket.

1621 1621 

1647 1647 

1648 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1648 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1649 1649 

1650 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`1650 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

1651 1651 

1652 The aggregated vector stores usage details of the specific time bucket.1652 The aggregated vector stores usage details of the specific time bucket.

1653 1653 

1663 1663 

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

1665 1665 

1666 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`1666 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

1667 1667 

1668 The aggregated code interpreter sessions usage details of the specific time bucket.1668 The aggregated code interpreter sessions usage details of the specific time bucket.

1669 1669 

1670 - `object: "organization.usage.code_interpreter_sessions.result"`1670 - `num_sessions: number`

1671 1671 

1672 - `"organization.usage.code_interpreter_sessions.result"`1672 The number of code interpreter sessions.

1673 1673 

1674 - `num_sessions: optional number`1674 - `object: "organization.usage.code_interpreter_sessions.result"`

1675 1675 

1676 The number of code interpreter sessions.1676 - `"organization.usage.code_interpreter_sessions.result"`

1677 1677 

1678 - `project_id: optional string`1678 - `project_id: optional string`

1679 1679 

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

1681 1681 

1682 - `CostsResult object { object, amount, api_key_id, 2 more }`1682 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

1683 1683 

1684 The aggregated costs details of the specific time bucket.1684 The aggregated costs details of the specific time bucket.

1685 1685 

1736 {1736 {

1737 "end_time": 0,1737 "end_time": 0,

1738 "object": "bucket",1738 "object": "bucket",

1739 "result": [1739 "results": [

1740 {1740 {

1741 "input_tokens": 0,1741 "input_tokens": 0,

1742 "num_model_requests": 0,1742 "num_model_requests": 0,

1872 1872 

1873### Returns1873### Returns

1874 1874 

1875- `data: array of object { end_time, object, result, start_time }`1875- `data: array of object { end_time, object, results, start_time }`

1876 1876 

1877 - `end_time: number`1877 - `end_time: number`

1878 1878 

1880 1880 

1881 - `"bucket"`1881 - `"bucket"`

1882 1882 

1883 - `result: 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 6 more`1883 - `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 6 more`

1884 1884 

1885 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`1885 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

1886 1886 

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

1888 1888 

1938 1938 

1939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1940 1940 

1941 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`1941 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

1942 1942 

1943 The aggregated embeddings usage details of the specific time bucket.1943 The aggregated embeddings usage details of the specific time bucket.

1944 1944 

1970 1970 

1971 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1971 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

1972 1972 

1973 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`1973 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

1974 1974 

1975 The aggregated moderations usage details of the specific time bucket.1975 The aggregated moderations usage details of the specific time bucket.

1976 1976 

2002 2002 

2003 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2003 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2004 2004 

2005 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`2005 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

2006 2006 

2007 The aggregated images usage details of the specific time bucket.2007 The aggregated images usage details of the specific time bucket.

2008 2008 

2042 2042 

2043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2044 2044 

2045 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`2045 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

2046 2046 

2047 The aggregated audio speeches usage details of the specific time bucket.2047 The aggregated audio speeches usage details of the specific time bucket.

2048 2048 

2074 2074 

2075 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2075 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2076 2076 

2077 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`2077 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

2078 2078 

2079 The aggregated audio transcriptions usage details of the specific time bucket.2079 The aggregated audio transcriptions usage details of the specific time bucket.

2080 2080 

2106 2106 

2107 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2107 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2108 2108 

2109 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`2109 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

2110 2110 

2111 The aggregated vector stores usage details of the specific time bucket.2111 The aggregated vector stores usage details of the specific time bucket.

2112 2112 

2122 2122 

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

2124 2124 

2125 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`2125 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

2126 2126 

2127 The aggregated code interpreter sessions usage details of the specific time bucket.2127 The aggregated code interpreter sessions usage details of the specific time bucket.

2128 2128 

2129 - `object: "organization.usage.code_interpreter_sessions.result"`2129 - `num_sessions: number`

2130 2130 

2131 - `"organization.usage.code_interpreter_sessions.result"`2131 The number of code interpreter sessions.

2132 2132 

2133 - `num_sessions: optional number`2133 - `object: "organization.usage.code_interpreter_sessions.result"`

2134 2134 

2135 The number of code interpreter sessions.2135 - `"organization.usage.code_interpreter_sessions.result"`

2136 2136 

2137 - `project_id: optional string`2137 - `project_id: optional string`

2138 2138 

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

2140 2140 

2141 - `CostsResult object { object, amount, api_key_id, 2 more }`2141 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

2142 2142 

2143 The aggregated costs details of the specific time bucket.2143 The aggregated costs details of the specific time bucket.

2144 2144 

2195 {2195 {

2196 "end_time": 0,2196 "end_time": 0,

2197 "object": "bucket",2197 "object": "bucket",

2198 "result": [2198 "results": [

2199 {2199 {

2200 "input_tokens": 0,2200 "input_tokens": 0,

2201 "num_model_requests": 0,2201 "num_model_requests": 0,

2353 2353 

2354### Returns2354### Returns

2355 2355 

2356- `data: array of object { end_time, object, result, start_time }`2356- `data: array of object { end_time, object, results, start_time }`

2357 2357 

2358 - `end_time: number`2358 - `end_time: number`

2359 2359 

2361 2361 

2362 - `"bucket"`2362 - `"bucket"`

2363 2363 

2364 - `result: 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 6 more`2364 - `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 6 more`

2365 2365 

2366 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`2366 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

2367 2367 

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

2369 2369 

2419 2419 

2420 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2420 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2421 2421 

2422 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`2422 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

2423 2423 

2424 The aggregated embeddings usage details of the specific time bucket.2424 The aggregated embeddings usage details of the specific time bucket.

2425 2425 

2451 2451 

2452 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2452 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2453 2453 

2454 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`2454 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

2455 2455 

2456 The aggregated moderations usage details of the specific time bucket.2456 The aggregated moderations usage details of the specific time bucket.

2457 2457 

2483 2483 

2484 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2484 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2485 2485 

2486 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`2486 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

2487 2487 

2488 The aggregated images usage details of the specific time bucket.2488 The aggregated images usage details of the specific time bucket.

2489 2489 

2523 2523 

2524 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2524 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2525 2525 

2526 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`2526 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

2527 2527 

2528 The aggregated audio speeches usage details of the specific time bucket.2528 The aggregated audio speeches usage details of the specific time bucket.

2529 2529 

2555 2555 

2556 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2556 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2557 2557 

2558 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`2558 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

2559 2559 

2560 The aggregated audio transcriptions usage details of the specific time bucket.2560 The aggregated audio transcriptions usage details of the specific time bucket.

2561 2561 

2587 2587 

2588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2589 2589 

2590 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`2590 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

2591 2591 

2592 The aggregated vector stores usage details of the specific time bucket.2592 The aggregated vector stores usage details of the specific time bucket.

2593 2593 

2603 2603 

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

2605 2605 

2606 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`2606 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

2607 2607 

2608 The aggregated code interpreter sessions usage details of the specific time bucket.2608 The aggregated code interpreter sessions usage details of the specific time bucket.

2609 2609 

2610 - `object: "organization.usage.code_interpreter_sessions.result"`2610 - `num_sessions: number`

2611 2611 

2612 - `"organization.usage.code_interpreter_sessions.result"`2612 The number of code interpreter sessions.

2613 2613 

2614 - `num_sessions: optional number`2614 - `object: "organization.usage.code_interpreter_sessions.result"`

2615 2615 

2616 The number of code interpreter sessions.2616 - `"organization.usage.code_interpreter_sessions.result"`

2617 2617 

2618 - `project_id: optional string`2618 - `project_id: optional string`

2619 2619 

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

2621 2621 

2622 - `CostsResult object { object, amount, api_key_id, 2 more }`2622 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

2623 2623 

2624 The aggregated costs details of the specific time bucket.2624 The aggregated costs details of the specific time bucket.

2625 2625 

2676 {2676 {

2677 "end_time": 0,2677 "end_time": 0,

2678 "object": "bucket",2678 "object": "bucket",

2679 "result": [2679 "results": [

2680 {2680 {

2681 "input_tokens": 0,2681 "input_tokens": 0,

2682 "num_model_requests": 0,2682 "num_model_requests": 0,

2808 2808 

2809### Returns2809### Returns

2810 2810 

2811- `data: array of object { end_time, object, result, start_time }`2811- `data: array of object { end_time, object, results, start_time }`

2812 2812 

2813 - `end_time: number`2813 - `end_time: number`

2814 2814 

2816 2816 

2817 - `"bucket"`2817 - `"bucket"`

2818 2818 

2819 - `result: 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 6 more`2819 - `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 6 more`

2820 2820 

2821 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`2821 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

2822 2822 

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

2824 2824 

2874 2874 

2875 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2875 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2876 2876 

2877 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`2877 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

2878 2878 

2879 The aggregated embeddings usage details of the specific time bucket.2879 The aggregated embeddings usage details of the specific time bucket.

2880 2880 

2906 2906 

2907 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2907 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2908 2908 

2909 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`2909 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

2910 2910 

2911 The aggregated moderations usage details of the specific time bucket.2911 The aggregated moderations usage details of the specific time bucket.

2912 2912 

2938 2938 

2939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2940 2940 

2941 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`2941 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

2942 2942 

2943 The aggregated images usage details of the specific time bucket.2943 The aggregated images usage details of the specific time bucket.

2944 2944 

2978 2978 

2979 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2979 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

2980 2980 

2981 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`2981 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

2982 2982 

2983 The aggregated audio speeches usage details of the specific time bucket.2983 The aggregated audio speeches usage details of the specific time bucket.

2984 2984 

3010 3010 

3011 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3011 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3012 3012 

3013 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`3013 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

3014 3014 

3015 The aggregated audio transcriptions usage details of the specific time bucket.3015 The aggregated audio transcriptions usage details of the specific time bucket.

3016 3016 

3042 3042 

3043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3044 3044 

3045 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`3045 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

3046 3046 

3047 The aggregated vector stores usage details of the specific time bucket.3047 The aggregated vector stores usage details of the specific time bucket.

3048 3048 

3058 3058 

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

3060 3060 

3061 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`3061 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

3062 3062 

3063 The aggregated code interpreter sessions usage details of the specific time bucket.3063 The aggregated code interpreter sessions usage details of the specific time bucket.

3064 3064 

3065 - `object: "organization.usage.code_interpreter_sessions.result"`3065 - `num_sessions: number`

3066 3066 

3067 - `"organization.usage.code_interpreter_sessions.result"`3067 The number of code interpreter sessions.

3068 3068 

3069 - `num_sessions: optional number`3069 - `object: "organization.usage.code_interpreter_sessions.result"`

3070 3070 

3071 The number of code interpreter sessions.3071 - `"organization.usage.code_interpreter_sessions.result"`

3072 3072 

3073 - `project_id: optional string`3073 - `project_id: optional string`

3074 3074 

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

3076 3076 

3077 - `CostsResult object { object, amount, api_key_id, 2 more }`3077 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

3078 3078 

3079 The aggregated costs details of the specific time bucket.3079 The aggregated costs details of the specific time bucket.

3080 3080 

3131 {3131 {

3132 "end_time": 0,3132 "end_time": 0,

3133 "object": "bucket",3133 "object": "bucket",

3134 "result": [3134 "results": [

3135 {3135 {

3136 "input_tokens": 0,3136 "input_tokens": 0,

3137 "num_model_requests": 0,3137 "num_model_requests": 0,

3243 3243 

3244### Returns3244### Returns

3245 3245 

3246- `data: array of object { end_time, object, result, start_time }`3246- `data: array of object { end_time, object, results, start_time }`

3247 3247 

3248 - `end_time: number`3248 - `end_time: number`

3249 3249 

3251 3251 

3252 - `"bucket"`3252 - `"bucket"`

3253 3253 

3254 - `result: 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 6 more`3254 - `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 6 more`

3255 3255 

3256 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`3256 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

3257 3257 

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

3259 3259 

3309 3309 

3310 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3310 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3311 3311 

3312 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`3312 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

3313 3313 

3314 The aggregated embeddings usage details of the specific time bucket.3314 The aggregated embeddings usage details of the specific time bucket.

3315 3315 

3341 3341 

3342 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3342 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3343 3343 

3344 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`3344 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

3345 3345 

3346 The aggregated moderations usage details of the specific time bucket.3346 The aggregated moderations usage details of the specific time bucket.

3347 3347 

3373 3373 

3374 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3374 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3375 3375 

3376 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`3376 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

3377 3377 

3378 The aggregated images usage details of the specific time bucket.3378 The aggregated images usage details of the specific time bucket.

3379 3379 

3413 3413 

3414 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3414 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3415 3415 

3416 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`3416 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

3417 3417 

3418 The aggregated audio speeches usage details of the specific time bucket.3418 The aggregated audio speeches usage details of the specific time bucket.

3419 3419 

3445 3445 

3446 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3446 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3447 3447 

3448 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`3448 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

3449 3449 

3450 The aggregated audio transcriptions usage details of the specific time bucket.3450 The aggregated audio transcriptions usage details of the specific time bucket.

3451 3451 

3477 3477 

3478 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3478 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3479 3479 

3480 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`3480 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

3481 3481 

3482 The aggregated vector stores usage details of the specific time bucket.3482 The aggregated vector stores usage details of the specific time bucket.

3483 3483 

3493 3493 

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

3495 3495 

3496 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`3496 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

3497 3497 

3498 The aggregated code interpreter sessions usage details of the specific time bucket.3498 The aggregated code interpreter sessions usage details of the specific time bucket.

3499 3499 

3500 - `object: "organization.usage.code_interpreter_sessions.result"`3500 - `num_sessions: number`

3501 3501 

3502 - `"organization.usage.code_interpreter_sessions.result"`3502 The number of code interpreter sessions.

3503 3503 

3504 - `num_sessions: optional number`3504 - `object: "organization.usage.code_interpreter_sessions.result"`

3505 3505 

3506 The number of code interpreter sessions.3506 - `"organization.usage.code_interpreter_sessions.result"`

3507 3507 

3508 - `project_id: optional string`3508 - `project_id: optional string`

3509 3509 

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

3511 3511 

3512 - `CostsResult object { object, amount, api_key_id, 2 more }`3512 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

3513 3513 

3514 The aggregated costs details of the specific time bucket.3514 The aggregated costs details of the specific time bucket.

3515 3515 

3566 {3566 {

3567 "end_time": 0,3567 "end_time": 0,

3568 "object": "bucket",3568 "object": "bucket",

3569 "result": [3569 "results": [

3570 {3570 {

3571 "input_tokens": 0,3571 "input_tokens": 0,

3572 "num_model_requests": 0,3572 "num_model_requests": 0,

3674 3674 

3675### Returns3675### Returns

3676 3676 

3677- `data: array of object { end_time, object, result, start_time }`3677- `data: array of object { end_time, object, results, start_time }`

3678 3678 

3679 - `end_time: number`3679 - `end_time: number`

3680 3680 

3682 3682 

3683 - `"bucket"`3683 - `"bucket"`

3684 3684 

3685 - `result: 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 6 more`3685 - `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 6 more`

3686 3686 

3687 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`3687 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

3688 3688 

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

3690 3690 

3740 3740 

3741 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3741 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3742 3742 

3743 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`3743 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

3744 3744 

3745 The aggregated embeddings usage details of the specific time bucket.3745 The aggregated embeddings usage details of the specific time bucket.

3746 3746 

3772 3772 

3773 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3773 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3774 3774 

3775 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`3775 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

3776 3776 

3777 The aggregated moderations usage details of the specific time bucket.3777 The aggregated moderations usage details of the specific time bucket.

3778 3778 

3804 3804 

3805 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3805 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3806 3806 

3807 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`3807 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

3808 3808 

3809 The aggregated images usage details of the specific time bucket.3809 The aggregated images usage details of the specific time bucket.

3810 3810 

3844 3844 

3845 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3845 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3846 3846 

3847 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`3847 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

3848 3848 

3849 The aggregated audio speeches usage details of the specific time bucket.3849 The aggregated audio speeches usage details of the specific time bucket.

3850 3850 

3876 3876 

3877 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3877 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3878 3878 

3879 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`3879 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

3880 3880 

3881 The aggregated audio transcriptions usage details of the specific time bucket.3881 The aggregated audio transcriptions usage details of the specific time bucket.

3882 3882 

3908 3908 

3909 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3909 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

3910 3910 

3911 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`3911 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

3912 3912 

3913 The aggregated vector stores usage details of the specific time bucket.3913 The aggregated vector stores usage details of the specific time bucket.

3914 3914 

3924 3924 

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

3926 3926 

3927 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`3927 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

3928 3928 

3929 The aggregated code interpreter sessions usage details of the specific time bucket.3929 The aggregated code interpreter sessions usage details of the specific time bucket.

3930 3930 

3931 - `object: "organization.usage.code_interpreter_sessions.result"`3931 - `num_sessions: number`

3932 3932 

3933 - `"organization.usage.code_interpreter_sessions.result"`3933 The number of code interpreter sessions.

3934 3934 

3935 - `num_sessions: optional number`3935 - `object: "organization.usage.code_interpreter_sessions.result"`

3936 3936 

3937 The number of code interpreter sessions.3937 - `"organization.usage.code_interpreter_sessions.result"`

3938 3938 

3939 - `project_id: optional string`3939 - `project_id: optional string`

3940 3940 

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

3942 3942 

3943 - `CostsResult object { object, amount, api_key_id, 2 more }`3943 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

3944 3944 

3945 The aggregated costs details of the specific time bucket.3945 The aggregated costs details of the specific time bucket.

3946 3946 

3997 {3997 {

3998 "end_time": 0,3998 "end_time": 0,

3999 "object": "bucket",3999 "object": "bucket",

4000 "result": [4000 "results": [

4001 {4001 {

4002 "input_tokens": 0,4002 "input_tokens": 0,

4003 "num_model_requests": 0,4003 "num_model_requests": 0,

4066 4066 

4067- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`4067- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`

4068 4068 

4069 - `data: array of object { end_time, object, result, start_time }`4069 - `data: array of object { end_time, object, results, start_time }`

4070 4070 

4071 - `end_time: number`4071 - `end_time: number`

4072 4072 

4074 4074 

4075 - `"bucket"`4075 - `"bucket"`

4076 4076 

4077 - `result: 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 6 more`4077 - `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 6 more`

4078 4078 

4079 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`4079 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

4080 4080 

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

4082 4082 

4132 4132 

4133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4134 4134 

4135 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`4135 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

4136 4136 

4137 The aggregated embeddings usage details of the specific time bucket.4137 The aggregated embeddings usage details of the specific time bucket.

4138 4138 

4164 4164 

4165 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4165 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4166 4166 

4167 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`4167 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

4168 4168 

4169 The aggregated moderations usage details of the specific time bucket.4169 The aggregated moderations usage details of the specific time bucket.

4170 4170 

4196 4196 

4197 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4197 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4198 4198 

4199 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`4199 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

4200 4200 

4201 The aggregated images usage details of the specific time bucket.4201 The aggregated images usage details of the specific time bucket.

4202 4202 

4236 4236 

4237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4238 4238 

4239 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`4239 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

4240 4240 

4241 The aggregated audio speeches usage details of the specific time bucket.4241 The aggregated audio speeches usage details of the specific time bucket.

4242 4242 

4268 4268 

4269 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4269 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4270 4270 

4271 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`4271 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

4272 4272 

4273 The aggregated audio transcriptions usage details of the specific time bucket.4273 The aggregated audio transcriptions usage details of the specific time bucket.

4274 4274 

4300 4300 

4301 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4301 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4302 4302 

4303 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`4303 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

4304 4304 

4305 The aggregated vector stores usage details of the specific time bucket.4305 The aggregated vector stores usage details of the specific time bucket.

4306 4306 

4316 4316 

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

4318 4318 

4319 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`4319 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

4320 4320 

4321 The aggregated code interpreter sessions usage details of the specific time bucket.4321 The aggregated code interpreter sessions usage details of the specific time bucket.

4322 4322 

4323 - `object: "organization.usage.code_interpreter_sessions.result"`4323 - `num_sessions: number`

4324 4324 

4325 - `"organization.usage.code_interpreter_sessions.result"`4325 The number of code interpreter sessions.

4326 4326 

4327 - `num_sessions: optional number`4327 - `object: "organization.usage.code_interpreter_sessions.result"`

4328 4328 

4329 The number of code interpreter sessions.4329 - `"organization.usage.code_interpreter_sessions.result"`

4330 4330 

4331 - `project_id: optional string`4331 - `project_id: optional string`

4332 4332 

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

4334 4334 

4335 - `CostsResult object { object, amount, api_key_id, 2 more }`4335 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

4336 4336 

4337 The aggregated costs details of the specific time bucket.4337 The aggregated costs details of the specific time bucket.

4338 4338 

4378 4378 

4379- `UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }`4379- `UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }`

4380 4380 

4381 - `data: array of object { end_time, object, result, start_time }`4381 - `data: array of object { end_time, object, results, start_time }`

4382 4382 

4383 - `end_time: number`4383 - `end_time: number`

4384 4384 

4386 4386 

4387 - `"bucket"`4387 - `"bucket"`

4388 4388 

4389 - `result: 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 6 more`4389 - `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 6 more`

4390 4390 

4391 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`4391 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

4392 4392 

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

4394 4394 

4444 4444 

4445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4446 4446 

4447 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`4447 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

4448 4448 

4449 The aggregated embeddings usage details of the specific time bucket.4449 The aggregated embeddings usage details of the specific time bucket.

4450 4450 

4476 4476 

4477 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4477 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4478 4478 

4479 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`4479 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

4480 4480 

4481 The aggregated moderations usage details of the specific time bucket.4481 The aggregated moderations usage details of the specific time bucket.

4482 4482 

4508 4508 

4509 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4509 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4510 4510 

4511 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`4511 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

4512 4512 

4513 The aggregated images usage details of the specific time bucket.4513 The aggregated images usage details of the specific time bucket.

4514 4514 

4548 4548 

4549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4550 4550 

4551 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`4551 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

4552 4552 

4553 The aggregated audio speeches usage details of the specific time bucket.4553 The aggregated audio speeches usage details of the specific time bucket.

4554 4554 

4580 4580 

4581 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4581 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4582 4582 

4583 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`4583 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

4584 4584 

4585 The aggregated audio transcriptions usage details of the specific time bucket.4585 The aggregated audio transcriptions usage details of the specific time bucket.

4586 4586 

4612 4612 

4613 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4613 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4614 4614 

4615 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`4615 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

4616 4616 

4617 The aggregated vector stores usage details of the specific time bucket.4617 The aggregated vector stores usage details of the specific time bucket.

4618 4618 

4628 4628 

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

4630 4630 

4631 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`4631 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

4632 4632 

4633 The aggregated code interpreter sessions usage details of the specific time bucket.4633 The aggregated code interpreter sessions usage details of the specific time bucket.

4634 4634 

4635 - `object: "organization.usage.code_interpreter_sessions.result"`4635 - `num_sessions: number`

4636 4636 

4637 - `"organization.usage.code_interpreter_sessions.result"`4637 The number of code interpreter sessions.

4638 4638 

4639 - `num_sessions: optional number`4639 - `object: "organization.usage.code_interpreter_sessions.result"`

4640 4640 

4641 The number of code interpreter sessions.4641 - `"organization.usage.code_interpreter_sessions.result"`

4642 4642 

4643 - `project_id: optional string`4643 - `project_id: optional string`

4644 4644 

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

4646 4646 

4647 - `CostsResult object { object, amount, api_key_id, 2 more }`4647 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

4648 4648 

4649 The aggregated costs details of the specific time bucket.4649 The aggregated costs details of the specific time bucket.

4650 4650 

4690 4690 

4691- `UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }`4691- `UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }`

4692 4692 

4693 - `data: array of object { end_time, object, result, start_time }`4693 - `data: array of object { end_time, object, results, start_time }`

4694 4694 

4695 - `end_time: number`4695 - `end_time: number`

4696 4696 

4698 4698 

4699 - `"bucket"`4699 - `"bucket"`

4700 4700 

4701 - `result: 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 6 more`4701 - `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 6 more`

4702 4702 

4703 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`4703 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

4704 4704 

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

4706 4706 

4756 4756 

4757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4758 4758 

4759 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`4759 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

4760 4760 

4761 The aggregated embeddings usage details of the specific time bucket.4761 The aggregated embeddings usage details of the specific time bucket.

4762 4762 

4788 4788 

4789 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4789 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4790 4790 

4791 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`4791 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

4792 4792 

4793 The aggregated moderations usage details of the specific time bucket.4793 The aggregated moderations usage details of the specific time bucket.

4794 4794 

4820 4820 

4821 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4821 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4822 4822 

4823 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`4823 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

4824 4824 

4825 The aggregated images usage details of the specific time bucket.4825 The aggregated images usage details of the specific time bucket.

4826 4826 

4860 4860 

4861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4862 4862 

4863 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`4863 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

4864 4864 

4865 The aggregated audio speeches usage details of the specific time bucket.4865 The aggregated audio speeches usage details of the specific time bucket.

4866 4866 

4892 4892 

4893 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4893 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4894 4894 

4895 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`4895 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

4896 4896 

4897 The aggregated audio transcriptions usage details of the specific time bucket.4897 The aggregated audio transcriptions usage details of the specific time bucket.

4898 4898 

4924 4924 

4925 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4925 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

4926 4926 

4927 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`4927 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

4928 4928 

4929 The aggregated vector stores usage details of the specific time bucket.4929 The aggregated vector stores usage details of the specific time bucket.

4930 4930 

4940 4940 

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

4942 4942 

4943 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`4943 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

4944 4944 

4945 The aggregated code interpreter sessions usage details of the specific time bucket.4945 The aggregated code interpreter sessions usage details of the specific time bucket.

4946 4946 

4947 - `object: "organization.usage.code_interpreter_sessions.result"`4947 - `num_sessions: number`

4948 4948 

4949 - `"organization.usage.code_interpreter_sessions.result"`4949 The number of code interpreter sessions.

4950 4950 

4951 - `num_sessions: optional number`4951 - `object: "organization.usage.code_interpreter_sessions.result"`

4952 4952 

4953 The number of code interpreter sessions.4953 - `"organization.usage.code_interpreter_sessions.result"`

4954 4954 

4955 - `project_id: optional string`4955 - `project_id: optional string`

4956 4956 

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

4958 4958 

4959 - `CostsResult object { object, amount, api_key_id, 2 more }`4959 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

4960 4960 

4961 The aggregated costs details of the specific time bucket.4961 The aggregated costs details of the specific time bucket.

4962 4962 

5002 5002 

5003- `UsageCompletionsResponse object { data, has_more, next_page, object }`5003- `UsageCompletionsResponse object { data, has_more, next_page, object }`

5004 5004 

5005 - `data: array of object { end_time, object, result, start_time }`5005 - `data: array of object { end_time, object, results, start_time }`

5006 5006 

5007 - `end_time: number`5007 - `end_time: number`

5008 5008 

5010 5010 

5011 - `"bucket"`5011 - `"bucket"`

5012 5012 

5013 - `result: 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 6 more`5013 - `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 6 more`

5014 5014 

5015 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`5015 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

5016 5016 

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

5018 5018 

5068 5068 

5069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5070 5070 

5071 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`5071 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

5072 5072 

5073 The aggregated embeddings usage details of the specific time bucket.5073 The aggregated embeddings usage details of the specific time bucket.

5074 5074 

5100 5100 

5101 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5101 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5102 5102 

5103 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`5103 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

5104 5104 

5105 The aggregated moderations usage details of the specific time bucket.5105 The aggregated moderations usage details of the specific time bucket.

5106 5106 

5132 5132 

5133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5134 5134 

5135 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`5135 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

5136 5136 

5137 The aggregated images usage details of the specific time bucket.5137 The aggregated images usage details of the specific time bucket.

5138 5138 

5172 5172 

5173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5174 5174 

5175 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`5175 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

5176 5176 

5177 The aggregated audio speeches usage details of the specific time bucket.5177 The aggregated audio speeches usage details of the specific time bucket.

5178 5178 

5204 5204 

5205 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5205 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5206 5206 

5207 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`5207 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

5208 5208 

5209 The aggregated audio transcriptions usage details of the specific time bucket.5209 The aggregated audio transcriptions usage details of the specific time bucket.

5210 5210 

5236 5236 

5237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5238 5238 

5239 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`5239 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

5240 5240 

5241 The aggregated vector stores usage details of the specific time bucket.5241 The aggregated vector stores usage details of the specific time bucket.

5242 5242 

5252 5252 

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

5254 5254 

5255 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`5255 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

5256 5256 

5257 The aggregated code interpreter sessions usage details of the specific time bucket.5257 The aggregated code interpreter sessions usage details of the specific time bucket.

5258 5258 

5259 - `object: "organization.usage.code_interpreter_sessions.result"`5259 - `num_sessions: number`

5260 5260 

5261 - `"organization.usage.code_interpreter_sessions.result"`5261 The number of code interpreter sessions.

5262 5262 

5263 - `num_sessions: optional number`5263 - `object: "organization.usage.code_interpreter_sessions.result"`

5264 5264 

5265 The number of code interpreter sessions.5265 - `"organization.usage.code_interpreter_sessions.result"`

5266 5266 

5267 - `project_id: optional string`5267 - `project_id: optional string`

5268 5268 

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

5270 5270 

5271 - `CostsResult object { object, amount, api_key_id, 2 more }`5271 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

5272 5272 

5273 The aggregated costs details of the specific time bucket.5273 The aggregated costs details of the specific time bucket.

5274 5274 

5314 5314 

5315- `UsageEmbeddingsResponse object { data, has_more, next_page, object }`5315- `UsageEmbeddingsResponse object { data, has_more, next_page, object }`

5316 5316 

5317 - `data: array of object { end_time, object, result, start_time }`5317 - `data: array of object { end_time, object, results, start_time }`

5318 5318 

5319 - `end_time: number`5319 - `end_time: number`

5320 5320 

5322 5322 

5323 - `"bucket"`5323 - `"bucket"`

5324 5324 

5325 - `result: 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 6 more`5325 - `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 6 more`

5326 5326 

5327 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`5327 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

5328 5328 

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

5330 5330 

5380 5380 

5381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5382 5382 

5383 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`5383 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

5384 5384 

5385 The aggregated embeddings usage details of the specific time bucket.5385 The aggregated embeddings usage details of the specific time bucket.

5386 5386 

5412 5412 

5413 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5413 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5414 5414 

5415 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`5415 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

5416 5416 

5417 The aggregated moderations usage details of the specific time bucket.5417 The aggregated moderations usage details of the specific time bucket.

5418 5418 

5444 5444 

5445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5446 5446 

5447 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`5447 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

5448 5448 

5449 The aggregated images usage details of the specific time bucket.5449 The aggregated images usage details of the specific time bucket.

5450 5450 

5484 5484 

5485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5486 5486 

5487 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`5487 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

5488 5488 

5489 The aggregated audio speeches usage details of the specific time bucket.5489 The aggregated audio speeches usage details of the specific time bucket.

5490 5490 

5516 5516 

5517 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5517 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5518 5518 

5519 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`5519 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

5520 5520 

5521 The aggregated audio transcriptions usage details of the specific time bucket.5521 The aggregated audio transcriptions usage details of the specific time bucket.

5522 5522 

5548 5548 

5549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5550 5550 

5551 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`5551 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

5552 5552 

5553 The aggregated vector stores usage details of the specific time bucket.5553 The aggregated vector stores usage details of the specific time bucket.

5554 5554 

5564 5564 

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

5566 5566 

5567 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`5567 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

5568 5568 

5569 The aggregated code interpreter sessions usage details of the specific time bucket.5569 The aggregated code interpreter sessions usage details of the specific time bucket.

5570 5570 

5571 - `object: "organization.usage.code_interpreter_sessions.result"`5571 - `num_sessions: number`

5572 5572 

5573 - `"organization.usage.code_interpreter_sessions.result"`5573 The number of code interpreter sessions.

5574 5574 

5575 - `num_sessions: optional number`5575 - `object: "organization.usage.code_interpreter_sessions.result"`

5576 5576 

5577 The number of code interpreter sessions.5577 - `"organization.usage.code_interpreter_sessions.result"`

5578 5578 

5579 - `project_id: optional string`5579 - `project_id: optional string`

5580 5580 

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

5582 5582 

5583 - `CostsResult object { object, amount, api_key_id, 2 more }`5583 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

5584 5584 

5585 The aggregated costs details of the specific time bucket.5585 The aggregated costs details of the specific time bucket.

5586 5586 

5626 5626 

5627- `UsageImagesResponse object { data, has_more, next_page, object }`5627- `UsageImagesResponse object { data, has_more, next_page, object }`

5628 5628 

5629 - `data: array of object { end_time, object, result, start_time }`5629 - `data: array of object { end_time, object, results, start_time }`

5630 5630 

5631 - `end_time: number`5631 - `end_time: number`

5632 5632 

5634 5634 

5635 - `"bucket"`5635 - `"bucket"`

5636 5636 

5637 - `result: 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 6 more`5637 - `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 6 more`

5638 5638 

5639 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`5639 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

5640 5640 

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

5642 5642 

5692 5692 

5693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5694 5694 

5695 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`5695 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

5696 5696 

5697 The aggregated embeddings usage details of the specific time bucket.5697 The aggregated embeddings usage details of the specific time bucket.

5698 5698 

5724 5724 

5725 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5725 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5726 5726 

5727 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`5727 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

5728 5728 

5729 The aggregated moderations usage details of the specific time bucket.5729 The aggregated moderations usage details of the specific time bucket.

5730 5730 

5756 5756 

5757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5758 5758 

5759 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`5759 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

5760 5760 

5761 The aggregated images usage details of the specific time bucket.5761 The aggregated images usage details of the specific time bucket.

5762 5762 

5796 5796 

5797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5798 5798 

5799 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`5799 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

5800 5800 

5801 The aggregated audio speeches usage details of the specific time bucket.5801 The aggregated audio speeches usage details of the specific time bucket.

5802 5802 

5828 5828 

5829 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5829 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5830 5830 

5831 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`5831 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

5832 5832 

5833 The aggregated audio transcriptions usage details of the specific time bucket.5833 The aggregated audio transcriptions usage details of the specific time bucket.

5834 5834 

5860 5860 

5861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

5862 5862 

5863 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`5863 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

5864 5864 

5865 The aggregated vector stores usage details of the specific time bucket.5865 The aggregated vector stores usage details of the specific time bucket.

5866 5866 

5876 5876 

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

5878 5878 

5879 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`5879 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

5880 5880 

5881 The aggregated code interpreter sessions usage details of the specific time bucket.5881 The aggregated code interpreter sessions usage details of the specific time bucket.

5882 5882 

5883 - `object: "organization.usage.code_interpreter_sessions.result"`5883 - `num_sessions: number`

5884 5884 

5885 - `"organization.usage.code_interpreter_sessions.result"`5885 The number of code interpreter sessions.

5886 5886 

5887 - `num_sessions: optional number`5887 - `object: "organization.usage.code_interpreter_sessions.result"`

5888 5888 

5889 The number of code interpreter sessions.5889 - `"organization.usage.code_interpreter_sessions.result"`

5890 5890 

5891 - `project_id: optional string`5891 - `project_id: optional string`

5892 5892 

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

5894 5894 

5895 - `CostsResult object { object, amount, api_key_id, 2 more }`5895 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

5896 5896 

5897 The aggregated costs details of the specific time bucket.5897 The aggregated costs details of the specific time bucket.

5898 5898 

5938 5938 

5939- `UsageModerationsResponse object { data, has_more, next_page, object }`5939- `UsageModerationsResponse object { data, has_more, next_page, object }`

5940 5940 

5941 - `data: array of object { end_time, object, result, start_time }`5941 - `data: array of object { end_time, object, results, start_time }`

5942 5942 

5943 - `end_time: number`5943 - `end_time: number`

5944 5944 

5946 5946 

5947 - `"bucket"`5947 - `"bucket"`

5948 5948 

5949 - `result: 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 6 more`5949 - `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 6 more`

5950 5950 

5951 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`5951 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

5952 5952 

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

5954 5954 

6004 6004 

6005 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6005 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6006 6006 

6007 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`6007 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

6008 6008 

6009 The aggregated embeddings usage details of the specific time bucket.6009 The aggregated embeddings usage details of the specific time bucket.

6010 6010 

6036 6036 

6037 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6037 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6038 6038 

6039 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`6039 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

6040 6040 

6041 The aggregated moderations usage details of the specific time bucket.6041 The aggregated moderations usage details of the specific time bucket.

6042 6042 

6068 6068 

6069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6070 6070 

6071 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`6071 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

6072 6072 

6073 The aggregated images usage details of the specific time bucket.6073 The aggregated images usage details of the specific time bucket.

6074 6074 

6108 6108 

6109 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6109 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6110 6110 

6111 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`6111 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

6112 6112 

6113 The aggregated audio speeches usage details of the specific time bucket.6113 The aggregated audio speeches usage details of the specific time bucket.

6114 6114 

6140 6140 

6141 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6141 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6142 6142 

6143 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`6143 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

6144 6144 

6145 The aggregated audio transcriptions usage details of the specific time bucket.6145 The aggregated audio transcriptions usage details of the specific time bucket.

6146 6146 

6172 6172 

6173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6174 6174 

6175 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`6175 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

6176 6176 

6177 The aggregated vector stores usage details of the specific time bucket.6177 The aggregated vector stores usage details of the specific time bucket.

6178 6178 

6188 6188 

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

6190 6190 

6191 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`6191 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

6192 6192 

6193 The aggregated code interpreter sessions usage details of the specific time bucket.6193 The aggregated code interpreter sessions usage details of the specific time bucket.

6194 6194 

6195 - `object: "organization.usage.code_interpreter_sessions.result"`6195 - `num_sessions: number`

6196 6196 

6197 - `"organization.usage.code_interpreter_sessions.result"`6197 The number of code interpreter sessions.

6198 6198 

6199 - `num_sessions: optional number`6199 - `object: "organization.usage.code_interpreter_sessions.result"`

6200 6200 

6201 The number of code interpreter sessions.6201 - `"organization.usage.code_interpreter_sessions.result"`

6202 6202 

6203 - `project_id: optional string`6203 - `project_id: optional string`

6204 6204 

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

6206 6206 

6207 - `CostsResult object { object, amount, api_key_id, 2 more }`6207 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

6208 6208 

6209 The aggregated costs details of the specific time bucket.6209 The aggregated costs details of the specific time bucket.

6210 6210 

6250 6250 

6251- `UsageVectorStoresResponse object { data, has_more, next_page, object }`6251- `UsageVectorStoresResponse object { data, has_more, next_page, object }`

6252 6252 

6253 - `data: array of object { end_time, object, result, start_time }`6253 - `data: array of object { end_time, object, results, start_time }`

6254 6254 

6255 - `end_time: number`6255 - `end_time: number`

6256 6256 

6258 6258 

6259 - `"bucket"`6259 - `"bucket"`

6260 6260 

6261 - `result: 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 6 more`6261 - `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 6 more`

6262 6262 

6263 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`6263 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

6264 6264 

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

6266 6266 

6316 6316 

6317 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6317 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6318 6318 

6319 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`6319 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

6320 6320 

6321 The aggregated embeddings usage details of the specific time bucket.6321 The aggregated embeddings usage details of the specific time bucket.

6322 6322 

6348 6348 

6349 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6349 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6350 6350 

6351 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`6351 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

6352 6352 

6353 The aggregated moderations usage details of the specific time bucket.6353 The aggregated moderations usage details of the specific time bucket.

6354 6354 

6380 6380 

6381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6382 6382 

6383 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`6383 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

6384 6384 

6385 The aggregated images usage details of the specific time bucket.6385 The aggregated images usage details of the specific time bucket.

6386 6386 

6420 6420 

6421 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6421 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6422 6422 

6423 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`6423 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

6424 6424 

6425 The aggregated audio speeches usage details of the specific time bucket.6425 The aggregated audio speeches usage details of the specific time bucket.

6426 6426 

6452 6452 

6453 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6453 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6454 6454 

6455 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`6455 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

6456 6456 

6457 The aggregated audio transcriptions usage details of the specific time bucket.6457 The aggregated audio transcriptions usage details of the specific time bucket.

6458 6458 

6484 6484 

6485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6486 6486 

6487 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`6487 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

6488 6488 

6489 The aggregated vector stores usage details of the specific time bucket.6489 The aggregated vector stores usage details of the specific time bucket.

6490 6490 

6500 6500 

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

6502 6502 

6503 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`6503 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

6504 6504 

6505 The aggregated code interpreter sessions usage details of the specific time bucket.6505 The aggregated code interpreter sessions usage details of the specific time bucket.

6506 6506 

6507 - `object: "organization.usage.code_interpreter_sessions.result"`6507 - `num_sessions: number`

6508 6508 

6509 - `"organization.usage.code_interpreter_sessions.result"`6509 The number of code interpreter sessions.

6510 6510 

6511 - `num_sessions: optional number`6511 - `object: "organization.usage.code_interpreter_sessions.result"`

6512 6512 

6513 The number of code interpreter sessions.6513 - `"organization.usage.code_interpreter_sessions.result"`

6514 6514 

6515 - `project_id: optional string`6515 - `project_id: optional string`

6516 6516 

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

6518 6518 

6519 - `CostsResult object { object, amount, api_key_id, 2 more }`6519 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

6520 6520 

6521 The aggregated costs details of the specific time bucket.6521 The aggregated costs details of the specific time bucket.

6522 6522 

6562 6562 

6563- `UsageCostsResponse object { data, has_more, next_page, object }`6563- `UsageCostsResponse object { data, has_more, next_page, object }`

6564 6564 

6565 - `data: array of object { end_time, object, result, start_time }`6565 - `data: array of object { end_time, object, results, start_time }`

6566 6566 

6567 - `end_time: number`6567 - `end_time: number`

6568 6568 

6570 6570 

6571 - `"bucket"`6571 - `"bucket"`

6572 6572 

6573 - `result: 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 6 more`6573 - `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 6 more`

6574 6574 

6575 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`6575 - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`

6576 6576 

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

6578 6578 

6628 6628 

6629 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6629 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6630 6630 

6631 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`6631 - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`

6632 6632 

6633 The aggregated embeddings usage details of the specific time bucket.6633 The aggregated embeddings usage details of the specific time bucket.

6634 6634 

6660 6660 

6661 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6661 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6662 6662 

6663 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`6663 - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`

6664 6664 

6665 The aggregated moderations usage details of the specific time bucket.6665 The aggregated moderations usage details of the specific time bucket.

6666 6666 

6692 6692 

6693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6694 6694 

6695 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`6695 - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`

6696 6696 

6697 The aggregated images usage details of the specific time bucket.6697 The aggregated images usage details of the specific time bucket.

6698 6698 

6732 6732 

6733 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6733 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6734 6734 

6735 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`6735 - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`

6736 6736 

6737 The aggregated audio speeches usage details of the specific time bucket.6737 The aggregated audio speeches usage details of the specific time bucket.

6738 6738 

6764 6764 

6765 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6765 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6766 6766 

6767 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`6767 - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`

6768 6768 

6769 The aggregated audio transcriptions usage details of the specific time bucket.6769 The aggregated audio transcriptions usage details of the specific time bucket.

6770 6770 

6796 6796 

6797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.

6798 6798 

6799 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`6799 - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`

6800 6800 

6801 The aggregated vector stores usage details of the specific time bucket.6801 The aggregated vector stores usage details of the specific time bucket.

6802 6802 

6812 6812 

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

6814 6814 

6815 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`6815 - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`

6816 6816 

6817 The aggregated code interpreter sessions usage details of the specific time bucket.6817 The aggregated code interpreter sessions usage details of the specific time bucket.

6818 6818 

6819 - `object: "organization.usage.code_interpreter_sessions.result"`6819 - `num_sessions: number`

6820 6820 

6821 - `"organization.usage.code_interpreter_sessions.result"`6821 The number of code interpreter sessions.

6822 6822 

6823 - `num_sessions: optional number`6823 - `object: "organization.usage.code_interpreter_sessions.result"`

6824 6824 

6825 The number of code interpreter sessions.6825 - `"organization.usage.code_interpreter_sessions.result"`

6826 6826 

6827 - `project_id: optional string`6827 - `project_id: optional string`

6828 6828 

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

6830 6830 

6831 - `CostsResult object { object, amount, api_key_id, 2 more }`6831 - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`

6832 6832 

6833 The aggregated costs details of the specific time bucket.6833 The aggregated costs details of the specific time bucket.

6834 6834 

Details

30 30 

31 The Unix timestamp (in seconds) of when the user was added.31 The Unix timestamp (in seconds) of when the user was added.

32 32 

33 - `email: string`33 - `object: "organization.user"`

34 

35 The object type, which is always `organization.user`

36 

37 - `"organization.user"`

38 

39 - `api_key_last_used_at: optional number`

40 

41 The Unix timestamp (in seconds) of the user's last API key usage.

42 

43 - `created: optional number`

44 

45 The Unix timestamp (in seconds) of when the user was created.

46 

47 - `developer_persona: optional string`

48 

49 The developer persona metadata for the user.

50 

51 - `email: optional string`

34 52 

35 The email address of the user53 The email address of the user

36 54 

37 - `name: string`55 - `is_default: optional boolean`

56 

57 Whether this is the organization's default user.

58 

59 - `is_scale_tier_authorized_purchaser: optional boolean`

60 

61 Whether the user is an authorized purchaser for Scale Tier.

62 

63 - `is_scim_managed: optional boolean`

64 

65 Whether the user is managed through SCIM.

66 

67 - `is_service_account: optional boolean`

68 

69 Whether the user is a service account.

70 

71 - `name: optional string`

38 72 

39 The name of the user73 The name of the user

40 74 

41 - `object: "organization.user"`75 - `projects: optional object { data, object }`

42 76 

43 The object type, which is always `organization.user`77 Projects associated with the user, if included.

44 78 

45 - `"organization.user"`79 - `data: array of object { id, name, role }`

46 80 

47 - `role: "owner" or "reader"`81 - `id: optional string`

82 

83 - `name: optional string`

84 

85 - `role: optional string`

86 

87 - `object: "list"`

88 

89 - `"list"`

90 

91 - `role: optional string`

48 92 

49 `owner` or `reader`93 `owner` or `reader`

50 94 

51 - `"owner"`95 - `technical_level: optional string`

52 96 

53 - `"reader"`97 The technical level metadata for the user.

54 98 

55- `first_id: string`99 - `user: optional object { id, object, banned, 5 more }`

56 100 

57- `has_more: boolean`101 Nested user details.

58 102 

59- `last_id: string`103 - `id: string`

104 

105 - `object: "user"`

106 

107 - `"user"`

108 

109 - `banned: optional boolean`

110 

111 - `banned_at: optional number`

112 

113 - `email: optional string`

114 

115 - `enabled: optional boolean`

116 

117 - `name: optional string`

118 

119 - `picture: optional string`

120 

121- `has_more: boolean`

60 122 

61- `object: "list"`123- `object: "list"`

62 124 

63 - `"list"`125 - `"list"`

64 126 

127- `first_id: optional string`

128 

129- `last_id: optional string`

130 

65### Example131### Example

66 132 

67```http133```http

77 {143 {

78 "id": "id",144 "id": "id",

79 "added_at": 0,145 "added_at": 0,

146 "object": "organization.user",

147 "api_key_last_used_at": 0,

148 "created": 0,

149 "developer_persona": "developer_persona",

80 "email": "email",150 "email": "email",

151 "is_default": true,

152 "is_scale_tier_authorized_purchaser": true,

153 "is_scim_managed": true,

154 "is_service_account": true,

81 "name": "name",155 "name": "name",

82 "object": "organization.user",156 "projects": {

83 "role": "owner"157 "data": [

158 {

159 "id": "id",

160 "name": "name",

161 "role": "role"

84 }162 }

85 ],163 ],

86 "first_id": "first_id",

87 "has_more": true,

88 "last_id": "last_id",

89 "object": "list"164 "object": "list"

165 },

166 "role": "role",

167 "technical_level": "technical_level",

168 "user": {

169 "id": "id",

170 "object": "user",

171 "banned": true,

172 "banned_at": 0,

173 "email": "email",

174 "enabled": true,

175 "name": "name",

176 "picture": "picture"

177 }

178 }

179 ],

180 "has_more": true,

181 "object": "list",

182 "first_id": "first_id",

183 "last_id": "last_id"

90}184}

91```185```

92 186 

Details

10 10 

11### Returns11### Returns

12 12 

13- `OrganizationUser object { id, added_at, email, 3 more }`13- `OrganizationUser object { id, added_at, object, 13 more }`

14 14 

15 Represents an individual `user` within an organization.15 Represents an individual `user` within an organization.

16 16 

22 22 

23 The Unix timestamp (in seconds) of when the user was added.23 The Unix timestamp (in seconds) of when the user was added.

24 24 

25 - `email: string`25 - `object: "organization.user"`

26 

27 The object type, which is always `organization.user`

28 

29 - `"organization.user"`

30 

31 - `api_key_last_used_at: optional number`

32 

33 The Unix timestamp (in seconds) of the user's last API key usage.

34 

35 - `created: optional number`

36 

37 The Unix timestamp (in seconds) of when the user was created.

38 

39 - `developer_persona: optional string`

40 

41 The developer persona metadata for the user.

42 

43 - `email: optional string`

26 44 

27 The email address of the user45 The email address of the user

28 46 

29 - `name: string`47 - `is_default: optional boolean`

48 

49 Whether this is the organization's default user.

50 

51 - `is_scale_tier_authorized_purchaser: optional boolean`

52 

53 Whether the user is an authorized purchaser for Scale Tier.

54 

55 - `is_scim_managed: optional boolean`

56 

57 Whether the user is managed through SCIM.

58 

59 - `is_service_account: optional boolean`

60 

61 Whether the user is a service account.

62 

63 - `name: optional string`

30 64 

31 The name of the user65 The name of the user

32 66 

33 - `object: "organization.user"`67 - `projects: optional object { data, object }`

34 68 

35 The object type, which is always `organization.user`69 Projects associated with the user, if included.

36 70 

37 - `"organization.user"`71 - `data: array of object { id, name, role }`

72 

73 - `id: optional string`

38 74 

39 - `role: "owner" or "reader"`75 - `name: optional string`

76 

77 - `role: optional string`

78 

79 - `object: "list"`

80 

81 - `"list"`

82 

83 - `role: optional string`

40 84 

41 `owner` or `reader`85 `owner` or `reader`

42 86 

43 - `"owner"`87 - `technical_level: optional string`

88 

89 The technical level metadata for the user.

90 

91 - `user: optional object { id, object, banned, 5 more }`

92 

93 Nested user details.

94 

95 - `id: string`

96 

97 - `object: "user"`

98 

99 - `"user"`

100 

101 - `banned: optional boolean`

44 102 

45 - `"reader"`103 - `banned_at: optional number`

104 

105 - `email: optional string`

106 

107 - `enabled: optional boolean`

108 

109 - `name: optional string`

110 

111 - `picture: optional string`

46 112 

47### Example113### Example

48 114 

57{123{

58 "id": "id",124 "id": "id",

59 "added_at": 0,125 "added_at": 0,

126 "object": "organization.user",

127 "api_key_last_used_at": 0,

128 "created": 0,

129 "developer_persona": "developer_persona",

60 "email": "email",130 "email": "email",

131 "is_default": true,

132 "is_scale_tier_authorized_purchaser": true,

133 "is_scim_managed": true,

134 "is_service_account": true,

61 "name": "name",135 "name": "name",

62 "object": "organization.user",136 "projects": {

63 "role": "owner"137 "data": [

138 {

139 "id": "id",

140 "name": "name",

141 "role": "role"

142 }

143 ],

144 "object": "list"

145 },

146 "role": "role",

147 "technical_level": "technical_level",

148 "user": {

149 "id": "id",

150 "object": "user",

151 "banned": true,

152 "banned_at": 0,

153 "email": "email",

154 "enabled": true,

155 "name": "name",

156 "picture": "picture"

157 }

64}158}

65```159```

66 160 

Details

10 10 

11### Body Parameters11### Body Parameters

12 12 

13- `role: "owner" or "reader"`13- `developer_persona: optional string`

14 

15 Developer persona metadata.

16 

17- `role: optional string`

14 18 

15 `owner` or `reader`19 `owner` or `reader`

16 20 

17 - `"owner"`21- `role_id: optional string`

22 

23 Role ID to assign to the user.

24 

25- `technical_level: optional string`

18 26 

19 - `"reader"`27 Technical level metadata.

20 28 

21### Returns29### Returns

22 30 

23- `OrganizationUser object { id, added_at, email, 3 more }`31- `OrganizationUser object { id, added_at, object, 13 more }`

24 32 

25 Represents an individual `user` within an organization.33 Represents an individual `user` within an organization.

26 34 

32 40 

33 The Unix timestamp (in seconds) of when the user was added.41 The Unix timestamp (in seconds) of when the user was added.

34 42 

35 - `email: string`43 - `object: "organization.user"`

44 

45 The object type, which is always `organization.user`

46 

47 - `"organization.user"`

48 

49 - `api_key_last_used_at: optional number`

50 

51 The Unix timestamp (in seconds) of the user's last API key usage.

52 

53 - `created: optional number`

54 

55 The Unix timestamp (in seconds) of when the user was created.

56 

57 - `developer_persona: optional string`

58 

59 The developer persona metadata for the user.

60 

61 - `email: optional string`

36 62 

37 The email address of the user63 The email address of the user

38 64 

39 - `name: string`65 - `is_default: optional boolean`

66 

67 Whether this is the organization's default user.

68 

69 - `is_scale_tier_authorized_purchaser: optional boolean`

70 

71 Whether the user is an authorized purchaser for Scale Tier.

72 

73 - `is_scim_managed: optional boolean`

74 

75 Whether the user is managed through SCIM.

76 

77 - `is_service_account: optional boolean`

78 

79 Whether the user is a service account.

80 

81 - `name: optional string`

40 82 

41 The name of the user83 The name of the user

42 84 

43 - `object: "organization.user"`85 - `projects: optional object { data, object }`

44 86 

45 The object type, which is always `organization.user`87 Projects associated with the user, if included.

46 88 

47 - `"organization.user"`89 - `data: array of object { id, name, role }`

90 

91 - `id: optional string`

48 92 

49 - `role: "owner" or "reader"`93 - `name: optional string`

94 

95 - `role: optional string`

96 

97 - `object: "list"`

98 

99 - `"list"`

100 

101 - `role: optional string`

50 102 

51 `owner` or `reader`103 `owner` or `reader`

52 104 

53 - `"owner"`105 - `technical_level: optional string`

106 

107 The technical level metadata for the user.

108 

109 - `user: optional object { id, object, banned, 5 more }`

110 

111 Nested user details.

112 

113 - `id: string`

114 

115 - `object: "user"`

116 

117 - `"user"`

118 

119 - `banned: optional boolean`

120 

121 - `banned_at: optional number`

122 

123 - `email: optional string`

54 124 

55 - `"reader"`125 - `enabled: optional boolean`

126 

127 - `name: optional string`

128 

129 - `picture: optional string`

56 130 

57### Example131### Example

58 132 

60curl https://api.openai.com/v1/organization/users/$USER_ID \134curl https://api.openai.com/v1/organization/users/$USER_ID \

61 -H 'Content-Type: application/json' \135 -H 'Content-Type: application/json' \

62 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \136 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \

63 -d '{137 -d '{}'

64 "role": "owner"

65 }'

66```138```

67 139 

68#### Response140#### Response

71{143{

72 "id": "id",144 "id": "id",

73 "added_at": 0,145 "added_at": 0,

146 "object": "organization.user",

147 "api_key_last_used_at": 0,

148 "created": 0,

149 "developer_persona": "developer_persona",

74 "email": "email",150 "email": "email",

151 "is_default": true,

152 "is_scale_tier_authorized_purchaser": true,

153 "is_scim_managed": true,

154 "is_service_account": true,

75 "name": "name",155 "name": "name",

76 "object": "organization.user",156 "projects": {

77 "role": "owner"157 "data": [

158 {

159 "id": "id",

160 "name": "name",

161 "role": "role"

162 }

163 ],

164 "object": "list"

165 },

166 "role": "role",

167 "technical_level": "technical_level",

168 "user": {

169 "id": "id",

170 "object": "user",

171 "banned": true,

172 "banned_at": 0,

173 "email": "email",

174 "enabled": true,

175 "name": "name",

176 "picture": "picture"

177 }

78}178}

79```179```

80 180 

Details

68 68 

69 The Unix timestamp (in seconds) of when the user was added.69 The Unix timestamp (in seconds) of when the user was added.

70 70 

71 - `email: string`71 - `object: "organization.user"`

72 

73 The object type, which is always `organization.user`

74 

75 - `"organization.user"`

76 

77 - `api_key_last_used_at: optional number`

78 

79 The Unix timestamp (in seconds) of the user's last API key usage.

80 

81 - `created: optional number`

82 

83 The Unix timestamp (in seconds) of when the user was created.

84 

85 - `developer_persona: optional string`

86 

87 The developer persona metadata for the user.

88 

89 - `email: optional string`

72 90 

73 The email address of the user91 The email address of the user

74 92 

75 - `name: string`93 - `is_default: optional boolean`

94 

95 Whether this is the organization's default user.

96 

97 - `is_scale_tier_authorized_purchaser: optional boolean`

98 

99 Whether the user is an authorized purchaser for Scale Tier.

100 

101 - `is_scim_managed: optional boolean`

102 

103 Whether the user is managed through SCIM.

104 

105 - `is_service_account: optional boolean`

106 

107 Whether the user is a service account.

108 

109 - `name: optional string`

76 110 

77 The name of the user111 The name of the user

78 112 

79 - `object: "organization.user"`113 - `projects: optional object { data, object }`

80 114 

81 The object type, which is always `organization.user`115 Projects associated with the user, if included.

82 116 

83 - `"organization.user"`117 - `data: array of object { id, name, role }`

118 

119 - `id: optional string`

120 

121 - `name: optional string`

122 

123 - `role: optional string`

84 124 

85 - `role: "owner" or "reader"`125 - `object: "list"`

126 

127 - `"list"`

128 

129 - `role: optional string`

86 130 

87 `owner` or `reader`131 `owner` or `reader`

88 132 

89 - `"owner"`133 - `technical_level: optional string`

134 

135 The technical level metadata for the user.

136 

137 - `user: optional object { id, object, banned, 5 more }`

138 

139 Nested user details.

140 

141 - `id: string`

142 

143 - `object: "user"`

144 

145 - `"user"`

146 

147 - `banned: optional boolean`

148 

149 - `banned_at: optional number`

150 

151 - `email: optional string`

152 

153 - `enabled: optional boolean`

90 154 

91 - `"reader"`155 - `name: optional string`

156 

157 - `picture: optional string`

92 158 

93### Example159### Example

94 160 

120 "user": {186 "user": {

121 "id": "id",187 "id": "id",

122 "added_at": 0,188 "added_at": 0,

189 "object": "organization.user",

190 "api_key_last_used_at": 0,

191 "created": 0,

192 "developer_persona": "developer_persona",

123 "email": "email",193 "email": "email",

194 "is_default": true,

195 "is_scale_tier_authorized_purchaser": true,

196 "is_scim_managed": true,

197 "is_service_account": true,

124 "name": "name",198 "name": "name",

125 "object": "organization.user",199 "projects": {

126 "role": "owner"200 "data": [

201 {

202 "id": "id",

203 "name": "name",

204 "role": "role"

205 }

206 ],

207 "object": "list"

208 },

209 "role": "role",

210 "technical_level": "technical_level",

211 "user": {

212 "id": "id",

213 "object": "user",

214 "banned": true,

215 "banned_at": 0,

216 "email": "email",

217 "enabled": true,

218 "name": "name",

219 "picture": "picture"

220 }

127 }221 }

128}222}

129```223```