Reference 2026-09-03 23:00 UTC to 2026-09-04 23:59 UTC

16 16 

17### Body Parameters17### Body Parameters

18 18 

19- `expires_in_seconds: optional number or null`

20 

21 Number of seconds until the API key expires.

22 

19- `name: optional string`23- `name: optional string`

20 24 

21 API key name.25 API key name.

48 52 

49 The unredacted API key value.53 The unredacted API key value.

50 54 

55- `expires_at: optional number or null`

56 

57 The Unix timestamp (in seconds) when the API key expires, or null if it does not expire.

58 

51### Example59### Example

52 60 

53```http61```http

64 "created_at": 0,72 "created_at": 0,

65 "name": "name",73 "name": "name",

66 "object": "organization.project.service_account.api_key",74 "object": "organization.project.service_account.api_key",

67 "value": "value"75 "value": "value",

76 "expires_at": 0

68}77}

69```78```

70 79 

1# Transcription streaming events

2 

3> For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL.

4 

5## transcript.text.segment

6 

7Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](https://developers.openai.com/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`.

8 

9### Schema

10 

11Schema name: `TranscriptTextSegmentEvent`

12 

13```json

14{

15 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema)": {

16 "kind": "HttpDeclTypeAlias",

17 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent",

18 "docstring": "Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`.\n",

19 "ident": "TranscriptionTextSegmentEvent",

20 "type": {

21 "kind": "HttpTypeObject",

22 "members": [

23 {

24 "ident": "id"

25 },

26 {

27 "ident": "end"

28 },

29 {

30 "ident": "speaker"

31 },

32 {

33 "ident": "start"

34 },

35 {

36 "ident": "text"

37 },

38 {

39 "ident": "type"

40 }

41 ]

42 },

43 "childrenParentSchema": "object",

44 "children": [

45 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) id",

46 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) end",

47 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) speaker",

48 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) start",

49 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) text",

50 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) type"

51 ]

52 },

53 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) id": {

54 "kind": "HttpDeclProperty",

55 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/id",

56 "deprecated": false,

57 "key": "id",

58 "docstring": "Unique identifier for the segment.",

59 "type": {

60 "kind": "HttpTypeString"

61 },

62 "optional": false,

63 "nullable": false,

64 "schemaType": "string",

65 "children": []

66 },

67 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) end": {

68 "kind": "HttpDeclProperty",

69 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/end",

70 "deprecated": false,

71 "key": "end",

72 "docstring": "End timestamp of the segment in seconds.",

73 "type": {

74 "kind": "HttpTypeNumber"

75 },

76 "constraints": {

77 "format": "double"

78 },

79 "optional": false,

80 "nullable": false,

81 "schemaType": "number",

82 "children": []

83 },

84 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) speaker": {

85 "kind": "HttpDeclProperty",

86 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/speaker",

87 "deprecated": false,

88 "key": "speaker",

89 "docstring": "Speaker label for this segment.",

90 "type": {

91 "kind": "HttpTypeString"

92 },

93 "optional": false,

94 "nullable": false,

95 "schemaType": "string",

96 "children": []

97 },

98 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) start": {

99 "kind": "HttpDeclProperty",

100 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/start",

101 "deprecated": false,

102 "key": "start",

103 "docstring": "Start timestamp of the segment in seconds.",

104 "type": {

105 "kind": "HttpTypeNumber"

106 },

107 "constraints": {

108 "format": "double"

109 },

110 "optional": false,

111 "nullable": false,

112 "schemaType": "number",

113 "children": []

114 },

115 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) text": {

116 "kind": "HttpDeclProperty",

117 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/text",

118 "deprecated": false,

119 "key": "text",

120 "docstring": "Transcript text for this segment.",

121 "type": {

122 "kind": "HttpTypeString"

123 },

124 "optional": false,

125 "nullable": false,

126 "schemaType": "string",

127 "children": []

128 },

129 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) type": {

130 "kind": "HttpDeclProperty",

131 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/type",

132 "deprecated": false,

133 "key": "type",

134 "docstring": "The type of the event. Always `transcript.text.segment`.",

135 "type": {

136 "kind": "HttpTypeUnion",

137 "oasRef": "#/components/schemas/TranscriptTextSegmentEvent/properties/type",

138 "types": [

139 {

140 "kind": "HttpTypeLiteral",

141 "literal": "transcript.text.segment"

142 }

143 ]

144 },

145 "optional": false,

146 "nullable": false,

147 "schemaType": "enum",

148 "childrenParentSchema": "enum",

149 "children": [

150 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) type > (member) 0"

151 ]

152 },

153 "(resource) audio.transcriptions > (model) transcription_text_segment_event > (schema) > (property) type > (member) 0": {

154 "kind": "HttpDeclReference",

155 "type": {

156 "kind": "HttpTypeLiteral",

157 "literal": "transcript.text.segment"

158 }

159 }

160}

161```

162 

163### Example

164 

165```json

166{

167 "type": "transcript.text.segment",

168 "id": "seg_002",

169 "start": 5.2,

170 "end": 12.8,

171 "text": "Hi, I need help with diarization.",

172 "speaker": "A"

173}

