Reference 2026-09-27 23:58 UTC to 2026-09-28 22:57 UTC

500{500{

501 "task": "transcribe",501 "task": "transcribe",

502 "language": "english",502 "language": "english",

503 "duration": 8.470000267028809,503 "duration": 3.32,

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

505 "segments": [505 "segments": [

506 {506 {

507 "id": 0,507 "id": 0,

516 "avg_logprob": -0.2860786020755768,516 "avg_logprob": -0.2860786020755768,

517 "compression_ratio": 1.2363636493682861,517 "compression_ratio": 1.2363636493682861,

518 "no_speech_prob": 0.00985979475080967518 "no_speech_prob": 0.00985979475080967

519 },519 }

520 ...

521 ],520 ],

522 "usage": {521 "usage": {

523 "type": "duration",522 "type": "duration",

524 "seconds": 9523 "seconds": 4

525 }524 }

526}525}

527```526```

623{622{

624 "task": "transcribe",623 "task": "transcribe",

625 "language": "english",624 "language": "english",

626 "duration": 8.470000267028809,625 "duration": 0.5,

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

628 "words": [627 "words": [

629 {628 {

630 "word": "The",629 "word": "Hello",

631 "start": 0.0,630 "start": 0.0,

632 "end": 0.23999999463558197631 "end": 0.5

633 },

634 ...

635 {

636 "word": "volleyball",

637 "start": 7.400000095367432,

638 "end": 7.900000095367432

639 }632 }

640 ],633 ],

641 "usage": {634 "usage": {

642 "type": "duration",635 "type": "duration",

643 "seconds": 9636 "seconds": 1

644 }637 }

645}638}

646```639```

58 58 

59 - `"cancelled"`59 - `"cancelled"`

60 60 

61 - `cancelled_at: optional number`61 - `cancelled_at: optional number or null`

62 62 

63 The Unix timestamp (in seconds) for when the batch was cancelled.63 The Unix timestamp (in seconds) for when the batch was cancelled.

64 64 

65 - `cancelling_at: optional number`65 - `cancelling_at: optional number or null`

66 66 

67 The Unix timestamp (in seconds) for when the batch started cancelling.67 The Unix timestamp (in seconds) for when the batch started cancelling.

68 68 

69 - `completed_at: optional number`69 - `completed_at: optional number or null`

70 70 

71 The Unix timestamp (in seconds) for when the batch was completed.71 The Unix timestamp (in seconds) for when the batch was completed.

72 72 

73 - `error_file_id: optional string`73 - `error_file_id: optional string or null`

74 74 

75 The ID of the file containing the outputs of requests with errors.75 The ID of the file containing the outputs of requests with errors.

76 76 

77 - `errors: optional object { data, object }`77 - `errors: optional object { data, object } or null`

78 78 

79 - `data: optional array of BatchError`79 - `data: optional array of BatchError`

80 80 

98 98 

99 The object type, which is always `list`.99 The object type, which is always `list`.

100 100 

101 - `expired_at: optional number`101 - `expired_at: optional number or null`

102 102 

103 The Unix timestamp (in seconds) for when the batch expired.103 The Unix timestamp (in seconds) for when the batch expired.

104 104 

105 - `expires_at: optional number`105 - `expires_at: optional number or null`

106 106 

107 The Unix timestamp (in seconds) for when the batch will expire.107 The Unix timestamp (in seconds) for when the batch will expire.

108 108 

109 - `failed_at: optional number`109 - `failed_at: optional number or null`

110 110 

111 The Unix timestamp (in seconds) for when the batch failed.111 The Unix timestamp (in seconds) for when the batch failed.

112 112 

113 - `finalizing_at: optional number`113 - `finalizing_at: optional number or null`

114 114 

115 The Unix timestamp (in seconds) for when the batch started finalizing.115 The Unix timestamp (in seconds) for when the batch started finalizing.

116 116 

117 - `in_progress_at: optional number`117 - `in_progress_at: optional number or null`

118 118 

119 The Unix timestamp (in seconds) for when the batch started processing.119 The Unix timestamp (in seconds) for when the batch started processing.

120 120 

134 characteristics, and price points. Refer to the [model134 characteristics, and price points. Refer to the [model

135 guide](/api/docs/models) to browse and compare available models.135 guide](/api/docs/models) to browse and compare available models.

136 136 

137 - `output_file_id: optional string`137 - `output_file_id: optional string or null`

138 138 

139 The ID of the file containing the outputs of successfully executed requests.139 The ID of the file containing the outputs of successfully executed requests.

140 140 

113 113 

114 - `"cancelled"`114 - `"cancelled"`

115 115 

116 - `cancelled_at: optional number`116 - `cancelled_at: optional number or null`

117 117 

118 The Unix timestamp (in seconds) for when the batch was cancelled.118 The Unix timestamp (in seconds) for when the batch was cancelled.

119 119 

120 - `cancelling_at: optional number`120 - `cancelling_at: optional number or null`

121 121 

122 The Unix timestamp (in seconds) for when the batch started cancelling.122 The Unix timestamp (in seconds) for when the batch started cancelling.

123 123 

124 - `completed_at: optional number`124 - `completed_at: optional number or null`

125 125 

126 The Unix timestamp (in seconds) for when the batch was completed.126 The Unix timestamp (in seconds) for when the batch was completed.

127 127 

128 - `error_file_id: optional string`128 - `error_file_id: optional string or null`

129 129 

130 The ID of the file containing the outputs of requests with errors.130 The ID of the file containing the outputs of requests with errors.

131 131 

132 - `errors: optional object { data, object }`132 - `errors: optional object { data, object } or null`

133 133 

134 - `data: optional array of BatchError`134 - `data: optional array of BatchError`

135 135 

153 153 

154 The object type, which is always `list`.154 The object type, which is always `list`.

155 155 

156 - `expired_at: optional number`156 - `expired_at: optional number or null`

157 157 

158 The Unix timestamp (in seconds) for when the batch expired.158 The Unix timestamp (in seconds) for when the batch expired.

159 159 

160 - `expires_at: optional number`160 - `expires_at: optional number or null`

161 161 

