SpyBara
Go Premium

Reference 2026-07-25 05:59 UTC to 2026-07-29 15:02 UTC

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

1# Administration Overview1# Administration Overview

2 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 

3Use the Administration API to manage organization resources such as users, invites, projects, API keys, and audit logs.5Use the Administration API to manage organization resources such as users, invites, projects, API keys, and audit logs.

4To access these endpoints, [create an Admin API key](https://platform.openai.com/settings/organization/admin-keys). Admin API keys cannot be used for non-administration endpoints.6To access these endpoints, [create an Admin API key](https://platform.openai.com/settings/organization/admin-keys). Admin API keys cannot be used for non-administration endpoints.

5 7 

Details

1# Chat Completions Overview1# Chat Completions Overview

2 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 

3The Chat Completions API endpoint will generate a model response from a5The Chat Completions API endpoint will generate a model response from a

4list of messages comprising a conversation.6list of messages comprising a conversation.

5 7 

overview.md +2 −0

Details

1# API Overview1# API Overview

2 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 

3Use this reference to look up OpenAI API endpoints, request and response5Use this reference to look up OpenAI API endpoints, request and response

4schemas, streaming events, client library methods, and shared behavior such as6schemas, streaming events, client library methods, and shared behavior such as

5authentication, errors, rate limits, and request IDs.7authentication, errors, rate limits, and request IDs.

Details

1# Realtime Beta Overview1# Realtime Beta Overview

2 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 

3Communicate with a multimodal model in real time over low latency interfaces like WebRTC, WebSocket, and SIP. Natively supports speech-to-speech as well as text, image, and audio inputs and outputs.5Communicate with a multimodal model in real time over low latency interfaces like WebRTC, WebSocket, and SIP. Natively supports speech-to-speech as well as text, image, and audio inputs and outputs.

4[Learn more about the Realtime API](https://developers.openai.com/docs/guides/realtime).6[Learn more about the Realtime API](https://developers.openai.com/docs/guides/realtime).

Details

22 22 

23 - `"USD"`23 - `"USD"`

24 24 

25 The currency for the threshold amount. Currently, only `USD` is supported.

26 

27 - `"USD"`25 - `"USD"`

28 26 

29 - `enforcement: object { status }`27 - `enforcement: object { status }`


52 50 

53 - `"month"`51 - `"month"`

54 52 

55 The time interval for evaluating spend against the threshold. Currently, only `month` is supported.

56 

57 - `"month"`53 - `"month"`

58 54 

59 - `object: "project.spend_limit"`55 - `object: "project.spend_limit"`

Details

40 40 

41 - `"USD"`41 - `"USD"`

42 42 

43 The currency for the threshold amount. Currently, only `USD` is supported.

44 

45 - `"USD"`43 - `"USD"`

46 44 

47 - `enforcement: object { status }`45 - `enforcement: object { status }`


70 68 

71 - `"month"`69 - `"month"`

72 70 

73 The time interval for evaluating spend against the threshold. Currently, only `month` is supported.

74 

75 - `"month"`71 - `"month"`

76 72 

77 - `object: "project.spend_limit"`73 - `object: "project.spend_limit"`

Details

18 18 

19 - `"USD"`19 - `"USD"`

20 20 

21 The currency for the threshold amount. Currently, only `USD` is supported.

22 

23 - `"USD"`21 - `"USD"`

24 22 

25 - `enforcement: object { status }`23 - `enforcement: object { status }`


48 46 

49 - `"month"`47 - `"month"`

50 48 

51 The time interval for evaluating spend against the threshold. Currently, only `month` is supported.

52 

53 - `"month"`49 - `"month"`

54 50 

55 - `object: "organization.spend_limit"`51 - `object: "organization.spend_limit"`

Details

36 36 

37 - `"USD"`37 - `"USD"`

38 38 

39 The currency for the threshold amount. Currently, only `USD` is supported.

40 

41 - `"USD"`39 - `"USD"`

42 40 

43 - `enforcement: object { status }`41 - `enforcement: object { status }`


66 64 

67 - `"month"`65 - `"month"`

68 66 

69 The time interval for evaluating spend against the threshold. Currently, only `month` is supported.

70 

71 - `"month"`67 - `"month"`

72 68 

73 - `object: "organization.spend_limit"`69 - `object: "organization.spend_limit"`

Details

9 9 

10### Returns10### Returns

11 11 

12- `Transcription object { text, logprobs, usage }`12- `Transcription object { text, languages, logprobs, usage }`

13 13 

14 Represents a transcription response returned by model, based on the provided input.14 Represents a transcription response returned by model, based on the provided input.

15 15 


17 17 

18 The transcribed text.18 The transcribed text.

19 19 

20 - `languages: optional array of TranscriptionLanguage`

21 

22 The languages detected in the audio. Returned by `gpt-transcribe`. An empty array indicates that no language could be reliably detected.

23 

24 - `code: string`

25 

26 The code of a language detected in the audio.

27 

20 - `logprobs: optional array of object { token, bytes, logprob }`28 - `logprobs: optional array of object { token, bytes, logprob }`

21 29 

22 The log probabilities of the tokens in the transcription. Only returned with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added to the `include` array.30 The log probabilities of the tokens in the transcription. Only returned with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` if `logprobs` is added to the `include` array.


37 45 

38 Token usage statistics for the request.46 Token usage statistics for the request.

39 47 

40 - `TokenUsage object { input_tokens, output_tokens, total_tokens, 2 more }`48 - `Tokens object { input_tokens, output_tokens, total_tokens, 2 more }`

41 49 

42 Usage statistics for models billed by token usage.50 Usage statistics for models billed by token usage.

43 51 


71 79 

72 Number of text tokens billed for this request.80 Number of text tokens billed for this request.

73 81 

74 - `DurationUsage object { seconds, type }`82 - `Duration object { seconds, type }`

75 83 

76 Usage statistics for models billed by audio input duration.84 Usage statistics for models billed by audio input duration.

77 85 


290```json298```json

291{299{

292 "text": "text",300 "text": "text",

301 "languages": [

302 {

303 "code": "code"

304 }

305 ],

293 "logprobs": [306 "logprobs": [

294 {307 {

295 "token": "token",308 "token": "token",


394}407}

395```408```

396 409 

397### Streaming

398 

399```http

400curl https://api.openai.com/v1/audio/transcriptions \

401 -H "Authorization: Bearer $OPENAI_API_KEY" \

402 -H "Content-Type: multipart/form-data" \

403 -F file="@/path/to/file/audio.mp3" \

404 -F model="gpt-4o-mini-transcribe" \

405 -F stream=true

406```

407 

408#### Response

409 

410```json

411data: {"type":"transcript.text.delta","delta":"I","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]}]}

412 

413data: {"type":"transcript.text.delta","delta":" see","logprobs":[{"token":" see","logprob":-3.1281633e-7,"bytes":[32,115,101,101]}]}

414 

415data: {"type":"transcript.text.delta","delta":" skies","logprobs":[{"token":" skies","logprob":-2.3392786e-6,"bytes":[32,115,107,105,101,115]}]}

416 

417data: {"type":"transcript.text.delta","delta":" of","logprobs":[{"token":" of","logprob":-3.1281633e-7,"bytes":[32,111,102]}]}

418 

419data: {"type":"transcript.text.delta","delta":" blue","logprobs":[{"token":" blue","logprob":-1.0280384e-6,"bytes":[32,98,108,117,101]}]}

420 

421data: {"type":"transcript.text.delta","delta":" and","logprobs":[{"token":" and","logprob":-0.0005108566,"bytes":[32,97,110,100]}]}

422 

423data: {"type":"transcript.text.delta","delta":" clouds","logprobs":[{"token":" clouds","logprob":-1.9361265e-7,"bytes":[32,99,108,111,117,100,115]}]}

424 

425data: {"type":"transcript.text.delta","delta":" of","logprobs":[{"token":" of","logprob":-1.9361265e-7,"bytes":[32,111,102]}]}

426 

427data: {"type":"transcript.text.delta","delta":" white","logprobs":[{"token":" white","logprob":-7.89631e-7,"bytes":[32,119,104,105,116,101]}]}

428 

429data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.0014890312,"bytes":[44]}]}

430 

431data: {"type":"transcript.text.delta","delta":" the","logprobs":[{"token":" the","logprob":-0.0110956915,"bytes":[32,116,104,101]}]}

432 

433data: {"type":"transcript.text.delta","delta":" bright","logprobs":[{"token":" bright","logprob":0.0,"bytes":[32,98,114,105,103,104,116]}]}

434 

435data: {"type":"transcript.text.delta","delta":" blessed","logprobs":[{"token":" blessed","logprob":-0.000045848617,"bytes":[32,98,108,101,115,115,101,100]}]}

436 

437data: {"type":"transcript.text.delta","delta":" days","logprobs":[{"token":" days","logprob":-0.000010802739,"bytes":[32,100,97,121,115]}]}

438 

439data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.00001700133,"bytes":[44]}]}

440 

441data: {"type":"transcript.text.delta","delta":" the","logprobs":[{"token":" the","logprob":-0.0000118755715,"bytes":[32,116,104,101]}]}

442 

443data: {"type":"transcript.text.delta","delta":" dark","logprobs":[{"token":" dark","logprob":-5.5122365e-7,"bytes":[32,100,97,114,107]}]}

444 

445data: {"type":"transcript.text.delta","delta":" sacred","logprobs":[{"token":" sacred","logprob":-5.4385737e-6,"bytes":[32,115,97,99,114,101,100]}]}

446 

447data: {"type":"transcript.text.delta","delta":" nights","logprobs":[{"token":" nights","logprob":-4.00813e-6,"bytes":[32,110,105,103,104,116,115]}]}

448 

449data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.0036910512,"bytes":[44]}]}

450 

451data: {"type":"transcript.text.delta","delta":" and","logprobs":[{"token":" and","logprob":-0.0031903093,"bytes":[32,97,110,100]}]}

452 

453data: {"type":"transcript.text.delta","delta":" I","logprobs":[{"token":" I","logprob":-1.504853e-6,"bytes":[32,73]}]}

454 

455data: {"type":"transcript.text.delta","delta":" think","logprobs":[{"token":" think","logprob":-4.3202e-7,"bytes":[32,116,104,105,110,107]}]}

456 

457data: {"type":"transcript.text.delta","delta":" to","logprobs":[{"token":" to","logprob":-1.9361265e-7,"bytes":[32,116,111]}]}

458 

459data: {"type":"transcript.text.delta","delta":" myself","logprobs":[{"token":" myself","logprob":-1.7432603e-6,"bytes":[32,109,121,115,101,108,102]}]}

460 

461data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.29254505,"bytes":[44]}]}

462 

463data: {"type":"transcript.text.delta","delta":" what","logprobs":[{"token":" what","logprob":-0.016815351,"bytes":[32,119,104,97,116]}]}

464 

465data: {"type":"transcript.text.delta","delta":" a","logprobs":[{"token":" a","logprob":-3.1281633e-7,"bytes":[32,97]}]}

466 

467data: {"type":"transcript.text.delta","delta":" wonderful","logprobs":[{"token":" wonderful","logprob":-2.1008714e-6,"bytes":[32,119,111,110,100,101,114,102,117,108]}]}

468 

469data: {"type":"transcript.text.delta","delta":" world","logprobs":[{"token":" world","logprob":-8.180258e-6,"bytes":[32,119,111,114,108,100]}]}

470 

471data: {"type":"transcript.text.delta","delta":".","logprobs":[{"token":".","logprob":-0.014231676,"bytes":[46]}]}

472 

473data: {"type":"transcript.text.done","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.","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]},{"token":" see","logprob":-3.1281633e-7,"bytes":[32,115,101,101]},{"token":" skies","logprob":-2.3392786e-6,"bytes":[32,115,107,105,101,115]},{"token":" of","logprob":-3.1281633e-7,"bytes":[32,111,102]},{"token":" blue","logprob":-1.0280384e-6,"bytes":[32,98,108,117,101]},{"token":" and","logprob":-0.0005108566,"bytes":[32,97,110,100]},{"token":" clouds","logprob":-1.9361265e-7,"bytes":[32,99,108,111,117,100,115]},{"token":" of","logprob":-1.9361265e-7,"bytes":[32,111,102]},{"token":" white","logprob":-7.89631e-7,"bytes":[32,119,104,105,116,101]},{"token":",","logprob":-0.0014890312,"bytes":[44]},{"token":" the","logprob":-0.0110956915,"bytes":[32,116,104,101]},{"token":" bright","logprob":0.0,"bytes":[32,98,114,105,103,104,116]},{"token":" blessed","logprob":-0.000045848617,"bytes":[32,98,108,101,115,115,101,100]},{"token":" days","logprob":-0.000010802739,"bytes":[32,100,97,121,115]},{"token":",","logprob":-0.00001700133,"bytes":[44]},{"token":" the","logprob":-0.0000118755715,"bytes":[32,116,104,101]},{"token":" dark","logprob":-5.5122365e-7,"bytes":[32,100,97,114,107]},{"token":" sacred","logprob":-5.4385737e-6,"bytes":[32,115,97,99,114,101,100]},{"token":" nights","logprob":-4.00813e-6,"bytes":[32,110,105,103,104,116,115]},{"token":",","logprob":-0.0036910512,"bytes":[44]},{"token":" and","logprob":-0.0031903093,"bytes":[32,97,110,100]},{"token":" I","logprob":-1.504853e-6,"bytes":[32,73]},{"token":" think","logprob":-4.3202e-7,"bytes":[32,116,104,105,110,107]},{"token":" to","logprob":-1.9361265e-7,"bytes":[32,116,111]},{"token":" myself","logprob":-1.7432603e-6,"bytes":[32,109,121,115,101,108,102]},{"token":",","logprob":-0.29254505,"bytes":[44]},{"token":" what","logprob":-0.016815351,"bytes":[32,119,104,97,116]},{"token":" a","logprob":-3.1281633e-7,"bytes":[32,97]},{"token":" wonderful","logprob":-2.1008714e-6,"bytes":[32,119,111,110,100,101,114,102,117,108]},{"token":" world","logprob":-8.180258e-6,"bytes":[32,119,111,114,108,100]},{"token":".","logprob":-0.014231676,"bytes":[46]}],"usage":{"input_tokens":14,"input_token_details":{"text_tokens":0,"audio_tokens":14},"output_tokens":45,"total_tokens":59}}

474```

475 

476### Logprobs410### Logprobs

477 411 

478```http412```http


545}479}

546```480```

547 481 

548### Word timestamps482### Segment timestamps

549 483 

550```http484```http

551curl https://api.openai.com/v1/audio/transcriptions \485curl https://api.openai.com/v1/audio/transcriptions \

552 -H "Authorization: Bearer $OPENAI_API_KEY" \486 -H "Authorization: Bearer $OPENAI_API_KEY" \

553 -H "Content-Type: multipart/form-data" \487 -H "Content-Type: multipart/form-data" \

554 -F file="@/path/to/file/audio.mp3" \488 -F file="@/path/to/file/audio.mp3" \

555 -F "timestamp_granularities[]=word" \489 -F "timestamp_granularities[]=segment" \

556 -F model="whisper-1" \490 -F model="whisper-1" \

557 -F response_format="verbose_json"491 -F response_format="verbose_json"

558```492```


565 "language": "english",499 "language": "english",

566 "duration": 8.470000267028809,500 "duration": 8.470000267028809,

567 "text": "The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.",501 "text": "The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.",

568 "words": [502 "segments": [

569 {503 {

570 "word": "The",504 "id": 0,

505 "seek": 0,

571 "start": 0.0,506 "start": 0.0,

572 "end": 0.23999999463558197507 "end": 3.319999933242798,

508 "text": " The beach was a popular spot on a hot summer day.",

509 "tokens": [

510 50364, 440, 7534, 390, 257, 3743, 4008, 322, 257, 2368, 4266, 786, 13, 50530

511 ],

512 "temperature": 0.0,

513 "avg_logprob": -0.2860786020755768,

514 "compression_ratio": 1.2363636493682861,

515 "no_speech_prob": 0.00985979475080967

573 },516 },

574 ...517 ...

575 {

576 "word": "volleyball",

577 "start": 7.400000095367432,

578 "end": 7.900000095367432

579 }

580 ],518 ],

581 "usage": {519 "usage": {

582 "type": "duration",520 "type": "duration",


585}523}

586```524```

587 525 

588### Segment timestamps526### Streaming

589 527 

590```http528```http

591curl https://api.openai.com/v1/audio/transcriptions \529curl https://api.openai.com/v1/audio/transcriptions \

592 -H "Authorization: Bearer $OPENAI_API_KEY" \530 -H "Authorization: Bearer $OPENAI_API_KEY" \

593 -H "Content-Type: multipart/form-data" \531 -H "Content-Type: multipart/form-data" \

594 -F file="@/path/to/file/audio.mp3" \532 -F file="@/path/to/file/audio.mp3" \

595 -F "timestamp_granularities[]=segment" \533 -F model="gpt-4o-mini-transcribe" \

534 -F stream=true

535```

536 

537#### Response

538 

539```json

540data: {"type":"transcript.text.delta","delta":"I","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]}]}

541 

542data: {"type":"transcript.text.delta","delta":" see","logprobs":[{"token":" see","logprob":-3.1281633e-7,"bytes":[32,115,101,101]}]}

543 

544data: {"type":"transcript.text.delta","delta":" skies","logprobs":[{"token":" skies","logprob":-2.3392786e-6,"bytes":[32,115,107,105,101,115]}]}

545 

546data: {"type":"transcript.text.delta","delta":" of","logprobs":[{"token":" of","logprob":-3.1281633e-7,"bytes":[32,111,102]}]}

547 

548data: {"type":"transcript.text.delta","delta":" blue","logprobs":[{"token":" blue","logprob":-1.0280384e-6,"bytes":[32,98,108,117,101]}]}

549 

550data: {"type":"transcript.text.delta","delta":" and","logprobs":[{"token":" and","logprob":-0.0005108566,"bytes":[32,97,110,100]}]}

551 

552data: {"type":"transcript.text.delta","delta":" clouds","logprobs":[{"token":" clouds","logprob":-1.9361265e-7,"bytes":[32,99,108,111,117,100,115]}]}

553 

554data: {"type":"transcript.text.delta","delta":" of","logprobs":[{"token":" of","logprob":-1.9361265e-7,"bytes":[32,111,102]}]}

555 

556data: {"type":"transcript.text.delta","delta":" white","logprobs":[{"token":" white","logprob":-7.89631e-7,"bytes":[32,119,104,105,116,101]}]}

557 

558data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.0014890312,"bytes":[44]}]}

559 

560data: {"type":"transcript.text.delta","delta":" the","logprobs":[{"token":" the","logprob":-0.0110956915,"bytes":[32,116,104,101]}]}

561 

562data: {"type":"transcript.text.delta","delta":" bright","logprobs":[{"token":" bright","logprob":0.0,"bytes":[32,98,114,105,103,104,116]}]}

563 

564data: {"type":"transcript.text.delta","delta":" blessed","logprobs":[{"token":" blessed","logprob":-0.000045848617,"bytes":[32,98,108,101,115,115,101,100]}]}

565 

566data: {"type":"transcript.text.delta","delta":" days","logprobs":[{"token":" days","logprob":-0.000010802739,"bytes":[32,100,97,121,115]}]}

567 

568data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.00001700133,"bytes":[44]}]}

569 

570data: {"type":"transcript.text.delta","delta":" the","logprobs":[{"token":" the","logprob":-0.0000118755715,"bytes":[32,116,104,101]}]}

571 

572data: {"type":"transcript.text.delta","delta":" dark","logprobs":[{"token":" dark","logprob":-5.5122365e-7,"bytes":[32,100,97,114,107]}]}

573 

574data: {"type":"transcript.text.delta","delta":" sacred","logprobs":[{"token":" sacred","logprob":-5.4385737e-6,"bytes":[32,115,97,99,114,101,100]}]}

575 

576data: {"type":"transcript.text.delta","delta":" nights","logprobs":[{"token":" nights","logprob":-4.00813e-6,"bytes":[32,110,105,103,104,116,115]}]}

577 

578data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.0036910512,"bytes":[44]}]}

579 

580data: {"type":"transcript.text.delta","delta":" and","logprobs":[{"token":" and","logprob":-0.0031903093,"bytes":[32,97,110,100]}]}

581 

582data: {"type":"transcript.text.delta","delta":" I","logprobs":[{"token":" I","logprob":-1.504853e-6,"bytes":[32,73]}]}

583 

584data: {"type":"transcript.text.delta","delta":" think","logprobs":[{"token":" think","logprob":-4.3202e-7,"bytes":[32,116,104,105,110,107]}]}

585 

586data: {"type":"transcript.text.delta","delta":" to","logprobs":[{"token":" to","logprob":-1.9361265e-7,"bytes":[32,116,111]}]}

587 

588data: {"type":"transcript.text.delta","delta":" myself","logprobs":[{"token":" myself","logprob":-1.7432603e-6,"bytes":[32,109,121,115,101,108,102]}]}

589 

590data: {"type":"transcript.text.delta","delta":",","logprobs":[{"token":",","logprob":-0.29254505,"bytes":[44]}]}

591 

592data: {"type":"transcript.text.delta","delta":" what","logprobs":[{"token":" what","logprob":-0.016815351,"bytes":[32,119,104,97,116]}]}

593 

594data: {"type":"transcript.text.delta","delta":" a","logprobs":[{"token":" a","logprob":-3.1281633e-7,"bytes":[32,97]}]}

595 

596data: {"type":"transcript.text.delta","delta":" wonderful","logprobs":[{"token":" wonderful","logprob":-2.1008714e-6,"bytes":[32,119,111,110,100,101,114,102,117,108]}]}

597 

598data: {"type":"transcript.text.delta","delta":" world","logprobs":[{"token":" world","logprob":-8.180258e-6,"bytes":[32,119,111,114,108,100]}]}

599 

600data: {"type":"transcript.text.delta","delta":".","logprobs":[{"token":".","logprob":-0.014231676,"bytes":[46]}]}

601 

602data: {"type":"transcript.text.done","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.","logprobs":[{"token":"I","logprob":-0.00007588794,"bytes":[73]},{"token":" see","logprob":-3.1281633e-7,"bytes":[32,115,101,101]},{"token":" skies","logprob":-2.3392786e-6,"bytes":[32,115,107,105,101,115]},{"token":" of","logprob":-3.1281633e-7,"bytes":[32,111,102]},{"token":" blue","logprob":-1.0280384e-6,"bytes":[32,98,108,117,101]},{"token":" and","logprob":-0.0005108566,"bytes":[32,97,110,100]},{"token":" clouds","logprob":-1.9361265e-7,"bytes":[32,99,108,111,117,100,115]},{"token":" of","logprob":-1.9361265e-7,"bytes":[32,111,102]},{"token":" white","logprob":-7.89631e-7,"bytes":[32,119,104,105,116,101]},{"token":",","logprob":-0.0014890312,"bytes":[44]},{"token":" the","logprob":-0.0110956915,"bytes":[32,116,104,101]},{"token":" bright","logprob":0.0,"bytes":[32,98,114,105,103,104,116]},{"token":" blessed","logprob":-0.000045848617,"bytes":[32,98,108,101,115,115,101,100]},{"token":" days","logprob":-0.000010802739,"bytes":[32,100,97,121,115]},{"token":",","logprob":-0.00001700133,"bytes":[44]},{"token":" the","logprob":-0.0000118755715,"bytes":[32,116,104,101]},{"token":" dark","logprob":-5.5122365e-7,"bytes":[32,100,97,114,107]},{"token":" sacred","logprob":-5.4385737e-6,"bytes":[32,115,97,99,114,101,100]},{"token":" nights","logprob":-4.00813e-6,"bytes":[32,110,105,103,104,116,115]},{"token":",","logprob":-0.0036910512,"bytes":[44]},{"token":" and","logprob":-0.0031903093,"bytes":[32,97,110,100]},{"token":" I","logprob":-1.504853e-6,"bytes":[32,73]},{"token":" think","logprob":-4.3202e-7,"bytes":[32,116,104,105,110,107]},{"token":" to","logprob":-1.9361265e-7,"bytes":[32,116,111]},{"token":" myself","logprob":-1.7432603e-6,"bytes":[32,109,121,115,101,108,102]},{"token":",","logprob":-0.29254505,"bytes":[44]},{"token":" what","logprob":-0.016815351,"bytes":[32,119,104,97,116]},{"token":" a","logprob":-3.1281633e-7,"bytes":[32,97]},{"token":" wonderful","logprob":-2.1008714e-6,"bytes":[32,119,111,110,100,101,114,102,117,108]},{"token":" world","logprob":-8.180258e-6,"bytes":[32,119,111,114,108,100]},{"token":".","logprob":-0.014231676,"bytes":[46]}],"usage":{"input_tokens":14,"input_token_details":{"text_tokens":0,"audio_tokens":14},"output_tokens":45,"total_tokens":59}}

603```

604 

605### Word timestamps

606 

607```http

608curl https://api.openai.com/v1/audio/transcriptions \

609 -H "Authorization: Bearer $OPENAI_API_KEY" \

610 -H "Content-Type: multipart/form-data" \

611 -F file="@/path/to/file/audio.mp3" \

612 -F "timestamp_granularities[]=word" \

596 -F model="whisper-1" \613 -F model="whisper-1" \

597 -F response_format="verbose_json"614 -F response_format="verbose_json"

598```615```


605 "language": "english",622 "language": "english",

606 "duration": 8.470000267028809,623 "duration": 8.470000267028809,

607 "text": "The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.",624 "text": "The beach was a popular spot on a hot summer day. People were swimming in the ocean, building sandcastles, and playing beach volleyball.",

608 "segments": [625 "words": [

609 {626 {

610 "id": 0,627 "word": "The",

611 "seek": 0,

612 "start": 0.0,628 "start": 0.0,

613 "end": 3.319999933242798,629 "end": 0.23999999463558197

614 "text": " The beach was a popular spot on a hot summer day.",

615 "tokens": [

616 50364, 440, 7534, 390, 257, 3743, 4008, 322, 257, 2368, 4266, 786, 13, 50530

617 ],

618 "temperature": 0.0,

619 "avg_logprob": -0.2860786020755768,

620 "compression_ratio": 1.2363636493682861,

621 "no_speech_prob": 0.00985979475080967

622 },630 },

623 ...631 ...

632 {

633 "word": "volleyball",

634 "start": 7.400000095367432,

635 "end": 7.900000095367432

636 }

624 ],637 ],

625 "usage": {638 "usage": {

626 "type": "duration",639 "type": "duration",

Details

250 250 

251 The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.251 The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.

252 252 

253 - `AutoChunkingStrategy object { type }`253 - `Auto object { type }`

254 254 

255 The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.255 The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.

256 256 


260 260 

261 - `"auto"`261 - `"auto"`

262 262 

263 - `StaticChunkingStrategy object { static, type }`263 - `Static object { static, type }`

264 264 

265 - `static: object { chunk_overlap_tokens, max_chunk_size_tokens }`265 - `static: object { chunk_overlap_tokens, max_chunk_size_tokens }`

266 266 

Details

6the `background` parameter set to `true` can be cancelled.6the `background` parameter set to `true` can be cancelled.

7[Learn more](/docs/guides/background).7[Learn more](/docs/guides/background).

8 8 

9### Path Parameters

10 

11- `response_id: string`

12 

13### Header Parameters9### Header Parameters

14 10 

15- `"openai-beta": optional array of "responses_multi_agent=v1"`11- `"openai-beta": optional array of "responses_multi_agent=v1"`

16 12 

17 - `"responses_multi_agent=v1"`13 - `"responses_multi_agent=v1"`

18 14 

15### Path Parameters

16 

17- `response_id: string`

18 

19### Returns19### Returns

20 20 

21- `BetaResponse object { id, created_at, error, 32 more }`21- `BetaResponse object { id, created_at, error, 32 more }`

Details

17629}17629}

17630```17630```

17631 17631 

17632### Text input17632### File input

17633 17633 

17634```http17634```http

17635curl https://api.openai.com/v1/responses \17635curl https://api.openai.com/v1/responses \


17637 -H "Authorization: Bearer $OPENAI_API_KEY" \17637 -H "Authorization: Bearer $OPENAI_API_KEY" \

17638 -d '{17638 -d '{

17639 "model": "gpt-5.4",17639 "model": "gpt-5.4",

17640 "input": "Tell me a three sentence bedtime story about a unicorn."17640 "input": [

17641 {

17642 "role": "user",

17643 "content": [

17644 {"type": "input_text", "text": "what is in this file?"},

17645 {

17646 "type": "input_file",

17647 "file_url": "https://www.berkshirehathaway.com/letters/2024ltr.pdf",

17648 "detail": "auto"

17649 }

17650 ]

17651 }

17652 ]

17641 }'17653 }'

17642```17654```

17643 17655 


17645 17657 

17646```json17658```json

17647{17659{

17648 "id": "resp_67ccd2bed1ec8190b14f964abc0542670bb6a6b452d3795b",17660 "id": "resp_686eef60237881a2bd1180bb8b13de430e34c516d176ff86",

17649 "object": "response",17661 "object": "response",

17650 "created_at": 1741476542,17662 "created_at": 1752100704,

17651 "status": "completed",17663 "status": "completed",

17652 "completed_at": 1741476543,17664 "completed_at": 1752100705,

17665 "background": false,

17653 "error": null,17666 "error": null,

17654 "incomplete_details": null,17667 "incomplete_details": null,

17655 "instructions": null,17668 "instructions": null,

17656 "max_output_tokens": null,17669 "max_output_tokens": null,

17670 "max_tool_calls": null,

17657 "model": "gpt-5.4",17671 "model": "gpt-5.4",

17658 "output": [17672 "output": [

17659 {17673 {

17674 "id": "msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86",

17660 "type": "message",17675 "type": "message",

17661 "id": "msg_67ccd2bf17f0819081ff3bb2cf6508e60bb6a6b452d3795b",

17662 "status": "completed",17676 "status": "completed",

17663 "role": "assistant",

17664 "content": [17677 "content": [

17665 {17678 {

17666 "type": "output_text",17679 "type": "output_text",

17667 "text": "In a peaceful grove beneath a silver moon, a unicorn named Lumina discovered a hidden pool that reflected the stars. As she dipped her horn into the water, the pool began to shimmer, revealing a pathway to a magical realm of endless night skies. Filled with wonder, Lumina whispered a wish for all who dream to find their own hidden magic, and as she glanced back, her hoofprints sparkled like stardust.",17680 "annotations": [],

17668 "annotations": []17681 "logprobs": [],

17682 "text": "The file seems to contain excerpts from a letter to the shareholders of Berkshire Hathaway Inc., likely written by Warren Buffett. It covers several topics:\n\n1. **Communication Philosophy**: Buffett emphasizes the importance of transparency and candidness in reporting mistakes and successes to shareholders.\n\n2. **Mistakes and Learnings**: The letter acknowledges past mistakes in business assessments and management hires, highlighting the importance of correcting errors promptly.\n\n3. **CEO Succession**: Mention of Greg Abel stepping in as the new CEO and continuing the tradition of honest communication.\n\n4. **Pete Liegl Story**: A detailed account of acquiring Forest River and the relationship with its founder, highlighting trust and effective business decisions.\n\n5. **2024 Performance**: Overview of business performance, particularly in insurance and investment activities, with a focus on GEICO's improvement.\n\n6. **Tax Contributions**: Discussion of significant tax payments to the U.S. Treasury, credited to shareholders' reinvestments.\n\n7. **Investment Strategy**: A breakdown of Berkshire\u2019s investments in both controlled subsidiaries and marketable equities, along with a focus on long-term holding strategies.\n\n8. **American Capitalism**: Reflections on America\u2019s economic development and Berkshire\u2019s role within it.\n\n9. **Property-Casualty Insurance**: Insights into the P/C insurance business model and its challenges and benefits.\n\n10. **Japanese Investments**: Information about Berkshire\u2019s investments in Japanese companies and future plans.\n\n11. **Annual Meeting**: Details about the upcoming annual gathering in Omaha, including schedule changes and new book releases.\n\n12. **Personal Anecdotes**: Light-hearted stories about family and interactions, conveying Buffett's personable approach.\n\n13. **Financial Performance Data**: Tables comparing Berkshire\u2019s annual performance to the S&P 500, showing impressive long-term gains.\n\nOverall, the letter reinforces Berkshire Hathaway's commitment to transparency, investment in both its businesses and the wider economy, and emphasizes strong leadership and prudent financial management."

17669 }17683 }

17670 ]17684 ],

17685 "role": "assistant"

17671 }17686 }

17672 ],17687 ],

17673 "parallel_tool_calls": true,17688 "parallel_tool_calls": true,


17676 "effort": null,17691 "effort": null,

17677 "summary": null17692 "summary": null

17678 },17693 },

17694 "service_tier": "default",

17679 "store": true,17695 "store": true,

17680 "temperature": 1.0,17696 "temperature": 1.0,

17681 "text": {17697 "text": {


17685 },17701 },

17686 "tool_choice": "auto",17702 "tool_choice": "auto",

17687 "tools": [],17703 "tools": [],

17704 "top_logprobs": 0,

17688 "top_p": 1.0,17705 "top_p": 1.0,

17689 "truncation": "disabled",17706 "truncation": "disabled",

17690 "usage": {17707 "usage": {

17691 "input_tokens": 36,17708 "input_tokens": 8438,

17692 "input_tokens_details": {17709 "input_tokens_details": {

17693 "cached_tokens": 0,17710 "cached_tokens": 0,

17694 "cache_write_tokens": 017711 "cache_write_tokens": 0

17695 },17712 },

17696 "output_tokens": 87,17713 "output_tokens": 398,

17697 "output_tokens_details": {17714 "output_tokens_details": {

17698 "reasoning_tokens": 017715 "reasoning_tokens": 0

17699 },17716 },

17700 "total_tokens": 12317717 "total_tokens": 8836

17701 },17718 },

17702 "user": null,17719 "user": null,

17703 "metadata": {}17720 "metadata": {}

17704}17721}

17705```17722```

17706 17723 

17707### Image input17724### File search

17708 17725 

17709```http17726```http

17710curl https://api.openai.com/v1/responses \17727curl https://api.openai.com/v1/responses \


17712 -H "Authorization: Bearer $OPENAI_API_KEY" \17729 -H "Authorization: Bearer $OPENAI_API_KEY" \

17713 -d '{17730 -d '{

17714 "model": "gpt-5.4",17731 "model": "gpt-5.4",

17715 "input": [17732 "tools": [{

17716 {17733 "type": "file_search",

17717 "role": "user",17734 "vector_store_ids": ["vs_1234567890"],

17718 "content": [17735 "max_num_results": 20

17719 {"type": "input_text", "text": "what is in this image?"},17736 }],

17720 {17737 "input": "What are the attributes of an ancient brown dragon?"

17721 "type": "input_image",

17722 "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"

17723 }

17724 ]

17725 }

17726 ]

17727 }'17738 }'

17728```17739```

17729 17740 


17731 17742 

17732```json17743```json

17733{17744{

17734 "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",17745 "id": "resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7",

17735 "object": "response",17746 "object": "response",

17736 "created_at": 1741476777,17747 "created_at": 1741485253,

17737 "status": "completed",17748 "status": "completed",

17738 "completed_at": 1741476778,17749 "completed_at": 1741485254,

17739 "error": null,17750 "error": null,

17740 "incomplete_details": null,17751 "incomplete_details": null,

17741 "instructions": null,17752 "instructions": null,

17742 "max_output_tokens": null,17753 "max_output_tokens": null,

17743 "model": "gpt-5.4",17754 "model": "gpt-5.4",

17744 "output": [17755 "output": [

17756 {

17757 "type": "file_search_call",

17758 "id": "fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7",

17759 "status": "completed",

17760 "queries": [

17761 "attributes of an ancient brown dragon"

17762 ],

17763 "results": null

17764 },

17745 {17765 {

17746 "type": "message",17766 "type": "message",

17747 "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",17767 "id": "msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7",

17748 "status": "completed",17768 "status": "completed",

17749 "role": "assistant",17769 "role": "assistant",

17750 "content": [17770 "content": [

17751 {17771 {

17752 "type": "output_text",17772 "type": "output_text",

17753 "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",17773 "text": "The attributes of an ancient brown dragon include...",

17754 "annotations": []17774 "annotations": [

17775 {

17776 "type": "file_citation",

17777 "index": 320,

17778 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17779 "filename": "dragons.pdf"

17780 },

17781 {

17782 "type": "file_citation",

17783 "index": 576,

17784 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17785 "filename": "dragons.pdf"

17786 },

17787 {

17788 "type": "file_citation",

17789 "index": 815,

17790 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17791 "filename": "dragons.pdf"

17792 },

17793 {

17794 "type": "file_citation",

17795 "index": 815,

17796 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17797 "filename": "dragons.pdf"

17798 },

17799 {

17800 "type": "file_citation",

17801 "index": 1030,

17802 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17803 "filename": "dragons.pdf"

17804 },

17805 {

17806 "type": "file_citation",

17807 "index": 1030,

17808 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17809 "filename": "dragons.pdf"

17810 },

17811 {

17812 "type": "file_citation",

17813 "index": 1156,

17814 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17815 "filename": "dragons.pdf"

17816 },

17817 {

17818 "type": "file_citation",

17819 "index": 1225,

17820 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

17821 "filename": "dragons.pdf"

17822 }

17823 ]

17755 }17824 }

17756 ]17825 ]

17757 }17826 }


17770 }17839 }

17771 },17840 },

17772 "tool_choice": "auto",17841 "tool_choice": "auto",

17773 "tools": [],17842 "tools": [

17843 {

17844 "type": "file_search",

17845 "filters": null,

17846 "max_num_results": 20,

17847 "ranking_options": {

17848 "ranker": "auto",

17849 "score_threshold": 0.0

17850 },

17851 "vector_store_ids": [

17852 "vs_1234567890"

17853 ]

17854 }

17855 ],

17774 "top_p": 1.0,17856 "top_p": 1.0,

17775 "truncation": "disabled",17857 "truncation": "disabled",

17776 "usage": {17858 "usage": {

17777 "input_tokens": 328,17859 "input_tokens": 18307,

17778 "input_tokens_details": {17860 "input_tokens_details": {

17779 "cached_tokens": 0,17861 "cached_tokens": 0,

17780 "cache_write_tokens": 017862 "cache_write_tokens": 0

17781 },17863 },

17782 "output_tokens": 52,17864 "output_tokens": 348,

17783 "output_tokens_details": {17865 "output_tokens_details": {

17784 "reasoning_tokens": 017866 "reasoning_tokens": 0

17785 },17867 },

17786 "total_tokens": 38017868 "total_tokens": 18655

17787 },17869 },

17788 "user": null,17870 "user": null,

17789 "metadata": {}17871 "metadata": {}

17790}17872}

17791```17873```

17792 17874 

17793### File input17875### Functions

17794 17876 

17795```http17877```http

17796curl https://api.openai.com/v1/responses \17878curl https://api.openai.com/v1/responses \


17798 -H "Authorization: Bearer $OPENAI_API_KEY" \17880 -H "Authorization: Bearer $OPENAI_API_KEY" \

17799 -d '{17881 -d '{

17800 "model": "gpt-5.4",17882 "model": "gpt-5.4",

17801 "input": [17883 "input": "What is the weather like in Boston today?",

17802 {17884 "tools": [

17803 "role": "user",

17804 "content": [

17805 {"type": "input_text", "text": "what is in this file?"},

17806 {17885 {

17807 "type": "input_file",17886 "type": "function",

17808 "file_url": "https://www.berkshirehathaway.com/letters/2024ltr.pdf",17887 "name": "get_current_weather",

17809 "detail": "auto"17888 "description": "Get the current weather in a given location",

17889 "parameters": {

17890 "type": "object",

17891 "properties": {

17892 "location": {

17893 "type": "string",

17894 "description": "The city and state, e.g. San Francisco, CA"

17895 },

17896 "unit": {

17897 "type": "string",

17898 "enum": ["celsius", "fahrenheit"]

17810 }17899 }

17811 ]17900 },

17901 "required": ["location", "unit"]

17812 }17902 }

17813 ]17903 }

17904 ],

17905 "tool_choice": "auto"

17814 }'17906 }'

17815```17907```

17816 17908 


17818 17910 

17819```json17911```json

17820{17912{

17821 "id": "resp_686eef60237881a2bd1180bb8b13de430e34c516d176ff86",17913 "id": "resp_67ca09c5efe0819096d0511c92b8c890096610f474011cc0",

17822 "object": "response",17914 "object": "response",

17823 "created_at": 1752100704,17915 "created_at": 1741294021,

17824 "status": "completed",17916 "status": "completed",

17825 "completed_at": 1752100705,17917 "completed_at": 1741294022,

17826 "background": false,

17827 "error": null,17918 "error": null,

17828 "incomplete_details": null,17919 "incomplete_details": null,

17829 "instructions": null,17920 "instructions": null,

17830 "max_output_tokens": null,17921 "max_output_tokens": null,

17831 "max_tool_calls": null,

17832 "model": "gpt-5.4",17922 "model": "gpt-5.4",

17833 "output": [17923 "output": [

17834 {17924 {

17835 "id": "msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86",17925 "type": "function_call",

17836 "type": "message",17926 "id": "fc_67ca09c6bedc8190a7abfec07b1a1332096610f474011cc0",

17837 "status": "completed",17927 "call_id": "call_unLAR8MvFNptuiZK6K6HCy5k",

17838 "content": [17928 "name": "get_current_weather",

17839 {17929 "arguments": "{\"location\":\"Boston, MA\",\"unit\":\"celsius\"}",

17840 "type": "output_text",17930 "status": "completed"

17841 "annotations": [],

17842 "logprobs": [],

17843 "text": "The file seems to contain excerpts from a letter to the shareholders of Berkshire Hathaway Inc., likely written by Warren Buffett. It covers several topics:\n\n1. **Communication Philosophy**: Buffett emphasizes the importance of transparency and candidness in reporting mistakes and successes to shareholders.\n\n2. **Mistakes and Learnings**: The letter acknowledges past mistakes in business assessments and management hires, highlighting the importance of correcting errors promptly.\n\n3. **CEO Succession**: Mention of Greg Abel stepping in as the new CEO and continuing the tradition of honest communication.\n\n4. **Pete Liegl Story**: A detailed account of acquiring Forest River and the relationship with its founder, highlighting trust and effective business decisions.\n\n5. **2024 Performance**: Overview of business performance, particularly in insurance and investment activities, with a focus on GEICO's improvement.\n\n6. **Tax Contributions**: Discussion of significant tax payments to the U.S. Treasury, credited to shareholders' reinvestments.\n\n7. **Investment Strategy**: A breakdown of Berkshire\u2019s investments in both controlled subsidiaries and marketable equities, along with a focus on long-term holding strategies.\n\n8. **American Capitalism**: Reflections on America\u2019s economic development and Berkshire\u2019s role within it.\n\n9. **Property-Casualty Insurance**: Insights into the P/C insurance business model and its challenges and benefits.\n\n10. **Japanese Investments**: Information about Berkshire\u2019s investments in Japanese companies and future plans.\n\n11. **Annual Meeting**: Details about the upcoming annual gathering in Omaha, including schedule changes and new book releases.\n\n12. **Personal Anecdotes**: Light-hearted stories about family and interactions, conveying Buffett's personable approach.\n\n13. **Financial Performance Data**: Tables comparing Berkshire\u2019s annual performance to the S&P 500, showing impressive long-term gains.\n\nOverall, the letter reinforces Berkshire Hathaway's commitment to transparency, investment in both its businesses and the wider economy, and emphasizes strong leadership and prudent financial management."

17844 }

17845 ],

17846 "role": "assistant"

17847 }17931 }

17848 ],17932 ],

17849 "parallel_tool_calls": true,17933 "parallel_tool_calls": true,


17852 "effort": null,17936 "effort": null,

17853 "summary": null17937 "summary": null

17854 },17938 },

17855 "service_tier": "default",

17856 "store": true,17939 "store": true,

17857 "temperature": 1.0,17940 "temperature": 1.0,

17858 "text": {17941 "text": {


17861 }17944 }

17862 },17945 },

17863 "tool_choice": "auto",17946 "tool_choice": "auto",

17864 "tools": [],17947 "tools": [

17865 "top_logprobs": 0,17948 {

17949 "type": "function",

17950 "description": "Get the current weather in a given location",

17951 "name": "get_current_weather",

17952 "parameters": {

17953 "type": "object",

17954 "properties": {

17955 "location": {

17956 "type": "string",

17957 "description": "The city and state, e.g. San Francisco, CA"

17958 },

17959 "unit": {

17960 "type": "string",

17961 "enum": [

17962 "celsius",

17963 "fahrenheit"

17964 ]

17965 }

17966 },

17967 "required": [

17968 "location",

17969 "unit"

17970 ]

17971 },

17972 "strict": true

17973 }

17974 ],

17866 "top_p": 1.0,17975 "top_p": 1.0,

17867 "truncation": "disabled",17976 "truncation": "disabled",

17868 "usage": {17977 "usage": {

17869 "input_tokens": 8438,17978 "input_tokens": 291,

17870 "input_tokens_details": {17979 "output_tokens": 23,

17871 "cached_tokens": 0,

17872 "cache_write_tokens": 0

17873 },

17874 "output_tokens": 398,

17875 "output_tokens_details": {17980 "output_tokens_details": {

17876 "reasoning_tokens": 017981 "reasoning_tokens": 0

17877 },17982 },

17878 "total_tokens": 883617983 "total_tokens": 314

17879 },17984 },

17880 "user": null,17985 "user": null,

17881 "metadata": {}17986 "metadata": {}

17882}17987}

17883```17988```

17884 17989 

17885### Web search17990### Image input

17886 17991 

17887```http17992```http

17888curl https://api.openai.com/v1/responses \17993curl https://api.openai.com/v1/responses \


17890 -H "Authorization: Bearer $OPENAI_API_KEY" \17995 -H "Authorization: Bearer $OPENAI_API_KEY" \

17891 -d '{17996 -d '{

17892 "model": "gpt-5.4",17997 "model": "gpt-5.4",

17893 "tools": [{ "type": "web_search_preview" }],17998 "input": [

17894 "input": "What was a positive news story from today?"17999 {

18000 "role": "user",

18001 "content": [

18002 {"type": "input_text", "text": "what is in this image?"},

18003 {

18004 "type": "input_image",

18005 "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"

18006 }

18007 ]

18008 }

18009 ]

17895 }'18010 }'

17896```18011```

17897 18012 


17899 18014 

17900```json18015```json

17901{18016{

17902 "id": "resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c",18017 "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",

17903 "object": "response",18018 "object": "response",

17904 "created_at": 1741484430,18019 "created_at": 1741476777,

17905 "status": "completed",18020 "status": "completed",

17906 "completed_at": 1741484431,18021 "completed_at": 1741476778,

17907 "error": null,18022 "error": null,

17908 "incomplete_details": null,18023 "incomplete_details": null,

17909 "instructions": null,18024 "instructions": null,

17910 "max_output_tokens": null,18025 "max_output_tokens": null,

17911 "model": "gpt-5.4",18026 "model": "gpt-5.4",

17912 "output": [18027 "output": [

17913 {

17914 "type": "web_search_call",

17915 "id": "ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c",

17916 "status": "completed"

17917 },

17918 {18028 {

17919 "type": "message",18029 "type": "message",

17920 "id": "msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c",18030 "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",

17921 "status": "completed",18031 "status": "completed",

17922 "role": "assistant",18032 "role": "assistant",

17923 "content": [18033 "content": [

17924 {18034 {

17925 "type": "output_text",18035 "type": "output_text",

17926 "text": "As of today, March 9, 2025, one notable positive news story...",18036 "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",

17927 "annotations": [18037 "annotations": []

17928 {

17929 "type": "url_citation",

17930 "start_index": 442,

17931 "end_index": 557,

17932 "url": "https://.../?utm_source=chatgpt.com",

17933 "title": "..."

17934 },

17935 {

17936 "type": "url_citation",

17937 "start_index": 962,

17938 "end_index": 1077,

17939 "url": "https://.../?utm_source=chatgpt.com",

17940 "title": "..."

17941 },

17942 {

17943 "type": "url_citation",

17944 "start_index": 1336,

17945 "end_index": 1451,

17946 "url": "https://.../?utm_source=chatgpt.com",

17947 "title": "..."

17948 }

17949 ]

17950 }18038 }

17951 ]18039 ]

17952 }18040 }


17965 }18053 }

17966 },18054 },

17967 "tool_choice": "auto",18055 "tool_choice": "auto",

17968 "tools": [18056 "tools": [],

17969 {

17970 "type": "web_search_preview",

17971 "domains": [],

17972 "search_context_size": "medium",

17973 "user_location": {

17974 "type": "approximate",

17975 "city": null,

17976 "country": "US",

17977 "region": null,

17978 "timezone": null

17979 }

17980 }

17981 ],

17982 "top_p": 1.0,18057 "top_p": 1.0,

17983 "truncation": "disabled",18058 "truncation": "disabled",

17984 "usage": {18059 "usage": {


17987 "cached_tokens": 0,18062 "cached_tokens": 0,

17988 "cache_write_tokens": 018063 "cache_write_tokens": 0

17989 },18064 },

17990 "output_tokens": 356,18065 "output_tokens": 52,

17991 "output_tokens_details": {18066 "output_tokens_details": {

17992 "reasoning_tokens": 018067 "reasoning_tokens": 0

17993 },18068 },

17994 "total_tokens": 68418069 "total_tokens": 380

17995 },18070 },

17996 "user": null,18071 "user": null,

17997 "metadata": {}18072 "metadata": {}

17998}18073}

17999```18074```

18000 18075 

18001### File search18076### Reasoning

18002 18077 

18003```http18078```http

18004curl https://api.openai.com/v1/responses \18079curl https://api.openai.com/v1/responses \

18005 -H "Content-Type: application/json" \18080 -H "Content-Type: application/json" \

18006 -H "Authorization: Bearer $OPENAI_API_KEY" \18081 -H "Authorization: Bearer $OPENAI_API_KEY" \

18007 -d '{18082 -d '{

18008 "model": "gpt-5.4",18083 "model": "o3-mini",

18009 "tools": [{18084 "input": "How much wood would a woodchuck chuck?",

18010 "type": "file_search",18085 "reasoning": {

18011 "vector_store_ids": ["vs_1234567890"],18086 "effort": "high"

18012 "max_num_results": 2018087 }

18013 }],

18014 "input": "What are the attributes of an ancient brown dragon?"

18015 }'18088 }'

18016```18089```

18017 18090 


18019 18092 

18020```json18093```json

18021{18094{

18022 "id": "resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7",18095 "id": "resp_67ccd7eca01881908ff0b5146584e408072912b2993db808",

18023 "object": "response",18096 "object": "response",

18024 "created_at": 1741485253,18097 "created_at": 1741477868,

18025 "status": "completed",18098 "status": "completed",

18026 "completed_at": 1741485254,18099 "completed_at": 1741477869,

18027 "error": null,18100 "error": null,

18028 "incomplete_details": null,18101 "incomplete_details": null,

18029 "instructions": null,18102 "instructions": null,

18030 "max_output_tokens": null,18103 "max_output_tokens": null,

18031 "model": "gpt-5.4",18104 "model": "o1-2024-12-17",

18032 "output": [18105 "output": [

18033 {

18034 "type": "file_search_call",

18035 "id": "fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7",

18036 "status": "completed",

18037 "queries": [

18038 "attributes of an ancient brown dragon"

18039 ],

18040 "results": null

18041 },

18042 {18106 {

18043 "type": "message",18107 "type": "message",

18044 "id": "msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7",18108 "id": "msg_67ccd7f7b5848190a6f3e95d809f6b44072912b2993db808",

18045 "status": "completed",18109 "status": "completed",

18046 "role": "assistant",18110 "role": "assistant",

18047 "content": [18111 "content": [

18048 {18112 {

18049 "type": "output_text",18113 "type": "output_text",

18050 "text": "The attributes of an ancient brown dragon include...",18114 "text": "The classic tongue twister...",

18051 "annotations": [18115 "annotations": []

18052 {

18053 "type": "file_citation",

18054 "index": 320,

18055 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18056 "filename": "dragons.pdf"

18057 },

18058 {

18059 "type": "file_citation",

18060 "index": 576,

18061 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18062 "filename": "dragons.pdf"

18063 },

18064 {

18065 "type": "file_citation",

18066 "index": 815,

18067 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18068 "filename": "dragons.pdf"

18069 },

18070 {

18071 "type": "file_citation",

18072 "index": 815,

18073 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18074 "filename": "dragons.pdf"

18075 },

18076 {

18077 "type": "file_citation",

18078 "index": 1030,

18079 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18080 "filename": "dragons.pdf"

18081 },

18082 {

18083 "type": "file_citation",

18084 "index": 1030,

18085 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18086 "filename": "dragons.pdf"

18087 },

18088 {

18089 "type": "file_citation",

18090 "index": 1156,

18091 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18092 "filename": "dragons.pdf"

18093 },

18094 {

18095 "type": "file_citation",

18096 "index": 1225,

18097 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

18098 "filename": "dragons.pdf"

18099 }

18100 ]

18101 }18116 }

18102 ]18117 ]

18103 }18118 }


18105 "parallel_tool_calls": true,18120 "parallel_tool_calls": true,

18106 "previous_response_id": null,18121 "previous_response_id": null,

18107 "reasoning": {18122 "reasoning": {

18108 "effort": null,18123 "effort": "high",

18109 "summary": null18124 "summary": null

18110 },18125 },

18111 "store": true,18126 "store": true,


18116 }18131 }

18117 },18132 },

18118 "tool_choice": "auto",18133 "tool_choice": "auto",

18119 "tools": [18134 "tools": [],

18120 {

18121 "type": "file_search",

18122 "filters": null,

18123 "max_num_results": 20,

18124 "ranking_options": {

18125 "ranker": "auto",

18126 "score_threshold": 0.0

18127 },

18128 "vector_store_ids": [

18129 "vs_1234567890"

18130 ]

18131 }

18132 ],

18133 "top_p": 1.0,18135 "top_p": 1.0,

18134 "truncation": "disabled",18136 "truncation": "disabled",

18135 "usage": {18137 "usage": {

18136 "input_tokens": 18307,18138 "input_tokens": 81,

18137 "input_tokens_details": {18139 "input_tokens_details": {

18138 "cached_tokens": 0,18140 "cached_tokens": 0,

18139 "cache_write_tokens": 018141 "cache_write_tokens": 0

18140 },18142 },

18141 "output_tokens": 348,18143 "output_tokens": 1035,

18142 "output_tokens_details": {18144 "output_tokens_details": {

18143 "reasoning_tokens": 018145 "reasoning_tokens": 832

18144 },18146 },

18145 "total_tokens": 1865518147 "total_tokens": 1116

18146 },18148 },

18147 "user": null,18149 "user": null,

18148 "metadata": {}18150 "metadata": {}


18196data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}18198data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}

18197```18199```

18198 18200 

18199### Functions18201### Text input

18200 18202 

18201```http18203```http

18202curl https://api.openai.com/v1/responses \18204curl https://api.openai.com/v1/responses \


18204 -H "Authorization: Bearer $OPENAI_API_KEY" \18206 -H "Authorization: Bearer $OPENAI_API_KEY" \

18205 -d '{18207 -d '{

18206 "model": "gpt-5.4",18208 "model": "gpt-5.4",

18207 "input": "What is the weather like in Boston today?",18209 "input": "Tell me a three sentence bedtime story about a unicorn."

18208 "tools": [

18209 {

18210 "type": "function",

18211 "name": "get_current_weather",

18212 "description": "Get the current weather in a given location",

18213 "parameters": {

18214 "type": "object",

18215 "properties": {

18216 "location": {

18217 "type": "string",

18218 "description": "The city and state, e.g. San Francisco, CA"

18219 },

18220 "unit": {

18221 "type": "string",

18222 "enum": ["celsius", "fahrenheit"]

18223 }

18224 },

18225 "required": ["location", "unit"]

18226 }

18227 }

18228 ],

18229 "tool_choice": "auto"

18230 }'18210 }'

18231```18211```

18232 18212 


18234 18214 

18235```json18215```json

18236{18216{

18237 "id": "resp_67ca09c5efe0819096d0511c92b8c890096610f474011cc0",18217 "id": "resp_67ccd2bed1ec8190b14f964abc0542670bb6a6b452d3795b",

18238 "object": "response",18218 "object": "response",

18239 "created_at": 1741294021,18219 "created_at": 1741476542,

18240 "status": "completed",18220 "status": "completed",

18241 "completed_at": 1741294022,18221 "completed_at": 1741476543,

18242 "error": null,18222 "error": null,

18243 "incomplete_details": null,18223 "incomplete_details": null,

18244 "instructions": null,18224 "instructions": null,


18246 "model": "gpt-5.4",18226 "model": "gpt-5.4",

18247 "output": [18227 "output": [

18248 {18228 {

18249 "type": "function_call",18229 "type": "message",

18250 "id": "fc_67ca09c6bedc8190a7abfec07b1a1332096610f474011cc0",18230 "id": "msg_67ccd2bf17f0819081ff3bb2cf6508e60bb6a6b452d3795b",

18251 "call_id": "call_unLAR8MvFNptuiZK6K6HCy5k",18231 "status": "completed",

18252 "name": "get_current_weather",18232 "role": "assistant",

18253 "arguments": "{\"location\":\"Boston, MA\",\"unit\":\"celsius\"}",18233 "content": [

18254 "status": "completed"18234 {

18235 "type": "output_text",

18236 "text": "In a peaceful grove beneath a silver moon, a unicorn named Lumina discovered a hidden pool that reflected the stars. As she dipped her horn into the water, the pool began to shimmer, revealing a pathway to a magical realm of endless night skies. Filled with wonder, Lumina whispered a wish for all who dream to find their own hidden magic, and as she glanced back, her hoofprints sparkled like stardust.",

18237 "annotations": []

18238 }

18239 ]

18255 }18240 }

18256 ],18241 ],

18257 "parallel_tool_calls": true,18242 "parallel_tool_calls": true,


18268 }18253 }

18269 },18254 },

18270 "tool_choice": "auto",18255 "tool_choice": "auto",

18271 "tools": [18256 "tools": [],

18272 {

18273 "type": "function",

18274 "description": "Get the current weather in a given location",

18275 "name": "get_current_weather",

18276 "parameters": {

18277 "type": "object",

18278 "properties": {

18279 "location": {

18280 "type": "string",

18281 "description": "The city and state, e.g. San Francisco, CA"

18282 },

18283 "unit": {

18284 "type": "string",

18285 "enum": [

18286 "celsius",

18287 "fahrenheit"

18288 ]

18289 }

18290 },

18291 "required": [

18292 "location",

18293 "unit"

18294 ]

18295 },

18296 "strict": true

18297 }

18298 ],

18299 "top_p": 1.0,18257 "top_p": 1.0,

18300 "truncation": "disabled",18258 "truncation": "disabled",

18301 "usage": {18259 "usage": {

18302 "input_tokens": 291,18260 "input_tokens": 36,

18303 "output_tokens": 23,18261 "input_tokens_details": {

18262 "cached_tokens": 0,

18263 "cache_write_tokens": 0

18264 },

18265 "output_tokens": 87,

18304 "output_tokens_details": {18266 "output_tokens_details": {

18305 "reasoning_tokens": 018267 "reasoning_tokens": 0

18306 },18268 },

18307 "total_tokens": 31418269 "total_tokens": 123

18308 },18270 },

18309 "user": null,18271 "user": null,

18310 "metadata": {}18272 "metadata": {}

18311}18273}

18312```18274```

18313 18275 

18314### Reasoning18276### Web search

18315 18277 

18316```http18278```http

18317curl https://api.openai.com/v1/responses \18279curl https://api.openai.com/v1/responses \

18318 -H "Content-Type: application/json" \18280 -H "Content-Type: application/json" \

18319 -H "Authorization: Bearer $OPENAI_API_KEY" \18281 -H "Authorization: Bearer $OPENAI_API_KEY" \

18320 -d '{18282 -d '{

18321 "model": "o3-mini",18283 "model": "gpt-5.4",

18322 "input": "How much wood would a woodchuck chuck?",18284 "tools": [{ "type": "web_search_preview" }],

18323 "reasoning": {18285 "input": "What was a positive news story from today?"

18324 "effort": "high"

18325 }

18326 }'18286 }'

18327```18287```

18328 18288 


18330 18290 

18331```json18291```json

18332{18292{

18333 "id": "resp_67ccd7eca01881908ff0b5146584e408072912b2993db808",18293 "id": "resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c",

18334 "object": "response",18294 "object": "response",

18335 "created_at": 1741477868,18295 "created_at": 1741484430,

18336 "status": "completed",18296 "status": "completed",

18337 "completed_at": 1741477869,18297 "completed_at": 1741484431,

18338 "error": null,18298 "error": null,

18339 "incomplete_details": null,18299 "incomplete_details": null,

18340 "instructions": null,18300 "instructions": null,

18341 "max_output_tokens": null,18301 "max_output_tokens": null,

18342 "model": "o1-2024-12-17",18302 "model": "gpt-5.4",

18343 "output": [18303 "output": [

18304 {

18305 "type": "web_search_call",

18306 "id": "ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c",

18307 "status": "completed"

18308 },

18344 {18309 {

18345 "type": "message",18310 "type": "message",

18346 "id": "msg_67ccd7f7b5848190a6f3e95d809f6b44072912b2993db808",18311 "id": "msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c",

18347 "status": "completed",18312 "status": "completed",

18348 "role": "assistant",18313 "role": "assistant",

18349 "content": [18314 "content": [

18350 {18315 {

18351 "type": "output_text",18316 "type": "output_text",

18352 "text": "The classic tongue twister...",18317 "text": "As of today, March 9, 2025, one notable positive news story...",

18353 "annotations": []18318 "annotations": [

18319 {

18320 "type": "url_citation",

18321 "start_index": 442,

18322 "end_index": 557,

18323 "url": "https://.../?utm_source=chatgpt.com",

18324 "title": "..."

18325 },

18326 {

18327 "type": "url_citation",

18328 "start_index": 962,

18329 "end_index": 1077,

18330 "url": "https://.../?utm_source=chatgpt.com",

18331 "title": "..."

18332 },

18333 {

18334 "type": "url_citation",

18335 "start_index": 1336,

18336 "end_index": 1451,

18337 "url": "https://.../?utm_source=chatgpt.com",

18338 "title": "..."

18339 }

18340 ]

18354 }18341 }

18355 ]18342 ]

18356 }18343 }


18358 "parallel_tool_calls": true,18345 "parallel_tool_calls": true,

18359 "previous_response_id": null,18346 "previous_response_id": null,

18360 "reasoning": {18347 "reasoning": {

18361 "effort": "high",18348 "effort": null,

18362 "summary": null18349 "summary": null

18363 },18350 },

18364 "store": true,18351 "store": true,


18369 }18356 }

18370 },18357 },

18371 "tool_choice": "auto",18358 "tool_choice": "auto",

18372 "tools": [],18359 "tools": [

18360 {

18361 "type": "web_search_preview",

18362 "domains": [],

18363 "search_context_size": "medium",

18364 "user_location": {

18365 "type": "approximate",

18366 "city": null,

18367 "country": "US",

18368 "region": null,

18369 "timezone": null

18370 }

18371 }

18372 ],

18373 "top_p": 1.0,18373 "top_p": 1.0,

18374 "truncation": "disabled",18374 "truncation": "disabled",

18375 "usage": {18375 "usage": {

18376 "input_tokens": 81,18376 "input_tokens": 328,

18377 "input_tokens_details": {18377 "input_tokens_details": {

18378 "cached_tokens": 0,18378 "cached_tokens": 0,

18379 "cache_write_tokens": 018379 "cache_write_tokens": 0

18380 },18380 },

18381 "output_tokens": 1035,18381 "output_tokens": 356,

18382 "output_tokens_details": {18382 "output_tokens_details": {

18383 "reasoning_tokens": 83218383 "reasoning_tokens": 0

18384 },18384 },

18385 "total_tokens": 111618385 "total_tokens": 684

18386 },18386 },

18387 "user": null,18387 "user": null,

18388 "metadata": {}18388 "metadata": {}

Details

4 4 

5Deletes a model response with the given ID.5Deletes a model response with the given ID.

6 6 

7### Path Parameters

8 

9- `response_id: string`

10 

11### Header Parameters7### Header Parameters

12 8 

13- `"openai-beta": optional array of "responses_multi_agent=v1"`9- `"openai-beta": optional array of "responses_multi_agent=v1"`

14 10 

15 - `"responses_multi_agent=v1"`11 - `"responses_multi_agent=v1"`

16 12 

13### Path Parameters

14 

15- `response_id: string`

16 

17### Example17### Example

18 18 

19```http19```http

Details

4 4 

5Retrieves a model response with the given ID.5Retrieves a model response with the given ID.

6 6 

7### Header Parameters

8 

9- `"openai-beta": optional array of "responses_multi_agent=v1"`

10 

11 - `"responses_multi_agent=v1"`

12 

7### Path Parameters13### Path Parameters

8 14 

9- `response_id: string`15- `response_id: string`


54 60 

55 - `false`61 - `false`

56 62 

57### Header Parameters

58 

59- `"openai-beta": optional array of "responses_multi_agent=v1"`

60 

61 - `"responses_multi_agent=v1"`

62 

63### Returns63### Returns

64 64 

65- `BetaResponse object { id, created_at, error, 32 more }`65- `BetaResponse object { id, created_at, error, 32 more }`

Details

4 4 

5Returns a list of input items for a given response.5Returns a list of input items for a given response.

6 6 

7### Header Parameters

8 

9- `"openai-beta": optional array of "responses_multi_agent=v1"`

10 

11 - `"responses_multi_agent=v1"`

12 

7### Path Parameters13### Path Parameters

8 14 

9- `response_id: string`15- `response_id: string`


51 57 

52 - `"desc"`58 - `"desc"`

53 59 

54### Header Parameters

55 

56- `"openai-beta": optional array of "responses_multi_agent=v1"`

57 

58 - `"responses_multi_agent=v1"`

59 

60### Returns60### Returns

61 61 

62- `BetaResponseItemList object { data, first_id, has_more, 2 more }`62- `BetaResponseItemList object { data, first_id, has_more, 2 more }`

Details

169 169 

170 The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.170 The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.

171 171 

172 - `AutoChunkingStrategy object { type }`172 - `Auto object { type }`

173 173 

174 The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.174 The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.

175 175 


179 179 

180 - `"auto"`180 - `"auto"`

181 181 

182 - `StaticChunkingStrategy object { static, type }`182 - `Static object { static, type }`

183 183 

184 - `static: object { chunk_overlap_tokens, max_chunk_size_tokens }`184 - `static: object { chunk_overlap_tokens, max_chunk_size_tokens }`

185 185 

Details

374 374 

375 The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.375 The chunking strategy used to chunk the file(s). If not set, will use the `auto` strategy.

376 376 

377 - `AutoChunkingStrategy object { type }`377 - `Auto object { type }`

378 378 

379 The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.379 The default strategy. This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.

380 380 


384 384 

385 - `"auto"`385 - `"auto"`

386 386 

387 - `StaticChunkingStrategy object { static, type }`387 - `Static object { static, type }`

388 388 

389 - `static: object { chunk_overlap_tokens, max_chunk_size_tokens }`389 - `static: object { chunk_overlap_tokens, max_chunk_size_tokens }`

390 390 

Details

1258 1258 

1259 The input format for the custom tool. Default is unconstrained text.1259 The input format for the custom tool. Default is unconstrained text.

1260 1260 

1261 - `TextFormat object { type }`1261 - `Text object { type }`

1262 1262 

1263 Unconstrained free-form text.1263 Unconstrained free-form text.

1264 1264 


1268 1268 

1269 - `"text"`1269 - `"text"`

1270 1270 

1271 - `GrammarFormat object { grammar, type }`1271 - `Grammar object { grammar, type }`

1272 1272 

1273 A grammar defined by the user.1273 A grammar defined by the user.

1274 1274 


2100}2100}

2101```2101```

2102 2102 

2103### Image input

2104 

2105```http

2106curl https://api.openai.com/v1/chat/completions \

2107 -H "Content-Type: application/json" \

2108 -H "Authorization: Bearer $OPENAI_API_KEY" \

2109 -d '{

2110 "model": "gpt-5.4",

2111 "messages": [

2112 {

2113 "role": "user",

2114 "content": [

2115 {

2116 "type": "text",

2117 "text": "What is in this image?"

2118 },

2119 {

2120 "type": "image_url",

2121 "image_url": {

2122 "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"

2123 }

2124 }

2125 ]

2126 }

2127 ],

2128 "max_tokens": 300

2129 }'

2130```

2131 

2132#### Response

2133 

2134```json

2135{

2136 "id": "chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG",

2137 "object": "chat.completion",

2138 "created": 1741570283,

2139 "model": "gpt-5.4",

2140 "choices": [

2141 {

2142 "index": 0,

2143 "message": {

2144 "role": "assistant",

2145 "content": "The image shows a wooden boardwalk path running through a lush green field or meadow. The sky is bright blue with some scattered clouds, giving the scene a serene and peaceful atmosphere. Trees and shrubs are visible in the background.",

2146 "refusal": null,

2147 "annotations": []

2148 },

2149 "logprobs": null,

2150 "finish_reason": "stop"

2151 }

2152 ],

2153 "usage": {

2154 "prompt_tokens": 1117,

2155 "completion_tokens": 46,

2156 "total_tokens": 1163,

2157 "prompt_tokens_details": {

2158 "cached_tokens": 0,

2159 "audio_tokens": 0

2160 },

2161 "completion_tokens_details": {

2162 "reasoning_tokens": 0,

2163 "audio_tokens": 0,

2164 "accepted_prediction_tokens": 0,

2165 "rejected_prediction_tokens": 0

2166 }

2167 },

2168 "service_tier": "default"

2169}

2170```

2171 

2172### Streaming

2173 

2174```http

2175curl https://api.openai.com/v1/chat/completions \

2176 -H "Content-Type: application/json" \

2177 -H "Authorization: Bearer $OPENAI_API_KEY" \

2178 -d '{

2179 "model": "VAR_chat_model_id",

2180 "messages": [

2181 {

2182 "role": "developer",

2183 "content": "You are a helpful assistant."

2184 },

2185 {

2186 "role": "user",

2187 "content": "Hello!"

2188 }

2189 ],

2190 "stream": true

2191 }'

2192```

2193 

2194#### Response

2195 

2196```json

2197{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]}

2198 

2199{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}]}

2200 

2201....

2202 

2203{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}

2204```

2205 

2206### Functions2103### Functions

2207 2104 

2208```http2105```http


2286}2183}

2287```2184```

2288 2185 

2186### Image input

2187 

2188```http

2189curl https://api.openai.com/v1/chat/completions \

2190 -H "Content-Type: application/json" \

2191 -H "Authorization: Bearer $OPENAI_API_KEY" \

2192 -d '{

2193 "model": "gpt-5.4",

2194 "messages": [

2195 {

2196 "role": "user",

2197 "content": [

2198 {

2199 "type": "text",

2200 "text": "What is in this image?"

2201 },

2202 {

2203 "type": "image_url",

2204 "image_url": {

2205 "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"

2206 }

2207 }

2208 ]

2209 }

2210 ],

2211 "max_tokens": 300

2212 }'

2213```

2214 

2215#### Response

2216 

2217```json

2218{

2219 "id": "chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG",

2220 "object": "chat.completion",

2221 "created": 1741570283,

2222 "model": "gpt-5.4",

2223 "choices": [

2224 {

2225 "index": 0,

2226 "message": {

2227 "role": "assistant",

2228 "content": "The image shows a wooden boardwalk path running through a lush green field or meadow. The sky is bright blue with some scattered clouds, giving the scene a serene and peaceful atmosphere. Trees and shrubs are visible in the background.",

2229 "refusal": null,

2230 "annotations": []

2231 },

2232 "logprobs": null,

2233 "finish_reason": "stop"

2234 }

2235 ],

2236 "usage": {

2237 "prompt_tokens": 1117,

2238 "completion_tokens": 46,

2239 "total_tokens": 1163,

2240 "prompt_tokens_details": {

2241 "cached_tokens": 0,

2242 "audio_tokens": 0

2243 },

2244 "completion_tokens_details": {

2245 "reasoning_tokens": 0,

2246 "audio_tokens": 0,

2247 "accepted_prediction_tokens": 0,

2248 "rejected_prediction_tokens": 0

2249 }

2250 },

2251 "service_tier": "default"

2252}

2253```

2254 

2289### Logprobs2255### Logprobs

2290 2256 

2291```http2257```http


2498 "system_fingerprint": null2464 "system_fingerprint": null

2499}2465}

2500```2466```

2467 

2468### Streaming

2469 

2470```http

2471curl https://api.openai.com/v1/chat/completions \

2472 -H "Content-Type: application/json" \

2473 -H "Authorization: Bearer $OPENAI_API_KEY" \

2474 -d '{

2475 "model": "VAR_chat_model_id",

2476 "messages": [

2477 {

2478 "role": "developer",

2479 "content": "You are a helpful assistant."

2480 },

2481 {

2482 "role": "user",

2483 "content": "Hello!"

2484 }

2485 ],

2486 "stream": true

2487 }'

2488```

2489 

2490#### Response

2491 

2492```json

2493{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]}

2494 

2495{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}]}

2496 

2497....

2498 

2499{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]}

2500```

Details

1# Chat Completions streaming events1# Chat Completions streaming events

2 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 

3Stream Chat Completions in real time. Receive chunks of completions5Stream Chat Completions in real time. Receive chunks of completions

4returned from the model using server-sent events.6returned from the model using server-sent events.

5[Learn more](https://developers.openai.com/docs/guides/streaming-responses?api-mode=chat).7[Learn more](https://developers.openai.com/docs/guides/streaming-responses?api-mode=chat).


19 "(resource) chat.completions > (model) chat_completion_chunk > (schema)": {21 "(resource) chat.completions > (model) chat_completion_chunk > (schema)": {

20 "kind": "HttpDeclTypeAlias",22 "kind": "HttpDeclTypeAlias",

21 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse",23 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse",

24 "docstring": "Represents a streamed chunk of a chat completion response returned\nby the model, based on the provided input. \n[Learn more](/docs/guides/streaming-responses).\n",

22 "ident": "ChatCompletionChunk",25 "ident": "ChatCompletionChunk",

23 "type": {26 "type": {

24 "kind": "HttpTypeObject",27 "kind": "HttpTypeObject",


52 }55 }

53 ]56 ]

54 },57 },

55 "docstring": "Represents a streamed chunk of a chat completion response returned\nby the model, based on the provided input. \n[Learn more](/docs/guides/streaming-responses).\n",

56 "childrenParentSchema": "object",58 "childrenParentSchema": "object",

57 "children": [59 "children": [

58 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) id",60 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) id",


68 },70 },

69 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) id": {71 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) id": {

70 "kind": "HttpDeclProperty",72 "kind": "HttpDeclProperty",

71 "docstring": "A unique identifier for the chat completion. Each chunk has the same ID.",73 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/id",

74 "deprecated": false,

72 "key": "id",75 "key": "id",

73 "optional": false,76 "docstring": "A unique identifier for the chat completion. Each chunk has the same ID.",

74 "nullable": false,

75 "type": {77 "type": {

76 "kind": "HttpTypeString"78 "kind": "HttpTypeString"

77 },79 },

78 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/id",80 "optional": false,

79 "deprecated": false,81 "nullable": false,

80 "schemaType": "string",82 "schemaType": "string",

81 "children": []83 "children": []

82 },84 },

83 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices": {85 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices": {

84 "kind": "HttpDeclProperty",86 "kind": "HttpDeclProperty",

85 "docstring": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the\nlast chunk if you set `stream_options: {\"include_usage\": true}`.\n",87 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices",

88 "deprecated": false,

86 "key": "choices",89 "key": "choices",

87 "optional": false,90 "docstring": "A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the\nlast chunk if you set `stream_options: {\"include_usage\": true}`.\n",

88 "nullable": false,

89 "type": {91 "type": {

90 "kind": "HttpTypeArray",92 "kind": "HttpTypeArray",

93 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices",

91 "elementType": {94 "elementType": {

92 "kind": "HttpTypeObject",95 "kind": "HttpTypeObject",

93 "members": [96 "members": [


104 "ident": "logprobs"107 "ident": "logprobs"

105 }108 }

106 ]109 ]

110 }

107 },111 },

108 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices"112 "optional": false,

109 },113 "nullable": false,

110 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices",

111 "deprecated": false,

112 "schemaType": "array",114 "schemaType": "array",

113 "childrenParentSchema": "object",115 "childrenParentSchema": "object",

114 "children": [116 "children": [


120 },122 },

121 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) created": {123 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) created": {

122 "kind": "HttpDeclProperty",124 "kind": "HttpDeclProperty",

123 "docstring": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.",125 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/created",

126 "deprecated": false,

124 "key": "created",127 "key": "created",

125 "optional": false,128 "docstring": "The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.",

126 "nullable": false,

127 "type": {129 "type": {

128 "kind": "HttpTypeNumber"130 "kind": "HttpTypeNumber"

129 },131 },

130 "constraints": {132 "constraints": {

131 "format": "unixtime"133 "format": "unixtime"

132 },134 },

133 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/created",135 "optional": false,

134 "deprecated": false,136 "nullable": false,

135 "schemaType": "integer",137 "schemaType": "integer",

136 "children": []138 "children": []

137 },139 },

138 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) model": {140 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) model": {

139 "kind": "HttpDeclProperty",141 "kind": "HttpDeclProperty",

140 "docstring": "The model to generate the completion.",142 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/model",

143 "deprecated": false,

141 "key": "model",144 "key": "model",

142 "optional": false,145 "docstring": "The model to generate the completion.",

143 "nullable": false,

144 "type": {146 "type": {

145 "kind": "HttpTypeString"147 "kind": "HttpTypeString"

146 },148 },

147 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/model",149 "optional": false,

148 "deprecated": false,150 "nullable": false,

149 "schemaType": "string",151 "schemaType": "string",

150 "children": []152 "children": []

151 },153 },

152 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) object": {154 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) object": {

153 "kind": "HttpDeclProperty",155 "kind": "HttpDeclProperty",

154 "docstring": "The object type, which is always `chat.completion.chunk`.",156 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/object",

157 "deprecated": false,

155 "key": "object",158 "key": "object",

156 "optional": false,159 "docstring": "The object type, which is always `chat.completion.chunk`.",

157 "nullable": false,

158 "type": {160 "type": {

159 "kind": "HttpTypeUnion",161 "kind": "HttpTypeUnion",

162 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/object",

160 "types": [163 "types": [

161 {164 {

162 "kind": "HttpTypeLiteral",165 "kind": "HttpTypeLiteral",

163 "literal": "chat.completion.chunk"166 "literal": "chat.completion.chunk"

164 }167 }

165 ],168 ]

166 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/object"

167 },169 },

168 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/object",170 "optional": false,

169 "deprecated": false,171 "nullable": false,

170 "schemaType": "enum",172 "schemaType": "enum",

171 "childrenParentSchema": "enum",173 "childrenParentSchema": "enum",

172 "children": [174 "children": [


175 },177 },

176 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation": {178 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation": {

177 "kind": "HttpDeclProperty",179 "kind": "HttpDeclProperty",

178 "docstring": "Moderation results for the request input and generated output. Present\non the moderation chunk when moderated completions are requested.\n",180 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/moderation",

181 "deprecated": false,

179 "key": "moderation",182 "key": "moderation",

180 "optional": true,183 "docstring": "Moderation results for the request input and generated output. Present\non the moderation chunk when moderated completions are requested.\n",

181 "nullable": true,

182 "type": {184 "type": {

183 "kind": "HttpTypeObject",185 "kind": "HttpTypeObject",

184 "members": [186 "members": [


190 }192 }

191 ]193 ]

192 },194 },

193 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/moderation",195 "optional": true,

194 "deprecated": false,196 "nullable": true,

195 "schemaType": "object",197 "schemaType": "object",

196 "childrenParentSchema": "object",198 "childrenParentSchema": "object",

197 "children": [199 "children": [


201 },203 },

202 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) service_tier": {204 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) service_tier": {

203 "kind": "HttpDeclProperty",205 "kind": "HttpDeclProperty",

204 "docstring": "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n",206 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/service_tier",

207 "deprecated": false,

205 "key": "service_tier",208 "key": "service_tier",

206 "optional": true,209 "docstring": "Specifies the processing type used for serving the request.\n - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n - When not set, the default behavior is 'auto'.\n\n When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n",

207 "nullable": true,

208 "default": "auto",

209 "type": {210 "type": {

210 "kind": "HttpTypeUnion",211 "kind": "HttpTypeUnion",

212 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/service_tier",

211 "types": [213 "types": [

212 {214 {

213 "kind": "HttpTypeLiteral",215 "kind": "HttpTypeLiteral",


229 "kind": "HttpTypeLiteral",231 "kind": "HttpTypeLiteral",

230 "literal": "priority"232 "literal": "priority"

231 }233 }

232 ],234 ]

233 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/service_tier"

234 },235 },

235 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/service_tier",236 "default": "auto",

236 "deprecated": false,237 "optional": true,

238 "nullable": true,

237 "schemaType": "enum",239 "schemaType": "enum",

238 "childrenParentSchema": "enum",240 "childrenParentSchema": "enum",

239 "children": [241 "children": [


246 },248 },

247 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) system_fingerprint": {249 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) system_fingerprint": {

248 "kind": "HttpDeclProperty",250 "kind": "HttpDeclProperty",

249 "docstring": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n",251 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/system_fingerprint",

252 "deprecated": true,

250 "key": "system_fingerprint",253 "key": "system_fingerprint",

251 "optional": true,254 "docstring": "This fingerprint represents the backend configuration that the model runs with.\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n",

252 "nullable": false,

253 "type": {255 "type": {

254 "kind": "HttpTypeString"256 "kind": "HttpTypeString"

255 },257 },

256 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/system_fingerprint",258 "optional": true,

257 "deprecated": true,259 "nullable": false,

258 "schemaType": "string",260 "schemaType": "string",

259 "children": []261 "children": []

260 },262 },

261 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) usage": {263 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) usage": {

262 "kind": "HttpDeclProperty",264 "kind": "HttpDeclProperty",

263 "docstring": "An optional field that will only be present when you set\n`stream_options: {\"include_usage\": true}` in your request. When present, it\ncontains a null value **except for the last chunk** which contains the\ntoken usage statistics for the entire request.\n\n**NOTE:** If the stream is interrupted or cancelled, you may not\nreceive the final usage chunk which contains the total token usage for\nthe request.\n",265 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/usage",

266 "deprecated": false,

264 "key": "usage",267 "key": "usage",

265 "optional": true,268 "docstring": "An optional field that will only be present when you set\n`stream_options: {\"include_usage\": true}` in your request. When present, it\ncontains a null value **except for the last chunk** which contains the\ntoken usage statistics for the entire request.\n\n**NOTE:** If the stream is interrupted or cancelled, you may not\nreceive the final usage chunk which contains the total token usage for\nthe request.\n",

266 "nullable": true,

267 "type": {269 "type": {

268 "kind": "HttpTypeReference",270 "kind": "HttpTypeReference",

269 "ident": "CompletionUsage",271 "ident": "CompletionUsage",

270 "$ref": "(resource) completions > (model) completion_usage > (schema)"272 "$ref": "(resource) completions > (model) completion_usage > (schema)"

271 },273 },

272 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/usage",274 "optional": true,

273 "deprecated": false,275 "nullable": true,

274 "schemaType": "object",

275 "modelImplicit": false,276 "modelImplicit": false,

277 "schemaType": "object",

276 "modelPath": "(resource) completions > (model) completion_usage",278 "modelPath": "(resource) completions > (model) completion_usage",

277 "childrenParentSchema": "object",279 "childrenParentSchema": "object",

278 "children": [280 "children": [


285 },287 },

286 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta": {288 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta": {

287 "kind": "HttpDeclProperty",289 "kind": "HttpDeclProperty",

288 "docstring": "A chat completion delta generated by streamed model responses.",290 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/delta",

291 "deprecated": false,

289 "key": "delta",292 "key": "delta",

290 "optional": false,293 "docstring": "A chat completion delta generated by streamed model responses.",

291 "nullable": false,

292 "type": {294 "type": {

293 "kind": "HttpTypeObject",295 "kind": "HttpTypeObject",

294 "members": [296 "members": [


309 }311 }

310 ]312 ]

311 },313 },

312 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/delta",314 "optional": false,

313 "deprecated": false,315 "nullable": false,

314 "schemaType": "object",316 "schemaType": "object",

315 "childrenParentSchema": "object",317 "childrenParentSchema": "object",

316 "children": [318 "children": [


323 },325 },

324 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) finish_reason": {326 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) finish_reason": {

325 "kind": "HttpDeclProperty",327 "kind": "HttpDeclProperty",

326 "docstring": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n",328 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/finish_reason",

329 "deprecated": false,

327 "key": "finish_reason",330 "key": "finish_reason",

328 "optional": false,331 "docstring": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n",

329 "nullable": true,

330 "type": {332 "type": {

331 "kind": "HttpTypeUnion",333 "kind": "HttpTypeUnion",

334 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/finish_reason",

332 "types": [335 "types": [

333 {336 {

334 "kind": "HttpTypeLiteral",337 "kind": "HttpTypeLiteral",


350 "kind": "HttpTypeLiteral",353 "kind": "HttpTypeLiteral",

351 "literal": "function_call"354 "literal": "function_call"

352 }355 }

353 ],356 ]

354 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/finish_reason"

355 },357 },

356 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/finish_reason",358 "optional": false,

357 "deprecated": false,359 "nullable": true,

358 "schemaType": "enum",360 "schemaType": "enum",

359 "childrenParentSchema": "enum",361 "childrenParentSchema": "enum",

360 "children": [362 "children": [


367 },369 },

368 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) index": {370 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) index": {

369 "kind": "HttpDeclProperty",371 "kind": "HttpDeclProperty",

370 "docstring": "The index of the choice in the list of choices.",372 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/index",

373 "deprecated": false,

371 "key": "index",374 "key": "index",

372 "optional": false,375 "docstring": "The index of the choice in the list of choices.",

373 "nullable": false,

374 "type": {376 "type": {

375 "kind": "HttpTypeNumber"377 "kind": "HttpTypeNumber"

376 },378 },

377 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/index",379 "optional": false,

378 "deprecated": false,380 "nullable": false,

379 "schemaType": "integer",381 "schemaType": "integer",

380 "children": []382 "children": []

381 },383 },

382 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) logprobs": {384 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) logprobs": {

383 "kind": "HttpDeclProperty",385 "kind": "HttpDeclProperty",

384 "docstring": "Log probability information for the choice.",386 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs",

387 "deprecated": false,

385 "key": "logprobs",388 "key": "logprobs",

386 "optional": true,389 "docstring": "Log probability information for the choice.",

387 "nullable": true,

388 "type": {390 "type": {

389 "kind": "HttpTypeObject",391 "kind": "HttpTypeObject",

390 "members": [392 "members": [


396 }398 }

397 ]399 ]

398 },400 },

399 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs",401 "optional": true,

400 "deprecated": false,402 "nullable": true,

401 "schemaType": "object",403 "schemaType": "object",

402 "childrenParentSchema": "object",404 "childrenParentSchema": "object",

403 "children": [405 "children": [


414 },416 },

415 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input": {417 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input": {

416 "kind": "HttpDeclProperty",418 "kind": "HttpDeclProperty",

417 "docstring": "Moderation for the request input.",419 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input",

420 "deprecated": false,

418 "key": "input",421 "key": "input",

419 "optional": false,422 "docstring": "Moderation for the request input.",

420 "nullable": false,

421 "type": {423 "type": {

422 "kind": "HttpTypeUnion",424 "kind": "HttpTypeUnion",

425 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input",

423 "types": [426 "types": [

424 {427 {

425 "kind": "HttpTypeObject",428 "kind": "HttpTypeObject",


449 }452 }

450 ]453 ]

451 }454 }

452 ],455 ]

453 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input"

454 },456 },

455 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input",457 "optional": false,

456 "deprecated": false,458 "nullable": false,

457 "schemaType": "union",459 "schemaType": "union",

458 "childrenParentSchema": "union",460 "childrenParentSchema": "union",

459 "children": [461 "children": [


463 },465 },

464 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output": {466 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output": {

465 "kind": "HttpDeclProperty",467 "kind": "HttpDeclProperty",

466 "docstring": "Moderation for the generated output.",468 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output",

469 "deprecated": false,

467 "key": "output",470 "key": "output",

468 "optional": false,471 "docstring": "Moderation for the generated output.",

469 "nullable": false,

470 "type": {472 "type": {

471 "kind": "HttpTypeUnion",473 "kind": "HttpTypeUnion",

474 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output",

472 "types": [475 "types": [

473 {476 {

474 "kind": "HttpTypeObject",477 "kind": "HttpTypeObject",


498 }501 }

499 ]502 ]

500 }503 }

501 ],504 ]

502 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output"

503 },505 },

504 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output",506 "optional": false,

505 "deprecated": false,507 "nullable": false,

506 "schemaType": "union",508 "schemaType": "union",

507 "childrenParentSchema": "union",509 "childrenParentSchema": "union",

508 "children": [510 "children": [


547 },549 },

548 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens": {550 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens": {

549 "kind": "HttpDeclProperty",551 "kind": "HttpDeclProperty",

550 "docstring": "Number of tokens in the generated completion.",552 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens",

553 "deprecated": false,

551 "key": "completion_tokens",554 "key": "completion_tokens",

552 "optional": false,555 "docstring": "Number of tokens in the generated completion.",

553 "nullable": false,

554 "default": 0,

555 "type": {556 "type": {

556 "kind": "HttpTypeNumber"557 "kind": "HttpTypeNumber"

557 },558 },

558 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens",559 "default": 0,

559 "deprecated": false,560 "optional": false,

561 "nullable": false,

560 "schemaType": "integer",562 "schemaType": "integer",

561 "children": []563 "children": []

562 },564 },

563 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens": {565 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens": {

564 "kind": "HttpDeclProperty",566 "kind": "HttpDeclProperty",

565 "docstring": "Number of tokens in the prompt.",567 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens",

568 "deprecated": false,

566 "key": "prompt_tokens",569 "key": "prompt_tokens",

567 "optional": false,570 "docstring": "Number of tokens in the prompt.",

568 "nullable": false,

569 "default": 0,

570 "type": {571 "type": {

571 "kind": "HttpTypeNumber"572 "kind": "HttpTypeNumber"

572 },573 },

573 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens",574 "default": 0,

574 "deprecated": false,575 "optional": false,

576 "nullable": false,

575 "schemaType": "integer",577 "schemaType": "integer",

576 "children": []578 "children": []

577 },579 },

578 "(resource) completions > (model) completion_usage > (schema) > (property) total_tokens": {580 "(resource) completions > (model) completion_usage > (schema) > (property) total_tokens": {

579 "kind": "HttpDeclProperty",581 "kind": "HttpDeclProperty",

580 "docstring": "Total number of tokens used in the request (prompt + completion).",582 "oasRef": "#/components/schemas/CompletionUsage/properties/total_tokens",

583 "deprecated": false,

581 "key": "total_tokens",584 "key": "total_tokens",

582 "optional": false,585 "docstring": "Total number of tokens used in the request (prompt + completion).",

583 "nullable": false,

584 "default": 0,

585 "type": {586 "type": {

586 "kind": "HttpTypeNumber"587 "kind": "HttpTypeNumber"

587 },588 },

588 "oasRef": "#/components/schemas/CompletionUsage/properties/total_tokens",589 "default": 0,

589 "deprecated": false,590 "optional": false,

591 "nullable": false,

590 "schemaType": "integer",592 "schemaType": "integer",

591 "children": []593 "children": []

592 },594 },

593 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details": {595 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details": {

594 "kind": "HttpDeclProperty",596 "kind": "HttpDeclProperty",

595 "docstring": "Breakdown of tokens used in a completion.",597 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details",

598 "deprecated": false,

596 "key": "completion_tokens_details",599 "key": "completion_tokens_details",

597 "optional": true,600 "docstring": "Breakdown of tokens used in a completion.",

598 "nullable": false,

599 "type": {601 "type": {

600 "kind": "HttpTypeObject",602 "kind": "HttpTypeObject",

601 "members": [603 "members": [


613 }615 }

614 ]616 ]

615 },617 },

616 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details",618 "optional": true,

617 "deprecated": false,619 "nullable": false,

618 "schemaType": "object",620 "schemaType": "object",

619 "childrenParentSchema": "object",621 "childrenParentSchema": "object",

620 "children": [622 "children": [


626 },628 },

627 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details": {629 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details": {

628 "kind": "HttpDeclProperty",630 "kind": "HttpDeclProperty",

629 "docstring": "Breakdown of tokens used in the prompt.",631 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details",

632 "deprecated": false,

630 "key": "prompt_tokens_details",633 "key": "prompt_tokens_details",

631 "optional": true,634 "docstring": "Breakdown of tokens used in the prompt.",

632 "nullable": false,

633 "type": {635 "type": {

634 "kind": "HttpTypeObject",636 "kind": "HttpTypeObject",

635 "members": [637 "members": [


644 }646 }

645 ]647 ]

646 },648 },

647 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details",649 "optional": true,

648 "deprecated": false,650 "nullable": false,

649 "schemaType": "object",651 "schemaType": "object",

650 "childrenParentSchema": "object",652 "childrenParentSchema": "object",

651 "children": [653 "children": [


657 "(resource) completions > (model) completion_usage > (schema)": {659 "(resource) completions > (model) completion_usage > (schema)": {

658 "kind": "HttpDeclTypeAlias",660 "kind": "HttpDeclTypeAlias",

659 "oasRef": "#/components/schemas/CompletionUsage",661 "oasRef": "#/components/schemas/CompletionUsage",

662 "docstring": "Usage statistics for the completion request.",

660 "ident": "CompletionUsage",663 "ident": "CompletionUsage",

661 "type": {664 "type": {

662 "kind": "HttpTypeObject",665 "kind": "HttpTypeObject",


678 }681 }

679 ]682 ]

680 },683 },

681 "docstring": "Usage statistics for the completion request.",

682 "childrenParentSchema": "object",684 "childrenParentSchema": "object",

683 "children": [685 "children": [

684 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens",686 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens",


690 },692 },

691 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) content": {693 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) content": {

692 "kind": "HttpDeclProperty",694 "kind": "HttpDeclProperty",

693 "docstring": "The contents of the chunk message.",695 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/content",

696 "deprecated": false,

694 "key": "content",697 "key": "content",

695 "optional": true,698 "docstring": "The contents of the chunk message.",

696 "nullable": true,

697 "type": {699 "type": {

698 "kind": "HttpTypeString"700 "kind": "HttpTypeString"

699 },701 },

700 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/content",702 "optional": true,

701 "deprecated": false,703 "nullable": true,

702 "schemaType": "string",704 "schemaType": "string",

703 "children": []705 "children": []

704 },706 },

705 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) function_call": {707 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) function_call": {

706 "kind": "HttpDeclProperty",708 "kind": "HttpDeclProperty",

707 "docstring": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",709 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/function_call",

710 "deprecated": true,

708 "key": "function_call",711 "key": "function_call",

709 "optional": true,712 "docstring": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.",

710 "nullable": false,

711 "type": {713 "type": {

712 "kind": "HttpTypeObject",714 "kind": "HttpTypeObject",

713 "members": [715 "members": [


719 }721 }

720 ]722 ]

721 },723 },

722 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/function_call",724 "optional": true,

723 "deprecated": true,725 "nullable": false,

724 "schemaType": "object",726 "schemaType": "object",

725 "childrenParentSchema": "object",727 "childrenParentSchema": "object",

726 "children": [728 "children": [


730 },732 },

731 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) refusal": {733 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) refusal": {

732 "kind": "HttpDeclProperty",734 "kind": "HttpDeclProperty",

733 "docstring": "The refusal message generated by the model.",735 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/refusal",

736 "deprecated": false,

734 "key": "refusal",737 "key": "refusal",

735 "optional": true,738 "docstring": "The refusal message generated by the model.",

736 "nullable": true,

737 "type": {739 "type": {

738 "kind": "HttpTypeString"740 "kind": "HttpTypeString"

739 },741 },

740 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/refusal",742 "optional": true,

741 "deprecated": false,743 "nullable": true,

742 "schemaType": "string",744 "schemaType": "string",

743 "children": []745 "children": []

744 },746 },

745 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) role": {747 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) role": {

746 "kind": "HttpDeclProperty",748 "kind": "HttpDeclProperty",

747 "docstring": "The role of the author of this message.",749 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/role",

750 "deprecated": false,

748 "key": "role",751 "key": "role",

749 "optional": true,752 "docstring": "The role of the author of this message.",

750 "nullable": false,

751 "type": {753 "type": {

752 "kind": "HttpTypeUnion",754 "kind": "HttpTypeUnion",

755 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/role",

753 "types": [756 "types": [

754 {757 {

755 "kind": "HttpTypeLiteral",758 "kind": "HttpTypeLiteral",


771 "kind": "HttpTypeLiteral",774 "kind": "HttpTypeLiteral",

772 "literal": "tool"775 "literal": "tool"

773 }776 }

774 ],777 ]

775 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/role"

776 },778 },

777 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/role",779 "optional": true,

778 "deprecated": false,780 "nullable": false,

779 "schemaType": "enum",781 "schemaType": "enum",

780 "childrenParentSchema": "enum",782 "childrenParentSchema": "enum",

781 "children": [783 "children": [


788 },790 },

789 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls": {791 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls": {

790 "kind": "HttpDeclProperty",792 "kind": "HttpDeclProperty",

793 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/tool_calls",

794 "deprecated": false,

791 "key": "tool_calls",795 "key": "tool_calls",

792 "optional": true,

793 "nullable": false,

794 "type": {796 "type": {

795 "kind": "HttpTypeArray",797 "kind": "HttpTypeArray",

798 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/tool_calls",

796 "elementType": {799 "elementType": {

797 "kind": "HttpTypeObject",800 "kind": "HttpTypeObject",

798 "members": [801 "members": [


809 "ident": "type"812 "ident": "type"

810 }813 }

811 ]814 ]

815 }

812 },816 },

813 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/tool_calls"817 "optional": true,

814 },818 "nullable": false,

815 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/tool_calls",

816 "deprecated": false,

817 "schemaType": "array",819 "schemaType": "array",

818 "childrenParentSchema": "object",820 "childrenParentSchema": "object",

819 "children": [821 "children": [


860 },862 },

861 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) logprobs > (property) content": {863 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) logprobs > (property) content": {

862 "kind": "HttpDeclProperty",864 "kind": "HttpDeclProperty",

863 "docstring": "A list of message content tokens with log probability information.",865 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/content",

866 "deprecated": false,

864 "key": "content",867 "key": "content",

865 "optional": false,868 "docstring": "A list of message content tokens with log probability information.",

866 "nullable": true,

867 "type": {869 "type": {

868 "kind": "HttpTypeArray",870 "kind": "HttpTypeArray",

871 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/content",

869 "elementType": {872 "elementType": {

870 "kind": "HttpTypeReference",873 "kind": "HttpTypeReference",

871 "ident": "ChatCompletionTokenLogprob",874 "ident": "ChatCompletionTokenLogprob",

872 "$ref": "(resource) chat.completions > (model) chat_completion_token_logprob > (schema)"875 "$ref": "(resource) chat.completions > (model) chat_completion_token_logprob > (schema)"

876 }

873 },877 },

874 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/content"878 "optional": false,

875 },879 "nullable": true,

876 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/content",

877 "deprecated": false,

878 "schemaType": "array",880 "schemaType": "array",

879 "childrenParentSchema": "object",881 "childrenParentSchema": "object",

880 "children": [882 "children": [


886 },888 },

887 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) logprobs > (property) refusal": {889 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) logprobs > (property) refusal": {

888 "kind": "HttpDeclProperty",890 "kind": "HttpDeclProperty",

889 "docstring": "A list of message refusal tokens with log probability information.",891 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/refusal",

892 "deprecated": false,

890 "key": "refusal",893 "key": "refusal",

891 "optional": false,894 "docstring": "A list of message refusal tokens with log probability information.",

892 "nullable": true,

893 "type": {895 "type": {

894 "kind": "HttpTypeArray",896 "kind": "HttpTypeArray",

897 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/refusal",

895 "elementType": {898 "elementType": {

896 "kind": "HttpTypeReference",899 "kind": "HttpTypeReference",

897 "ident": "ChatCompletionTokenLogprob",900 "ident": "ChatCompletionTokenLogprob",

898 "$ref": "(resource) chat.completions > (model) chat_completion_token_logprob > (schema)"901 "$ref": "(resource) chat.completions > (model) chat_completion_token_logprob > (schema)"

902 }

899 },903 },

900 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/refusal"904 "optional": false,

901 },905 "nullable": true,

902 "oasRef": "#/components/schemas/CreateChatCompletionStreamResponse/properties/choices/items/properties/logprobs/properties/refusal",

903 "deprecated": false,

904 "schemaType": "array",906 "schemaType": "array",

905 "childrenParentSchema": "object",907 "childrenParentSchema": "object",

906 "children": [908 "children": [


913 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0": {915 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0": {

914 "kind": "HttpDeclTypeAlias",916 "kind": "HttpDeclTypeAlias",

915 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input/oneOf/0",917 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input/oneOf/0",

918 "docstring": "Successful moderation results for the request input or generated output.",

916 "ident": "ModerationResults",919 "ident": "ModerationResults",

917 "type": {920 "type": {

918 "kind": "HttpTypeObject",921 "kind": "HttpTypeObject",


928 }931 }

929 ]932 ]

930 },933 },

931 "docstring": "Successful moderation results for the request input or generated output.",

932 "childrenParentSchema": "object",934 "childrenParentSchema": "object",

933 "children": [935 "children": [

934 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) model",936 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) model",


939 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1": {941 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1": {

940 "kind": "HttpDeclTypeAlias",942 "kind": "HttpDeclTypeAlias",

941 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input/oneOf/1",943 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/input/oneOf/1",

944 "docstring": "An error produced while attempting moderation.",

942 "ident": "Error",945 "ident": "Error",

943 "type": {946 "type": {

944 "kind": "HttpTypeObject",947 "kind": "HttpTypeObject",


954 }957 }

955 ]958 ]

956 },959 },

957 "docstring": "An error produced while attempting moderation.",

958 "childrenParentSchema": "object",960 "childrenParentSchema": "object",

959 "children": [961 "children": [

960 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) code",962 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) code",


965 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0": {967 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0": {

966 "kind": "HttpDeclTypeAlias",968 "kind": "HttpDeclTypeAlias",

967 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output/oneOf/0",969 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output/oneOf/0",

970 "docstring": "Successful moderation results for the request input or generated output.",

968 "ident": "ModerationResults",971 "ident": "ModerationResults",

969 "type": {972 "type": {

970 "kind": "HttpTypeObject",973 "kind": "HttpTypeObject",


980 }983 }

981 ]984 ]

982 },985 },

983 "docstring": "Successful moderation results for the request input or generated output.",

984 "childrenParentSchema": "object",986 "childrenParentSchema": "object",

985 "children": [987 "children": [

986 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) model",988 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) model",


991 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1": {993 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1": {

992 "kind": "HttpDeclTypeAlias",994 "kind": "HttpDeclTypeAlias",

993 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output/oneOf/1",995 "oasRef": "#/components/schemas/ChatCompletionModeration/properties/output/oneOf/1",

996 "docstring": "An error produced while attempting moderation.",

994 "ident": "Error",997 "ident": "Error",

995 "type": {998 "type": {

996 "kind": "HttpTypeObject",999 "kind": "HttpTypeObject",


1006 }1009 }

1007 ]1010 ]

1008 },1011 },

1009 "docstring": "An error produced while attempting moderation.",

1010 "childrenParentSchema": "object",1012 "childrenParentSchema": "object",

1011 "children": [1013 "children": [

1012 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) code",1014 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) code",


1016 },1018 },

1017 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) accepted_prediction_tokens": {1019 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) accepted_prediction_tokens": {

1018 "kind": "HttpDeclProperty",1020 "kind": "HttpDeclProperty",

1019 "docstring": "When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.\n",1021 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/accepted_prediction_tokens",

1022 "deprecated": false,

1020 "key": "accepted_prediction_tokens",1023 "key": "accepted_prediction_tokens",

1021 "optional": true,1024 "docstring": "When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.\n",

1022 "nullable": false,

1023 "default": 0,

1024 "type": {1025 "type": {

1025 "kind": "HttpTypeNumber"1026 "kind": "HttpTypeNumber"

1026 },1027 },

1027 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/accepted_prediction_tokens",1028 "default": 0,

1028 "deprecated": false,1029 "optional": true,

1030 "nullable": false,

1029 "schemaType": "integer",1031 "schemaType": "integer",

1030 "children": []1032 "children": []

1031 },1033 },

1032 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) audio_tokens": {1034 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) audio_tokens": {

1033 "kind": "HttpDeclProperty",1035 "kind": "HttpDeclProperty",

1034 "docstring": "Audio input tokens generated by the model.",1036 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/audio_tokens",

1037 "deprecated": false,

1035 "key": "audio_tokens",1038 "key": "audio_tokens",

1036 "optional": true,1039 "docstring": "Audio input tokens generated by the model.",

1037 "nullable": false,

1038 "default": 0,

1039 "type": {1040 "type": {

1040 "kind": "HttpTypeNumber"1041 "kind": "HttpTypeNumber"

1041 },1042 },

1042 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/audio_tokens",1043 "default": 0,

1043 "deprecated": false,1044 "optional": true,

1045 "nullable": false,

1044 "schemaType": "integer",1046 "schemaType": "integer",

1045 "children": []1047 "children": []

1046 },1048 },

1047 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) reasoning_tokens": {1049 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) reasoning_tokens": {

1048 "kind": "HttpDeclProperty",1050 "kind": "HttpDeclProperty",

1049 "docstring": "Tokens generated by the model for reasoning.",1051 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/reasoning_tokens",

1052 "deprecated": false,

1050 "key": "reasoning_tokens",1053 "key": "reasoning_tokens",

1051 "optional": true,1054 "docstring": "Tokens generated by the model for reasoning.",

1052 "nullable": false,

1053 "default": 0,

1054 "type": {1055 "type": {

1055 "kind": "HttpTypeNumber"1056 "kind": "HttpTypeNumber"

1056 },1057 },

1057 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/reasoning_tokens",1058 "default": 0,

1058 "deprecated": false,1059 "optional": true,

1060 "nullable": false,

1059 "schemaType": "integer",1061 "schemaType": "integer",

1060 "children": []1062 "children": []

1061 },1063 },

1062 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) rejected_prediction_tokens": {1064 "(resource) completions > (model) completion_usage > (schema) > (property) completion_tokens_details > (property) rejected_prediction_tokens": {

1063 "kind": "HttpDeclProperty",1065 "kind": "HttpDeclProperty",

1064 "docstring": "When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.\n",1066 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/rejected_prediction_tokens",

1067 "deprecated": false,

1065 "key": "rejected_prediction_tokens",1068 "key": "rejected_prediction_tokens",

1066 "optional": true,1069 "docstring": "When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.\n",

1067 "nullable": false,

1068 "default": 0,

1069 "type": {1070 "type": {

1070 "kind": "HttpTypeNumber"1071 "kind": "HttpTypeNumber"

1071 },1072 },

1072 "oasRef": "#/components/schemas/CompletionUsage/properties/completion_tokens_details/properties/rejected_prediction_tokens",1073 "default": 0,

1073 "deprecated": false,1074 "optional": true,

1075 "nullable": false,

1074 "schemaType": "integer",1076 "schemaType": "integer",

1075 "children": []1077 "children": []

1076 },1078 },

1077 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details > (property) audio_tokens": {1079 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details > (property) audio_tokens": {

1078 "kind": "HttpDeclProperty",1080 "kind": "HttpDeclProperty",

1079 "docstring": "Audio input tokens present in the prompt.",1081 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details/properties/audio_tokens",

1082 "deprecated": false,

1080 "key": "audio_tokens",1083 "key": "audio_tokens",

1081 "optional": true,1084 "docstring": "Audio input tokens present in the prompt.",

1082 "nullable": false,

1083 "default": 0,

1084 "type": {1085 "type": {

1085 "kind": "HttpTypeNumber"1086 "kind": "HttpTypeNumber"

1086 },1087 },

1087 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details/properties/audio_tokens",1088 "default": 0,

1088 "deprecated": false,1089 "optional": true,

1090 "nullable": false,

1089 "schemaType": "integer",1091 "schemaType": "integer",

1090 "children": []1092 "children": []

1091 },1093 },

1092 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details > (property) cache_write_tokens": {1094 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details > (property) cache_write_tokens": {

1093 "kind": "HttpDeclProperty",1095 "kind": "HttpDeclProperty",

1094 "docstring": "The unadjusted number of prompt tokens written to cache.",1096 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details/properties/cache_write_tokens",

1097 "deprecated": false,

1095 "key": "cache_write_tokens",1098 "key": "cache_write_tokens",

1096 "optional": true,1099 "docstring": "The unadjusted number of prompt tokens written to cache.",

1097 "nullable": false,

1098 "default": 0,

1099 "type": {1100 "type": {

1100 "kind": "HttpTypeNumber"1101 "kind": "HttpTypeNumber"

1101 },1102 },

1102 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details/properties/cache_write_tokens",1103 "default": 0,

1103 "deprecated": false,1104 "optional": true,

1105 "nullable": false,

1104 "schemaType": "integer",1106 "schemaType": "integer",

1105 "children": []1107 "children": []

1106 },1108 },

1107 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details > (property) cached_tokens": {1109 "(resource) completions > (model) completion_usage > (schema) > (property) prompt_tokens_details > (property) cached_tokens": {

1108 "kind": "HttpDeclProperty",1110 "kind": "HttpDeclProperty",

1109 "docstring": "Cached tokens present in the prompt.",1111 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details/properties/cached_tokens",

1112 "deprecated": false,

1110 "key": "cached_tokens",1113 "key": "cached_tokens",

1111 "optional": true,1114 "docstring": "Cached tokens present in the prompt.",

1112 "nullable": false,

1113 "default": 0,

1114 "type": {1115 "type": {

1115 "kind": "HttpTypeNumber"1116 "kind": "HttpTypeNumber"

1116 },1117 },

1117 "oasRef": "#/components/schemas/CompletionUsage/properties/prompt_tokens_details/properties/cached_tokens",1118 "default": 0,

1118 "deprecated": false,1119 "optional": true,

1120 "nullable": false,

1119 "schemaType": "integer",1121 "schemaType": "integer",

1120 "children": []1122 "children": []

1121 },1123 },

1122 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) function_call > (property) arguments": {1124 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) function_call > (property) arguments": {

1123 "kind": "HttpDeclProperty",1125 "kind": "HttpDeclProperty",

1124 "docstring": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.",1126 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/function_call/properties/arguments",

1127 "deprecated": false,

1125 "key": "arguments",1128 "key": "arguments",

1126 "optional": true,1129 "docstring": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.",

1127 "nullable": false,

1128 "type": {1130 "type": {

1129 "kind": "HttpTypeString"1131 "kind": "HttpTypeString"

1130 },1132 },

1131 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/function_call/properties/arguments",1133 "optional": true,

1132 "deprecated": false,1134 "nullable": false,

1133 "schemaType": "string",1135 "schemaType": "string",

1134 "children": []1136 "children": []

1135 },1137 },

1136 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) function_call > (property) name": {1138 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) function_call > (property) name": {

1137 "kind": "HttpDeclProperty",1139 "kind": "HttpDeclProperty",

1138 "docstring": "The name of the function to call.",1140 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/function_call/properties/name",

1141 "deprecated": false,

1139 "key": "name",1142 "key": "name",

1140 "optional": true,1143 "docstring": "The name of the function to call.",

1141 "nullable": false,

1142 "type": {1144 "type": {

1143 "kind": "HttpTypeString"1145 "kind": "HttpTypeString"

1144 },1146 },

1145 "oasRef": "#/components/schemas/ChatCompletionStreamResponseDelta/properties/function_call/properties/name",1147 "optional": true,

1146 "deprecated": false,1148 "nullable": false,

1147 "schemaType": "string",1149 "schemaType": "string",

1148 "children": []1150 "children": []

1149 },1151 },


1184 },1186 },

1185 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) index": {1187 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) index": {

1186 "kind": "HttpDeclProperty",1188 "kind": "HttpDeclProperty",

1189 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/index",

1190 "deprecated": false,

1187 "key": "index",1191 "key": "index",

1188 "optional": false,

1189 "nullable": false,

1190 "type": {1192 "type": {

1191 "kind": "HttpTypeNumber"1193 "kind": "HttpTypeNumber"

1192 },1194 },

1193 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/index",1195 "optional": false,

1194 "deprecated": false,1196 "nullable": false,

1195 "schemaType": "integer",1197 "schemaType": "integer",

1196 "children": []1198 "children": []

1197 },1199 },

1198 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) id": {1200 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) id": {

1199 "kind": "HttpDeclProperty",1201 "kind": "HttpDeclProperty",

1200 "docstring": "The ID of the tool call.",1202 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/id",

1203 "deprecated": false,

1201 "key": "id",1204 "key": "id",

1202 "optional": true,1205 "docstring": "The ID of the tool call.",

1203 "nullable": false,

1204 "type": {1206 "type": {

1205 "kind": "HttpTypeString"1207 "kind": "HttpTypeString"

1206 },1208 },

1207 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/id",1209 "optional": true,

1208 "deprecated": false,1210 "nullable": false,

1209 "schemaType": "string",1211 "schemaType": "string",

1210 "children": []1212 "children": []

1211 },1213 },

1212 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) function": {1214 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) function": {

1213 "kind": "HttpDeclProperty",1215 "kind": "HttpDeclProperty",

1216 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/function",

1217 "deprecated": false,

1214 "key": "function",1218 "key": "function",

1215 "optional": true,

1216 "nullable": false,

1217 "type": {1219 "type": {

1218 "kind": "HttpTypeObject",1220 "kind": "HttpTypeObject",

1219 "members": [1221 "members": [


1225 }1227 }

1226 ]1228 ]

1227 },1229 },

1228 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/function",1230 "optional": true,

1229 "deprecated": false,1231 "nullable": false,

1230 "schemaType": "object",1232 "schemaType": "object",

1231 "childrenParentSchema": "object",1233 "childrenParentSchema": "object",

1232 "children": [1234 "children": [


1236 },1238 },

1237 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) type": {1239 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) type": {

1238 "kind": "HttpDeclProperty",1240 "kind": "HttpDeclProperty",

1239 "docstring": "The type of the tool. Currently, only `function` is supported.",1241 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/type",

1242 "deprecated": false,

1240 "key": "type",1243 "key": "type",

1241 "optional": true,1244 "docstring": "The type of the tool. Currently, only `function` is supported.",

1242 "nullable": false,

1243 "type": {1245 "type": {

1244 "kind": "HttpTypeUnion",1246 "kind": "HttpTypeUnion",

1247 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/type",

1245 "types": [1248 "types": [

1246 {1249 {

1247 "kind": "HttpTypeLiteral",1250 "kind": "HttpTypeLiteral",

1248 "literal": "function"1251 "literal": "function"

1249 }1252 }

1250 ],1253 ]

1251 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/type"

1252 },1254 },

1253 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/type",1255 "optional": true,

1254 "deprecated": false,1256 "nullable": false,

1255 "schemaType": "enum",1257 "schemaType": "enum",

1256 "childrenParentSchema": "enum",1258 "childrenParentSchema": "enum",

1257 "children": [1259 "children": [


1260 },1262 },

1261 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) token": {1263 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) token": {

1262 "kind": "HttpDeclProperty",1264 "kind": "HttpDeclProperty",

1263 "docstring": "The token.",1265 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/token",

1266 "deprecated": false,

1264 "key": "token",1267 "key": "token",

1265 "optional": false,1268 "docstring": "The token.",

1266 "nullable": false,

1267 "type": {1269 "type": {

1268 "kind": "HttpTypeString"1270 "kind": "HttpTypeString"

1269 },1271 },

1270 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/token",1272 "optional": false,

1271 "deprecated": false,1273 "nullable": false,

1272 "schemaType": "string",1274 "schemaType": "string",

1273 "children": []1275 "children": []

1274 },1276 },

1275 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) bytes": {1277 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) bytes": {

1276 "kind": "HttpDeclProperty",1278 "kind": "HttpDeclProperty",

1277 "docstring": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.",1279 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/bytes",

1280 "deprecated": false,

1278 "key": "bytes",1281 "key": "bytes",

1279 "optional": false,1282 "docstring": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.",

1280 "nullable": true,

1281 "type": {1283 "type": {

1282 "kind": "HttpTypeArray",1284 "kind": "HttpTypeArray",

1285 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/bytes",

1283 "elementType": {1286 "elementType": {

1284 "kind": "HttpTypeNumber"1287 "kind": "HttpTypeNumber"

1288 }

1285 },1289 },

1286 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/bytes"1290 "optional": false,

1287 },1291 "nullable": true,

1288 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/bytes",

1289 "deprecated": false,

1290 "schemaType": "array",1292 "schemaType": "array",

1291 "children": []1293 "children": []

1292 },1294 },

1293 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) logprob": {1295 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) logprob": {

1294 "kind": "HttpDeclProperty",1296 "kind": "HttpDeclProperty",

1295 "docstring": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.",1297 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/logprob",

1298 "deprecated": false,

1296 "key": "logprob",1299 "key": "logprob",

1297 "optional": false,1300 "docstring": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.",

1298 "nullable": false,

1299 "type": {1301 "type": {

1300 "kind": "HttpTypeNumber"1302 "kind": "HttpTypeNumber"

1301 },1303 },

1302 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/logprob",1304 "optional": false,

1303 "deprecated": false,1305 "nullable": false,

1304 "schemaType": "number",1306 "schemaType": "number",

1305 "children": []1307 "children": []

1306 },1308 },

1307 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs": {1309 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs": {

1308 "kind": "HttpDeclProperty",1310 "kind": "HttpDeclProperty",

1309 "docstring": "List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested `top_logprobs`.",1311 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs",

1312 "deprecated": false,

1310 "key": "top_logprobs",1313 "key": "top_logprobs",

1311 "optional": false,1314 "docstring": "List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested `top_logprobs`.",

1312 "nullable": false,

1313 "type": {1315 "type": {

1314 "kind": "HttpTypeArray",1316 "kind": "HttpTypeArray",

1317 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs",

1315 "elementType": {1318 "elementType": {

1316 "kind": "HttpTypeObject",1319 "kind": "HttpTypeObject",

1317 "members": [1320 "members": [


1325 "ident": "logprob"1328 "ident": "logprob"

1326 }1329 }

1327 ]1330 ]

1331 }

1328 },1332 },

1329 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs"1333 "optional": false,

1330 },1334 "nullable": false,

1331 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs",

1332 "deprecated": false,

1333 "schemaType": "array",1335 "schemaType": "array",

1334 "childrenParentSchema": "object",1336 "childrenParentSchema": "object",

1335 "children": [1337 "children": [


1369 },1371 },

1370 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) model": {1372 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) model": {

1371 "kind": "HttpDeclProperty",1373 "kind": "HttpDeclProperty",

1372 "docstring": "The moderation model used to generate the results.",1374 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/model",

1375 "deprecated": false,

1373 "key": "model",1376 "key": "model",

1374 "optional": false,1377 "docstring": "The moderation model used to generate the results.",

1375 "nullable": false,

1376 "type": {1378 "type": {

1377 "kind": "HttpTypeString"1379 "kind": "HttpTypeString"

1378 },1380 },

1379 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/model",1381 "optional": false,

1380 "deprecated": false,1382 "nullable": false,

1381 "schemaType": "string",1383 "schemaType": "string",

1382 "children": []1384 "children": []

1383 },1385 },

1384 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results": {1386 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results": {

1385 "kind": "HttpDeclProperty",1387 "kind": "HttpDeclProperty",

1386 "docstring": "A list of moderation results.",1388 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results",

1389 "deprecated": false,

1387 "key": "results",1390 "key": "results",

1388 "optional": false,1391 "docstring": "A list of moderation results.",

1389 "nullable": false,

1390 "type": {1392 "type": {

1391 "kind": "HttpTypeArray",1393 "kind": "HttpTypeArray",

1394 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results",

1392 "elementType": {1395 "elementType": {

1393 "kind": "HttpTypeObject",1396 "kind": "HttpTypeObject",

1394 "members": [1397 "members": [


1411 "ident": "type"1414 "ident": "type"

1412 }1415 }

1413 ]1416 ]

1417 }

1414 },1418 },

1415 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results"1419 "optional": false,

1416 },1420 "nullable": false,

1417 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results",

1418 "deprecated": false,

1419 "schemaType": "array",1421 "schemaType": "array",

1420 "childrenParentSchema": "object",1422 "childrenParentSchema": "object",

1421 "children": [1423 "children": [


1429 },1431 },

1430 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) type": {1432 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) type": {

1431 "kind": "HttpDeclProperty",1433 "kind": "HttpDeclProperty",

1432 "docstring": "The object type, which is always `moderation_results`.",1434 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type",

1435 "deprecated": false,

1433 "key": "type",1436 "key": "type",

1434 "optional": false,1437 "docstring": "The object type, which is always `moderation_results`.",

1435 "nullable": false,

1436 "type": {1438 "type": {

1437 "kind": "HttpTypeUnion",1439 "kind": "HttpTypeUnion",

1440 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type",

1438 "types": [1441 "types": [

1439 {1442 {

1440 "kind": "HttpTypeLiteral",1443 "kind": "HttpTypeLiteral",

1441 "literal": "moderation_results"1444 "literal": "moderation_results"

1442 }1445 }

1443 ],1446 ]

1444 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type"

1445 },1447 },

1446 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type",1448 "optional": false,

1447 "deprecated": false,1449 "nullable": false,

1448 "schemaType": "enum",1450 "schemaType": "enum",

1449 "childrenParentSchema": "enum",1451 "childrenParentSchema": "enum",

1450 "children": [1452 "children": [


1453 },1455 },

1454 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) code": {1456 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) code": {

1455 "kind": "HttpDeclProperty",1457 "kind": "HttpDeclProperty",

1456 "docstring": "The error code.",1458 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/code",

1459 "deprecated": false,

1457 "key": "code",1460 "key": "code",

1458 "optional": false,1461 "docstring": "The error code.",

1459 "nullable": false,

1460 "type": {1462 "type": {

1461 "kind": "HttpTypeString"1463 "kind": "HttpTypeString"

1462 },1464 },

1463 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/code",1465 "optional": false,

1464 "deprecated": false,1466 "nullable": false,

1465 "schemaType": "string",1467 "schemaType": "string",

1466 "children": []1468 "children": []

1467 },1469 },

1468 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) message": {1470 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) message": {

1469 "kind": "HttpDeclProperty",1471 "kind": "HttpDeclProperty",

1470 "docstring": "The error message.",1472 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/message",

1473 "deprecated": false,

1471 "key": "message",1474 "key": "message",

1472 "optional": false,1475 "docstring": "The error message.",

1473 "nullable": false,

1474 "type": {1476 "type": {

1475 "kind": "HttpTypeString"1477 "kind": "HttpTypeString"

1476 },1478 },

1477 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/message",1479 "optional": false,

1478 "deprecated": false,1480 "nullable": false,

1479 "schemaType": "string",1481 "schemaType": "string",

1480 "children": []1482 "children": []

1481 },1483 },

1482 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) type": {1484 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 1 > (property) type": {

1483 "kind": "HttpDeclProperty",1485 "kind": "HttpDeclProperty",

1484 "docstring": "The object type, which is always `error`.",1486 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type",

1487 "deprecated": false,

1485 "key": "type",1488 "key": "type",

1486 "optional": false,1489 "docstring": "The object type, which is always `error`.",

1487 "nullable": false,

1488 "type": {1490 "type": {

1489 "kind": "HttpTypeUnion",1491 "kind": "HttpTypeUnion",

1492 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type",

1490 "types": [1493 "types": [

1491 {1494 {

1492 "kind": "HttpTypeLiteral",1495 "kind": "HttpTypeLiteral",

1493 "literal": "error"1496 "literal": "error"

1494 }1497 }

1495 ],1498 ]

1496 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type"

1497 },1499 },

1498 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type",1500 "optional": false,

1499 "deprecated": false,1501 "nullable": false,

1500 "schemaType": "enum",1502 "schemaType": "enum",

1501 "childrenParentSchema": "enum",1503 "childrenParentSchema": "enum",

1502 "children": [1504 "children": [


1505 },1507 },

1506 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) model": {1508 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) model": {

1507 "kind": "HttpDeclProperty",1509 "kind": "HttpDeclProperty",

1508 "docstring": "The moderation model used to generate the results.",1510 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/model",

1511 "deprecated": false,

1509 "key": "model",1512 "key": "model",

1510 "optional": false,1513 "docstring": "The moderation model used to generate the results.",

1511 "nullable": false,

1512 "type": {1514 "type": {

1513 "kind": "HttpTypeString"1515 "kind": "HttpTypeString"

1514 },1516 },

1515 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/model",1517 "optional": false,

1516 "deprecated": false,1518 "nullable": false,

1517 "schemaType": "string",1519 "schemaType": "string",

1518 "children": []1520 "children": []

1519 },1521 },

1520 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results": {1522 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results": {

1521 "kind": "HttpDeclProperty",1523 "kind": "HttpDeclProperty",

1522 "docstring": "A list of moderation results.",1524 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results",

1525 "deprecated": false,

1523 "key": "results",1526 "key": "results",

1524 "optional": false,1527 "docstring": "A list of moderation results.",

1525 "nullable": false,

1526 "type": {1528 "type": {

1527 "kind": "HttpTypeArray",1529 "kind": "HttpTypeArray",

1530 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results",

1528 "elementType": {1531 "elementType": {

1529 "kind": "HttpTypeObject",1532 "kind": "HttpTypeObject",

1530 "members": [1533 "members": [


1547 "ident": "type"1550 "ident": "type"

1548 }1551 }

1549 ]1552 ]

1553 }

1550 },1554 },

1551 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results"1555 "optional": false,

1552 },1556 "nullable": false,

1553 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/results",

1554 "deprecated": false,

1555 "schemaType": "array",1557 "schemaType": "array",

1556 "childrenParentSchema": "object",1558 "childrenParentSchema": "object",

1557 "children": [1559 "children": [


1565 },1567 },

1566 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) type": {1568 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) type": {

1567 "kind": "HttpDeclProperty",1569 "kind": "HttpDeclProperty",

1568 "docstring": "The object type, which is always `moderation_results`.",1570 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type",

1571 "deprecated": false,

1569 "key": "type",1572 "key": "type",

1570 "optional": false,1573 "docstring": "The object type, which is always `moderation_results`.",

1571 "nullable": false,

1572 "type": {1574 "type": {

1573 "kind": "HttpTypeUnion",1575 "kind": "HttpTypeUnion",

1576 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type",

1574 "types": [1577 "types": [

1575 {1578 {

1576 "kind": "HttpTypeLiteral",1579 "kind": "HttpTypeLiteral",

1577 "literal": "moderation_results"1580 "literal": "moderation_results"

1578 }1581 }

1579 ],1582 ]

1580 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type"

1581 },1583 },

1582 "oasRef": "#/components/schemas/ChatCompletionModerationResults/properties/type",1584 "optional": false,

1583 "deprecated": false,1585 "nullable": false,

1584 "schemaType": "enum",1586 "schemaType": "enum",

1585 "childrenParentSchema": "enum",1587 "childrenParentSchema": "enum",

1586 "children": [1588 "children": [


1589 },1591 },

1590 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) code": {1592 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) code": {

1591 "kind": "HttpDeclProperty",1593 "kind": "HttpDeclProperty",

1592 "docstring": "The error code.",1594 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/code",

1595 "deprecated": false,

1593 "key": "code",1596 "key": "code",

1594 "optional": false,1597 "docstring": "The error code.",

1595 "nullable": false,

1596 "type": {1598 "type": {

1597 "kind": "HttpTypeString"1599 "kind": "HttpTypeString"

1598 },1600 },

1599 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/code",1601 "optional": false,

1600 "deprecated": false,1602 "nullable": false,

1601 "schemaType": "string",1603 "schemaType": "string",

1602 "children": []1604 "children": []

1603 },1605 },

1604 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) message": {1606 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) message": {

1605 "kind": "HttpDeclProperty",1607 "kind": "HttpDeclProperty",

1606 "docstring": "The error message.",1608 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/message",

1609 "deprecated": false,

1607 "key": "message",1610 "key": "message",

1608 "optional": false,1611 "docstring": "The error message.",

1609 "nullable": false,

1610 "type": {1612 "type": {

1611 "kind": "HttpTypeString"1613 "kind": "HttpTypeString"

1612 },1614 },

1613 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/message",1615 "optional": false,

1614 "deprecated": false,1616 "nullable": false,

1615 "schemaType": "string",1617 "schemaType": "string",

1616 "children": []1618 "children": []

1617 },1619 },

1618 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) type": {1620 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 1 > (property) type": {

1619 "kind": "HttpDeclProperty",1621 "kind": "HttpDeclProperty",

1620 "docstring": "The object type, which is always `error`.",1622 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type",

1623 "deprecated": false,

1621 "key": "type",1624 "key": "type",

1622 "optional": false,1625 "docstring": "The object type, which is always `error`.",

1623 "nullable": false,

1624 "type": {1626 "type": {

1625 "kind": "HttpTypeUnion",1627 "kind": "HttpTypeUnion",

1628 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type",

1626 "types": [1629 "types": [

1627 {1630 {

1628 "kind": "HttpTypeLiteral",1631 "kind": "HttpTypeLiteral",

1629 "literal": "error"1632 "literal": "error"

1630 }1633 }

1631 ],1634 ]

1632 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type"

1633 },1635 },

1634 "oasRef": "#/components/schemas/ChatCompletionModerationError/properties/type",1636 "optional": false,

1635 "deprecated": false,1637 "nullable": false,

1636 "schemaType": "enum",1638 "schemaType": "enum",

1637 "childrenParentSchema": "enum",1639 "childrenParentSchema": "enum",

1638 "children": [1640 "children": [


1641 },1643 },

1642 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) function > (property) arguments": {1644 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) function > (property) arguments": {

1643 "kind": "HttpDeclProperty",1645 "kind": "HttpDeclProperty",

1644 "docstring": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.",1646 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/function/properties/arguments",

1647 "deprecated": false,

1645 "key": "arguments",1648 "key": "arguments",

1646 "optional": true,1649 "docstring": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.",

1647 "nullable": false,

1648 "type": {1650 "type": {

1649 "kind": "HttpTypeString"1651 "kind": "HttpTypeString"

1650 },1652 },

1651 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/function/properties/arguments",1653 "optional": true,

1652 "deprecated": false,1654 "nullable": false,

1653 "schemaType": "string",1655 "schemaType": "string",

1654 "children": []1656 "children": []

1655 },1657 },

1656 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) function > (property) name": {1658 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) choices > (items) > (property) delta > (property) tool_calls > (items) > (property) function > (property) name": {

1657 "kind": "HttpDeclProperty",1659 "kind": "HttpDeclProperty",

1658 "docstring": "The name of the function to call.",1660 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/function/properties/name",

1661 "deprecated": false,

1659 "key": "name",1662 "key": "name",

1660 "optional": true,1663 "docstring": "The name of the function to call.",

1661 "nullable": false,

1662 "type": {1664 "type": {

1663 "kind": "HttpTypeString"1665 "kind": "HttpTypeString"

1664 },1666 },

1665 "oasRef": "#/components/schemas/ChatCompletionMessageToolCallChunk/properties/function/properties/name",1667 "optional": true,

1666 "deprecated": false,1668 "nullable": false,

1667 "schemaType": "string",1669 "schemaType": "string",

1668 "children": []1670 "children": []

1669 },1671 },


1676 },1678 },

1677 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs > (items) > (property) token": {1679 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs > (items) > (property) token": {

1678 "kind": "HttpDeclProperty",1680 "kind": "HttpDeclProperty",

1679 "docstring": "The token.",1681 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/token",

1682 "deprecated": false,

1680 "key": "token",1683 "key": "token",

1681 "optional": false,1684 "docstring": "The token.",

1682 "nullable": false,

1683 "type": {1685 "type": {

1684 "kind": "HttpTypeString"1686 "kind": "HttpTypeString"

1685 },1687 },

1686 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/token",1688 "optional": false,

1687 "deprecated": false,1689 "nullable": false,

1688 "schemaType": "string",1690 "schemaType": "string",

1689 "children": []1691 "children": []

1690 },1692 },

1691 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs > (items) > (property) bytes": {1693 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs > (items) > (property) bytes": {

1692 "kind": "HttpDeclProperty",1694 "kind": "HttpDeclProperty",

1693 "docstring": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.",1695 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/bytes",

1696 "deprecated": false,

1694 "key": "bytes",1697 "key": "bytes",

1695 "optional": false,1698 "docstring": "A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token.",

1696 "nullable": true,

1697 "type": {1699 "type": {

1698 "kind": "HttpTypeArray",1700 "kind": "HttpTypeArray",

1701 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/bytes",

1699 "elementType": {1702 "elementType": {

1700 "kind": "HttpTypeNumber"1703 "kind": "HttpTypeNumber"

1704 }

1701 },1705 },

1702 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/bytes"1706 "optional": false,

1703 },1707 "nullable": true,

1704 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/bytes",

1705 "deprecated": false,

1706 "schemaType": "array",1708 "schemaType": "array",

1707 "children": []1709 "children": []

1708 },1710 },

1709 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs > (items) > (property) logprob": {1711 "(resource) chat.completions > (model) chat_completion_token_logprob > (schema) > (property) top_logprobs > (items) > (property) logprob": {

1710 "kind": "HttpDeclProperty",1712 "kind": "HttpDeclProperty",

1711 "docstring": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.",1713 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/logprob",

1714 "deprecated": false,

1712 "key": "logprob",1715 "key": "logprob",

1713 "optional": false,1716 "docstring": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely.",

1714 "nullable": false,

1715 "type": {1717 "type": {

1716 "kind": "HttpTypeNumber"1718 "kind": "HttpTypeNumber"

1717 },1719 },

1718 "oasRef": "#/components/schemas/ChatCompletionTokenLogprob/properties/top_logprobs/items/properties/logprob",1720 "optional": false,

1719 "deprecated": false,1721 "nullable": false,

1720 "schemaType": "number",1722 "schemaType": "number",

1721 "children": []1723 "children": []

1722 },1724 },

1723 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) categories": {1725 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) categories": {

1724 "kind": "HttpDeclProperty",1726 "kind": "HttpDeclProperty",

1725 "docstring": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.",1727 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories",

1728 "deprecated": false,

1726 "key": "categories",1729 "key": "categories",

1727 "optional": false,1730 "docstring": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.",

1728 "nullable": false,

1729 "type": {1731 "type": {

1730 "kind": "HttpTypeReference",1732 "kind": "HttpTypeReference",

1733 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories",

1731 "ident": "Record",1734 "ident": "Record",

1732 "typeParameters": [1735 "typeParameters": [

1733 {1736 {


1736 {1739 {

1737 "kind": "HttpTypeBoolean"1740 "kind": "HttpTypeBoolean"

1738 }1741 }

1739 ],1742 ]

1740 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories"

1741 },1743 },

1742 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories",1744 "optional": false,

1743 "deprecated": false,1745 "nullable": false,

1744 "schemaType": "map",1746 "schemaType": "map",

1745 "children": []1747 "children": []

1746 },1748 },

1747 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) category_applied_input_types": {1749 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) category_applied_input_types": {

1748 "kind": "HttpDeclProperty",1750 "kind": "HttpDeclProperty",

1749 "docstring": "Which modalities of input are reflected by the score for each category.",1751 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types",

1752 "deprecated": false,

1750 "key": "category_applied_input_types",1753 "key": "category_applied_input_types",

1751 "optional": false,1754 "docstring": "Which modalities of input are reflected by the score for each category.",

1752 "nullable": false,

1753 "type": {1755 "type": {

1754 "kind": "HttpTypeReference",1756 "kind": "HttpTypeReference",

1757 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types",

1755 "ident": "Record",1758 "ident": "Record",

1756 "typeParameters": [1759 "typeParameters": [

1757 {1760 {


1759 },1762 },

1760 {1763 {

1761 "kind": "HttpTypeArray",1764 "kind": "HttpTypeArray",

1765 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties",

1762 "elementType": {1766 "elementType": {

1763 "kind": "HttpTypeUnion",1767 "kind": "HttpTypeUnion",

1768 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties/items",

1764 "types": [1769 "types": [

1765 {1770 {

1766 "kind": "HttpTypeLiteral",1771 "kind": "HttpTypeLiteral",


1770 "kind": "HttpTypeLiteral",1775 "kind": "HttpTypeLiteral",

1771 "literal": "image"1776 "literal": "image"

1772 }1777 }

1773 ],1778 ]

1774 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties/items"1779 }

1775 },

1776 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties"

1777 }1780 }

1778 ],1781 ]

1779 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types"

1780 },1782 },

1781 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types",1783 "optional": false,

1782 "deprecated": false,1784 "nullable": false,

1783 "schemaType": "map",1785 "schemaType": "map",

1784 "childrenParentSchema": "enum",1786 "childrenParentSchema": "enum",

1785 "children": [1787 "children": [


1789 },1791 },

1790 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) category_scores": {1792 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) category_scores": {

1791 "kind": "HttpDeclProperty",1793 "kind": "HttpDeclProperty",

1792 "docstring": "A dictionary of moderation categories to scores.",1794 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores",

1795 "deprecated": false,

1793 "key": "category_scores",1796 "key": "category_scores",

1794 "optional": false,1797 "docstring": "A dictionary of moderation categories to scores.",

1795 "nullable": false,

1796 "type": {1798 "type": {

1797 "kind": "HttpTypeReference",1799 "kind": "HttpTypeReference",

1800 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores",

1798 "ident": "Record",1801 "ident": "Record",

1799 "typeParameters": [1802 "typeParameters": [

1800 {1803 {


1803 {1806 {

1804 "kind": "HttpTypeNumber"1807 "kind": "HttpTypeNumber"

1805 }1808 }

1806 ],1809 ]

1807 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores"

1808 },1810 },

1809 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores",1811 "optional": false,

1810 "deprecated": false,1812 "nullable": false,

1811 "schemaType": "map",1813 "schemaType": "map",

1812 "children": []1814 "children": []

1813 },1815 },

1814 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) flagged": {1816 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) flagged": {

1815 "kind": "HttpDeclProperty",1817 "kind": "HttpDeclProperty",

1816 "docstring": "A boolean indicating whether the content was flagged by any category.",1818 "oasRef": "#/components/schemas/ModerationResultBody/properties/flagged",

1819 "deprecated": false,

1817 "key": "flagged",1820 "key": "flagged",

1818 "optional": false,1821 "docstring": "A boolean indicating whether the content was flagged by any category.",

1819 "nullable": false,

1820 "type": {1822 "type": {

1821 "kind": "HttpTypeBoolean"1823 "kind": "HttpTypeBoolean"

1822 },1824 },

1823 "oasRef": "#/components/schemas/ModerationResultBody/properties/flagged",1825 "optional": false,

1824 "deprecated": false,1826 "nullable": false,

1825 "schemaType": "boolean",1827 "schemaType": "boolean",

1826 "children": []1828 "children": []

1827 },1829 },

1828 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) model": {1830 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) model": {

1829 "kind": "HttpDeclProperty",1831 "kind": "HttpDeclProperty",

1830 "docstring": "The moderation model that produced this result.",1832 "oasRef": "#/components/schemas/ModerationResultBody/properties/model",

1833 "deprecated": false,

1831 "key": "model",1834 "key": "model",

1832 "optional": false,1835 "docstring": "The moderation model that produced this result.",

1833 "nullable": false,

1834 "type": {1836 "type": {

1835 "kind": "HttpTypeString"1837 "kind": "HttpTypeString"

1836 },1838 },

1837 "oasRef": "#/components/schemas/ModerationResultBody/properties/model",1839 "optional": false,

1838 "deprecated": false,1840 "nullable": false,

1839 "schemaType": "string",1841 "schemaType": "string",

1840 "children": []1842 "children": []

1841 },1843 },

1842 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) type": {1844 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) input > (variant) 0 > (property) results > (items) > (property) type": {

1843 "kind": "HttpDeclProperty",1845 "kind": "HttpDeclProperty",

1844 "docstring": "The object type, which was always `moderation_result` for successful moderation results.",1846 "oasRef": "#/components/schemas/ModerationResultBody/properties/type",

1847 "deprecated": false,

1845 "key": "type",1848 "key": "type",

1846 "optional": false,1849 "docstring": "The object type, which was always `moderation_result` for successful moderation results.",

1847 "nullable": false,

1848 "default": "moderation_result",

1849 "type": {1850 "type": {

1850 "kind": "HttpTypeUnion",1851 "kind": "HttpTypeUnion",

1852 "oasRef": "#/components/schemas/ModerationResultBody/properties/type",

1851 "types": [1853 "types": [

1852 {1854 {

1853 "kind": "HttpTypeLiteral",1855 "kind": "HttpTypeLiteral",

1854 "literal": "moderation_result"1856 "literal": "moderation_result"

1855 }1857 }

1856 ],1858 ]

1857 "oasRef": "#/components/schemas/ModerationResultBody/properties/type"

1858 },1859 },

1859 "oasRef": "#/components/schemas/ModerationResultBody/properties/type",1860 "default": "moderation_result",

1860 "deprecated": false,1861 "optional": false,

1862 "nullable": false,

1861 "schemaType": "enum",1863 "schemaType": "enum",

1862 "childrenParentSchema": "enum",1864 "childrenParentSchema": "enum",

1863 "children": [1865 "children": [


1880 },1882 },

1881 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) categories": {1883 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) categories": {

1882 "kind": "HttpDeclProperty",1884 "kind": "HttpDeclProperty",

1883 "docstring": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.",1885 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories",

1886 "deprecated": false,

1884 "key": "categories",1887 "key": "categories",

1885 "optional": false,1888 "docstring": "A dictionary of moderation categories to booleans, True if the input is flagged under this category.",

1886 "nullable": false,

1887 "type": {1889 "type": {

1888 "kind": "HttpTypeReference",1890 "kind": "HttpTypeReference",

1891 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories",

1889 "ident": "Record",1892 "ident": "Record",

1890 "typeParameters": [1893 "typeParameters": [

1891 {1894 {


1894 {1897 {

1895 "kind": "HttpTypeBoolean"1898 "kind": "HttpTypeBoolean"

1896 }1899 }

1897 ],1900 ]

1898 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories"

1899 },1901 },

1900 "oasRef": "#/components/schemas/ModerationResultBody/properties/categories",1902 "optional": false,

1901 "deprecated": false,1903 "nullable": false,

1902 "schemaType": "map",1904 "schemaType": "map",

1903 "children": []1905 "children": []

1904 },1906 },

1905 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) category_applied_input_types": {1907 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) category_applied_input_types": {

1906 "kind": "HttpDeclProperty",1908 "kind": "HttpDeclProperty",

1907 "docstring": "Which modalities of input are reflected by the score for each category.",1909 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types",

1910 "deprecated": false,

1908 "key": "category_applied_input_types",1911 "key": "category_applied_input_types",

1909 "optional": false,1912 "docstring": "Which modalities of input are reflected by the score for each category.",

1910 "nullable": false,

1911 "type": {1913 "type": {

1912 "kind": "HttpTypeReference",1914 "kind": "HttpTypeReference",

1915 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types",

1913 "ident": "Record",1916 "ident": "Record",

1914 "typeParameters": [1917 "typeParameters": [

1915 {1918 {


1917 },1920 },

1918 {1921 {

1919 "kind": "HttpTypeArray",1922 "kind": "HttpTypeArray",

1923 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties",

1920 "elementType": {1924 "elementType": {

1921 "kind": "HttpTypeUnion",1925 "kind": "HttpTypeUnion",

1926 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties/items",

1922 "types": [1927 "types": [

1923 {1928 {

1924 "kind": "HttpTypeLiteral",1929 "kind": "HttpTypeLiteral",


1928 "kind": "HttpTypeLiteral",1933 "kind": "HttpTypeLiteral",

1929 "literal": "image"1934 "literal": "image"

1930 }1935 }

1931 ],1936 ]

1932 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties/items"

1933 },

1934 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types/additionalProperties"

1935 }1937 }

1936 ],1938 }

1937 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types"1939 ]

1938 },1940 },

1939 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_applied_input_types",1941 "optional": false,

1940 "deprecated": false,1942 "nullable": false,

1941 "schemaType": "map",1943 "schemaType": "map",

1942 "childrenParentSchema": "enum",1944 "childrenParentSchema": "enum",

1943 "children": [1945 "children": [


1947 },1949 },

1948 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) category_scores": {1950 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) category_scores": {

1949 "kind": "HttpDeclProperty",1951 "kind": "HttpDeclProperty",

1950 "docstring": "A dictionary of moderation categories to scores.",1952 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores",

1953 "deprecated": false,

1951 "key": "category_scores",1954 "key": "category_scores",

1952 "optional": false,1955 "docstring": "A dictionary of moderation categories to scores.",

1953 "nullable": false,

1954 "type": {1956 "type": {

1955 "kind": "HttpTypeReference",1957 "kind": "HttpTypeReference",

1958 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores",

1956 "ident": "Record",1959 "ident": "Record",

1957 "typeParameters": [1960 "typeParameters": [

1958 {1961 {


1961 {1964 {

1962 "kind": "HttpTypeNumber"1965 "kind": "HttpTypeNumber"

1963 }1966 }

1964 ],1967 ]

1965 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores"

1966 },1968 },

1967 "oasRef": "#/components/schemas/ModerationResultBody/properties/category_scores",1969 "optional": false,

1968 "deprecated": false,1970 "nullable": false,

1969 "schemaType": "map",1971 "schemaType": "map",

1970 "children": []1972 "children": []

1971 },1973 },

1972 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) flagged": {1974 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) flagged": {

1973 "kind": "HttpDeclProperty",1975 "kind": "HttpDeclProperty",

1974 "docstring": "A boolean indicating whether the content was flagged by any category.",1976 "oasRef": "#/components/schemas/ModerationResultBody/properties/flagged",

1977 "deprecated": false,

1975 "key": "flagged",1978 "key": "flagged",

1976 "optional": false,1979 "docstring": "A boolean indicating whether the content was flagged by any category.",

1977 "nullable": false,

1978 "type": {1980 "type": {

1979 "kind": "HttpTypeBoolean"1981 "kind": "HttpTypeBoolean"

1980 },1982 },

1981 "oasRef": "#/components/schemas/ModerationResultBody/properties/flagged",1983 "optional": false,

1982 "deprecated": false,1984 "nullable": false,

1983 "schemaType": "boolean",1985 "schemaType": "boolean",

1984 "children": []1986 "children": []

1985 },1987 },

1986 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) model": {1988 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) model": {

1987 "kind": "HttpDeclProperty",1989 "kind": "HttpDeclProperty",

1988 "docstring": "The moderation model that produced this result.",1990 "oasRef": "#/components/schemas/ModerationResultBody/properties/model",

1991 "deprecated": false,

1989 "key": "model",1992 "key": "model",

1990 "optional": false,1993 "docstring": "The moderation model that produced this result.",

1991 "nullable": false,

1992 "type": {1994 "type": {

1993 "kind": "HttpTypeString"1995 "kind": "HttpTypeString"

1994 },1996 },

1995 "oasRef": "#/components/schemas/ModerationResultBody/properties/model",1997 "optional": false,

1996 "deprecated": false,1998 "nullable": false,

1997 "schemaType": "string",1999 "schemaType": "string",

1998 "children": []2000 "children": []

1999 },2001 },

2000 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) type": {2002 "(resource) chat.completions > (model) chat_completion_chunk > (schema) > (property) moderation > (property) output > (variant) 0 > (property) results > (items) > (property) type": {

2001 "kind": "HttpDeclProperty",2003 "kind": "HttpDeclProperty",

2002 "docstring": "The object type, which was always `moderation_result` for successful moderation results.",2004 "oasRef": "#/components/schemas/ModerationResultBody/properties/type",

2005 "deprecated": false,

2003 "key": "type",2006 "key": "type",

2004 "optional": false,2007 "docstring": "The object type, which was always `moderation_result` for successful moderation results.",

2005 "nullable": false,

2006 "default": "moderation_result",

2007 "type": {2008 "type": {

2008 "kind": "HttpTypeUnion",2009 "kind": "HttpTypeUnion",

2010 "oasRef": "#/components/schemas/ModerationResultBody/properties/type",

2009 "types": [2011 "types": [

2010 {2012 {

2011 "kind": "HttpTypeLiteral",2013 "kind": "HttpTypeLiteral",

2012 "literal": "moderation_result"2014 "literal": "moderation_result"

2013 }2015 }

2014 ],2016 ]

2015 "oasRef": "#/components/schemas/ModerationResultBody/properties/type"

2016 },2017 },

2017 "oasRef": "#/components/schemas/ModerationResultBody/properties/type",2018 "default": "moderation_result",

2018 "deprecated": false,2019 "optional": false,

2020 "nullable": false,

2019 "schemaType": "enum",2021 "schemaType": "enum",

2020 "childrenParentSchema": "enum",2022 "childrenParentSchema": "enum",

2021 "children": [2023 "children": [

Details

55```http55```http

56curl https://api.openai.com/v1/containers/$CONTAINER_ID/files \56curl https://api.openai.com/v1/containers/$CONTAINER_ID/files \

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

58 -H "Authorization: Bearer $OPENAI_API_KEY"58 -H "Authorization: Bearer $OPENAI_API_KEY" \

59 -d '{}'

59```60```

60 61 

61#### Response62#### Response

Details

307 307 

308 - `"string_check"`308 - `"string_check"`

309 309 

310 - `TextSimilarityGrader = TextSimilarityGrader`310 - `TextSimilarity = TextSimilarityGrader`

311 311 

312 A TextSimilarityGrader object which grades text based on similarity metrics.312 A TextSimilarityGrader object which grades text based on similarity metrics.

313 313 


315 315 

316 The threshold for the score.316 The threshold for the score.

317 317 

318 - `PythonGrader = PythonGrader`318 - `Python = PythonGrader`

319 319 

320 A PythonGrader object that runs a python script on the input.320 A PythonGrader object that runs a python script on the input.

321 321 


323 323 

324 The threshold for the score.324 The threshold for the score.

325 325 

326 - `ScoreModelGrader = ScoreModelGrader`326 - `ScoreModel = ScoreModelGrader`

327 327 

328 A ScoreModelGrader object that uses a model to assign a score to the input.328 A ScoreModelGrader object that uses a model to assign a score to the input.

329 329 

Details

604}604}

605```605```

606 606 

607### Score text alignment607### Score an audio response

608 608 

609```http609```http

610curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \610curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \


613 -d '{613 -d '{

614 "grader": {614 "grader": {

615 "type": "score_model",615 "type": "score_model",

616 "name": "Example score model grader",616 "name": "Audio clarity grader",

617 "input": [617 "input": [

618 {618 {

619 "role": "user",619 "role": "user",

620 "content": [620 "content": [

621 {621 {

622 "type": "input_text",622 "type": "input_text",

623 "text": "Score how close the reference answer is to the model answer on a 0-1 scale. Return only the score.\n\nReference answer: {{item.reference_answer}}\n\nModel answer: {{sample.output_text}}"623 "text": "Listen to the clip and return a confidence score from 0 to 1 that the speaker said: {{item.target_phrase}}"

624 },

625 {

626 "type": "input_audio",

627 "input_audio": {

628 "data": "{{item.audio_clip_b64}}",

629 "format": "mp3"

630 }

624 }631 }

625 ]632 ]

626 }633 }

627 ],634 ],

628 "model": "gpt-5-mini",635 "model": "gpt-audio",

629 "sampling_params": {636 "sampling_params": {

630 "temperature": 1,637 "temperature": 0.2,

631 "top_p": 1,638 "top_p": 1,

632 "seed": 42639 "seed": 123

633 }640 }

634 },641 },

635 "item": {642 "item": {

636 "reference_answer": "fuzzy wuzzy was a bear"643 "target_phrase": "Please deliver the package on Tuesday",

644 "audio_clip_b64": "<base64-encoded mp3>"

637 },645 },

638 "model_sample": "fuzzy wuzzy was a bear"646 "model_sample": "Please deliver the package on Tuesday"

639 }'647 }'

640```648```

641 649 

642#### Response

643 

644```json

645{

646 "reward": 1.0,

647 "metadata": {

648 "name": "Example score model grader",

649 "type": "score_model",

650 "errors": {

651 "formula_parse_error": false,

652 "sample_parse_error": false,

653 "truncated_observation_error": false,

654 "unresponsive_reward_error": false,

655 "invalid_variable_error": false,

656 "other_error": false,

657 "python_grader_server_error": false,

658 "python_grader_server_error_type": null,

659 "python_grader_runtime_error": false,

660 "python_grader_runtime_error_details": null,

661 "model_grader_server_error": false,

662 "model_grader_refusal_error": false,

663 "model_grader_parse_error": false,

664 "model_grader_server_error_details": null

665 },

666 "execution_time": 4.365238428115845,

667 "scores": {},

668 "token_usage": {

669 "prompt_tokens": 190,

670 "total_tokens": 324,

671 "completion_tokens": 134,

672 "cached_tokens": 0

673 },

674 "sampled_model_name": "gpt-4o-2024-08-06"

675 },

676 "sub_rewards": {},

677 "model_grader_token_usage_per_model": {

678 "gpt-4o-2024-08-06": {

679 "prompt_tokens": 190,

680 "total_tokens": 324,

681 "completion_tokens": 134,

682 "cached_tokens": 0

683 }

684 }

685}

686```

687 

688### Score an image caption650### Score an image caption

689 651 

690```http652```http


724 }'686 }'

725```687```

726 688 

727### Score an audio response689### Score text alignment

728 690 

729```http691```http

730curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \692curl -X POST https://api.openai.com/v1/fine_tuning/alpha/graders/run \


733 -d '{695 -d '{

734 "grader": {696 "grader": {

735 "type": "score_model",697 "type": "score_model",

736 "name": "Audio clarity grader",698 "name": "Example score model grader",

737 "input": [699 "input": [

738 {700 {

739 "role": "user",701 "role": "user",

740 "content": [702 "content": [

741 {703 {

742 "type": "input_text",704 "type": "input_text",

743 "text": "Listen to the clip and return a confidence score from 0 to 1 that the speaker said: {{item.target_phrase}}"705 "text": "Score how close the reference answer is to the model answer on a 0-1 scale. Return only the score.\n\nReference answer: {{item.reference_answer}}\n\nModel answer: {{sample.output_text}}"

744 },

745 {

746 "type": "input_audio",

747 "input_audio": {

748 "data": "{{item.audio_clip_b64}}",

749 "format": "mp3"

750 }

751 }706 }

752 ]707 ]

753 }708 }

754 ],709 ],

755 "model": "gpt-audio",710 "model": "gpt-5-mini",

756 "sampling_params": {711 "sampling_params": {

757 "temperature": 0.2,712 "temperature": 1,

758 "top_p": 1,713 "top_p": 1,

759 "seed": 123714 "seed": 42

760 }715 }

761 },716 },

762 "item": {717 "item": {

763 "target_phrase": "Please deliver the package on Tuesday",718 "reference_answer": "fuzzy wuzzy was a bear"

764 "audio_clip_b64": "<base64-encoded mp3>"

765 },719 },

766 "model_sample": "Please deliver the package on Tuesday"720 "model_sample": "fuzzy wuzzy was a bear"

767 }'721 }'

768```722```

723 

724#### Response

725 

726```json

727{

728 "reward": 1.0,

729 "metadata": {

730 "name": "Example score model grader",

731 "type": "score_model",

732 "errors": {

733 "formula_parse_error": false,

734 "sample_parse_error": false,

735 "truncated_observation_error": false,

736 "unresponsive_reward_error": false,

737 "invalid_variable_error": false,

738 "other_error": false,

739 "python_grader_server_error": false,

740 "python_grader_server_error_type": null,

741 "python_grader_runtime_error": false,

742 "python_grader_runtime_error_details": null,

743 "model_grader_server_error": false,

744 "model_grader_refusal_error": false,

745 "model_grader_parse_error": false,

746 "model_grader_server_error_details": null

747 },

748 "execution_time": 4.365238428115845,

749 "scores": {},

750 "token_usage": {

751 "prompt_tokens": 190,

752 "total_tokens": 324,

753 "completion_tokens": 134,

754 "cached_tokens": 0

755 },

756 "sampled_model_name": "gpt-4o-2024-08-06"

757 },

758 "sub_rewards": {},

759 "model_grader_token_usage_per_model": {

760 "gpt-4o-2024-08-06": {

761 "prompt_tokens": 190,

762 "total_tokens": 324,

763 "completion_tokens": 134,

764 "cached_tokens": 0

765 }

766 }

767}

768```

Details

1730}1730}

1731```1731```

1732 1732 

1733### Example1733### DPO

1734 1734 

1735```http1735```http

1736curl https://api.openai.com/v1/fine_tuning/jobs \1736curl https://api.openai.com/v1/fine_tuning/jobs \

1737 -H "Content-Type: application/json" \1737 -H "Content-Type: application/json" \

1738 -H "Authorization: Bearer $OPENAI_API_KEY" \1738 -H "Authorization: Bearer $OPENAI_API_KEY" \

1739 -d '{1739 -d '{

1740 "training_file": "file-BK7bzQj3FfZFXr7DbL6xJwfo",1740 "training_file": "file-abc123",

1741 "model": "gpt-4o-mini"1741 "validation_file": "file-abc123",

1742 "model": "gpt-4o-mini",

1743 "method": {

1744 "type": "dpo",

1745 "dpo": {

1746 "hyperparameters": {

1747 "beta": 0.1

1748 }

1749 }

1750 }

1742 }'1751 }'

1743```1752```

1744 1753 


1747```json1756```json

1748{1757{

1749 "object": "fine_tuning.job",1758 "object": "fine_tuning.job",

1750 "id": "ftjob-abc123",1759 "id": "ftjob-abc",

1751 "model": "gpt-4o-mini-2024-07-18",1760 "model": "gpt-4o-mini",

1752 "created_at": 1721764800,1761 "created_at": 1746130590,

1753 "fine_tuned_model": null,1762 "fine_tuned_model": null,

1754 "organization_id": "org-123",1763 "organization_id": "org-abc",

1755 "result_files": [],1764 "result_files": [],

1756 "status": "queued",1765 "status": "queued",

1757 "validation_file": null,1766 "validation_file": "file-123",

1758 "training_file": "file-abc123",1767 "training_file": "file-abc",

1759 "method": {1768 "method": {

1760 "type": "supervised",1769 "type": "dpo",

1761 "supervised": {1770 "dpo": {

1762 "hyperparameters": {1771 "hyperparameters": {

1772 "beta": 0.1,

1763 "batch_size": "auto",1773 "batch_size": "auto",

1764 "learning_rate_multiplier": "auto",1774 "learning_rate_multiplier": "auto",

1765 "n_epochs": "auto",1775 "n_epochs": "auto"

1766 }1776 }

1767 }1777 }

1768 },1778 },

1769 "metadata": null1779 "metadata": null,

1780 "error": {

1781 "code": null,

1782 "message": null,

1783 "param": null

1784 },

1785 "finished_at": null,

1786 "hyperparameters": null,

1787 "seed": 1036326793,

1788 "estimated_finish": null,

1789 "integrations": [],

1790 "user_provided_suffix": null,

1791 "usage_metrics": null,

1792 "shared_with_openai": false

1770}1793}

1771```1794```

1772 1795 

1773### Epochs1796### Example

1774 1797 

1775```http1798```http

1776curl https://api.openai.com/v1/fine_tuning/jobs \1799curl https://api.openai.com/v1/fine_tuning/jobs \

1777 -H "Content-Type: application/json" \1800 -H "Content-Type: application/json" \

1778 -H "Authorization: Bearer $OPENAI_API_KEY" \1801 -H "Authorization: Bearer $OPENAI_API_KEY" \

1779 -d '{1802 -d '{

1780 "training_file": "file-abc123",1803 "training_file": "file-BK7bzQj3FfZFXr7DbL6xJwfo",

1781 "model": "gpt-4o-mini",1804 "model": "gpt-4o-mini"

1782 "method": {

1783 "type": "supervised",

1784 "supervised": {

1785 "hyperparameters": {

1786 "n_epochs": 2

1787 }

1788 }

1789 }

1790 }'1805 }'

1791```1806```

1792 1807 


1796{1811{

1797 "object": "fine_tuning.job",1812 "object": "fine_tuning.job",

1798 "id": "ftjob-abc123",1813 "id": "ftjob-abc123",

1799 "model": "gpt-4o-mini",1814 "model": "gpt-4o-mini-2024-07-18",

1800 "created_at": 1721764800,1815 "created_at": 1721764800,

1801 "fine_tuned_model": null,1816 "fine_tuned_model": null,

1802 "organization_id": "org-123",1817 "organization_id": "org-123",


1804 "status": "queued",1819 "status": "queued",

1805 "validation_file": null,1820 "validation_file": null,

1806 "training_file": "file-abc123",1821 "training_file": "file-abc123",

1807 "hyperparameters": {

1808 "batch_size": "auto",

1809 "learning_rate_multiplier": "auto",

1810 "n_epochs": 2

1811 },

1812 "method": {1822 "method": {

1813 "type": "supervised",1823 "type": "supervised",

1814 "supervised": {1824 "supervised": {

1815 "hyperparameters": {1825 "hyperparameters": {

1816 "batch_size": "auto",1826 "batch_size": "auto",

1817 "learning_rate_multiplier": "auto",1827 "learning_rate_multiplier": "auto",

1818 "n_epochs": 21828 "n_epochs": "auto",

1819 }1829 }

1820 }1830 }

1821 },1831 },

1822 "metadata": null,1832 "metadata": null

1823 "error": {

1824 "code": null,

1825 "message": null,

1826 "param": null

1827 },

1828 "finished_at": null,

1829 "seed": 683058546,

1830 "trained_tokens": null,

1831 "estimated_finish": null,

1832 "integrations": [],

1833 "user_provided_suffix": null,

1834 "usage_metrics": null,

1835 "shared_with_openai": false

1836}1833}

1837```1834```

1838 1835 

1839### DPO1836### Epochs

1840 1837 

1841```http1838```http

1842curl https://api.openai.com/v1/fine_tuning/jobs \1839curl https://api.openai.com/v1/fine_tuning/jobs \


1844 -H "Authorization: Bearer $OPENAI_API_KEY" \1841 -H "Authorization: Bearer $OPENAI_API_KEY" \

1845 -d '{1842 -d '{

1846 "training_file": "file-abc123",1843 "training_file": "file-abc123",

1847 "validation_file": "file-abc123",

1848 "model": "gpt-4o-mini",1844 "model": "gpt-4o-mini",

1849 "method": {1845 "method": {

1850 "type": "dpo",1846 "type": "supervised",

1851 "dpo": {1847 "supervised": {

1852 "hyperparameters": {1848 "hyperparameters": {

1853 "beta": 0.11849 "n_epochs": 2

1854 }1850 }

1855 }1851 }

1856 }1852 }


1862```json1858```json

1863{1859{

1864 "object": "fine_tuning.job",1860 "object": "fine_tuning.job",

1865 "id": "ftjob-abc",1861 "id": "ftjob-abc123",

1866 "model": "gpt-4o-mini",1862 "model": "gpt-4o-mini",

1867 "created_at": 1746130590,1863 "created_at": 1721764800,

1868 "fine_tuned_model": null,1864 "fine_tuned_model": null,

1869 "organization_id": "org-abc",1865 "organization_id": "org-123",

1870 "result_files": [],1866 "result_files": [],

1871 "status": "queued",1867 "status": "queued",

1872 "validation_file": "file-123",1868 "validation_file": null,

1873 "training_file": "file-abc",1869 "training_file": "file-abc123",

1870 "hyperparameters": {

1871 "batch_size": "auto",

1872 "learning_rate_multiplier": "auto",

1873 "n_epochs": 2

1874 },

1874 "method": {1875 "method": {

1875 "type": "dpo",1876 "type": "supervised",

1876 "dpo": {1877 "supervised": {

1877 "hyperparameters": {1878 "hyperparameters": {

1878 "beta": 0.1,

1879 "batch_size": "auto",1879 "batch_size": "auto",

1880 "learning_rate_multiplier": "auto",1880 "learning_rate_multiplier": "auto",

1881 "n_epochs": "auto"1881 "n_epochs": 2

1882 }1882 }

1883 }1883 }

1884 },1884 },


1889 "param": null1889 "param": null

1890 },1890 },

1891 "finished_at": null,1891 "finished_at": null,

1892 "hyperparameters": null,1892 "seed": 683058546,

1893 "seed": 1036326793,1893 "trained_tokens": null,

1894 "estimated_finish": null,1894 "estimated_finish": null,

1895 "integrations": [],1895 "integrations": [],

1896 "user_provided_suffix": null,1896 "user_provided_suffix": null,

Details

1# Image edit streaming events1# Image edit streaming events

2 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 

3Stream image generation and editing in real time with server-sent events.5Stream image generation and editing in real time with server-sent events.

4[Learn more about image streaming](https://developers.openai.com/docs/guides/image-generation).6[Learn more about image streaming](https://developers.openai.com/docs/guides/image-generation).

5 7 


16 "(resource) images > (model) image_edit_partial_image_event > (schema)": {18 "(resource) images > (model) image_edit_partial_image_event > (schema)": {

17 "kind": "HttpDeclTypeAlias",19 "kind": "HttpDeclTypeAlias",

18 "oasRef": "#/components/schemas/ImageEditPartialImageEvent",20 "oasRef": "#/components/schemas/ImageEditPartialImageEvent",

21 "docstring": "Emitted when a partial image is available during image editing streaming.\n",

19 "ident": "ImageEditPartialImageEvent",22 "ident": "ImageEditPartialImageEvent",

20 "type": {23 "type": {

21 "kind": "HttpTypeObject",24 "kind": "HttpTypeObject",


46 }49 }

47 ]50 ]

48 },51 },

49 "docstring": "Emitted when a partial image is available during image editing streaming.\n",

50 "childrenParentSchema": "object",52 "childrenParentSchema": "object",

51 "children": [53 "children": [

52 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) b64_json",54 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) b64_json",


61 },63 },

62 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) b64_json": {64 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) b64_json": {

63 "kind": "HttpDeclProperty",65 "kind": "HttpDeclProperty",

64 "docstring": "Base64-encoded partial image data, suitable for rendering as an image.\n",66 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/b64_json",

67 "deprecated": false,

65 "key": "b64_json",68 "key": "b64_json",

66 "optional": false,69 "docstring": "Base64-encoded partial image data, suitable for rendering as an image.\n",

67 "nullable": false,

68 "type": {70 "type": {

69 "kind": "HttpTypeString"71 "kind": "HttpTypeString"

70 },72 },

71 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/b64_json",73 "optional": false,

72 "deprecated": false,74 "nullable": false,

73 "schemaType": "string",75 "schemaType": "string",

74 "children": []76 "children": []

75 },77 },

76 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) background": {78 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) background": {

77 "kind": "HttpDeclProperty",79 "kind": "HttpDeclProperty",

78 "docstring": "The background setting for the requested edited image.\n",80 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/background",

81 "deprecated": false,

79 "key": "background",82 "key": "background",

80 "optional": false,83 "docstring": "The background setting for the requested edited image.\n",

81 "nullable": false,

82 "type": {84 "type": {

83 "kind": "HttpTypeUnion",85 "kind": "HttpTypeUnion",

86 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/background",

84 "types": [87 "types": [

85 {88 {

86 "kind": "HttpTypeLiteral",89 "kind": "HttpTypeLiteral",


94 "kind": "HttpTypeLiteral",97 "kind": "HttpTypeLiteral",

95 "literal": "auto"98 "literal": "auto"

96 }99 }

97 ],100 ]

98 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/background"

99 },101 },

100 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/background",102 "optional": false,

101 "deprecated": false,103 "nullable": false,

102 "schemaType": "enum",104 "schemaType": "enum",

103 "childrenParentSchema": "enum",105 "childrenParentSchema": "enum",

104 "children": [106 "children": [


109 },111 },

110 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) created_at": {112 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) created_at": {

111 "kind": "HttpDeclProperty",113 "kind": "HttpDeclProperty",

112 "docstring": "The Unix timestamp when the event was created.\n",114 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/created_at",

115 "deprecated": false,

113 "key": "created_at",116 "key": "created_at",

114 "optional": false,117 "docstring": "The Unix timestamp when the event was created.\n",

115 "nullable": false,

116 "type": {118 "type": {

117 "kind": "HttpTypeNumber"119 "kind": "HttpTypeNumber"

118 },120 },

119 "constraints": {121 "constraints": {

120 "format": "unixtime"122 "format": "unixtime"

121 },123 },

122 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/created_at",124 "optional": false,

123 "deprecated": false,125 "nullable": false,

124 "schemaType": "integer",126 "schemaType": "integer",

125 "children": []127 "children": []

126 },128 },

127 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) output_format": {129 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) output_format": {

128 "kind": "HttpDeclProperty",130 "kind": "HttpDeclProperty",

129 "docstring": "The output format for the requested edited image.\n",131 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/output_format",

132 "deprecated": false,

130 "key": "output_format",133 "key": "output_format",

131 "optional": false,134 "docstring": "The output format for the requested edited image.\n",

132 "nullable": false,

133 "type": {135 "type": {

134 "kind": "HttpTypeUnion",136 "kind": "HttpTypeUnion",

137 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/output_format",

135 "types": [138 "types": [

136 {139 {

137 "kind": "HttpTypeLiteral",140 "kind": "HttpTypeLiteral",


145 "kind": "HttpTypeLiteral",148 "kind": "HttpTypeLiteral",

146 "literal": "jpeg"149 "literal": "jpeg"

147 }150 }

148 ],151 ]

149 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/output_format"

150 },152 },

151 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/output_format",153 "optional": false,

152 "deprecated": false,154 "nullable": false,

153 "schemaType": "enum",155 "schemaType": "enum",

154 "childrenParentSchema": "enum",156 "childrenParentSchema": "enum",

155 "children": [157 "children": [


160 },162 },

161 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) partial_image_index": {163 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) partial_image_index": {

162 "kind": "HttpDeclProperty",164 "kind": "HttpDeclProperty",

163 "docstring": "0-based index for the partial image (streaming).\n",165 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/partial_image_index",

166 "deprecated": false,

164 "key": "partial_image_index",167 "key": "partial_image_index",

165 "optional": false,168 "docstring": "0-based index for the partial image (streaming).\n",

166 "nullable": false,

167 "type": {169 "type": {

168 "kind": "HttpTypeNumber"170 "kind": "HttpTypeNumber"

169 },171 },

170 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/partial_image_index",172 "optional": false,

171 "deprecated": false,173 "nullable": false,

172 "schemaType": "integer",174 "schemaType": "integer",

173 "children": []175 "children": []

174 },176 },

175 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) quality": {177 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) quality": {

176 "kind": "HttpDeclProperty",178 "kind": "HttpDeclProperty",

177 "docstring": "The quality setting for the requested edited image.\n",179 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/quality",

180 "deprecated": false,

178 "key": "quality",181 "key": "quality",

179 "optional": false,182 "docstring": "The quality setting for the requested edited image.\n",

180 "nullable": false,

181 "type": {183 "type": {

182 "kind": "HttpTypeUnion",184 "kind": "HttpTypeUnion",

185 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/quality",

183 "types": [186 "types": [

184 {187 {

185 "kind": "HttpTypeLiteral",188 "kind": "HttpTypeLiteral",


197 "kind": "HttpTypeLiteral",200 "kind": "HttpTypeLiteral",

198 "literal": "auto"201 "literal": "auto"

199 }202 }

200 ],203 ]

201 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/quality"

202 },204 },

203 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/quality",205 "optional": false,

204 "deprecated": false,206 "nullable": false,

205 "schemaType": "enum",207 "schemaType": "enum",

206 "childrenParentSchema": "enum",208 "childrenParentSchema": "enum",

207 "children": [209 "children": [


213 },215 },

214 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) size": {216 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) size": {

215 "kind": "HttpDeclProperty",217 "kind": "HttpDeclProperty",

216 "docstring": "The size of the requested edited image.\n",218 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/size",

219 "deprecated": false,

217 "key": "size",220 "key": "size",

218 "optional": false,221 "docstring": "The size of the requested edited image.\n",

219 "nullable": false,

220 "type": {222 "type": {

221 "kind": "HttpTypeUnion",223 "kind": "HttpTypeUnion",

224 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/size",

222 "types": [225 "types": [

223 {226 {

224 "kind": "HttpTypeLiteral",227 "kind": "HttpTypeLiteral",


236 "kind": "HttpTypeLiteral",239 "kind": "HttpTypeLiteral",

237 "literal": "auto"240 "literal": "auto"

238 }241 }

239 ],242 ]

240 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/size"

241 },243 },

242 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/size",244 "optional": false,

243 "deprecated": false,245 "nullable": false,

244 "schemaType": "enum",246 "schemaType": "enum",

245 "childrenParentSchema": "enum",247 "childrenParentSchema": "enum",

246 "children": [248 "children": [


252 },254 },

253 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) type": {255 "(resource) images > (model) image_edit_partial_image_event > (schema) > (property) type": {

254 "kind": "HttpDeclProperty",256 "kind": "HttpDeclProperty",

255 "docstring": "The type of the event. Always `image_edit.partial_image`.\n",257 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/type",

258 "deprecated": false,

256 "key": "type",259 "key": "type",

257 "optional": false,260 "docstring": "The type of the event. Always `image_edit.partial_image`.\n",

258 "nullable": false,

259 "type": {261 "type": {

260 "kind": "HttpTypeUnion",262 "kind": "HttpTypeUnion",

263 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/type",

261 "types": [264 "types": [

262 {265 {

263 "kind": "HttpTypeLiteral",266 "kind": "HttpTypeLiteral",

264 "literal": "image_edit.partial_image"267 "literal": "image_edit.partial_image"

265 }268 }

266 ],269 ]

267 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/type"

268 },270 },

269 "oasRef": "#/components/schemas/ImageEditPartialImageEvent/properties/type",271 "optional": false,

270 "deprecated": false,272 "nullable": false,

271 "schemaType": "enum",273 "schemaType": "enum",

272 "childrenParentSchema": "enum",274 "childrenParentSchema": "enum",

273 "children": [275 "children": [


410 "(resource) images > (model) image_edit_completed_event > (schema)": {412 "(resource) images > (model) image_edit_completed_event > (schema)": {

411 "kind": "HttpDeclTypeAlias",413 "kind": "HttpDeclTypeAlias",

412 "oasRef": "#/components/schemas/ImageEditCompletedEvent",414 "oasRef": "#/components/schemas/ImageEditCompletedEvent",

415 "docstring": "Emitted when image editing has completed and the final image is available.\n",

413 "ident": "ImageEditCompletedEvent",416 "ident": "ImageEditCompletedEvent",

414 "type": {417 "type": {

415 "kind": "HttpTypeObject",418 "kind": "HttpTypeObject",


440 }443 }

441 ]444 ]

442 },445 },

443 "docstring": "Emitted when image editing has completed and the final image is available.\n",

444 "childrenParentSchema": "object",446 "childrenParentSchema": "object",

445 "children": [447 "children": [

446 "(resource) images > (model) image_edit_completed_event > (schema) > (property) b64_json",448 "(resource) images > (model) image_edit_completed_event > (schema) > (property) b64_json",


455 },457 },

456 "(resource) images > (model) image_edit_completed_event > (schema) > (property) b64_json": {458 "(resource) images > (model) image_edit_completed_event > (schema) > (property) b64_json": {

457 "kind": "HttpDeclProperty",459 "kind": "HttpDeclProperty",

458 "docstring": "Base64-encoded final edited image data, suitable for rendering as an image.\n",460 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/b64_json",

461 "deprecated": false,

459 "key": "b64_json",462 "key": "b64_json",

460 "optional": false,463 "docstring": "Base64-encoded final edited image data, suitable for rendering as an image.\n",

461 "nullable": false,

462 "type": {464 "type": {

463 "kind": "HttpTypeString"465 "kind": "HttpTypeString"

464 },466 },

465 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/b64_json",467 "optional": false,

466 "deprecated": false,468 "nullable": false,

467 "schemaType": "string",469 "schemaType": "string",

468 "children": []470 "children": []

469 },471 },

470 "(resource) images > (model) image_edit_completed_event > (schema) > (property) background": {472 "(resource) images > (model) image_edit_completed_event > (schema) > (property) background": {

471 "kind": "HttpDeclProperty",473 "kind": "HttpDeclProperty",

472 "docstring": "The background setting for the edited image.\n",474 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/background",

475 "deprecated": false,

473 "key": "background",476 "key": "background",

474 "optional": false,477 "docstring": "The background setting for the edited image.\n",

475 "nullable": false,

476 "type": {478 "type": {

477 "kind": "HttpTypeUnion",479 "kind": "HttpTypeUnion",

480 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/background",

478 "types": [481 "types": [

479 {482 {

480 "kind": "HttpTypeLiteral",483 "kind": "HttpTypeLiteral",


488 "kind": "HttpTypeLiteral",491 "kind": "HttpTypeLiteral",

489 "literal": "auto"492 "literal": "auto"

490 }493 }

491 ],494 ]

492 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/background"

493 },495 },

494 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/background",496 "optional": false,

495 "deprecated": false,497 "nullable": false,

496 "schemaType": "enum",498 "schemaType": "enum",

497 "childrenParentSchema": "enum",499 "childrenParentSchema": "enum",

498 "children": [500 "children": [


503 },505 },

504 "(resource) images > (model) image_edit_completed_event > (schema) > (property) created_at": {506 "(resource) images > (model) image_edit_completed_event > (schema) > (property) created_at": {

505 "kind": "HttpDeclProperty",507 "kind": "HttpDeclProperty",

506 "docstring": "The Unix timestamp when the event was created.\n",508 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/created_at",

509 "deprecated": false,

507 "key": "created_at",510 "key": "created_at",

508 "optional": false,511 "docstring": "The Unix timestamp when the event was created.\n",

509 "nullable": false,

510 "type": {512 "type": {

511 "kind": "HttpTypeNumber"513 "kind": "HttpTypeNumber"

512 },514 },

513 "constraints": {515 "constraints": {

514 "format": "unixtime"516 "format": "unixtime"

515 },517 },

516 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/created_at",518 "optional": false,

517 "deprecated": false,519 "nullable": false,

518 "schemaType": "integer",520 "schemaType": "integer",

519 "children": []521 "children": []

520 },522 },

521 "(resource) images > (model) image_edit_completed_event > (schema) > (property) output_format": {523 "(resource) images > (model) image_edit_completed_event > (schema) > (property) output_format": {

522 "kind": "HttpDeclProperty",524 "kind": "HttpDeclProperty",

523 "docstring": "The output format for the edited image.\n",525 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/output_format",

526 "deprecated": false,

524 "key": "output_format",527 "key": "output_format",

525 "optional": false,528 "docstring": "The output format for the edited image.\n",

526 "nullable": false,

527 "type": {529 "type": {

528 "kind": "HttpTypeUnion",530 "kind": "HttpTypeUnion",

531 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/output_format",

529 "types": [532 "types": [

530 {533 {

531 "kind": "HttpTypeLiteral",534 "kind": "HttpTypeLiteral",


539 "kind": "HttpTypeLiteral",542 "kind": "HttpTypeLiteral",

540 "literal": "jpeg"543 "literal": "jpeg"

541 }544 }

542 ],545 ]

543 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/output_format"

544 },546 },

545 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/output_format",547 "optional": false,

546 "deprecated": false,548 "nullable": false,

547 "schemaType": "enum",549 "schemaType": "enum",

548 "childrenParentSchema": "enum",550 "childrenParentSchema": "enum",

549 "children": [551 "children": [


554 },556 },

555 "(resource) images > (model) image_edit_completed_event > (schema) > (property) quality": {557 "(resource) images > (model) image_edit_completed_event > (schema) > (property) quality": {

556 "kind": "HttpDeclProperty",558 "kind": "HttpDeclProperty",

557 "docstring": "The quality setting for the edited image.\n",559 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/quality",

560 "deprecated": false,

558 "key": "quality",561 "key": "quality",

559 "optional": false,562 "docstring": "The quality setting for the edited image.\n",

560 "nullable": false,

561 "type": {563 "type": {

562 "kind": "HttpTypeUnion",564 "kind": "HttpTypeUnion",

565 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/quality",

563 "types": [566 "types": [

564 {567 {

565 "kind": "HttpTypeLiteral",568 "kind": "HttpTypeLiteral",


577 "kind": "HttpTypeLiteral",580 "kind": "HttpTypeLiteral",

578 "literal": "auto"581 "literal": "auto"

579 }582 }

580 ],583 ]

581 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/quality"

582 },584 },

583 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/quality",585 "optional": false,

584 "deprecated": false,586 "nullable": false,

585 "schemaType": "enum",587 "schemaType": "enum",

586 "childrenParentSchema": "enum",588 "childrenParentSchema": "enum",

587 "children": [589 "children": [


593 },595 },

594 "(resource) images > (model) image_edit_completed_event > (schema) > (property) size": {596 "(resource) images > (model) image_edit_completed_event > (schema) > (property) size": {

595 "kind": "HttpDeclProperty",597 "kind": "HttpDeclProperty",

596 "docstring": "The size of the edited image.\n",598 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/size",

599 "deprecated": false,

597 "key": "size",600 "key": "size",

598 "optional": false,601 "docstring": "The size of the edited image.\n",

599 "nullable": false,

600 "type": {602 "type": {

601 "kind": "HttpTypeUnion",603 "kind": "HttpTypeUnion",

604 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/size",

602 "types": [605 "types": [

603 {606 {

604 "kind": "HttpTypeLiteral",607 "kind": "HttpTypeLiteral",


616 "kind": "HttpTypeLiteral",619 "kind": "HttpTypeLiteral",

617 "literal": "auto"620 "literal": "auto"

618 }621 }

619 ],622 ]

620 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/size"

621 },623 },

622 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/size",624 "optional": false,

623 "deprecated": false,625 "nullable": false,

624 "schemaType": "enum",626 "schemaType": "enum",

625 "childrenParentSchema": "enum",627 "childrenParentSchema": "enum",

626 "children": [628 "children": [


632 },634 },

633 "(resource) images > (model) image_edit_completed_event > (schema) > (property) type": {635 "(resource) images > (model) image_edit_completed_event > (schema) > (property) type": {

634 "kind": "HttpDeclProperty",636 "kind": "HttpDeclProperty",

635 "docstring": "The type of the event. Always `image_edit.completed`.\n",637 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/type",

638 "deprecated": false,

636 "key": "type",639 "key": "type",

637 "optional": false,640 "docstring": "The type of the event. Always `image_edit.completed`.\n",

638 "nullable": false,

639 "type": {641 "type": {

640 "kind": "HttpTypeUnion",642 "kind": "HttpTypeUnion",

643 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/type",

641 "types": [644 "types": [

642 {645 {

643 "kind": "HttpTypeLiteral",646 "kind": "HttpTypeLiteral",

644 "literal": "image_edit.completed"647 "literal": "image_edit.completed"

645 }648 }

646 ],649 ]

647 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/type"

648 },650 },

649 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/type",651 "optional": false,

650 "deprecated": false,652 "nullable": false,

651 "schemaType": "enum",653 "schemaType": "enum",

652 "childrenParentSchema": "enum",654 "childrenParentSchema": "enum",

653 "children": [655 "children": [


656 },658 },

657 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage": {659 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage": {

658 "kind": "HttpDeclProperty",660 "kind": "HttpDeclProperty",

659 "docstring": "For the GPT image models only, the token usage information for the image generation.\n",661 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/usage",

662 "deprecated": false,

660 "key": "usage",663 "key": "usage",

661 "optional": false,664 "docstring": "For the GPT image models only, the token usage information for the image generation.\n",

662 "nullable": false,

663 "type": {665 "type": {

664 "kind": "HttpTypeObject",666 "kind": "HttpTypeObject",

665 "members": [667 "members": [


677 }679 }

678 ]680 ]

679 },681 },

680 "oasRef": "#/components/schemas/ImageEditCompletedEvent/properties/usage",682 "optional": false,

681 "deprecated": false,683 "nullable": false,

682 "schemaType": "object",684 "schemaType": "object",

683 "childrenParentSchema": "object",685 "childrenParentSchema": "object",

684 "children": [686 "children": [


795 },797 },

796 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens": {798 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens": {

797 "kind": "HttpDeclProperty",799 "kind": "HttpDeclProperty",

798 "docstring": "The number of tokens (images and text) in the input prompt.",800 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens",

801 "deprecated": false,

799 "key": "input_tokens",802 "key": "input_tokens",

800 "optional": false,803 "docstring": "The number of tokens (images and text) in the input prompt.",

801 "nullable": false,

802 "type": {804 "type": {

803 "kind": "HttpTypeNumber"805 "kind": "HttpTypeNumber"

804 },806 },

805 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens",807 "optional": false,

806 "deprecated": false,808 "nullable": false,

807 "schemaType": "integer",809 "schemaType": "integer",

808 "children": []810 "children": []

809 },811 },

810 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens_details": {812 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens_details": {

811 "kind": "HttpDeclProperty",813 "kind": "HttpDeclProperty",

812 "docstring": "The input tokens detailed information for the image generation.",814 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details",

815 "deprecated": false,

813 "key": "input_tokens_details",816 "key": "input_tokens_details",

814 "optional": false,817 "docstring": "The input tokens detailed information for the image generation.",

815 "nullable": false,

816 "type": {818 "type": {

817 "kind": "HttpTypeObject",819 "kind": "HttpTypeObject",

818 "members": [820 "members": [


824 }826 }

825 ]827 ]

826 },828 },

827 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details",829 "optional": false,

828 "deprecated": false,830 "nullable": false,

829 "schemaType": "object",831 "schemaType": "object",

830 "childrenParentSchema": "object",832 "childrenParentSchema": "object",

831 "children": [833 "children": [


835 },837 },

836 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) output_tokens": {838 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) output_tokens": {

837 "kind": "HttpDeclProperty",839 "kind": "HttpDeclProperty",

838 "docstring": "The number of image tokens in the output image.",840 "oasRef": "#/components/schemas/ImagesUsage/properties/output_tokens",

841 "deprecated": false,

839 "key": "output_tokens",842 "key": "output_tokens",

840 "optional": false,843 "docstring": "The number of image tokens in the output image.",

841 "nullable": false,

842 "type": {844 "type": {

843 "kind": "HttpTypeNumber"845 "kind": "HttpTypeNumber"

844 },846 },

845 "oasRef": "#/components/schemas/ImagesUsage/properties/output_tokens",847 "optional": false,

846 "deprecated": false,848 "nullable": false,

847 "schemaType": "integer",849 "schemaType": "integer",

848 "children": []850 "children": []

849 },851 },

850 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) total_tokens": {852 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) total_tokens": {

851 "kind": "HttpDeclProperty",853 "kind": "HttpDeclProperty",

852 "docstring": "The total number of tokens (images and text) used for the image generation.\n",854 "oasRef": "#/components/schemas/ImagesUsage/properties/total_tokens",

855 "deprecated": false,

853 "key": "total_tokens",856 "key": "total_tokens",

854 "optional": false,857 "docstring": "The total number of tokens (images and text) used for the image generation.\n",

855 "nullable": false,

856 "type": {858 "type": {

857 "kind": "HttpTypeNumber"859 "kind": "HttpTypeNumber"

858 },860 },

859 "oasRef": "#/components/schemas/ImagesUsage/properties/total_tokens",861 "optional": false,

860 "deprecated": false,862 "nullable": false,

861 "schemaType": "integer",863 "schemaType": "integer",

862 "children": []864 "children": []

863 },865 },

864 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) image_tokens": {866 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) image_tokens": {

865 "kind": "HttpDeclProperty",867 "kind": "HttpDeclProperty",

866 "docstring": "The number of image tokens in the input prompt.",868 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/image_tokens",

869 "deprecated": false,

867 "key": "image_tokens",870 "key": "image_tokens",

868 "optional": false,871 "docstring": "The number of image tokens in the input prompt.",

869 "nullable": false,

870 "type": {872 "type": {

871 "kind": "HttpTypeNumber"873 "kind": "HttpTypeNumber"

872 },874 },

873 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/image_tokens",875 "optional": false,

874 "deprecated": false,876 "nullable": false,

875 "schemaType": "integer",877 "schemaType": "integer",

876 "children": []878 "children": []

877 },879 },

878 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) text_tokens": {880 "(resource) images > (model) image_edit_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) text_tokens": {

879 "kind": "HttpDeclProperty",881 "kind": "HttpDeclProperty",

880 "docstring": "The number of text tokens in the input prompt.",882 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/text_tokens",

883 "deprecated": false,

881 "key": "text_tokens",884 "key": "text_tokens",

882 "optional": false,885 "docstring": "The number of text tokens in the input prompt.",

883 "nullable": false,

884 "type": {886 "type": {

885 "kind": "HttpTypeNumber"887 "kind": "HttpTypeNumber"

886 },888 },

887 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/text_tokens",889 "optional": false,

888 "deprecated": false,890 "nullable": false,

889 "schemaType": "integer",891 "schemaType": "integer",

890 "children": []892 "children": []

891 }893 }

Details

1# Image generation streaming events1# Image generation streaming events

2 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 

3Stream image generation and editing in real time with server-sent events.5Stream image generation and editing in real time with server-sent events.

4[Learn more about image streaming](https://developers.openai.com/docs/guides/image-generation).6[Learn more about image streaming](https://developers.openai.com/docs/guides/image-generation).

5 7 


16 "(resource) images > (model) image_gen_partial_image_event > (schema)": {18 "(resource) images > (model) image_gen_partial_image_event > (schema)": {

17 "kind": "HttpDeclTypeAlias",19 "kind": "HttpDeclTypeAlias",

18 "oasRef": "#/components/schemas/ImageGenPartialImageEvent",20 "oasRef": "#/components/schemas/ImageGenPartialImageEvent",

21 "docstring": "Emitted when a partial image is available during image generation streaming.\n",

19 "ident": "ImageGenPartialImageEvent",22 "ident": "ImageGenPartialImageEvent",

20 "type": {23 "type": {

21 "kind": "HttpTypeObject",24 "kind": "HttpTypeObject",


46 }49 }

47 ]50 ]

48 },51 },

49 "docstring": "Emitted when a partial image is available during image generation streaming.\n",

50 "childrenParentSchema": "object",52 "childrenParentSchema": "object",

51 "children": [53 "children": [

52 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) b64_json",54 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) b64_json",


61 },63 },

62 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) b64_json": {64 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) b64_json": {

63 "kind": "HttpDeclProperty",65 "kind": "HttpDeclProperty",

64 "docstring": "Base64-encoded partial image data, suitable for rendering as an image.\n",66 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/b64_json",

67 "deprecated": false,

65 "key": "b64_json",68 "key": "b64_json",

66 "optional": false,69 "docstring": "Base64-encoded partial image data, suitable for rendering as an image.\n",

67 "nullable": false,

68 "type": {70 "type": {

69 "kind": "HttpTypeString"71 "kind": "HttpTypeString"

70 },72 },

71 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/b64_json",73 "optional": false,

72 "deprecated": false,74 "nullable": false,

73 "schemaType": "string",75 "schemaType": "string",

74 "children": []76 "children": []

75 },77 },

76 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) background": {78 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) background": {

77 "kind": "HttpDeclProperty",79 "kind": "HttpDeclProperty",

78 "docstring": "The background setting for the requested image.\n",80 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/background",

81 "deprecated": false,

79 "key": "background",82 "key": "background",

80 "optional": false,83 "docstring": "The background setting for the requested image.\n",

81 "nullable": false,

82 "type": {84 "type": {

83 "kind": "HttpTypeUnion",85 "kind": "HttpTypeUnion",

86 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/background",

84 "types": [87 "types": [

85 {88 {

86 "kind": "HttpTypeLiteral",89 "kind": "HttpTypeLiteral",


94 "kind": "HttpTypeLiteral",97 "kind": "HttpTypeLiteral",

95 "literal": "auto"98 "literal": "auto"

96 }99 }

97 ],100 ]

98 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/background"

99 },101 },

100 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/background",102 "optional": false,

101 "deprecated": false,103 "nullable": false,

102 "schemaType": "enum",104 "schemaType": "enum",

103 "childrenParentSchema": "enum",105 "childrenParentSchema": "enum",

104 "children": [106 "children": [


109 },111 },

110 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) created_at": {112 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) created_at": {

111 "kind": "HttpDeclProperty",113 "kind": "HttpDeclProperty",

112 "docstring": "The Unix timestamp when the event was created.\n",114 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/created_at",

115 "deprecated": false,

113 "key": "created_at",116 "key": "created_at",

114 "optional": false,117 "docstring": "The Unix timestamp when the event was created.\n",

115 "nullable": false,

116 "type": {118 "type": {

117 "kind": "HttpTypeNumber"119 "kind": "HttpTypeNumber"

118 },120 },

119 "constraints": {121 "constraints": {

120 "format": "unixtime"122 "format": "unixtime"

121 },123 },

122 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/created_at",124 "optional": false,

123 "deprecated": false,125 "nullable": false,

124 "schemaType": "integer",126 "schemaType": "integer",

125 "children": []127 "children": []

126 },128 },

127 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) output_format": {129 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) output_format": {

128 "kind": "HttpDeclProperty",130 "kind": "HttpDeclProperty",

129 "docstring": "The output format for the requested image.\n",131 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/output_format",

132 "deprecated": false,

130 "key": "output_format",133 "key": "output_format",

131 "optional": false,134 "docstring": "The output format for the requested image.\n",

132 "nullable": false,

133 "type": {135 "type": {

134 "kind": "HttpTypeUnion",136 "kind": "HttpTypeUnion",

137 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/output_format",

135 "types": [138 "types": [

136 {139 {

137 "kind": "HttpTypeLiteral",140 "kind": "HttpTypeLiteral",


145 "kind": "HttpTypeLiteral",148 "kind": "HttpTypeLiteral",

146 "literal": "jpeg"149 "literal": "jpeg"

147 }150 }

148 ],151 ]

149 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/output_format"

150 },152 },

151 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/output_format",153 "optional": false,

152 "deprecated": false,154 "nullable": false,

153 "schemaType": "enum",155 "schemaType": "enum",

154 "childrenParentSchema": "enum",156 "childrenParentSchema": "enum",

155 "children": [157 "children": [


160 },162 },

161 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) partial_image_index": {163 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) partial_image_index": {

162 "kind": "HttpDeclProperty",164 "kind": "HttpDeclProperty",

163 "docstring": "0-based index for the partial image (streaming).\n",165 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/partial_image_index",

166 "deprecated": false,

164 "key": "partial_image_index",167 "key": "partial_image_index",

165 "optional": false,168 "docstring": "0-based index for the partial image (streaming).\n",

166 "nullable": false,

167 "type": {169 "type": {

168 "kind": "HttpTypeNumber"170 "kind": "HttpTypeNumber"

169 },171 },

170 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/partial_image_index",172 "optional": false,

171 "deprecated": false,173 "nullable": false,

172 "schemaType": "integer",174 "schemaType": "integer",

173 "children": []175 "children": []

174 },176 },

175 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) quality": {177 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) quality": {

176 "kind": "HttpDeclProperty",178 "kind": "HttpDeclProperty",

177 "docstring": "The quality setting for the requested image.\n",179 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/quality",

180 "deprecated": false,

178 "key": "quality",181 "key": "quality",

179 "optional": false,182 "docstring": "The quality setting for the requested image.\n",

180 "nullable": false,

181 "type": {183 "type": {

182 "kind": "HttpTypeUnion",184 "kind": "HttpTypeUnion",

185 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/quality",

183 "types": [186 "types": [

184 {187 {

185 "kind": "HttpTypeLiteral",188 "kind": "HttpTypeLiteral",


197 "kind": "HttpTypeLiteral",200 "kind": "HttpTypeLiteral",

198 "literal": "auto"201 "literal": "auto"

199 }202 }

200 ],203 ]

201 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/quality"

202 },204 },

203 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/quality",205 "optional": false,

204 "deprecated": false,206 "nullable": false,

205 "schemaType": "enum",207 "schemaType": "enum",

206 "childrenParentSchema": "enum",208 "childrenParentSchema": "enum",

207 "children": [209 "children": [


213 },215 },

214 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) size": {216 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) size": {

215 "kind": "HttpDeclProperty",217 "kind": "HttpDeclProperty",

216 "docstring": "The size of the requested image.\n",218 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/size",

219 "deprecated": false,

217 "key": "size",220 "key": "size",

218 "optional": false,221 "docstring": "The size of the requested image.\n",

219 "nullable": false,

220 "type": {222 "type": {

221 "kind": "HttpTypeUnion",223 "kind": "HttpTypeUnion",

224 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/size",

222 "types": [225 "types": [

223 {226 {

224 "kind": "HttpTypeLiteral",227 "kind": "HttpTypeLiteral",


236 "kind": "HttpTypeLiteral",239 "kind": "HttpTypeLiteral",

237 "literal": "auto"240 "literal": "auto"

238 }241 }

239 ],242 ]

240 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/size"

241 },243 },

242 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/size",244 "optional": false,

243 "deprecated": false,245 "nullable": false,

244 "schemaType": "enum",246 "schemaType": "enum",

245 "childrenParentSchema": "enum",247 "childrenParentSchema": "enum",

246 "children": [248 "children": [


252 },254 },

253 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) type": {255 "(resource) images > (model) image_gen_partial_image_event > (schema) > (property) type": {

254 "kind": "HttpDeclProperty",256 "kind": "HttpDeclProperty",

255 "docstring": "The type of the event. Always `image_generation.partial_image`.\n",257 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/type",

258 "deprecated": false,

256 "key": "type",259 "key": "type",

257 "optional": false,260 "docstring": "The type of the event. Always `image_generation.partial_image`.\n",

258 "nullable": false,

259 "type": {261 "type": {

260 "kind": "HttpTypeUnion",262 "kind": "HttpTypeUnion",

263 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/type",

261 "types": [264 "types": [

262 {265 {

263 "kind": "HttpTypeLiteral",266 "kind": "HttpTypeLiteral",

264 "literal": "image_generation.partial_image"267 "literal": "image_generation.partial_image"

265 }268 }

266 ],269 ]

267 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/type"

268 },270 },

269 "oasRef": "#/components/schemas/ImageGenPartialImageEvent/properties/type",271 "optional": false,

270 "deprecated": false,272 "nullable": false,

271 "schemaType": "enum",273 "schemaType": "enum",

272 "childrenParentSchema": "enum",274 "childrenParentSchema": "enum",

273 "children": [275 "children": [


410 "(resource) images > (model) image_gen_completed_event > (schema)": {412 "(resource) images > (model) image_gen_completed_event > (schema)": {

411 "kind": "HttpDeclTypeAlias",413 "kind": "HttpDeclTypeAlias",

412 "oasRef": "#/components/schemas/ImageGenCompletedEvent",414 "oasRef": "#/components/schemas/ImageGenCompletedEvent",

415 "docstring": "Emitted when image generation has completed and the final image is available.\n",

413 "ident": "ImageGenCompletedEvent",416 "ident": "ImageGenCompletedEvent",

414 "type": {417 "type": {

415 "kind": "HttpTypeObject",418 "kind": "HttpTypeObject",


440 }443 }

441 ]444 ]

442 },445 },

443 "docstring": "Emitted when image generation has completed and the final image is available.\n",

444 "childrenParentSchema": "object",446 "childrenParentSchema": "object",

445 "children": [447 "children": [

446 "(resource) images > (model) image_gen_completed_event > (schema) > (property) b64_json",448 "(resource) images > (model) image_gen_completed_event > (schema) > (property) b64_json",


455 },457 },

456 "(resource) images > (model) image_gen_completed_event > (schema) > (property) b64_json": {458 "(resource) images > (model) image_gen_completed_event > (schema) > (property) b64_json": {

457 "kind": "HttpDeclProperty",459 "kind": "HttpDeclProperty",

458 "docstring": "Base64-encoded image data, suitable for rendering as an image.\n",460 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/b64_json",

461 "deprecated": false,

459 "key": "b64_json",462 "key": "b64_json",

460 "optional": false,463 "docstring": "Base64-encoded image data, suitable for rendering as an image.\n",

461 "nullable": false,

462 "type": {464 "type": {

463 "kind": "HttpTypeString"465 "kind": "HttpTypeString"

464 },466 },

465 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/b64_json",467 "optional": false,

466 "deprecated": false,468 "nullable": false,

467 "schemaType": "string",469 "schemaType": "string",

468 "children": []470 "children": []

469 },471 },

470 "(resource) images > (model) image_gen_completed_event > (schema) > (property) background": {472 "(resource) images > (model) image_gen_completed_event > (schema) > (property) background": {

471 "kind": "HttpDeclProperty",473 "kind": "HttpDeclProperty",

472 "docstring": "The background setting for the generated image.\n",474 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/background",

475 "deprecated": false,

473 "key": "background",476 "key": "background",

474 "optional": false,477 "docstring": "The background setting for the generated image.\n",

475 "nullable": false,

476 "type": {478 "type": {

477 "kind": "HttpTypeUnion",479 "kind": "HttpTypeUnion",

480 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/background",

478 "types": [481 "types": [

479 {482 {

480 "kind": "HttpTypeLiteral",483 "kind": "HttpTypeLiteral",


488 "kind": "HttpTypeLiteral",491 "kind": "HttpTypeLiteral",

489 "literal": "auto"492 "literal": "auto"

490 }493 }

491 ],494 ]

492 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/background"

493 },495 },

494 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/background",496 "optional": false,

495 "deprecated": false,497 "nullable": false,

496 "schemaType": "enum",498 "schemaType": "enum",

497 "childrenParentSchema": "enum",499 "childrenParentSchema": "enum",

498 "children": [500 "children": [


503 },505 },

504 "(resource) images > (model) image_gen_completed_event > (schema) > (property) created_at": {506 "(resource) images > (model) image_gen_completed_event > (schema) > (property) created_at": {

505 "kind": "HttpDeclProperty",507 "kind": "HttpDeclProperty",

506 "docstring": "The Unix timestamp when the event was created.\n",508 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/created_at",

509 "deprecated": false,

507 "key": "created_at",510 "key": "created_at",

508 "optional": false,511 "docstring": "The Unix timestamp when the event was created.\n",

509 "nullable": false,

510 "type": {512 "type": {

511 "kind": "HttpTypeNumber"513 "kind": "HttpTypeNumber"

512 },514 },

513 "constraints": {515 "constraints": {

514 "format": "unixtime"516 "format": "unixtime"

515 },517 },

516 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/created_at",518 "optional": false,

517 "deprecated": false,519 "nullable": false,

518 "schemaType": "integer",520 "schemaType": "integer",

519 "children": []521 "children": []

520 },522 },

521 "(resource) images > (model) image_gen_completed_event > (schema) > (property) output_format": {523 "(resource) images > (model) image_gen_completed_event > (schema) > (property) output_format": {

522 "kind": "HttpDeclProperty",524 "kind": "HttpDeclProperty",

523 "docstring": "The output format for the generated image.\n",525 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/output_format",

526 "deprecated": false,

524 "key": "output_format",527 "key": "output_format",

525 "optional": false,528 "docstring": "The output format for the generated image.\n",

526 "nullable": false,

527 "type": {529 "type": {

528 "kind": "HttpTypeUnion",530 "kind": "HttpTypeUnion",

531 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/output_format",

529 "types": [532 "types": [

530 {533 {

531 "kind": "HttpTypeLiteral",534 "kind": "HttpTypeLiteral",


539 "kind": "HttpTypeLiteral",542 "kind": "HttpTypeLiteral",

540 "literal": "jpeg"543 "literal": "jpeg"

541 }544 }

542 ],545 ]

543 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/output_format"

544 },546 },

545 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/output_format",547 "optional": false,

546 "deprecated": false,548 "nullable": false,

547 "schemaType": "enum",549 "schemaType": "enum",

548 "childrenParentSchema": "enum",550 "childrenParentSchema": "enum",

549 "children": [551 "children": [


554 },556 },

555 "(resource) images > (model) image_gen_completed_event > (schema) > (property) quality": {557 "(resource) images > (model) image_gen_completed_event > (schema) > (property) quality": {

556 "kind": "HttpDeclProperty",558 "kind": "HttpDeclProperty",

557 "docstring": "The quality setting for the generated image.\n",559 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/quality",

560 "deprecated": false,

558 "key": "quality",561 "key": "quality",

559 "optional": false,562 "docstring": "The quality setting for the generated image.\n",

560 "nullable": false,

561 "type": {563 "type": {

562 "kind": "HttpTypeUnion",564 "kind": "HttpTypeUnion",

565 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/quality",

563 "types": [566 "types": [

564 {567 {

565 "kind": "HttpTypeLiteral",568 "kind": "HttpTypeLiteral",


577 "kind": "HttpTypeLiteral",580 "kind": "HttpTypeLiteral",

578 "literal": "auto"581 "literal": "auto"

579 }582 }

580 ],583 ]

581 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/quality"

582 },584 },

583 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/quality",585 "optional": false,

584 "deprecated": false,586 "nullable": false,

585 "schemaType": "enum",587 "schemaType": "enum",

586 "childrenParentSchema": "enum",588 "childrenParentSchema": "enum",

587 "children": [589 "children": [


593 },595 },

594 "(resource) images > (model) image_gen_completed_event > (schema) > (property) size": {596 "(resource) images > (model) image_gen_completed_event > (schema) > (property) size": {

595 "kind": "HttpDeclProperty",597 "kind": "HttpDeclProperty",

596 "docstring": "The size of the generated image.\n",598 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/size",

599 "deprecated": false,

597 "key": "size",600 "key": "size",

598 "optional": false,601 "docstring": "The size of the generated image.\n",

599 "nullable": false,

600 "type": {602 "type": {

601 "kind": "HttpTypeUnion",603 "kind": "HttpTypeUnion",

604 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/size",

602 "types": [605 "types": [

603 {606 {

604 "kind": "HttpTypeLiteral",607 "kind": "HttpTypeLiteral",


616 "kind": "HttpTypeLiteral",619 "kind": "HttpTypeLiteral",

617 "literal": "auto"620 "literal": "auto"

618 }621 }

619 ],622 ]

620 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/size"

621 },623 },

622 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/size",624 "optional": false,

623 "deprecated": false,625 "nullable": false,

624 "schemaType": "enum",626 "schemaType": "enum",

625 "childrenParentSchema": "enum",627 "childrenParentSchema": "enum",

626 "children": [628 "children": [


632 },634 },

633 "(resource) images > (model) image_gen_completed_event > (schema) > (property) type": {635 "(resource) images > (model) image_gen_completed_event > (schema) > (property) type": {

634 "kind": "HttpDeclProperty",636 "kind": "HttpDeclProperty",

635 "docstring": "The type of the event. Always `image_generation.completed`.\n",637 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/type",

638 "deprecated": false,

636 "key": "type",639 "key": "type",

637 "optional": false,640 "docstring": "The type of the event. Always `image_generation.completed`.\n",

638 "nullable": false,

639 "type": {641 "type": {

640 "kind": "HttpTypeUnion",642 "kind": "HttpTypeUnion",

643 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/type",

641 "types": [644 "types": [

642 {645 {

643 "kind": "HttpTypeLiteral",646 "kind": "HttpTypeLiteral",

644 "literal": "image_generation.completed"647 "literal": "image_generation.completed"

645 }648 }

646 ],649 ]

647 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/type"

648 },650 },

649 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/type",651 "optional": false,

650 "deprecated": false,652 "nullable": false,

651 "schemaType": "enum",653 "schemaType": "enum",

652 "childrenParentSchema": "enum",654 "childrenParentSchema": "enum",

653 "children": [655 "children": [


656 },658 },

657 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage": {659 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage": {

658 "kind": "HttpDeclProperty",660 "kind": "HttpDeclProperty",

659 "docstring": "For the GPT image models only, the token usage information for the image generation.\n",661 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/usage",

662 "deprecated": false,

660 "key": "usage",663 "key": "usage",

661 "optional": false,664 "docstring": "For the GPT image models only, the token usage information for the image generation.\n",

662 "nullable": false,

663 "type": {665 "type": {

664 "kind": "HttpTypeObject",666 "kind": "HttpTypeObject",

665 "members": [667 "members": [


677 }679 }

678 ]680 ]

679 },681 },

680 "oasRef": "#/components/schemas/ImageGenCompletedEvent/properties/usage",682 "optional": false,

681 "deprecated": false,683 "nullable": false,

682 "schemaType": "object",684 "schemaType": "object",

683 "childrenParentSchema": "object",685 "childrenParentSchema": "object",

684 "children": [686 "children": [


795 },797 },

796 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens": {798 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens": {

797 "kind": "HttpDeclProperty",799 "kind": "HttpDeclProperty",

798 "docstring": "The number of tokens (images and text) in the input prompt.",800 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens",

801 "deprecated": false,

799 "key": "input_tokens",802 "key": "input_tokens",

800 "optional": false,803 "docstring": "The number of tokens (images and text) in the input prompt.",

801 "nullable": false,

802 "type": {804 "type": {

803 "kind": "HttpTypeNumber"805 "kind": "HttpTypeNumber"

804 },806 },

805 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens",807 "optional": false,

806 "deprecated": false,808 "nullable": false,

807 "schemaType": "integer",809 "schemaType": "integer",

808 "children": []810 "children": []

809 },811 },

810 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens_details": {812 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens_details": {

811 "kind": "HttpDeclProperty",813 "kind": "HttpDeclProperty",

812 "docstring": "The input tokens detailed information for the image generation.",814 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details",

815 "deprecated": false,

813 "key": "input_tokens_details",816 "key": "input_tokens_details",

814 "optional": false,817 "docstring": "The input tokens detailed information for the image generation.",

815 "nullable": false,

816 "type": {818 "type": {

817 "kind": "HttpTypeObject",819 "kind": "HttpTypeObject",

818 "members": [820 "members": [


824 }826 }

825 ]827 ]

826 },828 },

827 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details",829 "optional": false,

828 "deprecated": false,830 "nullable": false,

829 "schemaType": "object",831 "schemaType": "object",

830 "childrenParentSchema": "object",832 "childrenParentSchema": "object",

831 "children": [833 "children": [


835 },837 },

836 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) output_tokens": {838 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) output_tokens": {

837 "kind": "HttpDeclProperty",839 "kind": "HttpDeclProperty",

838 "docstring": "The number of image tokens in the output image.",840 "oasRef": "#/components/schemas/ImagesUsage/properties/output_tokens",

841 "deprecated": false,

839 "key": "output_tokens",842 "key": "output_tokens",

840 "optional": false,843 "docstring": "The number of image tokens in the output image.",

841 "nullable": false,

842 "type": {844 "type": {

843 "kind": "HttpTypeNumber"845 "kind": "HttpTypeNumber"

844 },846 },

845 "oasRef": "#/components/schemas/ImagesUsage/properties/output_tokens",847 "optional": false,

846 "deprecated": false,848 "nullable": false,

847 "schemaType": "integer",849 "schemaType": "integer",

848 "children": []850 "children": []

849 },851 },

850 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) total_tokens": {852 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) total_tokens": {

851 "kind": "HttpDeclProperty",853 "kind": "HttpDeclProperty",

852 "docstring": "The total number of tokens (images and text) used for the image generation.\n",854 "oasRef": "#/components/schemas/ImagesUsage/properties/total_tokens",

855 "deprecated": false,

853 "key": "total_tokens",856 "key": "total_tokens",

854 "optional": false,857 "docstring": "The total number of tokens (images and text) used for the image generation.\n",

855 "nullable": false,

856 "type": {858 "type": {

857 "kind": "HttpTypeNumber"859 "kind": "HttpTypeNumber"

858 },860 },

859 "oasRef": "#/components/schemas/ImagesUsage/properties/total_tokens",861 "optional": false,

860 "deprecated": false,862 "nullable": false,

861 "schemaType": "integer",863 "schemaType": "integer",

862 "children": []864 "children": []

863 },865 },

864 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) image_tokens": {866 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) image_tokens": {

865 "kind": "HttpDeclProperty",867 "kind": "HttpDeclProperty",

866 "docstring": "The number of image tokens in the input prompt.",868 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/image_tokens",

869 "deprecated": false,

867 "key": "image_tokens",870 "key": "image_tokens",

868 "optional": false,871 "docstring": "The number of image tokens in the input prompt.",

869 "nullable": false,

870 "type": {872 "type": {

871 "kind": "HttpTypeNumber"873 "kind": "HttpTypeNumber"

872 },874 },

873 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/image_tokens",875 "optional": false,

874 "deprecated": false,876 "nullable": false,

875 "schemaType": "integer",877 "schemaType": "integer",

876 "children": []878 "children": []

877 },879 },

878 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) text_tokens": {880 "(resource) images > (model) image_gen_completed_event > (schema) > (property) usage > (property) input_tokens_details > (property) text_tokens": {

879 "kind": "HttpDeclProperty",881 "kind": "HttpDeclProperty",

880 "docstring": "The number of text tokens in the input prompt.",882 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/text_tokens",

883 "deprecated": false,

881 "key": "text_tokens",884 "key": "text_tokens",

882 "optional": false,885 "docstring": "The number of text tokens in the input prompt.",

883 "nullable": false,

884 "type": {886 "type": {

885 "kind": "HttpTypeNumber"887 "kind": "HttpTypeNumber"

886 },888 },

887 "oasRef": "#/components/schemas/ImagesUsage/properties/input_tokens_details/properties/text_tokens",889 "optional": false,

888 "deprecated": false,890 "nullable": false,

889 "schemaType": "integer",891 "schemaType": "integer",

890 "children": []892 "children": []

891 }893 }

Details

257 }257 }

258 ],258 ],

259 "prompt": "Add a watercolor effect to this image",259 "prompt": "Add a watercolor effect to this image",

260 "background": "transparent",

261 "model": "gpt-image-1.5",260 "model": "gpt-image-1.5",

262 "moderation": "auto",

263 "n": 1,

264 "output_compression": 100,

265 "output_format": "png",

266 "partial_images": 1,

267 "quality": "high",261 "quality": "high",

268 "size": "1024x1024",262 "size": "1024x1024"

269 "user": "user-1234"

270 }'263 }'

271```264```

272 265 

Details

24 24 

25 An array of multi-modal inputs to the moderation model.25 An array of multi-modal inputs to the moderation model.

26 26 

27 - `object { image_url, type }`27 - `ImageURL object { image_url, type }`

28 28 

29 An object describing an image to classify.29 An object describing an image to classify.

30 30 


42 42 

43 - `"image_url"`43 - `"image_url"`

44 44 

45 - `object { text, type }`45 - `Text object { text, type }`

46 46 

47 An object describing text to classify.47 An object describing text to classify.

48 48 


394}394}

395```395```

396 396 

397### Single string

398 

399```http

400curl https://api.openai.com/v1/moderations \

401 -H "Content-Type: application/json" \

402 -H "Authorization: Bearer $OPENAI_API_KEY" \

403 -d '{

404 "input": "I want to kill them."

405 }'

406```

407 

408#### Response

409 

410```json

411{

412 "id": "modr-AB8CjOTu2jiq12hp1AQPfeqFWaORR",

413 "model": "text-moderation-007",

414 "results": [

415 {

416 "flagged": true,

417 "categories": {

418 "sexual": false,

419 "hate": false,

420 "harassment": true,

421 "self-harm": false,

422 "sexual/minors": false,

423 "hate/threatening": false,

424 "violence/graphic": false,

425 "self-harm/intent": false,

426 "self-harm/instructions": false,

427 "harassment/threatening": true,

428 "violence": true

429 },

430 "category_scores": {

431 "sexual": 0.000011726012417057063,

432 "hate": 0.22706663608551025,

433 "harassment": 0.5215635299682617,

434 "self-harm": 2.227119921371923e-6,

435 "sexual/minors": 7.107352217872176e-8,

436 "hate/threatening": 0.023547329008579254,

437 "violence/graphic": 0.00003391829886822961,

438 "self-harm/intent": 1.646940972932498e-6,

439 "self-harm/instructions": 1.1198755256458526e-9,

440 "harassment/threatening": 0.5694745779037476,

441 "violence": 0.9971134662628174

442 }

443 }

444 ]

445}

446```

447 

448### Image and text397### Image and text

449 398 

450```http399```http


556 ]505 ]

557}506}

558```507```

508 

509### Single string

510 

511```http

512curl https://api.openai.com/v1/moderations \

513 -H "Content-Type: application/json" \

514 -H "Authorization: Bearer $OPENAI_API_KEY" \

515 -d '{

516 "input": "I want to kill them."

517 }'

518```

519 

520#### Response

521 

522```json

523{

524 "id": "modr-AB8CjOTu2jiq12hp1AQPfeqFWaORR",

525 "model": "text-moderation-007",

526 "results": [

527 {

528 "flagged": true,

529 "categories": {

530 "sexual": false,

531 "hate": false,

532 "harassment": true,

533 "self-harm": false,

534 "sexual/minors": false,

535 "hate/threatening": false,

536 "violence/graphic": false,

537 "self-harm/intent": false,

538 "self-harm/instructions": false,

539 "harassment/threatening": true,

540 "violence": true

541 },

542 "category_scores": {

543 "sexual": 0.000011726012417057063,

544 "hate": 0.22706663608551025,

545 "harassment": 0.5215635299682617,

546 "self-harm": 2.227119921371923e-6,

547 "sexual/minors": 7.107352217872176e-8,

548 "hate/threatening": 0.023547329008579254,

549 "violence/graphic": 0.00003391829886822961,

550 "self-harm/intent": 1.646940972932498e-6,

551 "self-harm/instructions": 1.1198755256458526e-9,

552 "harassment/threatening": 0.5694745779037476,

553 "violence": 0.9971134662628174

554 }

555 }

556 ]

557}

558```

Details

1# Organization1# Organization

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization

Details

1# Organization Audit Logs1# Organization Audit Logs

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs

Details

1# Organization Audit Logs — List1# Organization Audit Logs — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/methods/list

Details

1# Organization Audit Logs Admin Api Keys1# Organization Audit Logs Admin Api Keys

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys

Details

1# Organization Audit Logs Admin Api Keys — Create1# Organization Audit Logs Admin Api Keys — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/create

Details

1# Organization Audit Logs Admin Api Keys — Delete1# Organization Audit Logs Admin Api Keys — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/delete

Details

1# Organization Audit Logs Admin Api Keys — List1# Organization Audit Logs Admin Api Keys — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/list

Details

1# Organization Audit Logs Admin Api Keys — Retrieve1# Organization Audit Logs Admin Api Keys — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/admin_api_keys/methods/retrieve

Details

1# Organization Audit Logs Usage1# Organization Audit Logs Usage

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/usage7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/audit_logs/subresources/usage

Details

1# Organization Groups1# Organization Groups

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups

Details

1# Organization Groups — Create1# Organization Groups — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/create

Details

1# Organization Groups — Delete1# Organization Groups — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/delete

Details

1# Organization Groups — List1# Organization Groups — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/list

Details

1# Organization Groups — Update1# Organization Groups — Update

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/update7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/methods/update

Details

1# Organization Groups Users1# Organization Groups Users

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users

Details

1# Organization Groups Users — Create1# Organization Groups Users — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/create

Details

1# Organization Groups Users — Delete1# Organization Groups Users — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/delete

Details

1# Organization Groups Users — List1# Organization Groups Users — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/groups/subresources/users/methods/list

Details

1# Organization Invites1# Organization Invites

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites

Details

1# Organization Invites — Create1# Organization Invites — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/create

Details

1# Organization Invites — Delete1# Organization Invites — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/delete

Details

1# Organization Invites — List1# Organization Invites — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/list

Details

1# Organization Invites — Retrieve1# Organization Invites — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/invites/methods/retrieve

Details

1# Organization Projects1# Organization Projects

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects

Details

1# Organization Projects — Create1# Organization Projects — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/create

Details

1# Organization Projects — List1# Organization Projects — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/list

Details

1# Organization Projects — Retrieve1# Organization Projects — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/retrieve

Details

1# Organization Projects — Update1# Organization Projects — Update

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/methods/update

Details

1# Organization Projects Api Keys1# Organization Projects Api Keys

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys

Details

1# Organization Projects Api Keys — Delete1# Organization Projects Api Keys — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/delete

Details

1# Organization Projects Api Keys — List1# Organization Projects Api Keys — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/list

Details

1# Organization Projects Api Keys — Retrieve1# Organization Projects Api Keys — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/api_keys/methods/retrieve

Details

1# Organization Projects Groups1# Organization Projects Groups

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups

Details

1# Organization Projects Groups — Delete1# Organization Projects Groups — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/delete

Details

1# Organization Projects Groups — List1# Organization Projects Groups — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/groups/methods/list

Details

1# Organization Projects Rate Limits1# Organization Projects Rate Limits

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/rate_limits7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/rate_limits

Details

1# Organization Projects Service Accounts1# Organization Projects Service Accounts

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts

Details

1# Organization Projects Service Accounts — Create1# Organization Projects Service Accounts — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/create

Details

1# Organization Projects Service Accounts — Delete1# Organization Projects Service Accounts — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/delete

Details

1# Organization Projects Service Accounts — List1# Organization Projects Service Accounts — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/list

Details

1# Organization Projects Service Accounts — Retrieve1# Organization Projects Service Accounts — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve

Details

1# Organization Projects Users1# Organization Projects Users

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users

Details

1# Organization Projects Users — Create1# Organization Projects Users — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/create

Details

1# Organization Projects Users — Delete1# Organization Projects Users — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/delete

Details

1# Organization Projects Users — List1# Organization Projects Users — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/list

Details

1# Organization Projects Users — Retrieve1# Organization Projects Users — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/retrieve

Details

1# Organization Projects Users — Update1# Organization Projects Users — Update

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/projects/subresources/users/methods/update

Details

1# Organization Roles1# Organization Roles

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles

Details

1# Organization Roles — Create1# Organization Roles — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/create

Details

1# Organization Roles — Delete1# Organization Roles — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/delete

Details

1# Organization Roles — List1# Organization Roles — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/list

Details

1# Organization Roles — Update1# Organization Roles — Update

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/roles/methods/update

Details

1# Organization Users1# Organization Users

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users

Details

1# Organization Users — Delete1# Organization Users — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/delete

Details

1# Organization Users — List1# Organization Users — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/list

Details

1# Organization Users — Retrieve1# Organization Users — Retrieve

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/retrieve7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/retrieve

Details

1# Organization Users — Update1# Organization Users — Update

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/methods/update

Details

1# Organization Users Roles — Create1# Organization Users Roles — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/create

Details

1# Organization Users Roles — Delete1# Organization Users Roles — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/delete

Details

1# Organization Users Roles — List1# Organization Users Roles — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/organization/subresources/users/subresources/roles/methods/list

Details

1# Projects1# Projects

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects

Details

1# Projects Groups1# Projects Groups

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups

Details

1# Projects Groups Roles — Create1# Projects Groups Roles — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/create

Details

1# Projects Groups Roles — Delete1# Projects Groups Roles — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/delete

Details

1# Projects Groups Roles — List1# Projects Groups Roles — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/groups/subresources/roles/methods/list

Details

1# Projects Roles — Create1# Projects Roles — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/create

Details

1# Projects Roles — Delete1# Projects Roles — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/delete

Details

1# Projects Roles — List1# Projects Roles — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/list

Details

1# Projects Roles — Update1# Projects Roles — Update

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/roles/methods/update

Details

1# Projects Users1# Projects Users

2 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 

3OpenAI API endpoint reference.5OpenAI API endpoint reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users

Details

1# Projects Users Roles — Create1# Projects Users Roles — Create

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/create

Details

1# Projects Users Roles — Delete1# Projects Users Roles — Delete

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/delete

Details

1# Projects Users Roles — List1# Projects Users Roles — List

2 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 

3OpenAI API endpoint method reference.5OpenAI API endpoint method reference.

4 6 

5Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list7Canonical reference URL: https://developers.openai.com/api/reference/resources/projects/subresources/users/subresources/roles/methods/list

Details

27 27 

28 The format of the input audio.28 The format of the input audio.

29 29 

30 - `PCMAudioFormat object { rate, type }`30 - `PCMAudio object { rate, type }`

31 31 

32 The PCM audio format. Only a 24kHz sample rate is supported.32 The PCM audio format. Only a 24kHz sample rate is supported.

33 33 


43 43 

44 - `"audio/pcm"`44 - `"audio/pcm"`

45 45 

46 - `PCMUAudioFormat object { type }`46 - `PCMUAudio object { type }`

47 47 

48 The G.711 μ-law format.48 The G.711 μ-law format.

49 49 


53 53 

54 - `"audio/pcmu"`54 - `"audio/pcmu"`

55 55 

56 - `PCMAAudioFormat object { type }`56 - `PCMAAudio object { type }`

57 57 

58 The G.711 A-law format.58 The G.711 A-law format.

59 59 


97 97 

98 - `"xhigh"`98 - `"xhigh"`

99 99 

100 - `keywords: optional array of string`

101 

102 Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.

103 

100 - `language: optional string`104 - `language: optional string`

101 105 

102 The language of the input audio. Supplying the input language in106 The language of the input audio. Supplying the input language in

103 [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format107 [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format

104 will improve accuracy and latency.108 will improve accuracy and latency.

105 109 

106 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`110 - `languages: optional array of string`

111 

112 Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.

107 113 

108 The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.114 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

115 

116 The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.

109 117 

110 - `string`118 - `string`

111 119 

112 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`120 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

113 121 

114 The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.122 The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.

115 123 

116 - `"whisper-1"`124 - `"whisper-1"`

117 125 

126 - `"gpt-transcribe"`

127 

128 - `"gpt-live-transcribe"`

129 

118 - `"gpt-4o-mini-transcribe"`130 - `"gpt-4o-mini-transcribe"`

119 131 

120 - `"gpt-4o-mini-transcribe-2025-12-15"`132 - `"gpt-4o-mini-transcribe-2025-12-15"`

Details

60 60 

61 The format of the input audio.61 The format of the input audio.

62 62 

63 - `PCMAudioFormat object { rate, type }`63 - `PCMAudio object { rate, type }`

64 64 

65 The PCM audio format. Only a 24kHz sample rate is supported.65 The PCM audio format. Only a 24kHz sample rate is supported.

66 66 


76 76 

77 - `"audio/pcm"`77 - `"audio/pcm"`

78 78 

79 - `PCMUAudioFormat object { type }`79 - `PCMUAudio object { type }`

80 80 

81 The G.711 μ-law format.81 The G.711 μ-law format.

82 82 


86 86 

87 - `"audio/pcmu"`87 - `"audio/pcmu"`

88 88 

89 - `PCMAAudioFormat object { type }`89 - `PCMAAudio object { type }`

90 90 

91 The G.711 A-law format.91 The G.711 A-law format.

92 92 


130 130 

131 - `"xhigh"`131 - `"xhigh"`

132 132 

133 - `keywords: optional array of string`

134 

135 Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.

136 

133 - `language: optional string`137 - `language: optional string`

134 138 

135 The language of the input audio. Supplying the input language in139 The language of the input audio. Supplying the input language in

136 [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format140 [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format

137 will improve accuracy and latency.141 will improve accuracy and latency.

138 142 

139 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`143 - `languages: optional array of string`

144 

145 Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.

146 

147 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

140 148 

141 The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.149 The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.

142 150 

143 - `string`151 - `string`

144 152 

145 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`153 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

146 154 

147 The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.155 The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.

148 156 

149 - `"whisper-1"`157 - `"whisper-1"`

150 158 

159 - `"gpt-transcribe"`

160 

161 - `"gpt-live-transcribe"`

162 

151 - `"gpt-4o-mini-transcribe"`163 - `"gpt-4o-mini-transcribe"`

152 164 

153 - `"gpt-4o-mini-transcribe-2025-12-15"`165 - `"gpt-4o-mini-transcribe-2025-12-15"`


1043 1055 

1044 The format of the input audio.1056 The format of the input audio.

1045 1057 

1046 - `PCMAudioFormat object { rate, type }`1058 - `PCMAudio object { rate, type }`

1047 1059 

1048 The PCM audio format. Only a 24kHz sample rate is supported.1060 The PCM audio format. Only a 24kHz sample rate is supported.

1049 1061 


1059 1071 

1060 - `"audio/pcm"`1072 - `"audio/pcm"`

1061 1073 

1062 - `PCMUAudioFormat object { type }`1074 - `PCMUAudio object { type }`

1063 1075 

1064 The G.711 μ-law format.1076 The G.711 μ-law format.

1065 1077 


1069 1081 

1070 - `"audio/pcmu"`1082 - `"audio/pcmu"`

1071 1083 

1072 - `PCMAAudioFormat object { type }`1084 - `PCMAAudio object { type }`

1073 1085 

1074 The G.711 A-law format.1086 The G.711 A-law format.

1075 1087 


1093 1105 

1094 - `"far_field"`1106 - `"far_field"`

1095 1107 

1096 - `transcription: optional object { language, model, prompt }`1108 - `transcription: optional object { language, languages, model, prompt }`

1097 1109 

1098 Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.1110 Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

1099 1111 


1101 1113 

1102 The language of the input audio.1114 The language of the input audio.

1103 1115 

1104 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`1116 - `languages: optional array of string`

1117 

1118 The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

1119 

1120 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

1105 1121 

1106 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.1122 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

1107 1123 

1108 - `string`1124 - `string`

1109 1125 

1110 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`1126 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

1111 1127 

1112 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.1128 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

1113 1129 

1114 - `"whisper-1"`1130 - `"whisper-1"`

1115 1131 

1132 - `"gpt-transcribe"`

1133 

1134 - `"gpt-live-transcribe"`

1135 

1116 - `"gpt-4o-mini-transcribe"`1136 - `"gpt-4o-mini-transcribe"`

1117 1137 

1118 - `"gpt-4o-mini-transcribe-2025-12-15"`1138 - `"gpt-4o-mini-transcribe-2025-12-15"`


1858 1878 

1859 Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.1879 Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.

1860 1880 

1861 - `transcription: optional object { language, model, prompt }`1881 - `transcription: optional object { language, languages, model, prompt }`

1862 1882 

1863 Configuration of the transcription model.1883 Configuration of the transcription model.

1864 1884 


1866 1886 

1867 The language of the input audio.1887 The language of the input audio.

1868 1888 

1869 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`1889 - `languages: optional array of string`

1890 

1891 The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

1892 

1893 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

1870 1894 

1871 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.1895 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

1872 1896 

1873 - `string`1897 - `string`

1874 1898 

1875 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`1899 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

1876 1900 

1877 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.1901 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

1878 1902 

1879 - `"whisper-1"`1903 - `"whisper-1"`

1880 1904 

1905 - `"gpt-transcribe"`

1906 

1907 - `"gpt-live-transcribe"`

1908 

1881 - `"gpt-4o-mini-transcribe"`1909 - `"gpt-4o-mini-transcribe"`

1882 1910 

1883 - `"gpt-4o-mini-transcribe-2025-12-15"`1911 - `"gpt-4o-mini-transcribe-2025-12-15"`


1964 },1992 },

1965 "transcription": {1993 "transcription": {

1966 "language": "language",1994 "language": "language",

1995 "languages": [

1996 "string"

1997 ],

1967 "model": "whisper-1",1998 "model": "whisper-1",

1968 "prompt": "prompt"1999 "prompt": "prompt"

1969 },2000 },

Details

402 402 

403 The PCM audio format. Only a 24kHz sample rate is supported.403 The PCM audio format. Only a 24kHz sample rate is supported.

404 404 

405 - `PCMAudioFormat object { rate, type }`405 - `PCMAudio object { rate, type }`

406 406 

407 The PCM audio format. Only a 24kHz sample rate is supported.407 The PCM audio format. Only a 24kHz sample rate is supported.

408 408 


418 418 

419 - `"audio/pcm"`419 - `"audio/pcm"`

420 420 

421 - `PCMUAudioFormat object { type }`421 - `PCMUAudio object { type }`

422 422 

423 The G.711 μ-law format.423 The G.711 μ-law format.

424 424 


428 428 

429 - `"audio/pcmu"`429 - `"audio/pcmu"`

430 430 

431 - `PCMAAudioFormat object { type }`431 - `PCMAAudio object { type }`

432 432 

433 The G.711 A-law format.433 The G.711 A-law format.

434 434 


450 450 

451 - `"far_field"`451 - `"far_field"`

452 452 

453 - `transcription: optional object { language, model, prompt }`453 - `transcription: optional object { language, languages, model, prompt }`

454 454 

455 Configuration for input audio transcription.455 Configuration for input audio transcription.

456 456 


458 458 

459 The language of the input audio.459 The language of the input audio.

460 460 

461 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`461 - `languages: optional array of string`

462 462 

463 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.463 The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

464 

465 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

466 

467 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

464 468 

465 - `string`469 - `string`

466 470 

467 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`471 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

468 472 

469 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.473 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

470 474 

471 - `"whisper-1"`475 - `"whisper-1"`

472 476 

477 - `"gpt-transcribe"`

478 

479 - `"gpt-live-transcribe"`

480 

473 - `"gpt-4o-mini-transcribe"`481 - `"gpt-4o-mini-transcribe"`

474 482 

475 - `"gpt-4o-mini-transcribe-2025-12-15"`483 - `"gpt-4o-mini-transcribe-2025-12-15"`


708 },716 },

709 "transcription": {717 "transcription": {

710 "language": "language",718 "language": "language",

719 "languages": [

720 "string"

721 ],

711 "model": "whisper-1",722 "model": "whisper-1",

712 "prompt": "prompt"723 "prompt": "prompt"

713 },724 },

Details

67 67 

68 - `"xhigh"`68 - `"xhigh"`

69 69 

70 - `keywords: optional array of string`

71 

72 Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.

73 

70 - `language: optional string`74 - `language: optional string`

71 75 

72 The language of the input audio. Supplying the input language in76 The language of the input audio. Supplying the input language in

73 [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format77 [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format

74 will improve accuracy and latency.78 will improve accuracy and latency.

75 79 

76 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`80 - `languages: optional array of string`

81 

82 Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.

77 83 

78 The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.84 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

85 

86 The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.

79 87 

80 - `string`88 - `string`

81 89 

82 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`90 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

83 91 

84 The model to use for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.92 The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.

85 93 

86 - `"whisper-1"`94 - `"whisper-1"`

87 95 

96 - `"gpt-transcribe"`

97 

98 - `"gpt-live-transcribe"`

99 

88 - `"gpt-4o-mini-transcribe"`100 - `"gpt-4o-mini-transcribe"`

89 101 

90 - `"gpt-4o-mini-transcribe-2025-12-15"`102 - `"gpt-4o-mini-transcribe-2025-12-15"`


152 164 

153 The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.165 The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`.

154 166 

155- `input_audio_transcription: optional object { language, model, prompt }`167- `input_audio_transcription: optional object { language, languages, model, prompt }`

156 168 

157 Configuration of the transcription model.169 Configuration of the transcription model.

158 170 


160 172 

161 The language of the input audio.173 The language of the input audio.

162 174 

163 - `model: optional string or "whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`175 - `languages: optional array of string`

164 176 

165 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.177 The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

178 

179 - `model: optional string or "whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

180 

181 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

166 182 

167 - `string`183 - `string`

168 184 

169 - `"whisper-1" or "gpt-4o-mini-transcribe" or "gpt-4o-mini-transcribe-2025-12-15" or 3 more`185 - `"whisper-1" or "gpt-transcribe" or "gpt-live-transcribe" or 5 more`

170 186 

171 The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.187 The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.

172 188 

173 - `"whisper-1"`189 - `"whisper-1"`

174 190 

191 - `"gpt-transcribe"`

192 

193 - `"gpt-live-transcribe"`

194 

175 - `"gpt-4o-mini-transcribe"`195 - `"gpt-4o-mini-transcribe"`

176 196 

177 - `"gpt-4o-mini-transcribe-2025-12-15"`197 - `"gpt-4o-mini-transcribe-2025-12-15"`


242 "input_audio_format": "input_audio_format",262 "input_audio_format": "input_audio_format",

243 "input_audio_transcription": {263 "input_audio_transcription": {

244 "language": "language",264 "language": "language",

265 "languages": [

266 "string"

267 ],

245 "model": "whisper-1",268 "model": "whisper-1",

246 "prompt": "prompt"269 "prompt": "prompt"

247 },270 },

Details

1# Realtime translation client events1# Realtime translation client events

2 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 

3These are events that the OpenAI Realtime Translation WebSocket server will accept from the client.5These are events that the OpenAI Realtime Translation WebSocket server will accept from the client.

4 6 

5## session.update7## session.update


17 "(resource) realtime > (model) realtime_translation_session_update_event > (schema)": {19 "(resource) realtime > (model) realtime_translation_session_update_event > (schema)": {

18 "kind": "HttpDeclTypeAlias",20 "kind": "HttpDeclTypeAlias",

19 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate",21 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate",

22 "docstring": "Send this event to update the translation session configuration. Translation\nsessions support updates to `audio.output.language`, `audio.input.transcription`,\nand `audio.input.noise_reduction`.\n",

20 "ident": "RealtimeTranslationSessionUpdateEvent",23 "ident": "RealtimeTranslationSessionUpdateEvent",

21 "type": {24 "type": {

22 "kind": "HttpTypeObject",25 "kind": "HttpTypeObject",


32 }35 }

33 ]36 ]

34 },37 },

35 "docstring": "Send this event to update the translation session configuration. Translation\nsessions support updates to `audio.output.language`, `audio.input.transcription`,\nand `audio.input.noise_reduction`.\n",

36 "childrenParentSchema": "object",38 "childrenParentSchema": "object",

37 "children": [39 "children": [

38 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) session",40 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) session",


42 },44 },

43 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) session": {45 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) session": {

44 "kind": "HttpDeclProperty",46 "kind": "HttpDeclProperty",

45 "title": "Realtime translation session update",47 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/session",

46 "docstring": "Translation session fields to update. The session `type` and `model` are set\nat creation and cannot be changed with `session.update`.\n",48 "deprecated": false,

47 "key": "session",49 "key": "session",

48 "optional": false,50 "docstring": "Translation session fields to update. The session `type` and `model` are set\nat creation and cannot be changed with `session.update`.\n",

49 "nullable": false,51 "title": "Realtime translation session update",

50 "type": {52 "type": {

51 "kind": "HttpTypeReference",53 "kind": "HttpTypeReference",

52 "ident": "RealtimeTranslationSessionUpdateRequest",54 "ident": "RealtimeTranslationSessionUpdateRequest",

53 "$ref": "(resource) realtime > (model) realtime_translation_session_update_request > (schema)"55 "$ref": "(resource) realtime > (model) realtime_translation_session_update_request > (schema)"

54 },56 },

55 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/session",57 "optional": false,

56 "deprecated": false,58 "nullable": false,

57 "schemaType": "object",

58 "modelImplicit": false,59 "modelImplicit": false,

60 "schemaType": "object",

59 "modelPath": "(resource) realtime > (model) realtime_translation_session_update_request",61 "modelPath": "(resource) realtime > (model) realtime_translation_session_update_request",

60 "childrenParentSchema": "object",62 "childrenParentSchema": "object",

61 "children": [63 "children": [


64 },66 },

65 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) type": {67 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) type": {

66 "kind": "HttpDeclProperty",68 "kind": "HttpDeclProperty",

67 "docstring": "The event type, must be `session.update`.",69 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/type",

70 "deprecated": false,

68 "key": "type",71 "key": "type",

69 "optional": false,72 "docstring": "The event type, must be `session.update`.",

70 "nullable": false,

71 "type": {73 "type": {

72 "kind": "HttpTypeUnion",74 "kind": "HttpTypeUnion",

75 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/type",

73 "types": [76 "types": [

74 {77 {

75 "kind": "HttpTypeLiteral",78 "kind": "HttpTypeLiteral",

76 "literal": "session.update"79 "literal": "session.update"

77 }80 }

78 ],81 ]

79 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/type"

80 },82 },

81 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/type",83 "optional": false,

82 "deprecated": false,84 "nullable": false,

83 "schemaType": "enum",85 "schemaType": "enum",

84 "childrenParentSchema": "enum",86 "childrenParentSchema": "enum",

85 "children": [87 "children": [


88 },90 },

89 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) event_id": {91 "(resource) realtime > (model) realtime_translation_session_update_event > (schema) > (property) event_id": {

90 "kind": "HttpDeclProperty",92 "kind": "HttpDeclProperty",

91 "docstring": "Optional client-generated ID used to identify this event.",93 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/event_id",

94 "deprecated": false,

92 "key": "event_id",95 "key": "event_id",

93 "optional": true,96 "docstring": "Optional client-generated ID used to identify this event.",

94 "nullable": false,

95 "type": {97 "type": {

96 "kind": "HttpTypeString"98 "kind": "HttpTypeString"

97 },99 },

98 "constraints": {100 "constraints": {

99 "maxLength": 512101 "maxLength": 512

100 },102 },

101 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionUpdate/properties/event_id",103 "optional": true,

102 "deprecated": false,104 "nullable": false,

103 "schemaType": "string",105 "schemaType": "string",

104 "children": []106 "children": []

105 },107 },

106 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio": {108 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio": {

107 "kind": "HttpDeclProperty",109 "kind": "HttpDeclProperty",

108 "docstring": "Configuration for translation input and output audio.\n",110 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio",

111 "deprecated": false,

109 "key": "audio",112 "key": "audio",

110 "optional": true,113 "docstring": "Configuration for translation input and output audio.\n",

111 "nullable": false,

112 "type": {114 "type": {

113 "kind": "HttpTypeObject",115 "kind": "HttpTypeObject",

114 "members": [116 "members": [


120 }122 }

121 ]123 ]

122 },124 },

123 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio",125 "optional": true,

124 "deprecated": false,126 "nullable": false,

125 "schemaType": "object",127 "schemaType": "object",

126 "childrenParentSchema": "object",128 "childrenParentSchema": "object",

127 "children": [129 "children": [


132 "(resource) realtime > (model) realtime_translation_session_update_request > (schema)": {134 "(resource) realtime > (model) realtime_translation_session_update_request > (schema)": {

133 "kind": "HttpDeclTypeAlias",135 "kind": "HttpDeclTypeAlias",

134 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest",136 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest",

137 "docstring": "Realtime translation session fields that can be updated with `session.update`.\n",

135 "ident": "RealtimeTranslationSessionUpdateRequest",138 "ident": "RealtimeTranslationSessionUpdateRequest",

136 "type": {139 "type": {

137 "kind": "HttpTypeObject",140 "kind": "HttpTypeObject",


141 }144 }

142 ]145 ]

143 },146 },

144 "docstring": "Realtime translation session fields that can be updated with `session.update`.\n",

145 "childrenParentSchema": "object",147 "childrenParentSchema": "object",

146 "children": [148 "children": [

147 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio"149 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio"


156 },158 },

157 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input": {159 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input": {

158 "kind": "HttpDeclProperty",160 "kind": "HttpDeclProperty",

161 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input",

162 "deprecated": false,

159 "key": "input",163 "key": "input",

160 "optional": true,

161 "nullable": false,

162 "type": {164 "type": {

163 "kind": "HttpTypeObject",165 "kind": "HttpTypeObject",

164 "members": [166 "members": [


170 }172 }

171 ]173 ]

172 },174 },

173 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input",175 "optional": true,

174 "deprecated": false,176 "nullable": false,

175 "schemaType": "object",177 "schemaType": "object",

176 "childrenParentSchema": "object",178 "childrenParentSchema": "object",

177 "children": [179 "children": [


181 },183 },

182 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) output": {184 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) output": {

183 "kind": "HttpDeclProperty",185 "kind": "HttpDeclProperty",

186 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/output",

187 "deprecated": false,

184 "key": "output",188 "key": "output",

185 "optional": true,

186 "nullable": false,

187 "type": {189 "type": {

188 "kind": "HttpTypeObject",190 "kind": "HttpTypeObject",

189 "members": [191 "members": [


192 }194 }

193 ]195 ]

194 },196 },

195 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/output",197 "optional": true,

196 "deprecated": false,198 "nullable": false,

197 "schemaType": "object",199 "schemaType": "object",

198 "childrenParentSchema": "object",200 "childrenParentSchema": "object",

199 "children": [201 "children": [


202 },204 },

203 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) noise_reduction": {205 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) noise_reduction": {

204 "kind": "HttpDeclProperty",206 "kind": "HttpDeclProperty",

205 "docstring": "Optional input noise reduction. Set to `null` to disable it.\n",207 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/noise_reduction",

208 "deprecated": false,

206 "key": "noise_reduction",209 "key": "noise_reduction",

207 "optional": true,210 "docstring": "Optional input noise reduction. Set to `null` to disable it.\n",

208 "nullable": true,

209 "type": {211 "type": {

210 "kind": "HttpTypeObject",212 "kind": "HttpTypeObject",

211 "members": [213 "members": [


214 }216 }

215 ]217 ]

216 },218 },

217 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/noise_reduction",219 "optional": true,

218 "deprecated": false,220 "nullable": true,

219 "schemaType": "object",221 "schemaType": "object",

220 "childrenParentSchema": "object",222 "childrenParentSchema": "object",

221 "children": [223 "children": [


224 },226 },

225 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) transcription": {227 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) transcription": {

226 "kind": "HttpDeclProperty",228 "kind": "HttpDeclProperty",

227 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",229 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/transcription",

230 "deprecated": false,

228 "key": "transcription",231 "key": "transcription",

229 "optional": true,232 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",

230 "nullable": true,

231 "type": {233 "type": {

232 "kind": "HttpTypeObject",234 "kind": "HttpTypeObject",

233 "members": [235 "members": [


236 }238 }

237 ]239 ]

238 },240 },

239 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/transcription",241 "optional": true,

240 "deprecated": false,242 "nullable": true,

241 "schemaType": "object",243 "schemaType": "object",

242 "childrenParentSchema": "object",244 "childrenParentSchema": "object",

243 "children": [245 "children": [


246 },248 },

247 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) output > (property) language": {249 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) output > (property) language": {

248 "kind": "HttpDeclProperty",250 "kind": "HttpDeclProperty",

249 "docstring": "Target language for translated output audio and transcript deltas.\n",251 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/output/properties/language",

252 "deprecated": false,

250 "key": "language",253 "key": "language",

251 "optional": true,254 "docstring": "Target language for translated output audio and transcript deltas.\n",

252 "nullable": false,

253 "type": {255 "type": {

254 "kind": "HttpTypeString"256 "kind": "HttpTypeString"

255 },257 },

256 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/output/properties/language",258 "optional": true,

257 "deprecated": false,259 "nullable": false,

258 "schemaType": "string",260 "schemaType": "string",

259 "children": []261 "children": []

260 },262 },

261 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {263 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {

262 "kind": "HttpDeclProperty",264 "kind": "HttpDeclProperty",

263 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",265 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",

266 "deprecated": false,

264 "key": "type",267 "key": "type",

265 "optional": false,268 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

266 "nullable": false,

267 "type": {269 "type": {

268 "kind": "HttpTypeReference",270 "kind": "HttpTypeReference",

269 "ident": "NoiseReductionType",271 "ident": "NoiseReductionType",

270 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"272 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"

271 },273 },

272 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",274 "optional": false,

273 "deprecated": false,275 "nullable": false,

274 "schemaType": "enum",

275 "modelImplicit": false,276 "modelImplicit": false,

277 "schemaType": "enum",

276 "modelPath": "(resource) realtime > (model) noise_reduction_type",278 "modelPath": "(resource) realtime > (model) noise_reduction_type",

277 "childrenParentSchema": "enum",279 "childrenParentSchema": "enum",

278 "children": [280 "children": [


282 },284 },

283 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {285 "(resource) realtime > (model) realtime_translation_session_update_request > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {

284 "kind": "HttpDeclProperty",286 "kind": "HttpDeclProperty",

285 "docstring": "The transcription model to use for source transcript deltas.",287 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",

288 "deprecated": false,

286 "key": "model",289 "key": "model",

287 "optional": false,290 "docstring": "The transcription model to use for source transcript deltas.",

288 "nullable": false,

289 "type": {291 "type": {

290 "kind": "HttpTypeString"292 "kind": "HttpTypeString"

291 },293 },

292 "oasRef": "#/components/schemas/RealtimeTranslationSessionUpdateRequest/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",294 "optional": false,

293 "deprecated": false,295 "nullable": false,

294 "schemaType": "string",296 "schemaType": "string",

295 "children": []297 "children": []

296 },298 },


311 "(resource) realtime > (model) noise_reduction_type > (schema)": {313 "(resource) realtime > (model) noise_reduction_type > (schema)": {

312 "kind": "HttpDeclTypeAlias",314 "kind": "HttpDeclTypeAlias",

313 "oasRef": "#/components/schemas/NoiseReductionType",315 "oasRef": "#/components/schemas/NoiseReductionType",

316 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

314 "ident": "NoiseReductionType",317 "ident": "NoiseReductionType",

315 "type": {318 "type": {

316 "kind": "HttpTypeUnion",319 "kind": "HttpTypeUnion",

320 "oasRef": "#/components/schemas/NoiseReductionType",

317 "types": [321 "types": [

318 {322 {

319 "kind": "HttpTypeLiteral",323 "kind": "HttpTypeLiteral",


323 "kind": "HttpTypeLiteral",327 "kind": "HttpTypeLiteral",

324 "literal": "far_field"328 "literal": "far_field"

325 }329 }

326 ],330 ]

327 "oasRef": "#/components/schemas/NoiseReductionType"

328 },331 },

329 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

330 "childrenParentSchema": "enum",332 "childrenParentSchema": "enum",

331 "children": [333 "children": [

332 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",334 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",


384 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema)": {386 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema)": {

385 "kind": "HttpDeclTypeAlias",387 "kind": "HttpDeclTypeAlias",

386 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend",388 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend",

389 "docstring": "Send this event to append audio bytes to the translation session input audio buffer.\n\nWebSocket translation sessions accept base64-encoded 24 kHz PCM16 mono\nlittle-endian raw audio bytes. Unsupported websocket audio formats return a\nvalidation error because lower-quality audio materially degrades translation\nquality.\n\nTranslation consumes 200 ms engine frames. For best realtime behavior, append\naudio in 200 ms chunks. If a chunk is shorter, the server buffers it until it\nhas enough audio for one frame. If a chunk is longer, the server splits it into\n200 ms frames and enqueues them back-to-back.\n\nKeep appending silence while the session is active. If a client stops sending\naudio and later resumes, model time treats the resumed audio as contiguous with\nthe previous audio rather than as a real-world pause.\n",

387 "ident": "RealtimeTranslationInputAudioBufferAppendEvent",390 "ident": "RealtimeTranslationInputAudioBufferAppendEvent",

388 "type": {391 "type": {

389 "kind": "HttpTypeObject",392 "kind": "HttpTypeObject",


399 }402 }

400 ]403 ]

401 },404 },

402 "docstring": "Send this event to append audio bytes to the translation session input audio buffer.\n\nWebSocket translation sessions accept base64-encoded 24 kHz PCM16 mono\nlittle-endian raw audio bytes. Unsupported websocket audio formats return a\nvalidation error because lower-quality audio materially degrades translation\nquality.\n\nTranslation consumes 200 ms engine frames. For best realtime behavior, append\naudio in 200 ms chunks. If a chunk is shorter, the server buffers it until it\nhas enough audio for one frame. If a chunk is longer, the server splits it into\n200 ms frames and enqueues them back-to-back.\n\nKeep appending silence while the session is active. If a client stops sending\naudio and later resumes, model time treats the resumed audio as contiguous with\nthe previous audio rather than as a real-world pause.\n",

403 "childrenParentSchema": "object",405 "childrenParentSchema": "object",

404 "children": [406 "children": [

405 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) audio",407 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) audio",


409 },411 },

410 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) audio": {412 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) audio": {

411 "kind": "HttpDeclProperty",413 "kind": "HttpDeclProperty",

412 "docstring": "Base64-encoded 24 kHz PCM16 mono audio bytes.",414 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/audio",

415 "deprecated": false,

413 "key": "audio",416 "key": "audio",

414 "optional": false,417 "docstring": "Base64-encoded 24 kHz PCM16 mono audio bytes.",

415 "nullable": false,

416 "type": {418 "type": {

417 "kind": "HttpTypeString"419 "kind": "HttpTypeString"

418 },420 },

419 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/audio",421 "optional": false,

420 "deprecated": false,422 "nullable": false,

421 "schemaType": "string",423 "schemaType": "string",

422 "children": []424 "children": []

423 },425 },

424 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) type": {426 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) type": {

425 "kind": "HttpDeclProperty",427 "kind": "HttpDeclProperty",

426 "docstring": "The event type, must be `session.input_audio_buffer.append`.",428 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/type",

429 "deprecated": false,

427 "key": "type",430 "key": "type",

428 "optional": false,431 "docstring": "The event type, must be `session.input_audio_buffer.append`.",

429 "nullable": false,

430 "type": {432 "type": {

431 "kind": "HttpTypeUnion",433 "kind": "HttpTypeUnion",

434 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/type",

432 "types": [435 "types": [

433 {436 {

434 "kind": "HttpTypeLiteral",437 "kind": "HttpTypeLiteral",

435 "literal": "session.input_audio_buffer.append"438 "literal": "session.input_audio_buffer.append"

436 }439 }

437 ],440 ]

438 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/type"

439 },441 },

440 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/type",442 "optional": false,

441 "deprecated": false,443 "nullable": false,

442 "schemaType": "enum",444 "schemaType": "enum",

443 "childrenParentSchema": "enum",445 "childrenParentSchema": "enum",

444 "children": [446 "children": [


447 },449 },

448 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) event_id": {450 "(resource) realtime > (model) realtime_translation_input_audio_buffer_append_event > (schema) > (property) event_id": {

449 "kind": "HttpDeclProperty",451 "kind": "HttpDeclProperty",

450 "docstring": "Optional client-generated ID used to identify this event.",452 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/event_id",

453 "deprecated": false,

451 "key": "event_id",454 "key": "event_id",

452 "optional": true,455 "docstring": "Optional client-generated ID used to identify this event.",

453 "nullable": false,

454 "type": {456 "type": {

455 "kind": "HttpTypeString"457 "kind": "HttpTypeString"

456 },458 },

457 "constraints": {459 "constraints": {

458 "maxLength": 512460 "maxLength": 512

459 },461 },

460 "oasRef": "#/components/schemas/RealtimeTranslationClientEventInputAudioBufferAppend/properties/event_id",462 "optional": true,

461 "deprecated": false,463 "nullable": false,

462 "schemaType": "string",464 "schemaType": "string",

463 "children": []465 "children": []

464 },466 },


497 "(resource) realtime > (model) realtime_translation_session_close_event > (schema)": {499 "(resource) realtime > (model) realtime_translation_session_close_event > (schema)": {

498 "kind": "HttpDeclTypeAlias",500 "kind": "HttpDeclTypeAlias",

499 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose",501 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose",

502 "docstring": "Gracefully close the realtime translation session. The server flushes pending\ninput audio and emits any remaining translated output before closing the\nsession.\n",

500 "ident": "RealtimeTranslationSessionCloseEvent",503 "ident": "RealtimeTranslationSessionCloseEvent",

501 "type": {504 "type": {

502 "kind": "HttpTypeObject",505 "kind": "HttpTypeObject",


509 }512 }

510 ]513 ]

511 },514 },

512 "docstring": "Gracefully close the realtime translation session. The server flushes pending\ninput audio and emits any remaining translated output before closing the\nsession.\n",

513 "childrenParentSchema": "object",515 "childrenParentSchema": "object",

514 "children": [516 "children": [

515 "(resource) realtime > (model) realtime_translation_session_close_event > (schema) > (property) type",517 "(resource) realtime > (model) realtime_translation_session_close_event > (schema) > (property) type",


518 },520 },

519 "(resource) realtime > (model) realtime_translation_session_close_event > (schema) > (property) type": {521 "(resource) realtime > (model) realtime_translation_session_close_event > (schema) > (property) type": {

520 "kind": "HttpDeclProperty",522 "kind": "HttpDeclProperty",

521 "docstring": "The event type, must be `session.close`.",523 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose/properties/type",

524 "deprecated": false,

522 "key": "type",525 "key": "type",

523 "optional": false,526 "docstring": "The event type, must be `session.close`.",

524 "nullable": false,

525 "type": {527 "type": {

526 "kind": "HttpTypeUnion",528 "kind": "HttpTypeUnion",

529 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose/properties/type",

527 "types": [530 "types": [

528 {531 {

529 "kind": "HttpTypeLiteral",532 "kind": "HttpTypeLiteral",

530 "literal": "session.close"533 "literal": "session.close"

531 }534 }

532 ],535 ]

533 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose/properties/type"

534 },536 },

535 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose/properties/type",537 "optional": false,

536 "deprecated": false,538 "nullable": false,

537 "schemaType": "enum",539 "schemaType": "enum",

538 "childrenParentSchema": "enum",540 "childrenParentSchema": "enum",

539 "children": [541 "children": [


542 },544 },

543 "(resource) realtime > (model) realtime_translation_session_close_event > (schema) > (property) event_id": {545 "(resource) realtime > (model) realtime_translation_session_close_event > (schema) > (property) event_id": {

544 "kind": "HttpDeclProperty",546 "kind": "HttpDeclProperty",

545 "docstring": "Optional client-generated ID used to identify this event.",547 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose/properties/event_id",

548 "deprecated": false,

546 "key": "event_id",549 "key": "event_id",

547 "optional": true,550 "docstring": "Optional client-generated ID used to identify this event.",

548 "nullable": false,

549 "type": {551 "type": {

550 "kind": "HttpTypeString"552 "kind": "HttpTypeString"

551 },553 },

552 "constraints": {554 "constraints": {

553 "maxLength": 512555 "maxLength": 512

554 },556 },

555 "oasRef": "#/components/schemas/RealtimeTranslationClientEventSessionClose/properties/event_id",557 "optional": true,

556 "deprecated": false,558 "nullable": false,

557 "schemaType": "string",559 "schemaType": "string",

558 "children": []560 "children": []

559 },561 },

Details

1# Realtime translation server events1# Realtime translation server events

2 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 

3These are events emitted from the OpenAI Realtime Translation WebSocket server to the client.5These are events emitted from the OpenAI Realtime Translation WebSocket server to the client.

4 6 

5## error7## error


17 "(resource) realtime > (model) realtime_error_event > (schema)": {19 "(resource) realtime > (model) realtime_error_event > (schema)": {

18 "kind": "HttpDeclTypeAlias",20 "kind": "HttpDeclTypeAlias",

19 "oasRef": "#/components/schemas/RealtimeServerEventError",21 "oasRef": "#/components/schemas/RealtimeServerEventError",

22 "docstring": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n",

20 "ident": "RealtimeErrorEvent",23 "ident": "RealtimeErrorEvent",

21 "type": {24 "type": {

22 "kind": "HttpTypeObject",25 "kind": "HttpTypeObject",


32 }35 }

33 ]36 ]

34 },37 },

35 "docstring": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n",

36 "childrenParentSchema": "object",38 "childrenParentSchema": "object",

37 "children": [39 "children": [

38 "(resource) realtime > (model) realtime_error_event > (schema) > (property) error",40 "(resource) realtime > (model) realtime_error_event > (schema) > (property) error",


42 },44 },

43 "(resource) realtime > (model) realtime_error_event > (schema) > (property) error": {45 "(resource) realtime > (model) realtime_error_event > (schema) > (property) error": {

44 "kind": "HttpDeclProperty",46 "kind": "HttpDeclProperty",

45 "docstring": "Details of the error.",47 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",

48 "deprecated": false,

46 "key": "error",49 "key": "error",

47 "optional": false,50 "docstring": "Details of the error.",

48 "nullable": false,

49 "type": {51 "type": {

50 "kind": "HttpTypeReference",52 "kind": "HttpTypeReference",

51 "ident": "RealtimeError",53 "ident": "RealtimeError",

52 "$ref": "(resource) realtime > (model) realtime_error > (schema)"54 "$ref": "(resource) realtime > (model) realtime_error > (schema)"

53 },55 },

54 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",56 "optional": false,

55 "deprecated": false,57 "nullable": false,

56 "schemaType": "object",

57 "modelImplicit": false,58 "modelImplicit": false,

59 "schemaType": "object",

58 "modelPath": "(resource) realtime > (model) realtime_error",60 "modelPath": "(resource) realtime > (model) realtime_error",

59 "childrenParentSchema": "object",61 "childrenParentSchema": "object",

60 "children": [62 "children": [


67 },69 },

68 "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id": {70 "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id": {

69 "kind": "HttpDeclProperty",71 "kind": "HttpDeclProperty",

70 "docstring": "The unique ID of the server event.",72 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/event_id",

73 "deprecated": false,

71 "key": "event_id",74 "key": "event_id",

72 "optional": false,75 "docstring": "The unique ID of the server event.",

73 "nullable": false,

74 "type": {76 "type": {

75 "kind": "HttpTypeString"77 "kind": "HttpTypeString"

76 },78 },

77 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/event_id",79 "optional": false,

78 "deprecated": false,80 "nullable": false,

79 "schemaType": "string",81 "schemaType": "string",

80 "children": []82 "children": []

81 },83 },

82 "(resource) realtime > (model) realtime_error_event > (schema) > (property) type": {84 "(resource) realtime > (model) realtime_error_event > (schema) > (property) type": {

83 "kind": "HttpDeclProperty",85 "kind": "HttpDeclProperty",

84 "docstring": "The event type, must be `error`.",86 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type",

87 "deprecated": false,

85 "key": "type",88 "key": "type",

86 "optional": false,89 "docstring": "The event type, must be `error`.",

87 "nullable": false,

88 "type": {90 "type": {

89 "kind": "HttpTypeUnion",91 "kind": "HttpTypeUnion",

92 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type",

90 "types": [93 "types": [

91 {94 {

92 "kind": "HttpTypeLiteral",95 "kind": "HttpTypeLiteral",

93 "literal": "error"96 "literal": "error"

94 }97 }

95 ],98 ]

96 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type"

97 },99 },

98 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type",100 "optional": false,

99 "deprecated": false,101 "nullable": false,

100 "schemaType": "enum",102 "schemaType": "enum",

101 "childrenParentSchema": "enum",103 "childrenParentSchema": "enum",

102 "children": [104 "children": [


105 },107 },

106 "(resource) realtime > (model) realtime_error > (schema) > (property) message": {108 "(resource) realtime > (model) realtime_error > (schema) > (property) message": {

107 "kind": "HttpDeclProperty",109 "kind": "HttpDeclProperty",

108 "docstring": "A human-readable error message.",110 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/message",

111 "deprecated": false,

109 "key": "message",112 "key": "message",

110 "optional": false,113 "docstring": "A human-readable error message.",

111 "nullable": false,

112 "type": {114 "type": {

113 "kind": "HttpTypeString"115 "kind": "HttpTypeString"

114 },116 },

115 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/message",117 "optional": false,

116 "deprecated": false,118 "nullable": false,

117 "schemaType": "string",119 "schemaType": "string",

118 "children": []120 "children": []

119 },121 },

120 "(resource) realtime > (model) realtime_error > (schema) > (property) type": {122 "(resource) realtime > (model) realtime_error > (schema) > (property) type": {

121 "kind": "HttpDeclProperty",123 "kind": "HttpDeclProperty",

122 "docstring": "The type of error (e.g., \"invalid_request_error\", \"server_error\").\n",124 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/type",

125 "deprecated": false,

123 "key": "type",126 "key": "type",

124 "optional": false,127 "docstring": "The type of error (e.g., \"invalid_request_error\", \"server_error\").\n",

125 "nullable": false,

126 "type": {128 "type": {

127 "kind": "HttpTypeString"129 "kind": "HttpTypeString"

128 },130 },

129 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/type",131 "optional": false,

130 "deprecated": false,132 "nullable": false,

131 "schemaType": "string",133 "schemaType": "string",

132 "children": []134 "children": []

133 },135 },

134 "(resource) realtime > (model) realtime_error > (schema) > (property) code": {136 "(resource) realtime > (model) realtime_error > (schema) > (property) code": {

135 "kind": "HttpDeclProperty",137 "kind": "HttpDeclProperty",

136 "docstring": "Error code, if any.",138 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/code",

139 "deprecated": false,

137 "key": "code",140 "key": "code",

138 "optional": true,141 "docstring": "Error code, if any.",

139 "nullable": true,

140 "type": {142 "type": {

141 "kind": "HttpTypeString"143 "kind": "HttpTypeString"

142 },144 },

143 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/code",145 "optional": true,

144 "deprecated": false,146 "nullable": true,

145 "schemaType": "string",147 "schemaType": "string",

146 "children": []148 "children": []

147 },149 },

148 "(resource) realtime > (model) realtime_error > (schema) > (property) event_id": {150 "(resource) realtime > (model) realtime_error > (schema) > (property) event_id": {

149 "kind": "HttpDeclProperty",151 "kind": "HttpDeclProperty",

150 "docstring": "The event_id of the client event that caused the error, if applicable.\n",152 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/event_id",

153 "deprecated": false,

151 "key": "event_id",154 "key": "event_id",

152 "optional": true,155 "docstring": "The event_id of the client event that caused the error, if applicable.\n",

153 "nullable": true,

154 "type": {156 "type": {

155 "kind": "HttpTypeString"157 "kind": "HttpTypeString"

156 },158 },

157 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/event_id",159 "optional": true,

158 "deprecated": false,160 "nullable": true,

159 "schemaType": "string",161 "schemaType": "string",

160 "children": []162 "children": []

161 },163 },

162 "(resource) realtime > (model) realtime_error > (schema) > (property) param": {164 "(resource) realtime > (model) realtime_error > (schema) > (property) param": {

163 "kind": "HttpDeclProperty",165 "kind": "HttpDeclProperty",

164 "docstring": "Parameter related to the error, if any.",166 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/param",

167 "deprecated": false,

165 "key": "param",168 "key": "param",

166 "optional": true,169 "docstring": "Parameter related to the error, if any.",

167 "nullable": true,

168 "type": {170 "type": {

169 "kind": "HttpTypeString"171 "kind": "HttpTypeString"

170 },172 },

171 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/param",173 "optional": true,

172 "deprecated": false,174 "nullable": true,

173 "schemaType": "string",175 "schemaType": "string",

174 "children": []176 "children": []

175 },177 },

176 "(resource) realtime > (model) realtime_error > (schema)": {178 "(resource) realtime > (model) realtime_error > (schema)": {

177 "kind": "HttpDeclTypeAlias",179 "kind": "HttpDeclTypeAlias",

178 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",180 "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error",

181 "docstring": "Details of the error.",

179 "ident": "RealtimeError",182 "ident": "RealtimeError",

180 "type": {183 "type": {

181 "kind": "HttpTypeObject",184 "kind": "HttpTypeObject",


197 }200 }

198 ]201 ]

199 },202 },

200 "docstring": "Details of the error.",

201 "childrenParentSchema": "object",203 "childrenParentSchema": "object",

202 "children": [204 "children": [

203 "(resource) realtime > (model) realtime_error > (schema) > (property) message",205 "(resource) realtime > (model) realtime_error > (schema) > (property) message",


248 "(resource) realtime > (model) realtime_translation_session_created_event > (schema)": {250 "(resource) realtime > (model) realtime_translation_session_created_event > (schema)": {

249 "kind": "HttpDeclTypeAlias",251 "kind": "HttpDeclTypeAlias",

250 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated",252 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated",

253 "docstring": "Returned when a translation session is created. Emitted automatically when a\nnew connection is established as the first server event. This event contains\nthe default translation session configuration.\n",

251 "ident": "RealtimeTranslationSessionCreatedEvent",254 "ident": "RealtimeTranslationSessionCreatedEvent",

252 "type": {255 "type": {

253 "kind": "HttpTypeObject",256 "kind": "HttpTypeObject",


263 }266 }

264 ]267 ]

265 },268 },

266 "docstring": "Returned when a translation session is created. Emitted automatically when a\nnew connection is established as the first server event. This event contains\nthe default translation session configuration.\n",

267 "childrenParentSchema": "object",269 "childrenParentSchema": "object",

268 "children": [270 "children": [

269 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id",271 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id",


273 },275 },

274 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id": {276 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) event_id": {

275 "kind": "HttpDeclProperty",277 "kind": "HttpDeclProperty",

276 "docstring": "The unique ID of the server event.",278 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/event_id",

279 "deprecated": false,

277 "key": "event_id",280 "key": "event_id",

278 "optional": false,281 "docstring": "The unique ID of the server event.",

279 "nullable": false,

280 "type": {282 "type": {

281 "kind": "HttpTypeString"283 "kind": "HttpTypeString"

282 },284 },

283 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/event_id",285 "optional": false,

284 "deprecated": false,286 "nullable": false,

285 "schemaType": "string",287 "schemaType": "string",

286 "children": []288 "children": []

287 },289 },

288 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) session": {290 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) session": {

289 "kind": "HttpDeclProperty",291 "kind": "HttpDeclProperty",

290 "title": "Realtime translation session",292 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/session",

291 "docstring": "The translation session configuration.",293 "deprecated": false,

292 "key": "session",294 "key": "session",

293 "optional": false,295 "docstring": "The translation session configuration.",

294 "nullable": false,296 "title": "Realtime translation session",

295 "type": {297 "type": {

296 "kind": "HttpTypeReference",298 "kind": "HttpTypeReference",

297 "ident": "RealtimeTranslationSession",299 "ident": "RealtimeTranslationSession",

298 "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"300 "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"

299 },301 },

300 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/session",302 "optional": false,

301 "deprecated": false,303 "nullable": false,

302 "schemaType": "object",

303 "modelImplicit": false,304 "modelImplicit": false,

305 "schemaType": "object",

304 "modelPath": "(resource) realtime > (model) realtime_translation_session",306 "modelPath": "(resource) realtime > (model) realtime_translation_session",

305 "childrenParentSchema": "object",307 "childrenParentSchema": "object",

306 "children": [308 "children": [


313 },315 },

314 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type": {316 "(resource) realtime > (model) realtime_translation_session_created_event > (schema) > (property) type": {

315 "kind": "HttpDeclProperty",317 "kind": "HttpDeclProperty",

316 "docstring": "The event type, must be `session.created`.",318 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type",

319 "deprecated": false,

317 "key": "type",320 "key": "type",

318 "optional": false,321 "docstring": "The event type, must be `session.created`.",

319 "nullable": false,

320 "type": {322 "type": {

321 "kind": "HttpTypeUnion",323 "kind": "HttpTypeUnion",

324 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type",

322 "types": [325 "types": [

323 {326 {

324 "kind": "HttpTypeLiteral",327 "kind": "HttpTypeLiteral",

325 "literal": "session.created"328 "literal": "session.created"

326 }329 }

327 ],330 ]

328 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type"

329 },331 },

330 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionCreated/properties/type",332 "optional": false,

331 "deprecated": false,333 "nullable": false,

332 "schemaType": "enum",334 "schemaType": "enum",

333 "childrenParentSchema": "enum",335 "childrenParentSchema": "enum",

334 "children": [336 "children": [


337 },339 },

338 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {340 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {

339 "kind": "HttpDeclProperty",341 "kind": "HttpDeclProperty",

340 "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",342 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",

343 "deprecated": false,

341 "key": "id",344 "key": "id",

342 "optional": false,345 "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",

343 "nullable": false,

344 "type": {346 "type": {

345 "kind": "HttpTypeString"347 "kind": "HttpTypeString"

346 },348 },

347 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",349 "optional": false,

348 "deprecated": false,350 "nullable": false,

349 "schemaType": "string",351 "schemaType": "string",

350 "children": []352 "children": []

351 },353 },

352 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {354 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {

353 "kind": "HttpDeclProperty",355 "kind": "HttpDeclProperty",

354 "docstring": "Configuration for translation input and output audio.\n",356 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",

357 "deprecated": false,

355 "key": "audio",358 "key": "audio",

356 "optional": false,359 "docstring": "Configuration for translation input and output audio.\n",

357 "nullable": false,

358 "type": {360 "type": {

359 "kind": "HttpTypeObject",361 "kind": "HttpTypeObject",

360 "members": [362 "members": [


366 }368 }

367 ]369 ]

368 },370 },

369 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",371 "optional": false,

370 "deprecated": false,372 "nullable": false,

371 "schemaType": "object",373 "schemaType": "object",

372 "childrenParentSchema": "object",374 "childrenParentSchema": "object",

373 "children": [375 "children": [


377 },379 },

378 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {380 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {

379 "kind": "HttpDeclProperty",381 "kind": "HttpDeclProperty",

380 "docstring": "Expiration timestamp for the session, in seconds since epoch.",382 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",

383 "deprecated": false,

381 "key": "expires_at",384 "key": "expires_at",

382 "optional": false,385 "docstring": "Expiration timestamp for the session, in seconds since epoch.",

383 "nullable": false,

384 "type": {386 "type": {

385 "kind": "HttpTypeNumber"387 "kind": "HttpTypeNumber"

386 },388 },

387 "constraints": {389 "constraints": {

388 "format": "unixtime"390 "format": "unixtime"

389 },391 },

390 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",392 "optional": false,

391 "deprecated": false,393 "nullable": false,

392 "schemaType": "integer",394 "schemaType": "integer",

393 "children": []395 "children": []

394 },396 },

395 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {397 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {

396 "kind": "HttpDeclProperty",398 "kind": "HttpDeclProperty",

397 "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",399 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",

400 "deprecated": false,

398 "key": "model",401 "key": "model",

399 "optional": false,402 "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",

400 "nullable": false,

401 "type": {403 "type": {

402 "kind": "HttpTypeString"404 "kind": "HttpTypeString"

403 },405 },

404 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",406 "optional": false,

405 "deprecated": false,407 "nullable": false,

406 "schemaType": "string",408 "schemaType": "string",

407 "children": []409 "children": []

408 },410 },

409 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {411 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {

410 "kind": "HttpDeclProperty",412 "kind": "HttpDeclProperty",

411 "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",413 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",

414 "deprecated": false,

412 "key": "type",415 "key": "type",

413 "optional": false,416 "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",

414 "nullable": false,

415 "type": {417 "type": {

416 "kind": "HttpTypeUnion",418 "kind": "HttpTypeUnion",

419 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",

417 "types": [420 "types": [

418 {421 {

419 "kind": "HttpTypeLiteral",422 "kind": "HttpTypeLiteral",

420 "literal": "translation"423 "literal": "translation"

421 }424 }

422 ],425 ]

423 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type"

424 },426 },

425 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",427 "optional": false,

426 "deprecated": false,428 "nullable": false,

427 "schemaType": "enum",429 "schemaType": "enum",

428 "childrenParentSchema": "enum",430 "childrenParentSchema": "enum",

429 "children": [431 "children": [


433 "(resource) realtime > (model) realtime_translation_session > (schema)": {435 "(resource) realtime > (model) realtime_translation_session > (schema)": {

434 "kind": "HttpDeclTypeAlias",436 "kind": "HttpDeclTypeAlias",

435 "oasRef": "#/components/schemas/RealtimeTranslationSession",437 "oasRef": "#/components/schemas/RealtimeTranslationSession",

438 "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",

436 "ident": "RealtimeTranslationSession",439 "ident": "RealtimeTranslationSession",

437 "type": {440 "type": {

438 "kind": "HttpTypeObject",441 "kind": "HttpTypeObject",


454 }457 }

455 ]458 ]

456 },459 },

457 "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",

458 "childrenParentSchema": "object",460 "childrenParentSchema": "object",

459 "children": [461 "children": [

460 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",462 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",


473 },475 },

474 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {476 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {

475 "kind": "HttpDeclProperty",477 "kind": "HttpDeclProperty",

478 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",

479 "deprecated": false,

476 "key": "input",480 "key": "input",

477 "optional": true,

478 "nullable": false,

479 "type": {481 "type": {

480 "kind": "HttpTypeObject",482 "kind": "HttpTypeObject",

481 "members": [483 "members": [


487 }489 }

488 ]490 ]

489 },491 },

490 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",492 "optional": true,

491 "deprecated": false,493 "nullable": false,

492 "schemaType": "object",494 "schemaType": "object",

493 "childrenParentSchema": "object",495 "childrenParentSchema": "object",

494 "children": [496 "children": [


498 },500 },

499 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {501 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {

500 "kind": "HttpDeclProperty",502 "kind": "HttpDeclProperty",

503 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",

504 "deprecated": false,

501 "key": "output",505 "key": "output",

502 "optional": true,

503 "nullable": false,

504 "type": {506 "type": {

505 "kind": "HttpTypeObject",507 "kind": "HttpTypeObject",

506 "members": [508 "members": [


509 }511 }

510 ]512 ]

511 },513 },

512 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",514 "optional": true,

513 "deprecated": false,515 "nullable": false,

514 "schemaType": "object",516 "schemaType": "object",

515 "childrenParentSchema": "object",517 "childrenParentSchema": "object",

516 "children": [518 "children": [


526 },528 },

527 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {529 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {

528 "kind": "HttpDeclProperty",530 "kind": "HttpDeclProperty",

529 "docstring": "Optional input noise reduction.\n",531 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",

532 "deprecated": false,

530 "key": "noise_reduction",533 "key": "noise_reduction",

531 "optional": true,534 "docstring": "Optional input noise reduction.\n",

532 "nullable": true,

533 "type": {535 "type": {

534 "kind": "HttpTypeObject",536 "kind": "HttpTypeObject",

535 "members": [537 "members": [


538 }540 }

539 ]541 ]

540 },542 },

541 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",543 "optional": true,

542 "deprecated": false,544 "nullable": true,

543 "schemaType": "object",545 "schemaType": "object",

544 "childrenParentSchema": "object",546 "childrenParentSchema": "object",

545 "children": [547 "children": [


548 },550 },

549 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {551 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {

550 "kind": "HttpDeclProperty",552 "kind": "HttpDeclProperty",

551 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",553 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",

554 "deprecated": false,

552 "key": "transcription",555 "key": "transcription",

553 "optional": true,556 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",

554 "nullable": true,

555 "type": {557 "type": {

556 "kind": "HttpTypeObject",558 "kind": "HttpTypeObject",

557 "members": [559 "members": [


560 }562 }

561 ]563 ]

562 },564 },

563 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",565 "optional": true,

564 "deprecated": false,566 "nullable": true,

565 "schemaType": "object",567 "schemaType": "object",

566 "childrenParentSchema": "object",568 "childrenParentSchema": "object",

567 "children": [569 "children": [


570 },572 },

571 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {573 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {

572 "kind": "HttpDeclProperty",574 "kind": "HttpDeclProperty",

573 "docstring": "Target language for translated output audio and transcript deltas.\n",575 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",

576 "deprecated": false,

574 "key": "language",577 "key": "language",

575 "optional": true,578 "docstring": "Target language for translated output audio and transcript deltas.\n",

576 "nullable": false,

577 "type": {579 "type": {

578 "kind": "HttpTypeString"580 "kind": "HttpTypeString"

579 },581 },

580 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",582 "optional": true,

581 "deprecated": false,583 "nullable": false,

582 "schemaType": "string",584 "schemaType": "string",

583 "children": []585 "children": []

584 },586 },

585 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {587 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {

586 "kind": "HttpDeclProperty",588 "kind": "HttpDeclProperty",

587 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",589 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",

590 "deprecated": false,

588 "key": "type",591 "key": "type",

589 "optional": false,592 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

590 "nullable": false,

591 "type": {593 "type": {

592 "kind": "HttpTypeReference",594 "kind": "HttpTypeReference",

593 "ident": "NoiseReductionType",595 "ident": "NoiseReductionType",

594 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"596 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"

595 },597 },

596 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",598 "optional": false,

597 "deprecated": false,599 "nullable": false,

598 "schemaType": "enum",

599 "modelImplicit": false,600 "modelImplicit": false,

601 "schemaType": "enum",

600 "modelPath": "(resource) realtime > (model) noise_reduction_type",602 "modelPath": "(resource) realtime > (model) noise_reduction_type",

601 "childrenParentSchema": "enum",603 "childrenParentSchema": "enum",

602 "children": [604 "children": [


606 },608 },

607 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {609 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {

608 "kind": "HttpDeclProperty",610 "kind": "HttpDeclProperty",

609 "docstring": "The transcription model used for source transcript deltas.",611 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",

612 "deprecated": false,

610 "key": "model",613 "key": "model",

611 "optional": false,614 "docstring": "The transcription model used for source transcript deltas.",

612 "nullable": false,

613 "type": {615 "type": {

614 "kind": "HttpTypeString"616 "kind": "HttpTypeString"

615 },617 },

616 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",618 "optional": false,

617 "deprecated": false,619 "nullable": false,

618 "schemaType": "string",620 "schemaType": "string",

619 "children": []621 "children": []

620 },622 },


635 "(resource) realtime > (model) noise_reduction_type > (schema)": {637 "(resource) realtime > (model) noise_reduction_type > (schema)": {

636 "kind": "HttpDeclTypeAlias",638 "kind": "HttpDeclTypeAlias",

637 "oasRef": "#/components/schemas/NoiseReductionType",639 "oasRef": "#/components/schemas/NoiseReductionType",

640 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

638 "ident": "NoiseReductionType",641 "ident": "NoiseReductionType",

639 "type": {642 "type": {

640 "kind": "HttpTypeUnion",643 "kind": "HttpTypeUnion",

644 "oasRef": "#/components/schemas/NoiseReductionType",

641 "types": [645 "types": [

642 {646 {

643 "kind": "HttpTypeLiteral",647 "kind": "HttpTypeLiteral",


647 "kind": "HttpTypeLiteral",651 "kind": "HttpTypeLiteral",

648 "literal": "far_field"652 "literal": "far_field"

649 }653 }

650 ],654 ]

651 "oasRef": "#/components/schemas/NoiseReductionType"

652 },655 },

653 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

654 "childrenParentSchema": "enum",656 "childrenParentSchema": "enum",

655 "children": [657 "children": [

656 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",658 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",


703 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema)": {705 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema)": {

704 "kind": "HttpDeclTypeAlias",706 "kind": "HttpDeclTypeAlias",

705 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated",707 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated",

708 "docstring": "Returned when a translation session is updated with a `session.update` event,\nunless there is an error.\n",

706 "ident": "RealtimeTranslationSessionUpdatedEvent",709 "ident": "RealtimeTranslationSessionUpdatedEvent",

707 "type": {710 "type": {

708 "kind": "HttpTypeObject",711 "kind": "HttpTypeObject",


718 }721 }

719 ]722 ]

720 },723 },

721 "docstring": "Returned when a translation session is updated with a `session.update` event,\nunless there is an error.\n",

722 "childrenParentSchema": "object",724 "childrenParentSchema": "object",

723 "children": [725 "children": [

724 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id",726 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id",


728 },730 },

729 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id": {731 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) event_id": {

730 "kind": "HttpDeclProperty",732 "kind": "HttpDeclProperty",

731 "docstring": "The unique ID of the server event.",733 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/event_id",

734 "deprecated": false,

732 "key": "event_id",735 "key": "event_id",

733 "optional": false,736 "docstring": "The unique ID of the server event.",

734 "nullable": false,

735 "type": {737 "type": {

736 "kind": "HttpTypeString"738 "kind": "HttpTypeString"

737 },739 },

738 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/event_id",740 "optional": false,

739 "deprecated": false,741 "nullable": false,

740 "schemaType": "string",742 "schemaType": "string",

741 "children": []743 "children": []

742 },744 },

743 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) session": {745 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) session": {

744 "kind": "HttpDeclProperty",746 "kind": "HttpDeclProperty",

745 "title": "Realtime translation session",747 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/session",

746 "docstring": "The translation session configuration.",748 "deprecated": false,

747 "key": "session",749 "key": "session",

748 "optional": false,750 "docstring": "The translation session configuration.",

749 "nullable": false,751 "title": "Realtime translation session",

750 "type": {752 "type": {

751 "kind": "HttpTypeReference",753 "kind": "HttpTypeReference",

752 "ident": "RealtimeTranslationSession",754 "ident": "RealtimeTranslationSession",

753 "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"755 "$ref": "(resource) realtime > (model) realtime_translation_session > (schema)"

754 },756 },

755 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/session",757 "optional": false,

756 "deprecated": false,758 "nullable": false,

757 "schemaType": "object",

758 "modelImplicit": false,759 "modelImplicit": false,

760 "schemaType": "object",

759 "modelPath": "(resource) realtime > (model) realtime_translation_session",761 "modelPath": "(resource) realtime > (model) realtime_translation_session",

760 "childrenParentSchema": "object",762 "childrenParentSchema": "object",

761 "children": [763 "children": [


768 },770 },

769 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type": {771 "(resource) realtime > (model) realtime_translation_session_updated_event > (schema) > (property) type": {

770 "kind": "HttpDeclProperty",772 "kind": "HttpDeclProperty",

771 "docstring": "The event type, must be `session.updated`.",773 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type",

774 "deprecated": false,

772 "key": "type",775 "key": "type",

773 "optional": false,776 "docstring": "The event type, must be `session.updated`.",

774 "nullable": false,

775 "type": {777 "type": {

776 "kind": "HttpTypeUnion",778 "kind": "HttpTypeUnion",

779 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type",

777 "types": [780 "types": [

778 {781 {

779 "kind": "HttpTypeLiteral",782 "kind": "HttpTypeLiteral",

780 "literal": "session.updated"783 "literal": "session.updated"

781 }784 }

782 ],785 ]

783 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type"

784 },786 },

785 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionUpdated/properties/type",787 "optional": false,

786 "deprecated": false,788 "nullable": false,

787 "schemaType": "enum",789 "schemaType": "enum",

788 "childrenParentSchema": "enum",790 "childrenParentSchema": "enum",

789 "children": [791 "children": [


792 },794 },

793 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {795 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id": {

794 "kind": "HttpDeclProperty",796 "kind": "HttpDeclProperty",

795 "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",797 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",

798 "deprecated": false,

796 "key": "id",799 "key": "id",

797 "optional": false,800 "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n",

798 "nullable": false,

799 "type": {801 "type": {

800 "kind": "HttpTypeString"802 "kind": "HttpTypeString"

801 },803 },

802 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/id",804 "optional": false,

803 "deprecated": false,805 "nullable": false,

804 "schemaType": "string",806 "schemaType": "string",

805 "children": []807 "children": []

806 },808 },

807 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {809 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio": {

808 "kind": "HttpDeclProperty",810 "kind": "HttpDeclProperty",

809 "docstring": "Configuration for translation input and output audio.\n",811 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",

812 "deprecated": false,

810 "key": "audio",813 "key": "audio",

811 "optional": false,814 "docstring": "Configuration for translation input and output audio.\n",

812 "nullable": false,

813 "type": {815 "type": {

814 "kind": "HttpTypeObject",816 "kind": "HttpTypeObject",

815 "members": [817 "members": [


821 }823 }

822 ]824 ]

823 },825 },

824 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio",826 "optional": false,

825 "deprecated": false,827 "nullable": false,

826 "schemaType": "object",828 "schemaType": "object",

827 "childrenParentSchema": "object",829 "childrenParentSchema": "object",

828 "children": [830 "children": [


832 },834 },

833 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {835 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) expires_at": {

834 "kind": "HttpDeclProperty",836 "kind": "HttpDeclProperty",

835 "docstring": "Expiration timestamp for the session, in seconds since epoch.",837 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",

838 "deprecated": false,

836 "key": "expires_at",839 "key": "expires_at",

837 "optional": false,840 "docstring": "Expiration timestamp for the session, in seconds since epoch.",

838 "nullable": false,

839 "type": {841 "type": {

840 "kind": "HttpTypeNumber"842 "kind": "HttpTypeNumber"

841 },843 },

842 "constraints": {844 "constraints": {

843 "format": "unixtime"845 "format": "unixtime"

844 },846 },

845 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/expires_at",847 "optional": false,

846 "deprecated": false,848 "nullable": false,

847 "schemaType": "integer",849 "schemaType": "integer",

848 "children": []850 "children": []

849 },851 },

850 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {852 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) model": {

851 "kind": "HttpDeclProperty",853 "kind": "HttpDeclProperty",

852 "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",854 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",

855 "deprecated": false,

853 "key": "model",856 "key": "model",

854 "optional": false,857 "docstring": "The Realtime translation model used for this session. This field is set at\nsession creation and cannot be changed with `session.update`.\n",

855 "nullable": false,

856 "type": {858 "type": {

857 "kind": "HttpTypeString"859 "kind": "HttpTypeString"

858 },860 },

859 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/model",861 "optional": false,

860 "deprecated": false,862 "nullable": false,

861 "schemaType": "string",863 "schemaType": "string",

862 "children": []864 "children": []

863 },865 },

864 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {866 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) type": {

865 "kind": "HttpDeclProperty",867 "kind": "HttpDeclProperty",

866 "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",868 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",

869 "deprecated": false,

867 "key": "type",870 "key": "type",

868 "optional": false,871 "docstring": "The session type. Always `translation` for Realtime translation sessions.\n",

869 "nullable": false,

870 "type": {872 "type": {

871 "kind": "HttpTypeUnion",873 "kind": "HttpTypeUnion",

874 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",

872 "types": [875 "types": [

873 {876 {

874 "kind": "HttpTypeLiteral",877 "kind": "HttpTypeLiteral",

875 "literal": "translation"878 "literal": "translation"

876 }879 }

877 ],880 ]

878 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type"

879 },881 },

880 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/type",882 "optional": false,

881 "deprecated": false,883 "nullable": false,

882 "schemaType": "enum",884 "schemaType": "enum",

883 "childrenParentSchema": "enum",885 "childrenParentSchema": "enum",

884 "children": [886 "children": [


888 "(resource) realtime > (model) realtime_translation_session > (schema)": {890 "(resource) realtime > (model) realtime_translation_session > (schema)": {

889 "kind": "HttpDeclTypeAlias",891 "kind": "HttpDeclTypeAlias",

890 "oasRef": "#/components/schemas/RealtimeTranslationSession",892 "oasRef": "#/components/schemas/RealtimeTranslationSession",

893 "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",

891 "ident": "RealtimeTranslationSession",894 "ident": "RealtimeTranslationSession",

892 "type": {895 "type": {

893 "kind": "HttpTypeObject",896 "kind": "HttpTypeObject",


909 }912 }

910 ]913 ]

911 },914 },

912 "docstring": "A Realtime translation session. Translation sessions continuously translate input\naudio into the configured output language.\n",

913 "childrenParentSchema": "object",915 "childrenParentSchema": "object",

914 "children": [916 "children": [

915 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",917 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) id",


928 },930 },

929 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {931 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input": {

930 "kind": "HttpDeclProperty",932 "kind": "HttpDeclProperty",

933 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",

934 "deprecated": false,

931 "key": "input",935 "key": "input",

932 "optional": true,

933 "nullable": false,

934 "type": {936 "type": {

935 "kind": "HttpTypeObject",937 "kind": "HttpTypeObject",

936 "members": [938 "members": [


942 }944 }

943 ]945 ]

944 },946 },

945 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input",947 "optional": true,

946 "deprecated": false,948 "nullable": false,

947 "schemaType": "object",949 "schemaType": "object",

948 "childrenParentSchema": "object",950 "childrenParentSchema": "object",

949 "children": [951 "children": [


953 },955 },

954 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {956 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output": {

955 "kind": "HttpDeclProperty",957 "kind": "HttpDeclProperty",

958 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",

959 "deprecated": false,

956 "key": "output",960 "key": "output",

957 "optional": true,

958 "nullable": false,

959 "type": {961 "type": {

960 "kind": "HttpTypeObject",962 "kind": "HttpTypeObject",

961 "members": [963 "members": [


964 }966 }

965 ]967 ]

966 },968 },

967 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output",969 "optional": true,

968 "deprecated": false,970 "nullable": false,

969 "schemaType": "object",971 "schemaType": "object",

970 "childrenParentSchema": "object",972 "childrenParentSchema": "object",

971 "children": [973 "children": [


981 },983 },

982 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {984 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction": {

983 "kind": "HttpDeclProperty",985 "kind": "HttpDeclProperty",

984 "docstring": "Optional input noise reduction.\n",986 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",

987 "deprecated": false,

985 "key": "noise_reduction",988 "key": "noise_reduction",

986 "optional": true,989 "docstring": "Optional input noise reduction.\n",

987 "nullable": true,

988 "type": {990 "type": {

989 "kind": "HttpTypeObject",991 "kind": "HttpTypeObject",

990 "members": [992 "members": [


993 }995 }

994 ]996 ]

995 },997 },

996 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction",998 "optional": true,

997 "deprecated": false,999 "nullable": true,

998 "schemaType": "object",1000 "schemaType": "object",

999 "childrenParentSchema": "object",1001 "childrenParentSchema": "object",

1000 "children": [1002 "children": [


1003 },1005 },

1004 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {1006 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription": {

1005 "kind": "HttpDeclProperty",1007 "kind": "HttpDeclProperty",

1006 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",1008 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",

1009 "deprecated": false,

1007 "key": "transcription",1010 "key": "transcription",

1008 "optional": true,1011 "docstring": "Optional source-language transcription. When configured, the server emits\n`session.input_transcript.delta` events. Translation itself still runs from\nthe input audio stream.\n",

1009 "nullable": true,

1010 "type": {1012 "type": {

1011 "kind": "HttpTypeObject",1013 "kind": "HttpTypeObject",

1012 "members": [1014 "members": [


1015 }1017 }

1016 ]1018 ]

1017 },1019 },

1018 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription",1020 "optional": true,

1019 "deprecated": false,1021 "nullable": true,

1020 "schemaType": "object",1022 "schemaType": "object",

1021 "childrenParentSchema": "object",1023 "childrenParentSchema": "object",

1022 "children": [1024 "children": [


1025 },1027 },

1026 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {1028 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) output > (property) language": {

1027 "kind": "HttpDeclProperty",1029 "kind": "HttpDeclProperty",

1028 "docstring": "Target language for translated output audio and transcript deltas.\n",1030 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",

1031 "deprecated": false,

1029 "key": "language",1032 "key": "language",

1030 "optional": true,1033 "docstring": "Target language for translated output audio and transcript deltas.\n",

1031 "nullable": false,

1032 "type": {1034 "type": {

1033 "kind": "HttpTypeString"1035 "kind": "HttpTypeString"

1034 },1036 },

1035 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/output/properties/language",1037 "optional": true,

1036 "deprecated": false,1038 "nullable": false,

1037 "schemaType": "string",1039 "schemaType": "string",

1038 "children": []1040 "children": []

1039 },1041 },

1040 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {1042 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": {

1041 "kind": "HttpDeclProperty",1043 "kind": "HttpDeclProperty",

1042 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",1044 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",

1045 "deprecated": false,

1043 "key": "type",1046 "key": "type",

1044 "optional": false,1047 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

1045 "nullable": false,

1046 "type": {1048 "type": {

1047 "kind": "HttpTypeReference",1049 "kind": "HttpTypeReference",

1048 "ident": "NoiseReductionType",1050 "ident": "NoiseReductionType",

1049 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"1051 "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)"

1050 },1052 },

1051 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/noise_reduction/anyOf/0/properties/type",1053 "optional": false,

1052 "deprecated": false,1054 "nullable": false,

1053 "schemaType": "enum",

1054 "modelImplicit": false,1055 "modelImplicit": false,

1056 "schemaType": "enum",

1055 "modelPath": "(resource) realtime > (model) noise_reduction_type",1057 "modelPath": "(resource) realtime > (model) noise_reduction_type",

1056 "childrenParentSchema": "enum",1058 "childrenParentSchema": "enum",

1057 "children": [1059 "children": [


1061 },1063 },

1062 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {1064 "(resource) realtime > (model) realtime_translation_session > (schema) > (property) audio > (property) input > (property) transcription > (property) model": {

1063 "kind": "HttpDeclProperty",1065 "kind": "HttpDeclProperty",

1064 "docstring": "The transcription model used for source transcript deltas.",1066 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",

1067 "deprecated": false,

1065 "key": "model",1068 "key": "model",

1066 "optional": false,1069 "docstring": "The transcription model used for source transcript deltas.",

1067 "nullable": false,

1068 "type": {1070 "type": {

1069 "kind": "HttpTypeString"1071 "kind": "HttpTypeString"

1070 },1072 },

1071 "oasRef": "#/components/schemas/RealtimeTranslationSession/properties/audio/properties/input/properties/transcription/anyOf/0/properties/model",1073 "optional": false,

1072 "deprecated": false,1074 "nullable": false,

1073 "schemaType": "string",1075 "schemaType": "string",

1074 "children": []1076 "children": []

1075 },1077 },


1090 "(resource) realtime > (model) noise_reduction_type > (schema)": {1092 "(resource) realtime > (model) noise_reduction_type > (schema)": {

1091 "kind": "HttpDeclTypeAlias",1093 "kind": "HttpDeclTypeAlias",

1092 "oasRef": "#/components/schemas/NoiseReductionType",1094 "oasRef": "#/components/schemas/NoiseReductionType",

1095 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

1093 "ident": "NoiseReductionType",1096 "ident": "NoiseReductionType",

1094 "type": {1097 "type": {

1095 "kind": "HttpTypeUnion",1098 "kind": "HttpTypeUnion",

1099 "oasRef": "#/components/schemas/NoiseReductionType",

1096 "types": [1100 "types": [

1097 {1101 {

1098 "kind": "HttpTypeLiteral",1102 "kind": "HttpTypeLiteral",


1102 "kind": "HttpTypeLiteral",1106 "kind": "HttpTypeLiteral",

1103 "literal": "far_field"1107 "literal": "far_field"

1104 }1108 }

1105 ],1109 ]

1106 "oasRef": "#/components/schemas/NoiseReductionType"

1107 },1110 },

1108 "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",

1109 "childrenParentSchema": "enum",1111 "childrenParentSchema": "enum",

1110 "children": [1112 "children": [

1111 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",1113 "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",


1157 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema)": {1159 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema)": {

1158 "kind": "HttpDeclTypeAlias",1160 "kind": "HttpDeclTypeAlias",

1159 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed",1161 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed",

1162 "docstring": "Returned when a realtime translation session is closed.\n",

1160 "ident": "RealtimeTranslationSessionClosedEvent",1163 "ident": "RealtimeTranslationSessionClosedEvent",

1161 "type": {1164 "type": {

1162 "kind": "HttpTypeObject",1165 "kind": "HttpTypeObject",


1169 }1172 }

1170 ]1173 ]

1171 },1174 },

1172 "docstring": "Returned when a realtime translation session is closed.\n",

1173 "childrenParentSchema": "object",1175 "childrenParentSchema": "object",

1174 "children": [1176 "children": [

1175 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id",1177 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id",


1178 },1180 },

1179 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id": {1181 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) event_id": {

1180 "kind": "HttpDeclProperty",1182 "kind": "HttpDeclProperty",

1181 "docstring": "The unique ID of the server event.",1183 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/event_id",

1184 "deprecated": false,

1182 "key": "event_id",1185 "key": "event_id",

1183 "optional": false,1186 "docstring": "The unique ID of the server event.",

1184 "nullable": false,

1185 "type": {1187 "type": {

1186 "kind": "HttpTypeString"1188 "kind": "HttpTypeString"

1187 },1189 },

1188 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/event_id",1190 "optional": false,

1189 "deprecated": false,1191 "nullable": false,

1190 "schemaType": "string",1192 "schemaType": "string",

1191 "children": []1193 "children": []

1192 },1194 },

1193 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type": {1195 "(resource) realtime > (model) realtime_translation_session_closed_event > (schema) > (property) type": {

1194 "kind": "HttpDeclProperty",1196 "kind": "HttpDeclProperty",

1195 "docstring": "The event type, must be `session.closed`.",1197 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type",

1198 "deprecated": false,

1196 "key": "type",1199 "key": "type",

1197 "optional": false,1200 "docstring": "The event type, must be `session.closed`.",

1198 "nullable": false,

1199 "type": {1201 "type": {

1200 "kind": "HttpTypeUnion",1202 "kind": "HttpTypeUnion",

1203 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type",

1201 "types": [1204 "types": [

1202 {1205 {

1203 "kind": "HttpTypeLiteral",1206 "kind": "HttpTypeLiteral",

1204 "literal": "session.closed"1207 "literal": "session.closed"

1205 }1208 }

1206 ],1209 ]

1207 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type"

1208 },1210 },

1209 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionClosed/properties/type",1211 "optional": false,

1210 "deprecated": false,1212 "nullable": false,

1211 "schemaType": "enum",1213 "schemaType": "enum",

1212 "childrenParentSchema": "enum",1214 "childrenParentSchema": "enum",

1213 "children": [1215 "children": [


1250 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema)": {1252 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema)": {

1251 "kind": "HttpDeclTypeAlias",1253 "kind": "HttpDeclTypeAlias",

1252 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta",1254 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta",

1255 "docstring": "Returned when optional source-language transcript text is available. This event\nis emitted only when `audio.input.transcription` is configured.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",

1253 "ident": "RealtimeTranslationInputTranscriptDeltaEvent",1256 "ident": "RealtimeTranslationInputTranscriptDeltaEvent",

1254 "type": {1257 "type": {

1255 "kind": "HttpTypeObject",1258 "kind": "HttpTypeObject",


1268 }1271 }

1269 ]1272 ]

1270 },1273 },

1271 "docstring": "Returned when optional source-language transcript text is available. This event\nis emitted only when `audio.input.transcription` is configured.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",

1272 "childrenParentSchema": "object",1274 "childrenParentSchema": "object",

1273 "children": [1275 "children": [

1274 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta",1276 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta",


1279 },1281 },

1280 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta": {1282 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) delta": {

1281 "kind": "HttpDeclProperty",1283 "kind": "HttpDeclProperty",

1282 "docstring": "Append-only source-language transcript text.",1284 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/delta",

1285 "deprecated": false,

1283 "key": "delta",1286 "key": "delta",

1284 "optional": false,1287 "docstring": "Append-only source-language transcript text.",

1285 "nullable": false,

1286 "type": {1288 "type": {

1287 "kind": "HttpTypeString"1289 "kind": "HttpTypeString"

1288 },1290 },

1289 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/delta",1291 "optional": false,

1290 "deprecated": false,1292 "nullable": false,

1291 "schemaType": "string",1293 "schemaType": "string",

1292 "children": []1294 "children": []

1293 },1295 },

1294 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) event_id": {1296 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) event_id": {

1295 "kind": "HttpDeclProperty",1297 "kind": "HttpDeclProperty",

1296 "docstring": "The unique ID of the server event.",1298 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/event_id",

1299 "deprecated": false,

1297 "key": "event_id",1300 "key": "event_id",

1298 "optional": false,1301 "docstring": "The unique ID of the server event.",

1299 "nullable": false,

1300 "type": {1302 "type": {

1301 "kind": "HttpTypeString"1303 "kind": "HttpTypeString"

1302 },1304 },

1303 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/event_id",1305 "optional": false,

1304 "deprecated": false,1306 "nullable": false,

1305 "schemaType": "string",1307 "schemaType": "string",

1306 "children": []1308 "children": []

1307 },1309 },

1308 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type": {1310 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) type": {

1309 "kind": "HttpDeclProperty",1311 "kind": "HttpDeclProperty",

1310 "docstring": "The event type, must be `session.input_transcript.delta`.",1312 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type",

1313 "deprecated": false,

1311 "key": "type",1314 "key": "type",

1312 "optional": false,1315 "docstring": "The event type, must be `session.input_transcript.delta`.",

1313 "nullable": false,

1314 "type": {1316 "type": {

1315 "kind": "HttpTypeUnion",1317 "kind": "HttpTypeUnion",

1318 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type",

1316 "types": [1319 "types": [

1317 {1320 {

1318 "kind": "HttpTypeLiteral",1321 "kind": "HttpTypeLiteral",

1319 "literal": "session.input_transcript.delta"1322 "literal": "session.input_transcript.delta"

1320 }1323 }

1321 ],1324 ]

1322 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type"

1323 },1325 },

1324 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/type",1326 "optional": false,

1325 "deprecated": false,1327 "nullable": false,

1326 "schemaType": "enum",1328 "schemaType": "enum",

1327 "childrenParentSchema": "enum",1329 "childrenParentSchema": "enum",

1328 "children": [1330 "children": [


1331 },1333 },

1332 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) elapsed_ms": {1334 "(resource) realtime > (model) realtime_translation_input_transcript_delta_event > (schema) > (property) elapsed_ms": {

1333 "kind": "HttpDeclProperty",1335 "kind": "HttpDeclProperty",

1334 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",1336 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/elapsed_ms",

1337 "deprecated": false,

1335 "key": "elapsed_ms",1338 "key": "elapsed_ms",

1336 "optional": true,1339 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",

1337 "nullable": true,

1338 "type": {1340 "type": {

1339 "kind": "HttpTypeNumber"1341 "kind": "HttpTypeNumber"

1340 },1342 },

1341 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionInputTranscriptDelta/properties/elapsed_ms",1343 "optional": true,

1342 "deprecated": false,1344 "nullable": true,

1343 "schemaType": "integer",1345 "schemaType": "integer",

1344 "children": []1346 "children": []

1345 },1347 },


1380 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema)": {1382 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema)": {

1381 "kind": "HttpDeclTypeAlias",1383 "kind": "HttpDeclTypeAlias",

1382 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta",1384 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta",

1385 "docstring": "Returned when translated transcript text is available.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",

1383 "ident": "RealtimeTranslationOutputTranscriptDeltaEvent",1386 "ident": "RealtimeTranslationOutputTranscriptDeltaEvent",

1384 "type": {1387 "type": {

1385 "kind": "HttpTypeObject",1388 "kind": "HttpTypeObject",


1398 }1401 }

1399 ]1402 ]

1400 },1403 },

1401 "docstring": "Returned when translated transcript text is available.\n\nTranscript deltas are append-only text fragments. Clients should not insert\nunconditional spaces between deltas.\n",

1402 "childrenParentSchema": "object",1404 "childrenParentSchema": "object",

1403 "children": [1405 "children": [

1404 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta",1406 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta",


1409 },1411 },

1410 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta": {1412 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) delta": {

1411 "kind": "HttpDeclProperty",1413 "kind": "HttpDeclProperty",

1412 "docstring": "Append-only transcript text for the translated output audio.",1414 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/delta",

1415 "deprecated": false,

1413 "key": "delta",1416 "key": "delta",

1414 "optional": false,1417 "docstring": "Append-only transcript text for the translated output audio.",

1415 "nullable": false,

1416 "type": {1418 "type": {

1417 "kind": "HttpTypeString"1419 "kind": "HttpTypeString"

1418 },1420 },

1419 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/delta",1421 "optional": false,

1420 "deprecated": false,1422 "nullable": false,

1421 "schemaType": "string",1423 "schemaType": "string",

1422 "children": []1424 "children": []

1423 },1425 },

1424 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) event_id": {1426 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) event_id": {

1425 "kind": "HttpDeclProperty",1427 "kind": "HttpDeclProperty",

1426 "docstring": "The unique ID of the server event.",1428 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/event_id",

1429 "deprecated": false,

1427 "key": "event_id",1430 "key": "event_id",

1428 "optional": false,1431 "docstring": "The unique ID of the server event.",

1429 "nullable": false,

1430 "type": {1432 "type": {

1431 "kind": "HttpTypeString"1433 "kind": "HttpTypeString"

1432 },1434 },

1433 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/event_id",1435 "optional": false,

1434 "deprecated": false,1436 "nullable": false,

1435 "schemaType": "string",1437 "schemaType": "string",

1436 "children": []1438 "children": []

1437 },1439 },

1438 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type": {1440 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) type": {

1439 "kind": "HttpDeclProperty",1441 "kind": "HttpDeclProperty",

1440 "docstring": "The event type, must be `session.output_transcript.delta`.",1442 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type",

1443 "deprecated": false,

1441 "key": "type",1444 "key": "type",

1442 "optional": false,1445 "docstring": "The event type, must be `session.output_transcript.delta`.",

1443 "nullable": false,

1444 "type": {1446 "type": {

1445 "kind": "HttpTypeUnion",1447 "kind": "HttpTypeUnion",

1448 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type",

1446 "types": [1449 "types": [

1447 {1450 {

1448 "kind": "HttpTypeLiteral",1451 "kind": "HttpTypeLiteral",

1449 "literal": "session.output_transcript.delta"1452 "literal": "session.output_transcript.delta"

1450 }1453 }

1451 ],1454 ]

1452 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type"

1453 },1455 },

1454 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/type",1456 "optional": false,

1455 "deprecated": false,1457 "nullable": false,

1456 "schemaType": "enum",1458 "schemaType": "enum",

1457 "childrenParentSchema": "enum",1459 "childrenParentSchema": "enum",

1458 "children": [1460 "children": [


1461 },1463 },

1462 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) elapsed_ms": {1464 "(resource) realtime > (model) realtime_translation_output_transcript_delta_event > (schema) > (property) elapsed_ms": {

1463 "kind": "HttpDeclProperty",1465 "kind": "HttpDeclProperty",

1464 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",1466 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/elapsed_ms",

1467 "deprecated": false,

1465 "key": "elapsed_ms",1468 "key": "elapsed_ms",

1466 "optional": true,1469 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. It advances in 200 ms increments, but multiple transcript\ndeltas may share the same `elapsed_ms`. Treat it as alignment metadata,\nnot a unique transcript-delta identifier.\n",

1467 "nullable": true,

1468 "type": {1470 "type": {

1469 "kind": "HttpTypeNumber"1471 "kind": "HttpTypeNumber"

1470 },1472 },

1471 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputTranscriptDelta/properties/elapsed_ms",1473 "optional": true,

1472 "deprecated": false,1474 "nullable": true,

1473 "schemaType": "integer",1475 "schemaType": "integer",

1474 "children": []1476 "children": []

1475 },1477 },


1508 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema)": {1510 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema)": {

1509 "kind": "HttpDeclTypeAlias",1511 "kind": "HttpDeclTypeAlias",

1510 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta",1512 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta",

1513 "docstring": "Returned when translated output audio is available. Output audio deltas are\n200 ms frames of PCM16 audio.\n",

1511 "ident": "RealtimeTranslationOutputAudioDeltaEvent",1514 "ident": "RealtimeTranslationOutputAudioDeltaEvent",

1512 "type": {1515 "type": {

1513 "kind": "HttpTypeObject",1516 "kind": "HttpTypeObject",


1535 }1538 }

1536 ]1539 ]

1537 },1540 },

1538 "docstring": "Returned when translated output audio is available. Output audio deltas are\n200 ms frames of PCM16 audio.\n",

1539 "childrenParentSchema": "object",1541 "childrenParentSchema": "object",

1540 "children": [1542 "children": [

1541 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta",1543 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta",


1549 },1551 },

1550 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta": {1552 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) delta": {

1551 "kind": "HttpDeclProperty",1553 "kind": "HttpDeclProperty",

1552 "docstring": "Base64-encoded translated audio data.",1554 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/delta",

1555 "deprecated": false,

1553 "key": "delta",1556 "key": "delta",

1554 "optional": false,1557 "docstring": "Base64-encoded translated audio data.",

1555 "nullable": false,

1556 "type": {1558 "type": {

1557 "kind": "HttpTypeString"1559 "kind": "HttpTypeString"

1558 },1560 },

1559 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/delta",1561 "optional": false,

1560 "deprecated": false,1562 "nullable": false,

1561 "schemaType": "string",1563 "schemaType": "string",

1562 "children": []1564 "children": []

1563 },1565 },

1564 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) event_id": {1566 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) event_id": {

1565 "kind": "HttpDeclProperty",1567 "kind": "HttpDeclProperty",

1566 "docstring": "The unique ID of the server event.",1568 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/event_id",

1569 "deprecated": false,

1567 "key": "event_id",1570 "key": "event_id",

1568 "optional": false,1571 "docstring": "The unique ID of the server event.",

1569 "nullable": false,

1570 "type": {1572 "type": {

1571 "kind": "HttpTypeString"1573 "kind": "HttpTypeString"

1572 },1574 },

1573 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/event_id",1575 "optional": false,

1574 "deprecated": false,1576 "nullable": false,

1575 "schemaType": "string",1577 "schemaType": "string",

1576 "children": []1578 "children": []

1577 },1579 },

1578 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type": {1580 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) type": {

1579 "kind": "HttpDeclProperty",1581 "kind": "HttpDeclProperty",

1580 "docstring": "The event type, must be `session.output_audio.delta`.",1582 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type",

1583 "deprecated": false,

1581 "key": "type",1584 "key": "type",

1582 "optional": false,1585 "docstring": "The event type, must be `session.output_audio.delta`.",

1583 "nullable": false,

1584 "type": {1586 "type": {

1585 "kind": "HttpTypeUnion",1587 "kind": "HttpTypeUnion",

1588 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type",

1586 "types": [1589 "types": [

1587 {1590 {

1588 "kind": "HttpTypeLiteral",1591 "kind": "HttpTypeLiteral",

1589 "literal": "session.output_audio.delta"1592 "literal": "session.output_audio.delta"

1590 }1593 }

1591 ],1594 ]

1592 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type"

1593 },1595 },

1594 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/type",1596 "optional": false,

1595 "deprecated": false,1597 "nullable": false,

1596 "schemaType": "enum",1598 "schemaType": "enum",

1597 "childrenParentSchema": "enum",1599 "childrenParentSchema": "enum",

1598 "children": [1600 "children": [


1601 },1603 },

1602 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) channels": {1604 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) channels": {

1603 "kind": "HttpDeclProperty",1605 "kind": "HttpDeclProperty",

1604 "docstring": "Number of audio channels.",1606 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/channels",

1607 "deprecated": false,

1605 "key": "channels",1608 "key": "channels",

1606 "optional": true,1609 "docstring": "Number of audio channels.",

1607 "nullable": false,

1608 "default": 1,

1609 "type": {1610 "type": {

1610 "kind": "HttpTypeNumber"1611 "kind": "HttpTypeNumber"

1611 },1612 },

1612 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/channels",1613 "default": 1,

1613 "deprecated": false,1614 "optional": true,

1615 "nullable": false,

1614 "schemaType": "integer",1616 "schemaType": "integer",

1615 "children": []1617 "children": []

1616 },1618 },

1617 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) elapsed_ms": {1619 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) elapsed_ms": {

1618 "kind": "HttpDeclProperty",1620 "kind": "HttpDeclProperty",

1619 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. Treat `elapsed_ms` as alignment metadata, not a unique\nevent identifier.\n",1621 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/elapsed_ms",

1622 "deprecated": false,

1620 "key": "elapsed_ms",1623 "key": "elapsed_ms",

1621 "optional": true,1624 "docstring": "Timing metadata for stream alignment, derived from the translation frame\nwhen available. Treat `elapsed_ms` as alignment metadata, not a unique\nevent identifier.\n",

1622 "nullable": true,

1623 "type": {1625 "type": {

1624 "kind": "HttpTypeNumber"1626 "kind": "HttpTypeNumber"

1625 },1627 },

1626 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/elapsed_ms",1628 "optional": true,

1627 "deprecated": false,1629 "nullable": true,

1628 "schemaType": "integer",1630 "schemaType": "integer",

1629 "children": []1631 "children": []

1630 },1632 },

1631 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format": {1633 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) format": {

1632 "kind": "HttpDeclProperty",1634 "kind": "HttpDeclProperty",

1633 "docstring": "Audio encoding for `delta`.",1635 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format",

1636 "deprecated": false,

1634 "key": "format",1637 "key": "format",

1635 "optional": true,1638 "docstring": "Audio encoding for `delta`.",

1636 "nullable": false,

1637 "type": {1639 "type": {

1638 "kind": "HttpTypeUnion",1640 "kind": "HttpTypeUnion",

1641 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format",

1639 "types": [1642 "types": [

1640 {1643 {

1641 "kind": "HttpTypeLiteral",1644 "kind": "HttpTypeLiteral",

1642 "literal": "pcm16"1645 "literal": "pcm16"

1643 }1646 }

1644 ],1647 ]

1645 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format"

1646 },1648 },

1647 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/format",1649 "optional": true,

1648 "deprecated": false,1650 "nullable": false,

1649 "schemaType": "enum",1651 "schemaType": "enum",

1650 "childrenParentSchema": "enum",1652 "childrenParentSchema": "enum",

1651 "children": [1653 "children": [


1654 },1656 },

1655 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) sample_rate": {1657 "(resource) realtime > (model) realtime_translation_output_audio_delta_event > (schema) > (property) sample_rate": {

1656 "kind": "HttpDeclProperty",1658 "kind": "HttpDeclProperty",

1657 "docstring": "Sample rate of the audio delta.",1659 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/sample_rate",

1660 "deprecated": false,

1658 "key": "sample_rate",1661 "key": "sample_rate",

1659 "optional": true,1662 "docstring": "Sample rate of the audio delta.",

1660 "nullable": false,

1661 "default": 24000,

1662 "type": {1663 "type": {

1663 "kind": "HttpTypeNumber"1664 "kind": "HttpTypeNumber"

1664 },1665 },

1665 "oasRef": "#/components/schemas/RealtimeTranslationServerEventSessionOutputAudioDelta/properties/sample_rate",1666 "default": 24000,

1666 "deprecated": false,1667 "optional": true,

1668 "nullable": false,

1667 "schemaType": "integer",1669 "schemaType": "integer",

1668 "children": []1670 "children": []

1669 },1671 },

Details

14939}14939}

14940```14940```

14941 14941 

14942### Text input14942### File input

14943 14943 

14944```http14944```http

14945curl https://api.openai.com/v1/responses \14945curl https://api.openai.com/v1/responses \


14947 -H "Authorization: Bearer $OPENAI_API_KEY" \14947 -H "Authorization: Bearer $OPENAI_API_KEY" \

14948 -d '{14948 -d '{

14949 "model": "gpt-5.4",14949 "model": "gpt-5.4",

14950 "input": "Tell me a three sentence bedtime story about a unicorn."14950 "input": [

14951 {

14952 "role": "user",

14953 "content": [

14954 {"type": "input_text", "text": "what is in this file?"},

14955 {

14956 "type": "input_file",

14957 "file_url": "https://www.berkshirehathaway.com/letters/2024ltr.pdf",

14958 "detail": "auto"

14959 }

14960 ]

14961 }

14962 ]

14951 }'14963 }'

14952```14964```

14953 14965 


14955 14967 

14956```json14968```json

14957{14969{

14958 "id": "resp_67ccd2bed1ec8190b14f964abc0542670bb6a6b452d3795b",14970 "id": "resp_686eef60237881a2bd1180bb8b13de430e34c516d176ff86",

14959 "object": "response",14971 "object": "response",

14960 "created_at": 1741476542,14972 "created_at": 1752100704,

14961 "status": "completed",14973 "status": "completed",

14962 "completed_at": 1741476543,14974 "completed_at": 1752100705,

14975 "background": false,

14963 "error": null,14976 "error": null,

14964 "incomplete_details": null,14977 "incomplete_details": null,

14965 "instructions": null,14978 "instructions": null,

14966 "max_output_tokens": null,14979 "max_output_tokens": null,

14980 "max_tool_calls": null,

14967 "model": "gpt-5.4",14981 "model": "gpt-5.4",

14968 "output": [14982 "output": [

14969 {14983 {

14984 "id": "msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86",

14970 "type": "message",14985 "type": "message",

14971 "id": "msg_67ccd2bf17f0819081ff3bb2cf6508e60bb6a6b452d3795b",

14972 "status": "completed",14986 "status": "completed",

14973 "role": "assistant",

14974 "content": [14987 "content": [

14975 {14988 {

14976 "type": "output_text",14989 "type": "output_text",

14977 "text": "In a peaceful grove beneath a silver moon, a unicorn named Lumina discovered a hidden pool that reflected the stars. As she dipped her horn into the water, the pool began to shimmer, revealing a pathway to a magical realm of endless night skies. Filled with wonder, Lumina whispered a wish for all who dream to find their own hidden magic, and as she glanced back, her hoofprints sparkled like stardust.",14990 "annotations": [],

14978 "annotations": []14991 "logprobs": [],

14992 "text": "The file seems to contain excerpts from a letter to the shareholders of Berkshire Hathaway Inc., likely written by Warren Buffett. It covers several topics:\n\n1. **Communication Philosophy**: Buffett emphasizes the importance of transparency and candidness in reporting mistakes and successes to shareholders.\n\n2. **Mistakes and Learnings**: The letter acknowledges past mistakes in business assessments and management hires, highlighting the importance of correcting errors promptly.\n\n3. **CEO Succession**: Mention of Greg Abel stepping in as the new CEO and continuing the tradition of honest communication.\n\n4. **Pete Liegl Story**: A detailed account of acquiring Forest River and the relationship with its founder, highlighting trust and effective business decisions.\n\n5. **2024 Performance**: Overview of business performance, particularly in insurance and investment activities, with a focus on GEICO's improvement.\n\n6. **Tax Contributions**: Discussion of significant tax payments to the U.S. Treasury, credited to shareholders' reinvestments.\n\n7. **Investment Strategy**: A breakdown of Berkshire\u2019s investments in both controlled subsidiaries and marketable equities, along with a focus on long-term holding strategies.\n\n8. **American Capitalism**: Reflections on America\u2019s economic development and Berkshire\u2019s role within it.\n\n9. **Property-Casualty Insurance**: Insights into the P/C insurance business model and its challenges and benefits.\n\n10. **Japanese Investments**: Information about Berkshire\u2019s investments in Japanese companies and future plans.\n\n11. **Annual Meeting**: Details about the upcoming annual gathering in Omaha, including schedule changes and new book releases.\n\n12. **Personal Anecdotes**: Light-hearted stories about family and interactions, conveying Buffett's personable approach.\n\n13. **Financial Performance Data**: Tables comparing Berkshire\u2019s annual performance to the S&P 500, showing impressive long-term gains.\n\nOverall, the letter reinforces Berkshire Hathaway's commitment to transparency, investment in both its businesses and the wider economy, and emphasizes strong leadership and prudent financial management."

14979 }14993 }

14980 ]14994 ],

14995 "role": "assistant"

14981 }14996 }

14982 ],14997 ],

14983 "parallel_tool_calls": true,14998 "parallel_tool_calls": true,


14986 "effort": null,15001 "effort": null,

14987 "summary": null15002 "summary": null

14988 },15003 },

15004 "service_tier": "default",

14989 "store": true,15005 "store": true,

14990 "temperature": 1.0,15006 "temperature": 1.0,

14991 "text": {15007 "text": {


14995 },15011 },

14996 "tool_choice": "auto",15012 "tool_choice": "auto",

14997 "tools": [],15013 "tools": [],

15014 "top_logprobs": 0,

14998 "top_p": 1.0,15015 "top_p": 1.0,

14999 "truncation": "disabled",15016 "truncation": "disabled",

15000 "usage": {15017 "usage": {

15001 "input_tokens": 36,15018 "input_tokens": 8438,

15002 "input_tokens_details": {15019 "input_tokens_details": {

15003 "cached_tokens": 0,15020 "cached_tokens": 0,

15004 "cache_write_tokens": 015021 "cache_write_tokens": 0

15005 },15022 },

15006 "output_tokens": 87,15023 "output_tokens": 398,

15007 "output_tokens_details": {15024 "output_tokens_details": {

15008 "reasoning_tokens": 015025 "reasoning_tokens": 0

15009 },15026 },

15010 "total_tokens": 12315027 "total_tokens": 8836

15011 },15028 },

15012 "user": null,15029 "user": null,

15013 "metadata": {}15030 "metadata": {}

15014}15031}

15015```15032```

15016 15033 

15017### Image input15034### File search

15018 15035 

15019```http15036```http

15020curl https://api.openai.com/v1/responses \15037curl https://api.openai.com/v1/responses \


15022 -H "Authorization: Bearer $OPENAI_API_KEY" \15039 -H "Authorization: Bearer $OPENAI_API_KEY" \

15023 -d '{15040 -d '{

15024 "model": "gpt-5.4",15041 "model": "gpt-5.4",

15025 "input": [15042 "tools": [{

15026 {15043 "type": "file_search",

15027 "role": "user",15044 "vector_store_ids": ["vs_1234567890"],

15028 "content": [15045 "max_num_results": 20

15029 {"type": "input_text", "text": "what is in this image?"},15046 }],

15030 {15047 "input": "What are the attributes of an ancient brown dragon?"

15031 "type": "input_image",

15032 "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"

15033 }

15034 ]

15035 }

15036 ]

15037 }'15048 }'

15038```15049```

15039 15050 


15041 15052 

15042```json15053```json

15043{15054{

15044 "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",15055 "id": "resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7",

15045 "object": "response",15056 "object": "response",

15046 "created_at": 1741476777,15057 "created_at": 1741485253,

15047 "status": "completed",15058 "status": "completed",

15048 "completed_at": 1741476778,15059 "completed_at": 1741485254,

15049 "error": null,15060 "error": null,

15050 "incomplete_details": null,15061 "incomplete_details": null,

15051 "instructions": null,15062 "instructions": null,

15052 "max_output_tokens": null,15063 "max_output_tokens": null,

15053 "model": "gpt-5.4",15064 "model": "gpt-5.4",

15054 "output": [15065 "output": [

15066 {

15067 "type": "file_search_call",

15068 "id": "fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7",

15069 "status": "completed",

15070 "queries": [

15071 "attributes of an ancient brown dragon"

15072 ],

15073 "results": null

15074 },

15055 {15075 {

15056 "type": "message",15076 "type": "message",

15057 "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",15077 "id": "msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7",

15058 "status": "completed",15078 "status": "completed",

15059 "role": "assistant",15079 "role": "assistant",

15060 "content": [15080 "content": [

15061 {15081 {

15062 "type": "output_text",15082 "type": "output_text",

15063 "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",15083 "text": "The attributes of an ancient brown dragon include...",

15064 "annotations": []15084 "annotations": [

15085 {

15086 "type": "file_citation",

15087 "index": 320,

15088 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15089 "filename": "dragons.pdf"

15090 },

15091 {

15092 "type": "file_citation",

15093 "index": 576,

15094 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15095 "filename": "dragons.pdf"

15096 },

15097 {

15098 "type": "file_citation",

15099 "index": 815,

15100 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15101 "filename": "dragons.pdf"

15102 },

15103 {

15104 "type": "file_citation",

15105 "index": 815,

15106 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15107 "filename": "dragons.pdf"

15108 },

15109 {

15110 "type": "file_citation",

15111 "index": 1030,

15112 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15113 "filename": "dragons.pdf"

15114 },

15115 {

15116 "type": "file_citation",

15117 "index": 1030,

15118 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15119 "filename": "dragons.pdf"

15120 },

15121 {

15122 "type": "file_citation",

15123 "index": 1156,

15124 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15125 "filename": "dragons.pdf"

15126 },

15127 {

15128 "type": "file_citation",

15129 "index": 1225,

15130 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15131 "filename": "dragons.pdf"

15132 }

15133 ]

15065 }15134 }

15066 ]15135 ]

15067 }15136 }


15080 }15149 }

15081 },15150 },

15082 "tool_choice": "auto",15151 "tool_choice": "auto",

15083 "tools": [],15152 "tools": [

15153 {

15154 "type": "file_search",

15155 "filters": null,

15156 "max_num_results": 20,

15157 "ranking_options": {

15158 "ranker": "auto",

15159 "score_threshold": 0.0

15160 },

15161 "vector_store_ids": [

15162 "vs_1234567890"

15163 ]

15164 }

15165 ],

15084 "top_p": 1.0,15166 "top_p": 1.0,

15085 "truncation": "disabled",15167 "truncation": "disabled",

15086 "usage": {15168 "usage": {

15087 "input_tokens": 328,15169 "input_tokens": 18307,

15088 "input_tokens_details": {15170 "input_tokens_details": {

15089 "cached_tokens": 0,15171 "cached_tokens": 0,

15090 "cache_write_tokens": 015172 "cache_write_tokens": 0

15091 },15173 },

15092 "output_tokens": 52,15174 "output_tokens": 348,

15093 "output_tokens_details": {15175 "output_tokens_details": {

15094 "reasoning_tokens": 015176 "reasoning_tokens": 0

15095 },15177 },

15096 "total_tokens": 38015178 "total_tokens": 18655

15097 },15179 },

15098 "user": null,15180 "user": null,

15099 "metadata": {}15181 "metadata": {}

15100}15182}

15101```15183```

15102 15184 

15103### File input15185### Functions

15104 15186 

15105```http15187```http

15106curl https://api.openai.com/v1/responses \15188curl https://api.openai.com/v1/responses \


15108 -H "Authorization: Bearer $OPENAI_API_KEY" \15190 -H "Authorization: Bearer $OPENAI_API_KEY" \

15109 -d '{15191 -d '{

15110 "model": "gpt-5.4",15192 "model": "gpt-5.4",

15111 "input": [15193 "input": "What is the weather like in Boston today?",

15112 {15194 "tools": [

15113 "role": "user",

15114 "content": [

15115 {"type": "input_text", "text": "what is in this file?"},

15116 {15195 {

15117 "type": "input_file",15196 "type": "function",

15118 "file_url": "https://www.berkshirehathaway.com/letters/2024ltr.pdf",15197 "name": "get_current_weather",

15119 "detail": "auto"15198 "description": "Get the current weather in a given location",

15199 "parameters": {

15200 "type": "object",

15201 "properties": {

15202 "location": {

15203 "type": "string",

15204 "description": "The city and state, e.g. San Francisco, CA"

15205 },

15206 "unit": {

15207 "type": "string",

15208 "enum": ["celsius", "fahrenheit"]

15120 }15209 }

15121 ]15210 },

15211 "required": ["location", "unit"]

15122 }15212 }

15123 ]15213 }

15214 ],

15215 "tool_choice": "auto"

15124 }'15216 }'

15125```15217```

15126 15218 


15128 15220 

15129```json15221```json

15130{15222{

15131 "id": "resp_686eef60237881a2bd1180bb8b13de430e34c516d176ff86",15223 "id": "resp_67ca09c5efe0819096d0511c92b8c890096610f474011cc0",

15132 "object": "response",15224 "object": "response",

15133 "created_at": 1752100704,15225 "created_at": 1741294021,

15134 "status": "completed",15226 "status": "completed",

15135 "completed_at": 1752100705,15227 "completed_at": 1741294022,

15136 "background": false,

15137 "error": null,15228 "error": null,

15138 "incomplete_details": null,15229 "incomplete_details": null,

15139 "instructions": null,15230 "instructions": null,

15140 "max_output_tokens": null,15231 "max_output_tokens": null,

15141 "max_tool_calls": null,

15142 "model": "gpt-5.4",15232 "model": "gpt-5.4",

15143 "output": [15233 "output": [

15144 {15234 {

15145 "id": "msg_686eef60d3e081a29283bdcbc4322fd90e34c516d176ff86",15235 "type": "function_call",

15146 "type": "message",15236 "id": "fc_67ca09c6bedc8190a7abfec07b1a1332096610f474011cc0",

15147 "status": "completed",15237 "call_id": "call_unLAR8MvFNptuiZK6K6HCy5k",

15148 "content": [15238 "name": "get_current_weather",

15149 {15239 "arguments": "{\"location\":\"Boston, MA\",\"unit\":\"celsius\"}",

15150 "type": "output_text",15240 "status": "completed"

15151 "annotations": [],

15152 "logprobs": [],

15153 "text": "The file seems to contain excerpts from a letter to the shareholders of Berkshire Hathaway Inc., likely written by Warren Buffett. It covers several topics:\n\n1. **Communication Philosophy**: Buffett emphasizes the importance of transparency and candidness in reporting mistakes and successes to shareholders.\n\n2. **Mistakes and Learnings**: The letter acknowledges past mistakes in business assessments and management hires, highlighting the importance of correcting errors promptly.\n\n3. **CEO Succession**: Mention of Greg Abel stepping in as the new CEO and continuing the tradition of honest communication.\n\n4. **Pete Liegl Story**: A detailed account of acquiring Forest River and the relationship with its founder, highlighting trust and effective business decisions.\n\n5. **2024 Performance**: Overview of business performance, particularly in insurance and investment activities, with a focus on GEICO's improvement.\n\n6. **Tax Contributions**: Discussion of significant tax payments to the U.S. Treasury, credited to shareholders' reinvestments.\n\n7. **Investment Strategy**: A breakdown of Berkshire\u2019s investments in both controlled subsidiaries and marketable equities, along with a focus on long-term holding strategies.\n\n8. **American Capitalism**: Reflections on America\u2019s economic development and Berkshire\u2019s role within it.\n\n9. **Property-Casualty Insurance**: Insights into the P/C insurance business model and its challenges and benefits.\n\n10. **Japanese Investments**: Information about Berkshire\u2019s investments in Japanese companies and future plans.\n\n11. **Annual Meeting**: Details about the upcoming annual gathering in Omaha, including schedule changes and new book releases.\n\n12. **Personal Anecdotes**: Light-hearted stories about family and interactions, conveying Buffett's personable approach.\n\n13. **Financial Performance Data**: Tables comparing Berkshire\u2019s annual performance to the S&P 500, showing impressive long-term gains.\n\nOverall, the letter reinforces Berkshire Hathaway's commitment to transparency, investment in both its businesses and the wider economy, and emphasizes strong leadership and prudent financial management."

15154 }

15155 ],

15156 "role": "assistant"

15157 }15241 }

15158 ],15242 ],

15159 "parallel_tool_calls": true,15243 "parallel_tool_calls": true,


15162 "effort": null,15246 "effort": null,

15163 "summary": null15247 "summary": null

15164 },15248 },

15165 "service_tier": "default",

15166 "store": true,15249 "store": true,

15167 "temperature": 1.0,15250 "temperature": 1.0,

15168 "text": {15251 "text": {


15171 }15254 }

15172 },15255 },

15173 "tool_choice": "auto",15256 "tool_choice": "auto",

15174 "tools": [],15257 "tools": [

15175 "top_logprobs": 0,15258 {

15259 "type": "function",

15260 "description": "Get the current weather in a given location",

15261 "name": "get_current_weather",

15262 "parameters": {

15263 "type": "object",

15264 "properties": {

15265 "location": {

15266 "type": "string",

15267 "description": "The city and state, e.g. San Francisco, CA"

15268 },

15269 "unit": {

15270 "type": "string",

15271 "enum": [

15272 "celsius",

15273 "fahrenheit"

15274 ]

15275 }

15276 },

15277 "required": [

15278 "location",

15279 "unit"

15280 ]

15281 },

15282 "strict": true

15283 }

15284 ],

15176 "top_p": 1.0,15285 "top_p": 1.0,

15177 "truncation": "disabled",15286 "truncation": "disabled",

15178 "usage": {15287 "usage": {

15179 "input_tokens": 8438,15288 "input_tokens": 291,

15180 "input_tokens_details": {15289 "output_tokens": 23,

15181 "cached_tokens": 0,

15182 "cache_write_tokens": 0

15183 },

15184 "output_tokens": 398,

15185 "output_tokens_details": {15290 "output_tokens_details": {

15186 "reasoning_tokens": 015291 "reasoning_tokens": 0

15187 },15292 },

15188 "total_tokens": 883615293 "total_tokens": 314

15189 },15294 },

15190 "user": null,15295 "user": null,

15191 "metadata": {}15296 "metadata": {}

15192}15297}

15193```15298```

15194 15299 

15195### Web search15300### Image input

15196 15301 

15197```http15302```http

15198curl https://api.openai.com/v1/responses \15303curl https://api.openai.com/v1/responses \


15200 -H "Authorization: Bearer $OPENAI_API_KEY" \15305 -H "Authorization: Bearer $OPENAI_API_KEY" \

15201 -d '{15306 -d '{

15202 "model": "gpt-5.4",15307 "model": "gpt-5.4",

15203 "tools": [{ "type": "web_search_preview" }],15308 "input": [

15204 "input": "What was a positive news story from today?"15309 {

15310 "role": "user",

15311 "content": [

15312 {"type": "input_text", "text": "what is in this image?"},

15313 {

15314 "type": "input_image",

15315 "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"

15316 }

15317 ]

15318 }

15319 ]

15205 }'15320 }'

15206```15321```

15207 15322 


15209 15324 

15210```json15325```json

15211{15326{

15212 "id": "resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c",15327 "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",

15213 "object": "response",15328 "object": "response",

15214 "created_at": 1741484430,15329 "created_at": 1741476777,

15215 "status": "completed",15330 "status": "completed",

15216 "completed_at": 1741484431,15331 "completed_at": 1741476778,

15217 "error": null,15332 "error": null,

15218 "incomplete_details": null,15333 "incomplete_details": null,

15219 "instructions": null,15334 "instructions": null,

15220 "max_output_tokens": null,15335 "max_output_tokens": null,

15221 "model": "gpt-5.4",15336 "model": "gpt-5.4",

15222 "output": [15337 "output": [

15223 {

15224 "type": "web_search_call",

15225 "id": "ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c",

15226 "status": "completed"

15227 },

15228 {15338 {

15229 "type": "message",15339 "type": "message",

15230 "id": "msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c",15340 "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",

15231 "status": "completed",15341 "status": "completed",

15232 "role": "assistant",15342 "role": "assistant",

15233 "content": [15343 "content": [

15234 {15344 {

15235 "type": "output_text",15345 "type": "output_text",

15236 "text": "As of today, March 9, 2025, one notable positive news story...",15346 "text": "The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.",

15237 "annotations": [15347 "annotations": []

15238 {

15239 "type": "url_citation",

15240 "start_index": 442,

15241 "end_index": 557,

15242 "url": "https://.../?utm_source=chatgpt.com",

15243 "title": "..."

15244 },

15245 {

15246 "type": "url_citation",

15247 "start_index": 962,

15248 "end_index": 1077,

15249 "url": "https://.../?utm_source=chatgpt.com",

15250 "title": "..."

15251 },

15252 {

15253 "type": "url_citation",

15254 "start_index": 1336,

15255 "end_index": 1451,

15256 "url": "https://.../?utm_source=chatgpt.com",

15257 "title": "..."

15258 }

15259 ]

15260 }15348 }

15261 ]15349 ]

15262 }15350 }


15275 }15363 }

15276 },15364 },

15277 "tool_choice": "auto",15365 "tool_choice": "auto",

15278 "tools": [15366 "tools": [],

15279 {

15280 "type": "web_search_preview",

15281 "domains": [],

15282 "search_context_size": "medium",

15283 "user_location": {

15284 "type": "approximate",

15285 "city": null,

15286 "country": "US",

15287 "region": null,

15288 "timezone": null

15289 }

15290 }

15291 ],

15292 "top_p": 1.0,15367 "top_p": 1.0,

15293 "truncation": "disabled",15368 "truncation": "disabled",

15294 "usage": {15369 "usage": {


15297 "cached_tokens": 0,15372 "cached_tokens": 0,

15298 "cache_write_tokens": 015373 "cache_write_tokens": 0

15299 },15374 },

15300 "output_tokens": 356,15375 "output_tokens": 52,

15301 "output_tokens_details": {15376 "output_tokens_details": {

15302 "reasoning_tokens": 015377 "reasoning_tokens": 0

15303 },15378 },

15304 "total_tokens": 68415379 "total_tokens": 380

15305 },15380 },

15306 "user": null,15381 "user": null,

15307 "metadata": {}15382 "metadata": {}

15308}15383}

15309```15384```

15310 15385 

15311### File search15386### Reasoning

15312 15387 

15313```http15388```http

15314curl https://api.openai.com/v1/responses \15389curl https://api.openai.com/v1/responses \

15315 -H "Content-Type: application/json" \15390 -H "Content-Type: application/json" \

15316 -H "Authorization: Bearer $OPENAI_API_KEY" \15391 -H "Authorization: Bearer $OPENAI_API_KEY" \

15317 -d '{15392 -d '{

15318 "model": "gpt-5.4",15393 "model": "o3-mini",

15319 "tools": [{15394 "input": "How much wood would a woodchuck chuck?",

15320 "type": "file_search",15395 "reasoning": {

15321 "vector_store_ids": ["vs_1234567890"],15396 "effort": "high"

15322 "max_num_results": 2015397 }

15323 }],

15324 "input": "What are the attributes of an ancient brown dragon?"

15325 }'15398 }'

15326```15399```

15327 15400 


15329 15402 

15330```json15403```json

15331{15404{

15332 "id": "resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7",15405 "id": "resp_67ccd7eca01881908ff0b5146584e408072912b2993db808",

15333 "object": "response",15406 "object": "response",

15334 "created_at": 1741485253,15407 "created_at": 1741477868,

15335 "status": "completed",15408 "status": "completed",

15336 "completed_at": 1741485254,15409 "completed_at": 1741477869,

15337 "error": null,15410 "error": null,

15338 "incomplete_details": null,15411 "incomplete_details": null,

15339 "instructions": null,15412 "instructions": null,

15340 "max_output_tokens": null,15413 "max_output_tokens": null,

15341 "model": "gpt-5.4",15414 "model": "o1-2024-12-17",

15342 "output": [15415 "output": [

15343 {

15344 "type": "file_search_call",

15345 "id": "fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7",

15346 "status": "completed",

15347 "queries": [

15348 "attributes of an ancient brown dragon"

15349 ],

15350 "results": null

15351 },

15352 {15416 {

15353 "type": "message",15417 "type": "message",

15354 "id": "msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7",15418 "id": "msg_67ccd7f7b5848190a6f3e95d809f6b44072912b2993db808",

15355 "status": "completed",15419 "status": "completed",

15356 "role": "assistant",15420 "role": "assistant",

15357 "content": [15421 "content": [

15358 {15422 {

15359 "type": "output_text",15423 "type": "output_text",

15360 "text": "The attributes of an ancient brown dragon include...",15424 "text": "The classic tongue twister...",

15361 "annotations": [15425 "annotations": []

15362 {

15363 "type": "file_citation",

15364 "index": 320,

15365 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15366 "filename": "dragons.pdf"

15367 },

15368 {

15369 "type": "file_citation",

15370 "index": 576,

15371 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15372 "filename": "dragons.pdf"

15373 },

15374 {

15375 "type": "file_citation",

15376 "index": 815,

15377 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15378 "filename": "dragons.pdf"

15379 },

15380 {

15381 "type": "file_citation",

15382 "index": 815,

15383 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15384 "filename": "dragons.pdf"

15385 },

15386 {

15387 "type": "file_citation",

15388 "index": 1030,

15389 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15390 "filename": "dragons.pdf"

15391 },

15392 {

15393 "type": "file_citation",

15394 "index": 1030,

15395 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15396 "filename": "dragons.pdf"

15397 },

15398 {

15399 "type": "file_citation",

15400 "index": 1156,

15401 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15402 "filename": "dragons.pdf"

15403 },

15404 {

15405 "type": "file_citation",

15406 "index": 1225,

15407 "file_id": "file-4wDz5b167pAf72nx1h9eiN",

15408 "filename": "dragons.pdf"

15409 }

15410 ]

15411 }15426 }

15412 ]15427 ]

15413 }15428 }


15415 "parallel_tool_calls": true,15430 "parallel_tool_calls": true,

15416 "previous_response_id": null,15431 "previous_response_id": null,

15417 "reasoning": {15432 "reasoning": {

15418 "effort": null,15433 "effort": "high",

15419 "summary": null15434 "summary": null

15420 },15435 },

15421 "store": true,15436 "store": true,


15426 }15441 }

15427 },15442 },

15428 "tool_choice": "auto",15443 "tool_choice": "auto",

15429 "tools": [15444 "tools": [],

15430 {

15431 "type": "file_search",

15432 "filters": null,

15433 "max_num_results": 20,

15434 "ranking_options": {

15435 "ranker": "auto",

15436 "score_threshold": 0.0

15437 },

15438 "vector_store_ids": [

15439 "vs_1234567890"

15440 ]

15441 }

15442 ],

15443 "top_p": 1.0,15445 "top_p": 1.0,

15444 "truncation": "disabled",15446 "truncation": "disabled",

15445 "usage": {15447 "usage": {

15446 "input_tokens": 18307,15448 "input_tokens": 81,

15447 "input_tokens_details": {15449 "input_tokens_details": {

15448 "cached_tokens": 0,15450 "cached_tokens": 0,

15449 "cache_write_tokens": 015451 "cache_write_tokens": 0

15450 },15452 },

15451 "output_tokens": 348,15453 "output_tokens": 1035,

15452 "output_tokens_details": {15454 "output_tokens_details": {

15453 "reasoning_tokens": 015455 "reasoning_tokens": 832

15454 },15456 },

15455 "total_tokens": 1865515457 "total_tokens": 1116

15456 },15458 },

15457 "user": null,15459 "user": null,

15458 "metadata": {}15460 "metadata": {}


15506data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}15508data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"You are a helpful assistant.","max_output_tokens":null,"model":"gpt-5.4","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}

15507```15509```

15508 15510 

15509### Functions15511### Text input

15510 15512 

15511```http15513```http

15512curl https://api.openai.com/v1/responses \15514curl https://api.openai.com/v1/responses \


15514 -H "Authorization: Bearer $OPENAI_API_KEY" \15516 -H "Authorization: Bearer $OPENAI_API_KEY" \

15515 -d '{15517 -d '{

15516 "model": "gpt-5.4",15518 "model": "gpt-5.4",

15517 "input": "What is the weather like in Boston today?",15519 "input": "Tell me a three sentence bedtime story about a unicorn."

15518 "tools": [

15519 {

15520 "type": "function",

15521 "name": "get_current_weather",

15522 "description": "Get the current weather in a given location",

15523 "parameters": {

15524 "type": "object",

15525 "properties": {

15526 "location": {

15527 "type": "string",

15528 "description": "The city and state, e.g. San Francisco, CA"

15529 },

15530 "unit": {

15531 "type": "string",

15532 "enum": ["celsius", "fahrenheit"]

15533 }

15534 },

15535 "required": ["location", "unit"]

15536 }

15537 }

15538 ],

15539 "tool_choice": "auto"

15540 }'15520 }'

15541```15521```

15542 15522 


15544 15524 

15545```json15525```json

15546{15526{

15547 "id": "resp_67ca09c5efe0819096d0511c92b8c890096610f474011cc0",15527 "id": "resp_67ccd2bed1ec8190b14f964abc0542670bb6a6b452d3795b",

15548 "object": "response",15528 "object": "response",

15549 "created_at": 1741294021,15529 "created_at": 1741476542,

15550 "status": "completed",15530 "status": "completed",

15551 "completed_at": 1741294022,15531 "completed_at": 1741476543,

15552 "error": null,15532 "error": null,

15553 "incomplete_details": null,15533 "incomplete_details": null,

15554 "instructions": null,15534 "instructions": null,


15556 "model": "gpt-5.4",15536 "model": "gpt-5.4",

15557 "output": [15537 "output": [

15558 {15538 {

15559 "type": "function_call",15539 "type": "message",

15560 "id": "fc_67ca09c6bedc8190a7abfec07b1a1332096610f474011cc0",15540 "id": "msg_67ccd2bf17f0819081ff3bb2cf6508e60bb6a6b452d3795b",

15561 "call_id": "call_unLAR8MvFNptuiZK6K6HCy5k",15541 "status": "completed",

15562 "name": "get_current_weather",15542 "role": "assistant",

15563 "arguments": "{\"location\":\"Boston, MA\",\"unit\":\"celsius\"}",15543 "content": [

15564 "status": "completed"15544 {

15545 "type": "output_text",

15546 "text": "In a peaceful grove beneath a silver moon, a unicorn named Lumina discovered a hidden pool that reflected the stars. As she dipped her horn into the water, the pool began to shimmer, revealing a pathway to a magical realm of endless night skies. Filled with wonder, Lumina whispered a wish for all who dream to find their own hidden magic, and as she glanced back, her hoofprints sparkled like stardust.",

15547 "annotations": []

15548 }

15549 ]

15565 }15550 }

15566 ],15551 ],

15567 "parallel_tool_calls": true,15552 "parallel_tool_calls": true,


15578 }15563 }

15579 },15564 },

15580 "tool_choice": "auto",15565 "tool_choice": "auto",

15581 "tools": [15566 "tools": [],

15582 {

15583 "type": "function",

15584 "description": "Get the current weather in a given location",

15585 "name": "get_current_weather",

15586 "parameters": {

15587 "type": "object",

15588 "properties": {

15589 "location": {

15590 "type": "string",

15591 "description": "The city and state, e.g. San Francisco, CA"

15592 },

15593 "unit": {

15594 "type": "string",

15595 "enum": [

15596 "celsius",

15597 "fahrenheit"

15598 ]

15599 }

15600 },

15601 "required": [

15602 "location",

15603 "unit"

15604 ]

15605 },

15606 "strict": true

15607 }

15608 ],

15609 "top_p": 1.0,15567 "top_p": 1.0,

15610 "truncation": "disabled",15568 "truncation": "disabled",

15611 "usage": {15569 "usage": {

15612 "input_tokens": 291,15570 "input_tokens": 36,

15613 "output_tokens": 23,15571 "input_tokens_details": {

15572 "cached_tokens": 0,

15573 "cache_write_tokens": 0

15574 },

15575 "output_tokens": 87,

15614 "output_tokens_details": {15576 "output_tokens_details": {

15615 "reasoning_tokens": 015577 "reasoning_tokens": 0

15616 },15578 },

15617 "total_tokens": 31415579 "total_tokens": 123

15618 },15580 },

15619 "user": null,15581 "user": null,

15620 "metadata": {}15582 "metadata": {}

15621}15583}

15622```15584```

15623 15585 

15624### Reasoning15586### Web search

15625 15587 

15626```http15588```http

15627curl https://api.openai.com/v1/responses \15589curl https://api.openai.com/v1/responses \

15628 -H "Content-Type: application/json" \15590 -H "Content-Type: application/json" \

15629 -H "Authorization: Bearer $OPENAI_API_KEY" \15591 -H "Authorization: Bearer $OPENAI_API_KEY" \

15630 -d '{15592 -d '{

15631 "model": "o3-mini",15593 "model": "gpt-5.4",

15632 "input": "How much wood would a woodchuck chuck?",15594 "tools": [{ "type": "web_search_preview" }],

15633 "reasoning": {15595 "input": "What was a positive news story from today?"

15634 "effort": "high"

15635 }

15636 }'15596 }'

15637```15597```

15638 15598 


15640 15600 

15641```json15601```json

15642{15602{

15643 "id": "resp_67ccd7eca01881908ff0b5146584e408072912b2993db808",15603 "id": "resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c",

15644 "object": "response",15604 "object": "response",

15645 "created_at": 1741477868,15605 "created_at": 1741484430,

15646 "status": "completed",15606 "status": "completed",

15647 "completed_at": 1741477869,15607 "completed_at": 1741484431,

15648 "error": null,15608 "error": null,

15649 "incomplete_details": null,15609 "incomplete_details": null,

15650 "instructions": null,15610 "instructions": null,

15651 "max_output_tokens": null,15611 "max_output_tokens": null,

15652 "model": "o1-2024-12-17",15612 "model": "gpt-5.4",

15653 "output": [15613 "output": [

15614 {

15615 "type": "web_search_call",

15616 "id": "ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c",

15617 "status": "completed"

15618 },

15654 {15619 {

15655 "type": "message",15620 "type": "message",

15656 "id": "msg_67ccd7f7b5848190a6f3e95d809f6b44072912b2993db808",15621 "id": "msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c",

15657 "status": "completed",15622 "status": "completed",

15658 "role": "assistant",15623 "role": "assistant",

15659 "content": [15624 "content": [

15660 {15625 {

15661 "type": "output_text",15626 "type": "output_text",

15662 "text": "The classic tongue twister...",15627 "text": "As of today, March 9, 2025, one notable positive news story...",

15663 "annotations": []15628 "annotations": [

15629 {

15630 "type": "url_citation",

15631 "start_index": 442,

15632 "end_index": 557,

15633 "url": "https://.../?utm_source=chatgpt.com",

15634 "title": "..."

15635 },

15636 {

15637 "type": "url_citation",

15638 "start_index": 962,

15639 "end_index": 1077,

15640 "url": "https://.../?utm_source=chatgpt.com",

15641 "title": "..."

15642 },

15643 {

15644 "type": "url_citation",

15645 "start_index": 1336,

15646 "end_index": 1451,

15647 "url": "https://.../?utm_source=chatgpt.com",

15648 "title": "..."

15649 }

15650 ]

15664 }15651 }

15665 ]15652 ]

15666 }15653 }


15668 "parallel_tool_calls": true,15655 "parallel_tool_calls": true,

15669 "previous_response_id": null,15656 "previous_response_id": null,

15670 "reasoning": {15657 "reasoning": {

15671 "effort": "high",15658 "effort": null,

15672 "summary": null15659 "summary": null

15673 },15660 },

15674 "store": true,15661 "store": true,


15679 }15666 }

15680 },15667 },

15681 "tool_choice": "auto",15668 "tool_choice": "auto",

15682 "tools": [],15669 "tools": [

15670 {

15671 "type": "web_search_preview",

15672 "domains": [],

15673 "search_context_size": "medium",

15674 "user_location": {

15675 "type": "approximate",

15676 "city": null,

15677 "country": "US",

15678 "region": null,

15679 "timezone": null

15680 }

15681 }

15682 ],

15683 "top_p": 1.0,15683 "top_p": 1.0,

15684 "truncation": "disabled",15684 "truncation": "disabled",

15685 "usage": {15685 "usage": {

15686 "input_tokens": 81,15686 "input_tokens": 328,

15687 "input_tokens_details": {15687 "input_tokens_details": {

15688 "cached_tokens": 0,15688 "cached_tokens": 0,

15689 "cache_write_tokens": 015689 "cache_write_tokens": 0

15690 },15690 },

15691 "output_tokens": 1035,15691 "output_tokens": 356,

15692 "output_tokens_details": {15692 "output_tokens_details": {

15693 "reasoning_tokens": 83215693 "reasoning_tokens": 0

15694 },15694 },

15695 "total_tokens": 111615695 "total_tokens": 684

15696 },15696 },

15697 "user": null,15697 "user": null,

15698 "metadata": {}15698 "metadata": {}

Details

58curl https://api.openai.com/v1/skills \58curl https://api.openai.com/v1/skills \

59 -H 'Content-Type: application/json' \59 -H 'Content-Type: application/json' \

60 -H "Authorization: Bearer $OPENAI_API_KEY" \60 -H "Authorization: Bearer $OPENAI_API_KEY" \

61 -F files='["Example data"]'61 -d '{

62 "files": [

63 "string"

64 ]

65 }'

62```66```

63 67 

64#### Response68#### Response

Details

66curl https://api.openai.com/v1/skills/$SKILL_ID/versions \66curl https://api.openai.com/v1/skills/$SKILL_ID/versions \

67 -H 'Content-Type: application/json' \67 -H 'Content-Type: application/json' \

68 -H "Authorization: Bearer $OPENAI_API_KEY" \68 -H "Authorization: Bearer $OPENAI_API_KEY" \

69 -F files='["Example data"]'69 -d '{

70 "files": [

71 "string"

72 ]

73 }'

70```74```

71 75 

72#### Response76#### Response

Details

186 "progress": 0,186 "progress": 0,

187 "prompt": "prompt",187 "prompt": "prompt",

188 "remixed_from_video_id": "remixed_from_video_id",188 "remixed_from_video_id": "remixed_from_video_id",

189 "seconds": "seconds",189 "seconds": "string",

190 "size": "720x1280",190 "size": "720x1280",

191 "status": "queued"191 "status": "queued"

192}192}

Details

147 "progress": 0,147 "progress": 0,

148 "prompt": "prompt",148 "prompt": "prompt",

149 "remixed_from_video_id": "remixed_from_video_id",149 "remixed_from_video_id": "remixed_from_video_id",

150 "seconds": "seconds",150 "seconds": "string",

151 "size": "720x1280",151 "size": "720x1280",

152 "status": "queued"152 "status": "queued"

153}153}

Details

158 "progress": 0,158 "progress": 0,

159 "prompt": "prompt",159 "prompt": "prompt",

160 "remixed_from_video_id": "remixed_from_video_id",160 "remixed_from_video_id": "remixed_from_video_id",

161 "seconds": "seconds",161 "seconds": "string",

162 "size": "720x1280",162 "size": "720x1280",

163 "status": "queued"163 "status": "queued"

164}164}

Details

164 "progress": 0,164 "progress": 0,

165 "prompt": "prompt",165 "prompt": "prompt",

166 "remixed_from_video_id": "remixed_from_video_id",166 "remixed_from_video_id": "remixed_from_video_id",

167 "seconds": "seconds",167 "seconds": "string",

168 "size": "720x1280",168 "size": "720x1280",

169 "status": "queued"169 "status": "queued"

170 }170 }

Details

140 "progress": 0,140 "progress": 0,

141 "prompt": "prompt",141 "prompt": "prompt",

142 "remixed_from_video_id": "remixed_from_video_id",142 "remixed_from_video_id": "remixed_from_video_id",

143 "seconds": "seconds",143 "seconds": "string",

144 "size": "720x1280",144 "size": "720x1280",

145 "status": "queued"145 "status": "queued"

146}146}

Details

130 "progress": 0,130 "progress": 0,

131 "prompt": "prompt",131 "prompt": "prompt",

132 "remixed_from_video_id": "remixed_from_video_id",132 "remixed_from_video_id": "remixed_from_video_id",

133 "seconds": "seconds",133 "seconds": "string",

134 "size": "720x1280",134 "size": "720x1280",

135 "status": "queued"135 "status": "queued"

136}136}

Details

1# Responses Overview1# Responses Overview

2 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 

3OpenAI's most advanced interface for generating model responses. Supports5OpenAI's most advanced interface for generating model responses. Supports

4text and image inputs, and text outputs. Create stateful interactions6text and image inputs, and text outputs. Create stateful interactions

5with the model, using the output of previous responses as input. Extend7with the model, using the output of previous responses as input. Extend

Details

1# Workload identity token exchange1# Workload identity token exchange

2 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 

3Use this reference to exchange an externally issued identity token for a short-lived OpenAI access token after you configure a trusted provider and service account mapping. For concepts, dashboard configuration, provider-specific setup, and SDK examples, see the [workload identity federation guide](https://developers.openai.com/api/docs/guides/workload-identity-federation).5Use this reference to exchange an externally issued identity token for a short-lived OpenAI access token after you configure a trusted provider and service account mapping. For concepts, dashboard configuration, provider-specific setup, and SDK examples, see the [workload identity federation guide](https://developers.openai.com/api/docs/guides/workload-identity-federation).

4 6 

5## Exchange a subject token7## Exchange a subject token