174```

175 

176## transcript.text.delta

177 

178Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](https://developers.openai.com/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.

179 

180### Schema

181 

182Schema name: `TranscriptTextDeltaEvent`

183 

184```json

185{

186 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema)": {

187 "kind": "HttpDeclTypeAlias",

188 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent",

189 "docstring": "Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.",

190 "ident": "TranscriptionTextDeltaEvent",

191 "type": {

192 "kind": "HttpTypeObject",

193 "members": [

194 {

195 "ident": "delta"

196 },

197 {

198 "ident": "type"

199 },

200 {

201 "ident": "logprobs"

202 },

203 {

204 "ident": "segment_id"

205 }

206 ]

207 },

208 "childrenParentSchema": "object",

209 "children": [

210 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) delta",

211 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) type",

212 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs",

213 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) segment_id"

214 ]

215 },

216 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) delta": {

217 "kind": "HttpDeclProperty",

218 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/delta",

219 "deprecated": false,

220 "key": "delta",

221 "docstring": "The text delta that was additionally transcribed.\n",

222 "type": {

223 "kind": "HttpTypeString"

224 },

225 "optional": false,

226 "nullable": false,

227 "schemaType": "string",

228 "children": []

229 },

230 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) type": {

231 "kind": "HttpDeclProperty",

232 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/type",

233 "deprecated": false,

234 "key": "type",

235 "docstring": "The type of the event. Always `transcript.text.delta`.\n",

236 "type": {

237 "kind": "HttpTypeUnion",

238 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/type",

239 "types": [

240 {

241 "kind": "HttpTypeLiteral",

242 "literal": "transcript.text.delta"

243 }

244 ]

245 },

246 "optional": false,

247 "nullable": false,

248 "schemaType": "enum",

249 "childrenParentSchema": "enum",

250 "children": [

251 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) type > (member) 0"

252 ]

253 },

254 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs": {

255 "kind": "HttpDeclProperty",

256 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/logprobs",

257 "deprecated": false,

258 "key": "logprobs",

259 "docstring": "The log probabilities of the delta. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.\n",

260 "type": {

261 "kind": "HttpTypeArray",

262 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/logprobs",

263 "elementType": {

264 "kind": "HttpTypeObject",

265 "members": [

266 {

267 "ident": "token"

268 },

269 {

270 "ident": "bytes"

271 },

272 {

273 "ident": "logprob"

274 }

275 ]

276 }

277 },

278 "optional": true,

279 "nullable": false,

280 "schemaType": "array",

281 "childrenParentSchema": "object",

282 "children": [

283 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs > (items) > (property) token",

284 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs > (items) > (property) bytes",

285 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs > (items) > (property) logprob"

286 ]

287 },

288 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) segment_id": {

289 "kind": "HttpDeclProperty",

290 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/segment_id",

291 "deprecated": false,

292 "key": "segment_id",

293 "docstring": "Identifier of the diarized segment that this delta belongs to. Only present when using `gpt-4o-transcribe-diarize`.\n",

294 "type": {

295 "kind": "HttpTypeString"

296 },

297 "optional": true,

298 "nullable": false,

299 "schemaType": "string",

300 "children": []

301 },

302 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) type > (member) 0": {

303 "kind": "HttpDeclReference",

304 "type": {

305 "kind": "HttpTypeLiteral",

306 "literal": "transcript.text.delta"

307 }

308 },

309 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs > (items) > (property) token": {

310 "kind": "HttpDeclProperty",

311 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/logprobs/items/properties/token",

312 "deprecated": false,

313 "key": "token",

314 "docstring": "The token that was used to generate the log probability.\n",

315 "type": {

316 "kind": "HttpTypeString"

317 },

318 "optional": true,

319 "nullable": false,

320 "schemaType": "string",

321 "children": []

322 },

323 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs > (items) > (property) bytes": {

324 "kind": "HttpDeclProperty",

325 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/logprobs/items/properties/bytes",

326 "deprecated": false,

327 "key": "bytes",

328 "docstring": "The bytes that were used to generate the log probability.\n",

329 "type": {

330 "kind": "HttpTypeArray",

331 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/logprobs/items/properties/bytes",

332 "elementType": {

333 "kind": "HttpTypeNumber"

334 }

335 },

336 "optional": true,

337 "nullable": false,

338 "schemaType": "array",

339 "children": []

340 },

341 "(resource) audio.transcriptions > (model) transcription_text_delta_event > (schema) > (property) logprobs > (items) > (property) logprob": {

342 "kind": "HttpDeclProperty",

343 "oasRef": "#/components/schemas/TranscriptTextDeltaEvent/properties/logprobs/items/properties/logprob",

344 "deprecated": false,

345 "key": "logprob",

346 "docstring": "The log probability of the token.\n",

347 "type": {

348 "kind": "HttpTypeNumber"

349 },

350 "optional": true,

351 "nullable": false,

352 "schemaType": "number",

353 "children": []

354 }

355}

356```

357 

358### Example

359 

360```json

361{

362 "type": "transcript.text.delta",

363 "delta": " wonderful"

364}

365```

366 

367## transcript.text.done

368 

369Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](https://developers.openai.com/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.

370 

371### Schema

372 

373Schema name: `TranscriptTextDoneEvent`

374 

375```json