162 The Unix timestamp (in seconds) for when the batch will expire.162 The Unix timestamp (in seconds) for when the batch will expire.

163 163 

164 - `failed_at: optional number`164 - `failed_at: optional number or null`

165 165 

166 The Unix timestamp (in seconds) for when the batch failed.166 The Unix timestamp (in seconds) for when the batch failed.

167 167 

168 - `finalizing_at: optional number`168 - `finalizing_at: optional number or null`

169 169 

170 The Unix timestamp (in seconds) for when the batch started finalizing.170 The Unix timestamp (in seconds) for when the batch started finalizing.

171 171 

172 - `in_progress_at: optional number`172 - `in_progress_at: optional number or null`

173 173 

174 The Unix timestamp (in seconds) for when the batch started processing.174 The Unix timestamp (in seconds) for when the batch started processing.

175 175 

189 characteristics, and price points. Refer to the [model189 characteristics, and price points. Refer to the [model

190 guide](/api/docs/models) to browse and compare available models.190 guide](/api/docs/models) to browse and compare available models.

191 191 

192 - `output_file_id: optional string`192 - `output_file_id: optional string or null`

193 193 

194 The ID of the file containing the outputs of successfully executed requests.194 The ID of the file containing the outputs of successfully executed requests.

195 195 

64 64 

65 - `"cancelled"`65 - `"cancelled"`

66 66 

67 - `cancelled_at: optional number`67 - `cancelled_at: optional number or null`

68 68 

69 The Unix timestamp (in seconds) for when the batch was cancelled.69 The Unix timestamp (in seconds) for when the batch was cancelled.

70 70 

71 - `cancelling_at: optional number`71 - `cancelling_at: optional number or null`

72 72 

73 The Unix timestamp (in seconds) for when the batch started cancelling.73 The Unix timestamp (in seconds) for when the batch started cancelling.

74 74 

75 - `completed_at: optional number`75 - `completed_at: optional number or null`

76 76 

77 The Unix timestamp (in seconds) for when the batch was completed.77 The Unix timestamp (in seconds) for when the batch was completed.

78 78 

79 - `error_file_id: optional string`79 - `error_file_id: optional string or null`

80 80 

81 The ID of the file containing the outputs of requests with errors.81 The ID of the file containing the outputs of requests with errors.

82 82 

83 - `errors: optional object { data, object }`83 - `errors: optional object { data, object } or null`

84 84 

85 - `data: optional array of BatchError`85 - `data: optional array of BatchError`

86 86 

104 104 

105 The object type, which is always `list`.105 The object type, which is always `list`.

106 106 

107 - `expired_at: optional number`107 - `expired_at: optional number or null`

108 108 

109 The Unix timestamp (in seconds) for when the batch expired.109 The Unix timestamp (in seconds) for when the batch expired.

110 110 

111 - `expires_at: optional number`111 - `expires_at: optional number or null`

112 112 

113 The Unix timestamp (in seconds) for when the batch will expire.113 The Unix timestamp (in seconds) for when the batch will expire.

114 114 

115 - `failed_at: optional number`115 - `failed_at: optional number or null`

116 116 

117 The Unix timestamp (in seconds) for when the batch failed.117 The Unix timestamp (in seconds) for when the batch failed.

118 118 

119 - `finalizing_at: optional number`119 - `finalizing_at: optional number or null`

120 120 

121 The Unix timestamp (in seconds) for when the batch started finalizing.121 The Unix timestamp (in seconds) for when the batch started finalizing.

122 122 

123 - `in_progress_at: optional number`123 - `in_progress_at: optional number or null`

124 124 

125 The Unix timestamp (in seconds) for when the batch started processing.125 The Unix timestamp (in seconds) for when the batch started processing.

126 126 

140 characteristics, and price points. Refer to the [model140 characteristics, and price points. Refer to the [model

141 guide](/api/docs/models) to browse and compare available models.141 guide](/api/docs/models) to browse and compare available models.

142 142 

143 - `output_file_id: optional string`143 - `output_file_id: optional string or null`

144 144 

145 The ID of the file containing the outputs of successfully executed requests.145 The ID of the file containing the outputs of successfully executed requests.

146 146 

315 },315 },

316 "metadata": {316 "metadata": {

317 "customer_id": "user_123456789",317 "customer_id": "user_123456789",

318 "batch_description": "Nightly job",318 "batch_description": "Nightly job"

319 }

319 }320 }

320 },

321 { ... },

322 ],321 ],

323 "first_id": "batch_abc123",322 "first_id": "batch_abc123",

324 "last_id": "batch_abc456",323 "last_id": "batch_abc123",

325 "has_more": true324 "has_more": false

326}325}

327```326```

58 58 

59 - `"cancelled"`59 - `"cancelled"`

60 60 

61 - `cancelled_at: optional number`61 - `cancelled_at: optional number or null`

62 62 

63 The Unix timestamp (in seconds) for when the batch was cancelled.63 The Unix timestamp (in seconds) for when the batch was cancelled.

64 64 

65 - `cancelling_at: optional number`65 - `cancelling_at: optional number or null`

66 66 

67 The Unix timestamp (in seconds) for when the batch started cancelling.67 The Unix timestamp (in seconds) for when the batch started cancelling.

68 68 

69 - `completed_at: optional number`69 - `completed_at: optional number or null`

70 70 

71 The Unix timestamp (in seconds) for when the batch was completed.71 The Unix timestamp (in seconds) for when the batch was completed.

72 72 

73 - `error_file_id: optional string`73 - `error_file_id: optional string or null`

74 74 

75 The ID of the file containing the outputs of requests with errors.75 The ID of the file containing the outputs of requests with errors.

76 76 

77 - `errors: optional object { data, object }`77 - `errors: optional object { data, object } or null`

78 78 

79 - `data: optional array of BatchError`79 - `data: optional array of BatchError`

80 80 

98 98 

99 The object type, which is always `list`.99 The object type, which is always `list`.

100 100 

101 - `expired_at: optional number`101 - `expired_at: optional number or null`

102 102 

103 The Unix timestamp (in seconds) for when the batch expired.103 The Unix timestamp (in seconds) for when the batch expired.

104 104 