376{

377 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema)": {

378 "kind": "HttpDeclTypeAlias",

379 "oasRef": "#/components/schemas/TranscriptTextDoneEvent",

380 "docstring": "Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](/docs/api-reference/audio/create-transcription) with the `Stream` parameter set to `true`.",

381 "ident": "TranscriptionTextDoneEvent",

382 "type": {

383 "kind": "HttpTypeObject",

384 "members": [

385 {

386 "ident": "text"

387 },

388 {

389 "ident": "type"

390 },

391 {

392 "ident": "languages"

393 },

394 {

395 "ident": "logprobs"

396 },

397 {

398 "ident": "usage"

399 }

400 ]

401 },

402 "childrenParentSchema": "object",

403 "children": [

404 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) text",

405 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) type",

406 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) languages",

407 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs",

408 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage"

409 ]

410 },

411 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) text": {

412 "kind": "HttpDeclProperty",

413 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/text",

414 "deprecated": false,

415 "key": "text",

416 "docstring": "The text that was transcribed.\n",

417 "type": {

418 "kind": "HttpTypeString"

419 },

420 "optional": false,

421 "nullable": false,

422 "schemaType": "string",

423 "children": []

424 },

425 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) type": {

426 "kind": "HttpDeclProperty",

427 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/type",

428 "deprecated": false,

429 "key": "type",

430 "docstring": "The type of the event. Always `transcript.text.done`.\n",

431 "type": {

432 "kind": "HttpTypeUnion",

433 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/type",

434 "types": [

435 {

436 "kind": "HttpTypeLiteral",

437 "literal": "transcript.text.done"

438 }

439 ]

440 },

441 "optional": false,

442 "nullable": false,

443 "schemaType": "enum",

444 "childrenParentSchema": "enum",

445 "children": [

446 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) type > (member) 0"

447 ]

448 },

449 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) languages": {

450 "kind": "HttpDeclProperty",

451 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/languages",

452 "deprecated": false,

453 "key": "languages",

454 "docstring": "The languages detected in the audio. Returned by `gpt-transcribe`. An empty array indicates that no language could be reliably detected.\n",

455 "type": {

456 "kind": "HttpTypeArray",

457 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/languages",

458 "elementType": {

459 "kind": "HttpTypeReference",

460 "ident": "TranscriptionLanguage",

461 "$ref": "(resource) audio.transcriptions > (model) transcription_language > (schema)"

462 }

463 },

464 "optional": true,

465 "nullable": false,

466 "schemaType": "array",

467 "childrenParentSchema": "object",

468 "children": [

469 "(resource) audio.transcriptions > (model) transcription_language > (schema) > (property) code"

470 ]

471 },

472 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs": {

473 "kind": "HttpDeclProperty",

474 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/logprobs",

475 "deprecated": false,

476 "key": "logprobs",

477 "docstring": "The log probabilities of the individual tokens in the transcription. Only included if you [create a transcription](/docs/api-reference/audio/create-transcription) with the `include[]` parameter set to `logprobs`.\n",

478 "type": {

479 "kind": "HttpTypeArray",

480 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/logprobs",

481 "elementType": {

482 "kind": "HttpTypeObject",

483 "members": [

484 {

485 "ident": "token"

486 },

487 {

488 "ident": "bytes"

489 },

490 {

491 "ident": "logprob"

492 }

493 ]

494 }

495 },

496 "optional": true,

497 "nullable": false,

498 "schemaType": "array",

499 "childrenParentSchema": "object",

500 "children": [

501 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs > (items) > (property) token",

502 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs > (items) > (property) bytes",

503 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs > (items) > (property) logprob"

504 ]

505 },

506 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage": {

507 "kind": "HttpDeclProperty",

508 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/usage",

509 "deprecated": false,

510 "key": "usage",

511 "docstring": "Usage statistics for models billed by token usage.",

512 "title": "Token Usage",

513 "type": {

514 "kind": "HttpTypeObject",

515 "members": [

516 {

517 "ident": "input_tokens"

518 },

519 {

520 "ident": "output_tokens"

521 },

522 {

523 "ident": "total_tokens"

524 },

525 {

526 "ident": "type"

527 },

528 {

529 "ident": "input_token_details"

530 }

531 ]

532 },

533 "optional": true,

534 "nullable": false,

535 "schemaType": "object",

536 "childrenParentSchema": "object",

537 "children": [

538 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_tokens",

539 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) output_tokens",

540 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) total_tokens",

541 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) type",

542 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_token_details"

543 ]

544 },

545 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) type > (member) 0": {

546 "kind": "HttpDeclReference",

547 "type": {

548 "kind": "HttpTypeLiteral",

549 "literal": "transcript.text.done"

550 }

551 },

552 "(resource) audio.transcriptions > (model) transcription_language > (schema) > (property) code": {

553 "kind": "HttpDeclProperty",

554 "oasRef": "#/components/schemas/TranscriptionLanguage/properties/code",

555 "deprecated": false,

556 "key": "code",

557 "docstring": "The code of a language detected in the audio.",

558 "type": {

559 "kind": "HttpTypeString"

560 },

561 "optional": false,

562 "nullable": false,

563 "schemaType": "string",

564 "children": []

565 },

566 "(resource) audio.transcriptions > (model) transcription_language > (schema)": {

567 "kind": "HttpDeclTypeAlias",

568 "oasRef": "#/components/schemas/TranscriptionLanguage",

569 "docstring": "A language detected in transcribed audio.",

570 "ident": "TranscriptionLanguage",

571 "type": {

572 "kind": "HttpTypeObject",

573 "members": [

574 {

575 "ident": "code"

576 }

577 ]

578 },

579 "childrenParentSchema": "object",

580 "children": [

581 "(resource) audio.transcriptions > (model) transcription_language > (schema) > (property) code"

582 ]

583 },

584 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs > (items) > (property) token": {

585 "kind": "HttpDeclProperty",

586 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/logprobs/items/properties/token",

587 "deprecated": false,

588 "key": "token",

589 "docstring": "The token that was used to generate the log probability.\n",

590 "type": {

591 "kind": "HttpTypeString"

592 },

593 "optional": true,

594 "nullable": false,

595 "schemaType": "string",

596 "children": []

597 },

598 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs > (items) > (property) bytes": {

599 "kind": "HttpDeclProperty",

600 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/logprobs/items/properties/bytes",

601 "deprecated": false,

602 "key": "bytes",

603 "docstring": "The bytes that were used to generate the log probability.\n",

604 "type": {

605 "kind": "HttpTypeArray",

606 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/logprobs/items/properties/bytes",

607 "elementType": {

608 "kind": "HttpTypeNumber"

609 }

610 },

611 "optional": true,

612 "nullable": false,

613 "schemaType": "array",

614 "children": []

615 },

616 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) logprobs > (items) > (property) logprob": {

617 "kind": "HttpDeclProperty",

618 "oasRef": "#/components/schemas/TranscriptTextDoneEvent/properties/logprobs/items/properties/logprob",

619 "deprecated": false,

620 "key": "logprob",

621 "docstring": "The log probability of the token.\n",

622 "type": {

623 "kind": "HttpTypeNumber"

624 },

625 "optional": true,

626 "nullable": false,

627 "schemaType": "number",

628 "children": []

629 },

630 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_tokens": {

631 "kind": "HttpDeclProperty",

632 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_tokens",

633 "deprecated": false,

634 "key": "input_tokens",

635 "docstring": "Number of input tokens billed for this request.",

636 "type": {

637 "kind": "HttpTypeNumber"

638 },

639 "optional": false,

640 "nullable": false,

641 "schemaType": "integer",

642 "children": []

643 },

644 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) output_tokens": {

645 "kind": "HttpDeclProperty",

646 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/output_tokens",

647 "deprecated": false,

648 "key": "output_tokens",

649 "docstring": "Number of output tokens generated.",

650 "type": {

651 "kind": "HttpTypeNumber"

652 },

653 "optional": false,

654 "nullable": false,

655 "schemaType": "integer",

656 "children": []

657 },

658 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) total_tokens": {

659 "kind": "HttpDeclProperty",

660 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/total_tokens",

661 "deprecated": false,

662 "key": "total_tokens",

663 "docstring": "Total number of tokens used (input + output).",

664 "type": {

665 "kind": "HttpTypeNumber"

666 },

667 "optional": false,

668 "nullable": false,

669 "schemaType": "integer",

670 "children": []

671 },

672 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) type": {

673 "kind": "HttpDeclProperty",

674 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/type",

675 "deprecated": false,

676 "key": "type",

677 "docstring": "The type of the usage object. Always `tokens` for this variant.",

678 "type": {

679 "kind": "HttpTypeUnion",

680 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/type",

681 "types": [

682 {

683 "kind": "HttpTypeLiteral",

684 "literal": "tokens"

685 }

686 ]

687 },

688 "optional": false,

689 "nullable": false,

690 "schemaType": "enum",

691 "childrenParentSchema": "enum",

692 "children": [

693 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) type > (member) 0"

694 ]

695 },

696 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_token_details": {

697 "kind": "HttpDeclProperty",

698 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details",

699 "deprecated": false,

700 "key": "input_token_details",

701 "docstring": "Details about the input tokens billed for this request.",

702 "type": {

703 "kind": "HttpTypeObject",

704 "members": [

705 {

706 "ident": "audio_tokens"

707 },

708 {

709 "ident": "text_tokens"

710 }

711 ]

712 },

713 "optional": true,

714 "nullable": false,

715 "schemaType": "object",

716 "childrenParentSchema": "object",

717 "children": [

718 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_token_details > (property) audio_tokens",

719 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_token_details > (property) text_tokens"

720 ]

721 },

722 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) type > (member) 0": {

723 "kind": "HttpDeclReference",

724 "type": {

725 "kind": "HttpTypeLiteral",

726 "literal": "tokens"

727 }

728 },

729 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_token_details > (property) audio_tokens": {

730 "kind": "HttpDeclProperty",

731 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details/properties/audio_tokens",

732 "deprecated": false,

733 "key": "audio_tokens",

734 "docstring": "Number of audio tokens billed for this request.",

735 "type": {

736 "kind": "HttpTypeNumber"

737 },