105 - `expires_at: optional number`105 - `expires_at: optional number or null`

106 106 

107 The Unix timestamp (in seconds) for when the batch will expire.107 The Unix timestamp (in seconds) for when the batch will expire.

108 108 

109 - `failed_at: optional number`109 - `failed_at: optional number or null`

110 110 

111 The Unix timestamp (in seconds) for when the batch failed.111 The Unix timestamp (in seconds) for when the batch failed.

112 112 

113 - `finalizing_at: optional number`113 - `finalizing_at: optional number or null`

114 114 

115 The Unix timestamp (in seconds) for when the batch started finalizing.115 The Unix timestamp (in seconds) for when the batch started finalizing.

116 116 

117 - `in_progress_at: optional number`117 - `in_progress_at: optional number or null`

118 118 

119 The Unix timestamp (in seconds) for when the batch started processing.119 The Unix timestamp (in seconds) for when the batch started processing.

120 120 

134 characteristics, and price points. Refer to the [model134 characteristics, and price points. Refer to the [model

135 guide](/api/docs/models) to browse and compare available models.135 guide](/api/docs/models) to browse and compare available models.

136 136 

137 - `output_file_id: optional string`137 - `output_file_id: optional string or null`

138 138 

139 The ID of the file containing the outputs of successfully executed requests.139 The ID of the file containing the outputs of successfully executed requests.

140 140 

167 {167 {

168 "id": "cthr_abc123",168 "id": "cthr_abc123",

169 "object": "chatkit.thread",169 "object": "chatkit.thread",

170 "title": "Customer escalation"170 "title": "Customer escalation",

171 "created_at": 1712345600,

172 "status": {

173 "type": "active"

174 },

175 "user": "user_123"

171 },176 },

172 {177 {

173 "id": "cthr_def456",178 "id": "cthr_def456",

174 "object": "chatkit.thread",179 "object": "chatkit.thread",

175 "title": "Demo feedback"180 "title": "Demo feedback",

181 "created_at": 1712345600,

182 "status": {

183 "type": "active"

184 },

185 "user": "user_456"

176 }186 }

177 ],187 ],

178 "has_more": false,188 "has_more": false,

179 "object": "list"189 "object": "list",

190 "first_id": "cthr_abc123",

191 "last_id": "cthr_def456"

180}192}

181```193```

497 {497 {

498 "id": "cthi_user_001",498 "id": "cthi_user_001",

499 "object": "chatkit.thread_item",499 "object": "chatkit.thread_item",

500 "type": "user_message",500 "type": "chatkit.user_message",

501 "content": [501 "content": [

502 {502 {

503 "type": "input_text",503 "type": "input_text",

504 "text": "I need help debugging an onboarding issue."504 "text": "I need help debugging an onboarding issue."

505 }505 }

506 ],506 ],

507 "attachments": []507 "attachments": [],

508 "created_at": 1712345600,

509 "thread_id": "cthr_abc123",

510 "inference_options": null

508 },511 },

509 {512 {

510 "id": "cthi_assistant_002",513 "id": "cthi_assistant_002",

511 "object": "chatkit.thread_item",514 "object": "chatkit.thread_item",

512 "type": "assistant_message",515 "type": "chatkit.assistant_message",

513 "content": [516 "content": [

514 {517 {

515 "type": "output_text",518 "type": "output_text",

516 "text": "Let's start by confirming the workflow version you deployed."519 "text": "Let's start by confirming the workflow version you deployed.",

520 "annotations": []

517 }521 }

518 ]522 ],

523 "created_at": 1712345601,

524 "thread_id": "cthr_abc123"

519 }525 }

520 ],526 ],

521 "has_more": false,527 "has_more": false,

522 "object": "list"528 "object": "list",

529 "first_id": "cthi_user_001",

530 "last_id": "cthi_assistant_002"

523}531}

524```532```

118 "id": "cthr_abc123",118 "id": "cthr_abc123",

119 "object": "chatkit.thread",119 "object": "chatkit.thread",

120 "title": "Customer escalation",120 "title": "Customer escalation",

121 "items": {121 "created_at": 1712345600,

122 "data": [122 "status": {

123 {123 "type": "active"

124 "id": "cthi_user_001",

125 "object": "chatkit.thread_item",

126 "type": "user_message",

127 "content": [

128 {

129 "type": "input_text",

130 "text": "I need help debugging an onboarding issue."

131 }

132 ],

133 "attachments": []

134 },124 },

135 {125 "user": "user_123"

136 "id": "cthi_assistant_002",

137 "object": "chatkit.thread_item",

138 "type": "assistant_message",

139 "content": [

140 {

141 "type": "output_text",

142 "text": "Let's start by confirming the workflow version you deployed."

143 }

144 ]

145 }

146 ],

147 "has_more": false

148 }

149}126}

150```127```

440 440 

441```json441```json

442{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-6-astra", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}],"obfuscation":"r4N7vQ2m"}442{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-6-astra", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}],"obfuscation":"r4N7vQ2m"}

443 

444{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-6-astra", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}],"obfuscation":"p9K3xT6w"}

445 

446....

447 

448{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-6-astra", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}],"obfuscation":""}

449```443```

10 10 

11- `container_id: string`11- `container_id: string`

12 12 

13### Returns

14 

15- `id: string`

16 

17- `deleted: boolean`

18 

19- `object: "container.deleted"`

20 

21 - `"container.deleted"`

22 

13### Example23### Example

14 24 

15```http25```http

18 -H "Authorization: Bearer $OPENAI_API_KEY"28 -H "Authorization: Bearer $OPENAI_API_KEY"

19```29```

20 30 

31#### Response

32 

33```json

34{

35 "id": "id",

36 "deleted": true,

37 "object": "container.deleted"

38}

39```

40 

21### Example41### Example

22 42 

23```http43```http

12 12 

13- `file_id: string`13- `file_id: string`

14 14 

15### Returns

16 

17- `id: string`

18 

19- `deleted: boolean`

20 

21- `object: "container.file.deleted"`

22 

23 - `"container.file.deleted"`

24 

15### Example25### Example

16 26 

17```http27```http

20 -H "Authorization: Bearer $OPENAI_API_KEY"30 -H "Authorization: Bearer $OPENAI_API_KEY"

21```31```

22 32 

33#### Response

34 

35```json

36{

37 "id": "id",

38 "deleted": true,

39 "object": "container.file.deleted"

40}

41```

42 

23### Example43### Example

24 44 

25```http45```http

245 245 

246 - `index: number`246 - `index: number`

247 247 

248 The index of the file in the list of files.248 The index in the output text at which to insert the file citation.

249 249 

250 - `type: "file_citation"`250 - `type: "file_citation"`

251 251 

813 813 

814 - `"incomplete"`814 - `"incomplete"`

815 815 

816 - `WebSearchCall object { id, action, status, type }`816 - `WebSearchCall object { id, status, type, action }`

817 817 

818 The results of a web search tool call. See the818 The results of a web search tool call. See the

819 [web search guide](/api/docs/guides/tools-web-search) for more information.819 [web search guide](/api/docs/guides/tools-web-search) for more information.

822 822 

823 The unique ID of the web search tool call.823 The unique ID of the web search tool call.

824 824 

825 - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`825 - `status: "in_progress" or "searching" or "completed" or 2 more`

826 

827 The status of the web search tool call.

828 

829 - `"in_progress"`

830 

831 - `"searching"`

832 

833 - `"completed"`

834 

835 - `"failed"`

836 

837 - `"incomplete"`

838 

839 - `type: "web_search_call"`

840 

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

842 

843 - `"web_search_call"`

844 

845 - `action: optional object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`

826 846 

827 An object describing the specific action taken in this web search call.847 An object describing the specific action taken in this web search call.

828 Includes details on how the model used the web (search, open_page, find_in_page).848 Includes details on how the model used the web (search, open_page, find_in_page).

891 911 

892 The URL of the page searched for the pattern.912 The URL of the page searched for the pattern.

893 913 

894 - `status: "in_progress" or "searching" or "completed" or 2 more`

895 

896 The status of the web search tool call.

897 

898 - `"in_progress"`

899 

900 - `"searching"`

901 

902 - `"completed"`

903 

904 - `"failed"`

905 

906 - `"incomplete"`

907 

908 - `type: "web_search_call"`

909 

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

911 

912 - `"web_search_call"`

913 

914 - `FunctionCall object { arguments, call_id, name, 6 more }`914 - `FunctionCall object { arguments, call_id, name, 6 more }`

915 915 

916 A tool call to run a function. See the916 A tool call to run a function. See the

1314 1314 

1315 Combine multiple filters using `and` or `or`.1315 Combine multiple filters using `and` or `or`.

1316 1316 

1317 - `filters: array of ComparisonFilter or unknown`1317 - `filters: array of ComparisonFilter or CompoundFilter`

1318 1318 

1319 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.1319 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

1320 1320 

1322 1322 

1323 A filter used to compare a specified attribute key to a given value using a defined comparison operation.1323 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

1324 1324 

1325 - `unknown`1325 - `CompoundFilter object { filters, type }`

1326 

1327 Combine multiple filters using `and` or `or`.

1326 1328 

1327 - `type: "and" or "or"`1329 - `type: "and" or "or"`

1328 1330 

128 128 

129 - `index: number`129 - `index: number`

130 130 

131 The index of the file in the list of files.131 The index in the output text at which to insert the file citation.

132 132 

133 - `type: "file_citation"`133 - `type: "file_citation"`

134 134 

673 673 

674 The text that was retrieved from the file.674 The text that was retrieved from the file.

675 675 

676 - `WebSearchCall object { id, action, status, type }`676 - `WebSearchCall object { id, status, type, action }`

677 677 

678 The results of a web search tool call. See the678 The results of a web search tool call. See the

679 [web search guide](/api/docs/guides/tools-web-search) for more information.679 [web search guide](/api/docs/guides/tools-web-search) for more information.

682 682 

683 The unique ID of the web search tool call.683 The unique ID of the web search tool call.

684 684 

685 - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`685 - `status: "in_progress" or "searching" or "completed" or 2 more`

686 

687 The status of the web search tool call.

688 

689 - `"in_progress"`

690 

691 - `"searching"`

692 

693 - `"completed"`

694 

695 - `"failed"`

696 

697 - `"incomplete"`

698 

699 - `type: "web_search_call"`

700 

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

702 

703 - `"web_search_call"`

704 

705 - `action: optional object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`

686 706 

687 An object describing the specific action taken in this web search call.707 An object describing the specific action taken in this web search call.

688 Includes details on how the model used the web (search, open_page, find_in_page).708 Includes details on how the model used the web (search, open_page, find_in_page).

751 771 

752 The URL of the page searched for the pattern.772 The URL of the page searched for the pattern.

753 773 

754 - `status: "in_progress" or "searching" or "completed" or 2 more`

755 

756 The status of the web search tool call.

757 

758 - `"in_progress"`

759 

760 - `"searching"`

761 

762 - `"completed"`

763 

764 - `"failed"`

765 

766 - `"incomplete"`

767 

768 - `type: "web_search_call"`

769 

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

771 

772 - `"web_search_call"`

773 

774 - `ImageGenerationCall object { id, result, status, 7 more }`774 - `ImageGenerationCall object { id, result, status, 7 more }`

775 775 

776 An image generation request made by the model.776 An image generation request made by the model.

1411 1411 

1412 Combine multiple filters using `and` or `or`.1412 Combine multiple filters using `and` or `or`.

1413 1413 

1414 - `filters: array of ComparisonFilter or unknown`1414 - `filters: array of ComparisonFilter or CompoundFilter`

1415 1415 

1416 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.1416 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

1417 1417 

1419 1419 

1420 A filter used to compare a specified attribute key to a given value using a defined comparison operation.1420 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

1421 1421 

1422 - `unknown`1422 - `CompoundFilter object { filters, type }`

1423 

1424 Combine multiple filters using `and` or `or`.

1423 1425 

1424 - `type: "and" or "or"`1426 - `type: "and" or "or"`

1425 1427 

66 66 

67 The list of embeddings generated by the model.67 The list of embeddings generated by the model.

68 68 

69 - `embedding: array of number`69 - `embedding: array of number or string`

70 70 

71 The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](/api/docs/guides/embeddings).71 The embedding vector, returned as a list of floats when `encoding_format` is `float` (the default), or as a base64-encoded string when `encoding_format` is `base64`. The length of the vector depends on the model as listed in the [embedding guide](/api/docs/guides/embeddings).

72 

73 - `array of number`

74 

75 - `string`

72 76 

73 - `index: number`77 - `index: number`

74 78 

145 -H "Authorization: Bearer $OPENAI_API_KEY" \149 -H "Authorization: Bearer $OPENAI_API_KEY" \

146 -H "Content-Type: application/json" \150 -H "Content-Type: application/json" \

147 -d '{151 -d '{

148 "input": "The food was delicious and the waiter...",152 "input": "Hello world",

149 "model": "text-embedding-ada-002",153 "model": "text-embedding-3-small",

150 "encoding_format": "float"154 "encoding_format": "float",

155 "dimensions": 3

151 }'156 }'

152```157```

153 158 

160 {165 {

161 "object": "embedding",166 "object": "embedding",

162 "embedding": [167 "embedding": [

163 0.0023064255,168 0.26726124,

164 -0.009327292,169 0.53452248,

165 .... (1536 floats total for ada-002)170 0.80178373

166 -0.0028842222,

167 ],171 ],

168 "index": 0172 "index": 0

169 }173 }

170 ],174 ],