738 "optional": true,

739 "nullable": false,

740 "schemaType": "integer",

741 "children": []

742 },

743 "(resource) audio.transcriptions > (model) transcription_text_done_event > (schema) > (property) usage > (property) input_token_details > (property) text_tokens": {

744 "kind": "HttpDeclProperty",

745 "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details/properties/text_tokens",

746 "deprecated": false,

747 "key": "text_tokens",

748 "docstring": "Number of text tokens billed for this request.",

749 "type": {

750 "kind": "HttpTypeNumber"

751 },

752 "optional": true,

753 "nullable": false,

754 "schemaType": "integer",

755 "children": []

756 }

757}

758```

759 

760### Example

761 

762```json

763{

764 "type": "transcript.text.done",

765 "text": "I see skies of blue and clouds of white, the bright blessed days, the dark sacred nights, and I think to myself, what a wonderful world.",

766 "usage": {

767 "type": "tokens",

768 "input_tokens": 14,

769 "input_token_details": {

770 "text_tokens": 10,

771 "audio_tokens": 4

772 },

773 "output_tokens": 31,

774 "total_tokens": 45

775 }

776}

777```

1070 1070 

1071 The URL of the page searched for the pattern.1071 The URL of the page searched for the pattern.

1072 1072 

1073 - `status: "in_progress" or "searching" or "completed" or "failed"`1073 - `status: "in_progress" or "searching" or "completed" or 2 more`

1074 1074 

1075 The status of the web search tool call.1075 The status of the web search tool call.

1076 1076 

1082 1082 

1083 - `"failed"`1083 - `"failed"`

1084 1084 

1085 - `"incomplete"`

1086 

1085 - `type: "web_search_call"`1087 - `type: "web_search_call"`

1086 1088 

1087 The type of the web search tool call. Always `web_search_call`.1089 The type of the web search tool call. Always `web_search_call`.

5892 5894 

5893 The URL of the page searched for the pattern.5895 The URL of the page searched for the pattern.

5894 5896 

5895 - `status: "in_progress" or "searching" or "completed" or "failed"`5897 - `status: "in_progress" or "searching" or "completed" or 2 more`

5896 5898 

5897 The status of the web search tool call.5899 The status of the web search tool call.

5898 5900 

5904 5906 

5905 - `"failed"`5907 - `"failed"`

5906 5908 

5909 - `"incomplete"`

5910 

5907 - `type: "web_search_call"`5911 - `type: "web_search_call"`

5908 5912 

5909 The type of the web search tool call. Always `web_search_call`.5913 The type of the web search tool call. Always `web_search_call`.

1161 1161 

1162 The URL of the page searched for the pattern.1162 The URL of the page searched for the pattern.

1163 1163 

1164 - `status: "in_progress" or "searching" or "completed" or "failed"`1164 - `status: "in_progress" or "searching" or "completed" or 2 more`

1165 1165 

1166 The status of the web search tool call.1166 The status of the web search tool call.

1167 1167 

1173 1173 

1174 - `"failed"`1174 - `"failed"`

1175 1175 

1176 - `"incomplete"`

1177 

1176 - `type: "web_search_call"`1178 - `type: "web_search_call"`

1177 1179 

1178 The type of the web search tool call. Always `web_search_call`.1180 The type of the web search tool call. Always `web_search_call`.

8610 8612 

8611 The URL of the page searched for the pattern.8613 The URL of the page searched for the pattern.

8612 8614 

8613 - `status: "in_progress" or "searching" or "completed" or "failed"`8615 - `status: "in_progress" or "searching" or "completed" or 2 more`

8614 8616 

8615 The status of the web search tool call.8617 The status of the web search tool call.

8616 8618 

8622 8624 

8623 - `"failed"`8625 - `"failed"`

8624 8626 

8627 - `"incomplete"`

8628 

8625 - `type: "web_search_call"`8629 - `type: "web_search_call"`

8626 8630 

8627 The type of the web search tool call. Always `web_search_call`.8631 The type of the web search tool call. Always `web_search_call`.

1021 1021 

1022 The URL of the page searched for the pattern.1022 The URL of the page searched for the pattern.

1023 1023 

1024 - `status: "in_progress" or "searching" or "completed" or "failed"`1024 - `status: "in_progress" or "searching" or "completed" or 2 more`

1025 1025 

1026 The status of the web search tool call.1026 The status of the web search tool call.

1027 1027 

1033 1033 

1034 - `"failed"`1034 - `"failed"`

1035 1035 

1036 - `"incomplete"`

1037 

1036 - `type: "web_search_call"`1038 - `type: "web_search_call"`

1037 1039 

1038 The type of the web search tool call. Always `web_search_call`.1040 The type of the web search tool call. Always `web_search_call`.

5536 5538 

5537 Whether to store the generated model response for later retrieval via5539 Whether to store the generated model response for later retrieval via

5538 API.5540 API.

5541 Defaults to true when omitted.

5542 If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](/api/docs/guides/your-data#v1responses).

5539 5543 

5540- `stream: optional boolean or null`5544- `stream: optional boolean or null`

5541 5545 

7957 7961 

7958 The URL of the page searched for the pattern.7962 The URL of the page searched for the pattern.

7959 7963 

7960 - `status: "in_progress" or "searching" or "completed" or "failed"`7964 - `status: "in_progress" or "searching" or "completed" or 2 more`

7961 7965 

7962 The status of the web search tool call.7966 The status of the web search tool call.

7963 7967 

7969 7973 

7970 - `"failed"`7974 - `"failed"`

7971 7975 

7976 - `"incomplete"`

7977 

7972 - `type: "web_search_call"`7978 - `type: "web_search_call"`

7973 7979 

7974 The type of the web search tool call. Always `web_search_call`.7980 The type of the web search tool call. Always `web_search_call`.

12779 12785 

12780 The URL of the page searched for the pattern.12786 The URL of the page searched for the pattern.

12781 12787 

12782 - `status: "in_progress" or "searching" or "completed" or "failed"`12788 - `status: "in_progress" or "searching" or "completed" or 2 more`

12783 12789 

12784 The status of the web search tool call.12790 The status of the web search tool call.

12785 12791 

12791 12797 

12792 - `"failed"`12798 - `"failed"`

12793 12799 

12800 - `"incomplete"`

12801 

12794 - `type: "web_search_call"`12802 - `type: "web_search_call"`

12795 12803 

12796 The type of the web search tool call. Always `web_search_call`.12804 The type of the web search tool call. Always `web_search_call`.

1114 1114 

1115 The URL of the page searched for the pattern.1115 The URL of the page searched for the pattern.

1116 1116 

1117 - `status: "in_progress" or "searching" or "completed" or "failed"`1117 - `status: "in_progress" or "searching" or "completed" or 2 more`

1118 1118 

1119 The status of the web search tool call.1119 The status of the web search tool call.

1120 1120 

1126 1126 

1127 - `"failed"`1127 - `"failed"`

1128 1128 

1129 - `"incomplete"`

1130 

1129 - `type: "web_search_call"`1131 - `type: "web_search_call"`

1130 1132 

1131 The type of the web search tool call. Always `web_search_call`.1133 The type of the web search tool call. Always `web_search_call`.

5936 5938 

5937 The URL of the page searched for the pattern.5939 The URL of the page searched for the pattern.

5938 5940 

5939 - `status: "in_progress" or "searching" or "completed" or "failed"`5941 - `status: "in_progress" or "searching" or "completed" or 2 more`

5940 5942 

5941 The status of the web search tool call.5943 The status of the web search tool call.

5942 5944 

5948 5950 

5949 - `"failed"`5951 - `"failed"`

5950 5952 

5953 - `"incomplete"`

5954 

5951 - `type: "web_search_call"`5955 - `type: "web_search_call"`

5952 5956 

5953 The type of the web search tool call. Always `web_search_call`.5957 The type of the web search tool call. Always `web_search_call`.

941 941 

942 The URL of the page searched for the pattern.942 The URL of the page searched for the pattern.

943 943 

944 - `status: "in_progress" or "searching" or "completed" or "failed"`944 - `status: "in_progress" or "searching" or "completed" or 2 more`

945 945 

946 The status of the web search tool call.946 The status of the web search tool call.

947 947 

953 953 

954 - `"failed"`954 - `"failed"`

955 955 

956 - `"incomplete"`

957 

956 - `type: "web_search_call"`958 - `type: "web_search_call"`

957 959 

958 The type of the web search tool call. Always `web_search_call`.960 The type of the web search tool call. Always `web_search_call`.

962 962 

963 The URL of the page searched for the pattern.963 The URL of the page searched for the pattern.

964 964 

965 - `status: "in_progress" or "searching" or "completed" or "failed"`965 - `status: "in_progress" or "searching" or "completed" or 2 more`

966 966 

967 The status of the web search tool call.967 The status of the web search tool call.

968 968 

974 974 

975 - `"failed"`975 - `"failed"`

976 976 

977 - `"incomplete"`

978 

977 - `type: "web_search_call"`979 - `type: "web_search_call"`

978 980 

979 The type of the web search tool call. Always `web_search_call`.981 The type of the web search tool call. Always `web_search_call`.

889 889 

890 The URL of the page searched for the pattern.890 The URL of the page searched for the pattern.

891 891 

892 - `status: "in_progress" or "searching" or "completed" or "failed"`892 - `status: "in_progress" or "searching" or "completed" or 2 more`

893 893 

894 The status of the web search tool call.894 The status of the web search tool call.

895 895 

901 901 

902 - `"failed"`902 - `"failed"`

903 903 

904 - `"incomplete"`

905 

904 - `type: "web_search_call"`906 - `type: "web_search_call"`

905 907 

906 The type of the web search tool call. Always `web_search_call`.908 The type of the web search tool call. Always `web_search_call`.

916 916 

917 The URL of the page searched for the pattern.917 The URL of the page searched for the pattern.

918 918 

919 - `status: "in_progress" or "searching" or "completed" or "failed"`919 - `status: "in_progress" or "searching" or "completed" or 2 more`

920 920 

921 The status of the web search tool call.921 The status of the web search tool call.

922 922 

928 928 

929 - `"failed"`929 - `"failed"`

930 930 

931 - `"incomplete"`

932 

931 - `type: "web_search_call"`933 - `type: "web_search_call"`

932 934 

933 The type of the web search tool call. Always `web_search_call`.935 The type of the web search tool call. Always `web_search_call`.

4908 4910 

4909 The URL of the page searched for the pattern.4911 The URL of the page searched for the pattern.

4910 4912 

4911 - `status: "in_progress" or "searching" or "completed" or "failed"`4913 - `status: "in_progress" or "searching" or "completed" or 2 more`

4912 4914 

4913 The status of the web search tool call.4915 The status of the web search tool call.

4914 4916 

4920 4922 

4921 - `"failed"`4923 - `"failed"`

4922 4924 

4925 - `"incomplete"`

4926 

4923 - `type: "web_search_call"`4927 - `type: "web_search_call"`

4924 4928 

4925 The type of the web search tool call. Always `web_search_call`.4929 The type of the web search tool call. Always `web_search_call`.

749 749 

750 The URL of the page searched for the pattern.750 The URL of the page searched for the pattern.

751 751 

752 - `status: "in_progress" or "searching" or "completed" or "failed"`752 - `status: "in_progress" or "searching" or "completed" or 2 more`

753 753 

754 The status of the web search tool call.754 The status of the web search tool call.

755 755 

761 761 

762 - `"failed"`762 - `"failed"`

763 763 

764 - `"incomplete"`

765 

764 - `type: "web_search_call"`766 - `type: "web_search_call"`

765 767 

766 The type of the web search tool call. Always `web_search_call`.768 The type of the web search tool call. Always `web_search_call`.

720 720 

721 The URL of the page searched for the pattern.721 The URL of the page searched for the pattern.

722 722 

723 - `status: "in_progress" or "searching" or "completed" or "failed"`723 - `status: "in_progress" or "searching" or "completed" or 2 more`

724 724 

725 The status of the web search tool call.725 The status of the web search tool call.

726 726 

732 732 

733 - `"failed"`733 - `"failed"`

734 734 

735 - `"incomplete"`

736 

735 - `type: "web_search_call"`737 - `type: "web_search_call"`

736 738 

737 The type of the web search tool call. Always `web_search_call`.739 The type of the web search tool call. Always `web_search_call`.

1024 1024 

1025 The URL of the page searched for the pattern.1025 The URL of the page searched for the pattern.

1026 1026 

1027 - `status: "in_progress" or "searching" or "completed" or "failed"`1027 - `status: "in_progress" or "searching" or "completed" or 2 more`

1028 1028 

1029 The status of the web search tool call.1029 The status of the web search tool call.

1030 1030 

1036 1036 

1037 - `"failed"`1037 - `"failed"`

1038 1038 

1039 - `"incomplete"`

1040 

1039 - `type: "web_search_call"`1041 - `type: "web_search_call"`

1040 1042 

1041 The type of the web search tool call. Always `web_search_call`.1043 The type of the web search tool call. Always `web_search_call`.

4874 4876 

4875 The URL of the page searched for the pattern.4877 The URL of the page searched for the pattern.

4876 4878 

4877 - `status: "in_progress" or "searching" or "completed" or "failed"`4879 - `status: "in_progress" or "searching" or "completed" or 2 more`

4878 4880 

4879 The status of the web search tool call.4881 The status of the web search tool call.

4880 4882 

4886 4888 

4887 - `"failed"`4889 - `"failed"`

4888 4890 

4891 - `"incomplete"`

4892 

4889 - `type: "web_search_call"`4893 - `type: "web_search_call"`

4890 4894 

4891 The type of the web search tool call. Always `web_search_call`.4895 The type of the web search tool call. Always `web_search_call`.

1115 1115 

1116 The URL of the page searched for the pattern.1116 The URL of the page searched for the pattern.

1117 1117 

1118 - `status: "in_progress" or "searching" or "completed" or "failed"`1118 - `status: "in_progress" or "searching" or "completed" or 2 more`

1119 1119 

1120 The status of the web search tool call.1120 The status of the web search tool call.

1121 1121 

1127 1127 

1128 - `"failed"`1128 - `"failed"`

1129 1129 

1130 - `"incomplete"`

1131 

1130 - `type: "web_search_call"`1132 - `type: "web_search_call"`

1131 1133 

1132 The type of the web search tool call. Always `web_search_call`.1134 The type of the web search tool call. Always `web_search_call`.

7272 7274 

7273 The URL of the page searched for the pattern.7275 The URL of the page searched for the pattern.

7274 7276 

7275 - `status: "in_progress" or "searching" or "completed" or "failed"`7277 - `status: "in_progress" or "searching" or "completed" or 2 more`

7276 7278 

7277 The status of the web search tool call.7279 The status of the web search tool call.

7278 7280 

7284 7286 

7285 - `"failed"`7287 - `"failed"`

7286 7288 

7289 - `"incomplete"`

7290 

7287 - `type: "web_search_call"`7291 - `type: "web_search_call"`

7288 7292 

7289 The type of the web search tool call. Always `web_search_call`.7293 The type of the web search tool call. Always `web_search_call`.

975 975 

976 The URL of the page searched for the pattern.976 The URL of the page searched for the pattern.

977 977 

978 - `status: "in_progress" or "searching" or "completed" or "failed"`978 - `status: "in_progress" or "searching" or "completed" or 2 more`

979 979 

980 The status of the web search tool call.980 The status of the web search tool call.

981 981 

987 987 

988 - `"failed"`988 - `"failed"`

989 989 

990 - `"incomplete"`

991 

990 - `type: "web_search_call"`992 - `type: "web_search_call"`

991 993 

992 The type of the web search tool call. Always `web_search_call`.994 The type of the web search tool call. Always `web_search_call`.

4753 4755 

4754 Whether to store the generated model response for later retrieval via4756 Whether to store the generated model response for later retrieval via

4755 API.4757 API.

4758 Defaults to true when omitted.

4759 If set to true, response data will be stored for at least 30 days, subject to the [data retention exceptions](/api/docs/guides/your-data#v1responses).

4756 4760 

4757- `stream: optional boolean or null`4761- `stream: optional boolean or null`

4758 4762 

6954 6958 

6955 The URL of the page searched for the pattern.6959 The URL of the page searched for the pattern.

6956 6960 

6957 - `status: "in_progress" or "searching" or "completed" or "failed"`6961 - `status: "in_progress" or "searching" or "completed" or 2 more`

6958 6962 

6959 The status of the web search tool call.6963 The status of the web search tool call.

6960 6964 

6966 6970 

6967 - `"failed"`6971 - `"failed"`

6968 6972 

6973 - `"incomplete"`

6974 

6969 - `type: "web_search_call"`6975 - `type: "web_search_call"`

6970 6976 

6971 The type of the web search tool call. Always `web_search_call`.6977 The type of the web search tool call. Always `web_search_call`.

10804 10810 

10805 The URL of the page searched for the pattern.10811 The URL of the page searched for the pattern.

10806 10812 

10807 - `status: "in_progress" or "searching" or "completed" or "failed"`10813 - `status: "in_progress" or "searching" or "completed" or 2 more`

10808 10814 

10809 The status of the web search tool call.10815 The status of the web search tool call.

10810 10816 

10816 10822 

10817 - `"failed"`10823 - `"failed"`

10818 10824 

10825 - `"incomplete"`

10826 

10819 - `type: "web_search_call"`10827 - `type: "web_search_call"`

10820 10828 

10821 The type of the web search tool call. Always `web_search_call`.10829 The type of the web search tool call. Always `web_search_call`.

1068 1068 

1069 The URL of the page searched for the pattern.1069 The URL of the page searched for the pattern.

1070 1070 

1071 - `status: "in_progress" or "searching" or "completed" or "failed"`1071 - `status: "in_progress" or "searching" or "completed" or 2 more`

1072 1072 

1073 The status of the web search tool call.1073 The status of the web search tool call.

1074 1074 

1080 1080 

1081 - `"failed"`1081 - `"failed"`

1082 1082 

1083 - `"incomplete"`

1084 

1083 - `type: "web_search_call"`1085 - `type: "web_search_call"`

1084 1086 

1085 The type of the web search tool call. Always `web_search_call`.1087 The type of the web search tool call. Always `web_search_call`.

4918 4920 

4919 The URL of the page searched for the pattern.4921 The URL of the page searched for the pattern.

4920 4922 

4921 - `status: "in_progress" or "searching" or "completed" or "failed"`4923 - `status: "in_progress" or "searching" or "completed" or 2 more`

4922 4924 

4923 The status of the web search tool call.4925 The status of the web search tool call.

4924 4926 

4930 4932 

4931 - `"failed"`4933 - `"failed"`

4932 4934 

4935 - `"incomplete"`

4936 

4933 - `type: "web_search_call"`4937 - `type: "web_search_call"`

4934 4938 

4935 The type of the web search tool call. Always `web_search_call`.4939 The type of the web search tool call. Always `web_search_call`.

895 895 

896 The URL of the page searched for the pattern.896 The URL of the page searched for the pattern.

897 897 

898 - `status: "in_progress" or "searching" or "completed" or "failed"`898 - `status: "in_progress" or "searching" or "completed" or 2 more`

899 899 

900 The status of the web search tool call.900 The status of the web search tool call.

901 901 

907 907 

908 - `"failed"`908 - `"failed"`

909 909 

910 - `"incomplete"`

911 

910 - `type: "web_search_call"`912 - `type: "web_search_call"`

911 913 

912 The type of the web search tool call. Always `web_search_call`.914 The type of the web search tool call. Always `web_search_call`.

916 916 

917 The URL of the page searched for the pattern.917 The URL of the page searched for the pattern.

918 918 

919 - `status: "in_progress" or "searching" or "completed" or "failed"`919 - `status: "in_progress" or "searching" or "completed" or 2 more`

920 920 

921 The status of the web search tool call.921 The status of the web search tool call.

922 922 

928 928 

929 - `"failed"`929 - `"failed"`

930 930 

931 - `"incomplete"`

932 

931 - `type: "web_search_call"`933 - `type: "web_search_call"`

932 934 

933 The type of the web search tool call. Always `web_search_call`.935 The type of the web search tool call. Always `web_search_call`.