171 "model": "text-embedding-ada-002",175 "model": "text-embedding-3-small",

172 "usage": {176 "usage": {

173 "prompt_tokens": 8,177 "prompt_tokens": 2,

174 "total_tokens": 8178 "total_tokens": 2

175 }179 }

176}180}

177```181```

1076 1076 

1077 Combine multiple filters using `and` or `or`.1077 Combine multiple filters using `and` or `or`.

1078 1078 

1079 - `filters: array of ComparisonFilter or unknown`1079 - `filters: array of ComparisonFilter or CompoundFilter`

1080 1080 

1081 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.1081 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

1082 1082 

1084 1084 

1085 A filter used to compare a specified attribute key to a given value using a defined comparison operation.1085 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

1086 1086 

1087 - `unknown`1087 - `CompoundFilter object { filters, type }`

1088 

1089 Combine multiple filters using `and` or `or`.

1088 1090 

1089 - `type: "and" or "or"`1091 - `type: "and" or "or"`

1090 1092 

128curl https://api.openai.com/v1/files \128curl https://api.openai.com/v1/files \

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

130 -F purpose="fine-tune" \130 -F purpose="fine-tune" \

131 -F file="@mydata.jsonl"131 -F file="@mydata.jsonl" \

132 -F expires_after[anchor]="created_at"132 -F 'expires_after[anchor]=created_at' \

133 -F expires_after[seconds]=2592000133 -F 'expires_after[seconds]=2592000'

134```134```

135 135 

136#### Response136#### Response

141 "object": "file",141 "object": "file",

142 "bytes": 120000,142 "bytes": 120000,

143 "created_at": 1677610602,143 "created_at": 1677610602,

144 "expires_at": 1677614202,144 "expires_at": 1680202602,

145 "filename": "mydata.jsonl",145 "filename": "mydata.jsonl",

146 "purpose": "fine-tune"146 "purpose": "fine-tune",

147 "status": "processed"

147}148}

148```149```

151 "created_at": 1613677385,151 "created_at": 1613677385,

152 "expires_at": 1677614202,152 "expires_at": 1677614202,

153 "filename": "salesOverview.pdf",153 "filename": "salesOverview.pdf",

154 "purpose": "assistants"154 "purpose": "assistants",

155 "status": "processed"

155 },156 },

156 {157 {

157 "id": "file-abc456",158 "id": "file-abc456",

160 "created_at": 1613779121,161 "created_at": 1613779121,

161 "expires_at": 1677614202,162 "expires_at": 1677614202,

162 "filename": "puppy.jsonl",163 "filename": "puppy.jsonl",

163 "purpose": "fine-tune"164 "purpose": "fine-tune",

165 "status": "processed"

164 }166 }

165 ],167 ],

166 "first_id": "file-abc123",168 "first_id": "file-abc123",

114 "object": "file",114 "object": "file",

115 "bytes": 120000,115 "bytes": 120000,

116 "created_at": 1677610602,116 "created_at": 1677610602,

117 "expires_at": 1677614202,117 "expires_at": 1680202602,

118 "filename": "mydata.jsonl",118 "filename": "mydata.jsonl",

119 "purpose": "fine-tune"119 "purpose": "fine-tune",

120 "status": "processed"

120}121}

121```122```

32 32 

33 The Unix timestamp (in seconds) for when the fine-tuning job was created.33 The Unix timestamp (in seconds) for when the fine-tuning job was created.

34 34 

35 - `error: object { code, message, param } or null`35 - `error: object { code, message, param } or unknown or null`

36 

37 For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure.

38 

39 - `object { code, message, param }`

36 40 

37 For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure.41 For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure.

38 42 

48 52 

49 The parameter that was invalid, usually `training_file` or `validation_file`. This field will be null if the failure was not parameter-specific.53 The parameter that was invalid, usually `training_file` or `validation_file`. This field will be null if the failure was not parameter-specific.

50 54 

55 - `unknown`

56 

51 - `fine_tuned_model: string or null`57 - `fine_tuned_model: string or null`

52 58 

53 The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.59 The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running.

56 62 

57 The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.63 The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running.

58 64 

59 - `hyperparameters: object { batch_size, learning_rate_multiplier, n_epochs }`

60 

61 The hyperparameters used for the fine-tuning job. This value will only be returned when running `supervised` jobs.

62 

63 - `batch_size: optional "auto" or number or null`

64 

65 Number of examples in each batch. A larger batch size means that model parameters

66 are updated less frequently, but with lower variance.

67 

68 - `"auto"`

69 

70 - `"auto"`

71 

72 - `number`

73 

74 - `learning_rate_multiplier: optional "auto" or number`

75 

76 Scaling factor for the learning rate. A smaller learning rate may be useful to avoid

77 overfitting.

78 

79 - `"auto"`

80 

81 - `"auto"`

82 

83 - `number`

84 

85 - `n_epochs: optional "auto" or number`

86 

87 The number of epochs to train the model for. An epoch refers to one full cycle

88 through the training dataset.

89 

90 - `"auto"`

91 

92 - `"auto"`

93 

94 - `number`

95 

96 - `model: string`65 - `model: string`

97 66 

98 The base model that is being fine-tuned.67 The base model that is being fine-tuned.

111 80 

112 The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](/api/reference/resources/files/methods/content).81 The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](/api/reference/resources/files/methods/content).

113 82 

114 - `seed: number`83 - `seed: number or null`

115 84 

116 The seed used for the fine-tuning job.85 The seed used for the fine-tuning job.

117 86 

118 - `status: "validating_files" or "queued" or "running" or 3 more`87 - `status: "validating_files" or "queued" or "running" or 5 more`

119 88 

120 The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`.89 The current status of the fine-tuning job, which can be `validating_files`, `queued`, `running`, `pausing`, `paused`, `succeeded`, `failed`, or `cancelled`.

121 90 

122 - `"validating_files"`91 - `"validating_files"`

123 92 

131 100 

132 - `"cancelled"`101 - `"cancelled"`

133 102 

103 - `"pausing"`

104 

105 - `"paused"`

106 

134 - `trained_tokens: number or null`107 - `trained_tokens: number or null`

135 108 

136 The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.109 The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running.

147 120 

148 The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.121 The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running.

149 122 

123 - `hyperparameters: optional object { batch_size, learning_rate_multiplier, n_epochs } or null`

124 

125 The hyperparameters used for the fine-tuning job. This value will only be returned when running `supervised` jobs.

126 

127 - `batch_size: optional "auto" or number or null`

128 

129 Number of examples in each batch. A larger batch size means that model parameters

130 are updated less frequently, but with lower variance.

131 

132 - `"auto"`

133 

134 - `"auto"`

135 

136 - `number`

137 

138 - `learning_rate_multiplier: optional "auto" or number`

139 

140 Scaling factor for the learning rate. A smaller learning rate may be useful to avoid

141 overfitting.

142 

143 - `"auto"`

144 

145 - `"auto"`

146 

147 - `number`

148 

149 - `n_epochs: optional "auto" or number`

150 

151 The number of epochs to train the model for. An epoch refers to one full cycle

152 through the training dataset.

153 

154 - `"auto"`

155 

156 - `"auto"`

157 

158 - `number`

159 

150 - `integrations: optional array of FineTuningJobWandbIntegrationObject or null`160 - `integrations: optional array of FineTuningJobWandbIntegrationObject or null`

151 161 

152 A list of integrations to enable for this fine-tuning job.162 A list of integrations to enable for this fine-tuning job.

190 Keys are strings with a maximum length of 64 characters. Values are strings200 Keys are strings with a maximum length of 64 characters. Values are strings

191 with a maximum length of 512 characters.201 with a maximum length of 512 characters.

192 202 

193 - `method: optional object { type, dpo, reinforcement, supervised }`203 - `method: optional object { type, dpo, reinforcement, supervised } or null`

194 204 

195 The method used for fine-tuning.205 The method used for fine-tuning.

196 206 

874 },884 },

875 "fine_tuned_model": "fine_tuned_model",885 "fine_tuned_model": "fine_tuned_model",

876 "finished_at": 0,886 "finished_at": 0,

877 "hyperparameters": {

878 "batch_size": "auto",

879 "learning_rate_multiplier": "auto",

880 "n_epochs": "auto"

881 },

882 "model": "model",887 "model": "model",

883 "object": "fine_tuning.job",888 "object": "fine_tuning.job",

884 "organization_id": "organization_id",889 "organization_id": "organization_id",

891 "training_file": "training_file",896 "training_file": "training_file",

892 "validation_file": "validation_file",897 "validation_file": "validation_file",

893 "estimated_finish": 0,898 "estimated_finish": 0,

899 "hyperparameters": {

900 "batch_size": "auto",

901 "learning_rate_multiplier": "auto",

902 "n_epochs": "auto"

903 },

894 "integrations": [904 "integrations": [

895 {905 {

896 "type": "wandb",906 "type": "wandb",

953### Example963### Example

954 964 

955```http965```http

956curl https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value \966curl "https://api.openai.com/v1/fine_tuning/jobs?limit=2&metadata[key]=value" \

957 -H "Authorization: Bearer $OPENAI_API_KEY"967 -H "Authorization: Bearer $OPENAI_API_KEY"

958```968```

959 969 

974 "status": "queued",984 "status": "queued",

975 "validation_file": null,985 "validation_file": null,

976 "training_file": "file-abc123",986 "training_file": "file-abc123",

987 "error": null,

988 "finished_at": null,

989 "trained_tokens": null,

990 "seed": 42,

991 "hyperparameters": {

992 "batch_size": "auto",

993 "learning_rate_multiplier": "auto",

994 "n_epochs": "auto"

995 },

996 "method": {

997 "type": "supervised",

998 "supervised": {

999 "hyperparameters": {

1000 "batch_size": "auto",

1001 "learning_rate_multiplier": "auto",

1002 "n_epochs": "auto"

1003 }

1004 }

1005 },

977 "metadata": {1006 "metadata": {

978 "key": "value"1007 "key": "value"

979 }1008 }

980 },1009 }

981 { ... },1010 ],

982 { ... }1011 "has_more": false

983 ], "has_more": true

984}1012}

985```1013```

1016 1016 

1017 - `index: number`1017 - `index: number`

1018 1018 

1019 The index of the file in the list of files.1019 The index in the output text at which to insert the file citation.

1020 1020 

1021 - `type: "file_citation"`1021 - `type: "file_citation"`

1022 1022 

1584 1584 

1585 - `"incomplete"`1585 - `"incomplete"`

1586 1586 

1587 - `WebSearchCall object { id, action, status, type }`1587 - `WebSearchCall object { id, status, type, action }`

1588 1588 

1589 The results of a web search tool call. See the1589 The results of a web search tool call. See the

1590 [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.1590 [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.

1593 1593 

1594 The unique ID of the web search tool call.1594 The unique ID of the web search tool call.

1595 1595 

1596 - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`1596 - `status: "in_progress" or "searching" or "completed" or 2 more`

1597 

1598 The status of the web search tool call.

1599 

1600 - `"in_progress"`

1601 

1602 - `"searching"`

1603 

1604 - `"completed"`

1605 

1606 - `"failed"`

1607 

1608 - `"incomplete"`

1609 

1610 - `type: "web_search_call"`

1611 

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

1613 

1614 - `"web_search_call"`

1615 

1616 - `action: optional object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`

1597 1617 

1598 An object describing the specific action taken in this web search call.1618 An object describing the specific action taken in this web search call.

1599 Includes details on how the model used the web (search, open_page, find_in_page).1619 Includes details on how the model used the web (search, open_page, find_in_page).

1662 1682 

1663 The URL of the page searched for the pattern.1683 The URL of the page searched for the pattern.

1664 1684 

1665 - `status: "in_progress" or "searching" or "completed" or 2 more`

1666 

1667 The status of the web search tool call.

1668 

1669 - `"in_progress"`

1670 

1671 - `"searching"`

1672 

1673 - `"completed"`

1674 

1675 - `"failed"`

1676 

1677 - `"incomplete"`

1678 

1679 - `type: "web_search_call"`

1680 

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

1682 

1683 - `"web_search_call"`

1684 

1685 - `FunctionCall object { arguments, call_id, name, 6 more }`1685 - `FunctionCall object { arguments, call_id, name, 6 more }`

1686 1686 

1687 A tool call to run a function. See the1687 A tool call to run a function. See the

2085 2085 

2086 Combine multiple filters using `and` or `or`.2086 Combine multiple filters using `and` or `or`.

2087 2087 

2088 - `filters: array of ComparisonFilter or unknown`2088 - `filters: array of ComparisonFilter or CompoundFilter`

2089 2089 

2090 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.2090 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

2091 2091 

2093 2093 

2094 A filter used to compare a specified attribute key to a given value using a defined comparison operation.2094 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

2095 2095 

2096 - `unknown`2096 - `CompoundFilter object { filters, type }`

2097 

2098 Combine multiple filters using `and` or `or`.

2097 2099 

2098 - `type: "and" or "or"`2100 - `type: "and" or "or"`

2099 2101 

7590 7592 

7591### transport.dtmf.send7593### transport.dtmf.send

7592 7594 

7593A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to sideband observers; this is not a client command.7595A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.

7594 7596 

7595#### Schema7597#### Schema

7596 7598 

7604 7606 

7605 - `"transport.dtmf.send"`7607 - `"transport.dtmf.send"`

7606 7608 

7609- `client_event_id: optional string`

7610 

7611 The event_id of the client command, when supplied.

7612 

7607#### Example7613#### Example

7608 7614 

7609```json7615```json

1286 1286 

1287 - `index: number`1287 - `index: number`

1288 1288 

1289 The index of the file in the list of files.1289 The index in the output text at which to insert the file citation.

1290 1290 

1291 - `type: "file_citation"`1291 - `type: "file_citation"`

1292 1292 

1854 1854 

1855 - `"incomplete"`1855 - `"incomplete"`

1856 1856 

1857 - `WebSearchCall object { id, action, status, type }`1857 - `WebSearchCall object { id, status, type, action }`

1858 1858 

1859 The results of a web search tool call. See the1859 The results of a web search tool call. See the

1860 [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.1860 [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.

1863 1863 

1864 The unique ID of the web search tool call.1864 The unique ID of the web search tool call.

1865 1865 

1866 - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`1866 - `status: "in_progress" or "searching" or "completed" or 2 more`

1867 

1868 The status of the web search tool call.

1869 

1870 - `"in_progress"`

1871 

1872 - `"searching"`

1873 

1874 - `"completed"`

1875 

1876 - `"failed"`

1877 

1878 - `"incomplete"`

1879 

1880 - `type: "web_search_call"`

1881 

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

1883 

1884 - `"web_search_call"`

1885 

1886 - `action: optional object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`

1867 1887 

1868 An object describing the specific action taken in this web search call.1888 An object describing the specific action taken in this web search call.

1869 Includes details on how the model used the web (search, open_page, find_in_page).1889 Includes details on how the model used the web (search, open_page, find_in_page).

1932 1952 

1933 The URL of the page searched for the pattern.1953 The URL of the page searched for the pattern.

1934 1954 

1935 - `status: "in_progress" or "searching" or "completed" or 2 more`

1936 

1937 The status of the web search tool call.

1938 

1939 - `"in_progress"`

1940 

1941 - `"searching"`

1942 

1943 - `"completed"`

1944 

1945 - `"failed"`

1946 

1947 - `"incomplete"`

1948 

1949 - `type: "web_search_call"`

1950 

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

1952 

1953 - `"web_search_call"`

1954 

1955 - `FunctionCall object { arguments, call_id, name, 6 more }`1955 - `FunctionCall object { arguments, call_id, name, 6 more }`

1956 1956 

1957 A tool call to run a function. See the1957 A tool call to run a function. See the

2355 2355 

2356 Combine multiple filters using `and` or `or`.2356 Combine multiple filters using `and` or `or`.

2357 2357 

2358 - `filters: array of ComparisonFilter or unknown`2358 - `filters: array of ComparisonFilter or CompoundFilter`

2359 2359 

2360 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.2360 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

2361 2361 

2363 2363 

2364 A filter used to compare a specified attribute key to a given value using a defined comparison operation.2364 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

2365 2365 

2366 - `unknown`2366 - `CompoundFilter object { filters, type }`

2367 

2368 Combine multiple filters using `and` or `or`.

2367 2369 

2368 - `type: "and" or "or"`2370 - `type: "and" or "or"`

2369 2371 

7860 7862 

7861### transport.dtmf.send7863### transport.dtmf.send

7862 7864 

7863A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to sideband observers; this is not a client command.7865A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.

7864 7866 

7865#### Schema7867#### Schema

7866 7868 

7874 7876 

7875 - `"transport.dtmf.send"`7877 - `"transport.dtmf.send"`

7876 7878 

7879- `client_event_id: optional string`

7880 

7881 The event_id of the client command, when supplied.

7882 

7877#### Example7883#### Example

7878 7884 

7879```json7885```json

705 705 

706 - `index: number`706 - `index: number`

707 707 

708 The index of the file in the list of files.708 The index in the output text at which to insert the file citation.

709 709 

710 - `type: "file_citation"`710 - `type: "file_citation"`

711 711 

1273 1273 

1274 - `"incomplete"`1274 - `"incomplete"`

1275 1275 

1276 - `WebSearchCall object { id, action, status, type }`1276 - `WebSearchCall object { id, status, type, action }`

1277 1277 

1278 The results of a web search tool call. See the1278 The results of a web search tool call. See the

1279 [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.1279 [web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information.

1282 1282 

1283 The unique ID of the web search tool call.1283 The unique ID of the web search tool call.

1284 1284 

1285 - `action: object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`1285 - `status: "in_progress" or "searching" or "completed" or 2 more`

1286 

1287 The status of the web search tool call.

1288 

1289 - `"in_progress"`

1290 

1291 - `"searching"`

1292 

1293 - `"completed"`

1294 

1295 - `"failed"`

1296 

1297 - `"incomplete"`

1298 

1299 - `type: "web_search_call"`

1300 

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

1302 

1303 - `"web_search_call"`

1304 

1305 - `action: optional object { type, queries, query, sources } or object { type, url } or object { pattern, type, url }`

1286 1306 

1287 An object describing the specific action taken in this web search call.1307 An object describing the specific action taken in this web search call.

1288 Includes details on how the model used the web (search, open_page, find_in_page).1308 Includes details on how the model used the web (search, open_page, find_in_page).

1351 1371 

1352 The URL of the page searched for the pattern.1372 The URL of the page searched for the pattern.

1353 1373 

1354 - `status: "in_progress" or "searching" or "completed" or 2 more`

1355 

1356 The status of the web search tool call.

1357 

1358 - `"in_progress"`

1359 

1360 - `"searching"`

1361 

1362 - `"completed"`

1363 

1364 - `"failed"`

1365 

1366 - `"incomplete"`

1367 

1368 - `type: "web_search_call"`

1369 

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

1371 

1372 - `"web_search_call"`

1373 

1374 - `FunctionCall object { arguments, call_id, name, 6 more }`1374 - `FunctionCall object { arguments, call_id, name, 6 more }`

1375 1375 

1376 A tool call to run a function. See the1376 A tool call to run a function. See the

1774 1774 

1775 Combine multiple filters using `and` or `or`.1775 Combine multiple filters using `and` or `or`.

1776 1776 

1777 - `filters: array of ComparisonFilter or unknown`1777 - `filters: array of ComparisonFilter or CompoundFilter`

1778 1778 

1779 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.1779 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.

1780 1780 

1782 1782 

1783 A filter used to compare a specified attribute key to a given value using a defined comparison operation.1783 A filter used to compare a specified attribute key to a given value using a defined comparison operation.

1784 1784 

1785 - `unknown`1785 - `CompoundFilter object { filters, type }`

1786 

1787 Combine multiple filters using `and` or `or`.

1786 1788 

1787 - `type: "and" or "or"`1789 - `type: "and" or "or"`

1788 1790 

7279 7281 

7280### transport.dtmf.send7282### transport.dtmf.send

7281 7283 

7282A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to sideband observers; this is not a client command.7284A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to sideband observers; this is not a client command.

7283 7285 

7284#### Schema7286#### Schema

7285 7287 

7293 7295 

7294 - `"transport.dtmf.send"`7296 - `"transport.dtmf.send"`

7295 7297 

7298- `client_event_id: optional string`

7299 

7300 The event_id of the client command, when supplied.

7301 

7296#### Example7302#### Example

7297 7303 

7298```json7304```json

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

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

517 -d '{517 -d '{

518 "model": "omni-moderation-latest",

518 "input": "I want to kill them."519 "input": "I want to kill them."

519 }'520 }'

520```521```

524```json525```json

525{526{

526 "id": "modr-AB8CjOTu2jiq12hp1AQPfeqFWaORR",527 "id": "modr-AB8CjOTu2jiq12hp1AQPfeqFWaORR",

527 "model": "text-moderation-007",528 "model": "omni-moderation-latest",

528 "results": [529 "results": [

529 {530 {

530 "flagged": true,531 "flagged": true,

539 "self-harm/intent": false,540 "self-harm/intent": false,

540 "self-harm/instructions": false,541 "self-harm/instructions": false,

541 "harassment/threatening": true,542 "harassment/threatening": true,

542 "violence": true543 "violence": true,

544 "illicit": false,

545 "illicit/violent": false

543 },546 },

544 "category_scores": {547 "category_scores": {

545 "sexual": 0.000011726012417057063,548 "sexual": 1.1726012417057063e-05,

546 "hate": 0.22706663608551025,549 "hate": 0.22706663608551025,

547 "harassment": 0.5215635299682617,550 "harassment": 0.5215635299682617,

548 "self-harm": 2.227119921371923e-6,551 "self-harm": 2.227119921371923e-06,

549 "sexual/minors": 7.107352217872176e-8,552 "sexual/minors": 7.107352217872176e-08,

550 "hate/threatening": 0.023547329008579254,553 "hate/threatening": 0.023547329008579254,

551 "violence/graphic": 0.00003391829886822961,554 "violence/graphic": 3.391829886822961e-05,

552 "self-harm/intent": 1.646940972932498e-6,555 "self-harm/intent": 1.646940972932498e-06,

553 "self-harm/instructions": 1.1198755256458526e-9,556 "self-harm/instructions": 1.1198755256458526e-09,

554 "harassment/threatening": 0.5694745779037476,557 "harassment/threatening": 0.5694745779037476,

555 "violence": 0.9971134662628174558 "violence": 0.9971134662628174,

559 "illicit": 0.001,

560 "illicit/violent": 0.001

561 },

562 "category_applied_input_types": {

563 "sexual": [

564 "text"

565 ],

566 "hate": [

567 "text"