Python 88.3%
TypeScript 7.6%
Shell 4.1%
1{2 "domain": "openai-agents-platform",3 "generated_at": "2026-09-18T00:00:00Z",4 "count": 81,5 "records": [6 {7 "provider": "openai",8 "api_family": "agents-platform/agents",9 "name": "Agent (saved, reusable agent definition)",10 "object": "agent",11 "schema_name": "AgentResource",12 "description": "A reusable agent scoped to the caller's project.",13 "fields": [14 {15 "name": "id",16 "type": "string",17 "required": true,18 "description": "The ID of the reusable agent."19 },20 {21 "name": "object",22 "type": "string",23 "required": true,24 "description": "The object type. Always `agent`."25 },26 {27 "name": "created_at",28 "type": "integer",29 "required": true,30 "description": "The Unix timestamp, in seconds, when the agent was created."31 },32 {33 "name": "updated_at",34 "type": "integer",35 "required": true,36 "description": "The Unix timestamp, in seconds, when the agent was last updated."37 },38 {39 "name": "name",40 "type": "string | null",41 "required": true,42 "description": "A human-readable name for the agent, or null if it is unnamed."43 },44 {45 "name": "metadata",46 "type": "object",47 "required": true,48 "description": "Custom string key-value pairs attached to the agent."49 },50 {51 "name": "model",52 "type": "string",53 "required": true,54 "description": "The requested model name used for inference."55 },56 {57 "name": "reasoning",58 "type": "ReasoningResource",59 "required": true,60 "description": "The resolved reasoning configuration, including the model default for an omitted effort."61 },62 {63 "name": "text",64 "type": "TextResource",65 "required": true,66 "description": "The resolved configuration for text generated by the agent."67 },68 {69 "name": "service_tier",70 "type": "ServiceTierResource",71 "required": true,72 "description": "The resolved service-tier policy used for model requests.",73 "enum": [74 "auto",75 "default",76 "flex",77 "priority",78 "fast"79 ]80 },81 {82 "name": "instructions",83 "type": "string | null",84 "required": true,85 "description": "Custom instructions appended to the agent's default base instructions."86 },87 {88 "name": "tools",89 "type": "array<PersistedAgentToolResource>",90 "required": true,91 "description": "Tools available to the agent."92 },93 {94 "name": "multi_agent",95 "type": "MultiAgentConfigResource",96 "required": true,97 "description": "The resolved configuration for creating and coordinating subagents."98 }99 ],100 "status": [101 "DOCUMENTED",102 "BETA",103 "LIVE_VERIFIED"104 ],105 "example": {106 "id": "agent_f0363c606b6e418287a352178f20c141750d483e3399419c99",107 "object": "agent",108 "created_at": 1789782093,109 "updated_at": 1789782093,110 "name": "atlas-probe",111 "metadata": {112 "atlas": "probe"113 },114 "model": "gpt-5.6-luna",115 "reasoning": {116 "effort": "medium",117 "summary": null118 },119 "text": {120 "format": {121 "type": "text"122 },123 "verbosity": "medium"124 },125 "service_tier": "auto",126 "instructions": "Reply with OK.",127 "tools": [],128 "multi_agent": {129 "enabled": false,130 "max_concurrent_subagents": null131 }132 },133 "example_source": "live 2026-09-18",134 "sources": [135 {136 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",137 "retrieved_at": "2026-09-18T00:00:00Z"138 },139 {140 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",141 "retrieved_at": "2026-09-18T00:00:00Z"142 }143 ]144 },145 {146 "provider": "openai",147 "api_family": "agents-platform/agents",148 "name": "DeletedAgentResource",149 "object": "agent.deleted",150 "schema_name": "DeletedAgentResource",151 "description": "A deleted reusable agent.",152 "fields": [153 {154 "name": "id",155 "type": "string",156 "required": true,157 "description": "The ID of the deleted agent."158 },159 {160 "name": "object",161 "type": "string",162 "required": true,163 "description": "The object type. Always `agent.deleted`."164 },165 {166 "name": "deleted",167 "type": "boolean",168 "required": true,169 "description": "Whether the agent was deleted. Always `true`."170 }171 ],172 "status": [173 "DOCUMENTED",174 "BETA",175 "LIVE_VERIFIED"176 ],177 "example": {178 "id": "agent_f0363c606b6e418287a352178f20c141750d483e3399419c99",179 "object": "agent.deleted",180 "deleted": true181 },182 "example_source": "live 2026-09-18",183 "sources": [184 {185 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",186 "retrieved_at": "2026-09-18T00:00:00Z"187 },188 {189 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",190 "retrieved_at": "2026-09-18T00:00:00Z"191 }192 ]193 },194 {195 "provider": "openai",196 "api_family": "agents-platform/agents",197 "name": "Session",198 "object": "agent.session",199 "schema_name": "SessionResource",200 "description": "A Managed Agents session.",201 "fields": [202 {203 "name": "metadata",204 "type": "object",205 "required": true,206 "description": "Custom string key-value pairs attached to the session."207 },208 {209 "name": "id",210 "type": "string",211 "required": true,212 "description": "The ID of the session."213 },214 {215 "name": "object",216 "type": "string",217 "required": true,218 "description": "The object type. Always `agent.session`."219 },220 {221 "name": "created_at",222 "type": "integer",223 "required": true,224 "description": "The Unix timestamp, in seconds, when the session was created."225 },226 {227 "name": "last_active_at",228 "type": "integer",229 "required": true,230 "description": "The Unix timestamp, in seconds, when the session was last active."231 },232 {233 "name": "status",234 "type": "SessionStatusResource",235 "required": true,236 "description": "The current status of the session.",237 "enum": [238 "idle",239 "in_progress",240 "requires_action",241 "failed"242 ]243 },244 {245 "name": "required_actions",246 "type": "array<SessionRequiredActionResource>",247 "required": true,248 "description": "Actions that must be completed before the session can continue."249 },250 {251 "name": "error",252 "type": "string | null",253 "required": true,254 "description": "The error that caused the session to fail, if any."255 },256 {257 "name": "agent",258 "type": "SessionAgentResource",259 "required": true,260 "description": "The agent running in the session."261 },262 {263 "name": "environment",264 "type": "EnvironmentResource",265 "required": true,266 "description": "The execution environment for the session."267 },268 {269 "name": "vault_ids",270 "type": "array<string>",271 "required": true,272 "description": "The IDs of vaults made available to the session."273 },274 {275 "name": "usage",276 "type": "TokenUsageResource | null",277 "required": true,278 "description": "Best-effort token usage for the session, or null if unknown. Recorded usage may change."279 }280 ],281 "status": [282 "DOCUMENTED",283 "BETA",284 "LIVE_VERIFIED"285 ],286 "example": {287 "metadata": {288 "atlas": "probe"289 },290 "id": "sess_0b52151131840c7d006aade89b61c88195a75804fb31b33990",291 "object": "agent.session",292 "created_at": 1789782171,293 "last_active_at": 1789782171,294 "status": "idle",295 "required_actions": [],296 "error": null,297 "agent": {298 "id": "agent_f0363c606b6e418287a352178f20c141750d483e3399419c99",299 "name": "atlas-probe",300 "model": "gpt-5.6-luna",301 "reasoning": {302 "effort": "medium",303 "summary": null304 },305 "text": {306 "format": {307 "type": "text"308 },309 "verbosity": "medium"310 },311 "service_tier": "auto",312 "instructions": "Reply with OK.",313 "tools": [],314 "multi_agent": {315 "enabled": false,316 "max_concurrent_subagents": null317 }318 },319 "environment": {320 "type": "none"321 },322 "vault_ids": [],323 "usage": null324 },325 "example_source": "live 2026-09-18",326 "sources": [327 {328 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",329 "retrieved_at": "2026-09-18T00:00:00Z"330 },331 {332 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",333 "retrieved_at": "2026-09-18T00:00:00Z"334 }335 ]336 },337 {338 "provider": "openai",339 "api_family": "agents-platform/agents",340 "name": "DeletedSessionResource",341 "object": "agent.session.deleted",342 "schema_name": "DeletedSessionResource",343 "description": "A Managed Agents session removed from the public API. Physical cleanup may continue asynchronously.",344 "fields": [345 {346 "name": "id",347 "type": "string",348 "required": true,349 "description": "The ID of the deleted session."350 },351 {352 "name": "object",353 "type": "string",354 "required": true,355 "description": "The object type. Always `agent.session.deleted`."356 },357 {358 "name": "deleted",359 "type": "boolean",360 "required": true,361 "description": "Whether the session has been removed from the public API. Always `true`. Physical cleanup may still be in progress."362 }363 ],364 "status": [365 "DOCUMENTED",366 "BETA",367 "LIVE_VERIFIED"368 ],369 "example": {370 "id": "sess_0b52151131840c7d006aade89b61c88195a75804fb31b33990",371 "object": "agent.session.deleted",372 "deleted": true373 },374 "example_source": "live 2026-09-18",375 "sources": [376 {377 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",378 "retrieved_at": "2026-09-18T00:00:00Z"379 },380 {381 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",382 "retrieved_at": "2026-09-18T00:00:00Z"383 }384 ]385 },386 {387 "provider": "openai",388 "api_family": "agents-platform/agents",389 "name": "Turn",390 "object": "agent.session.turn",391 "schema_name": "TurnResource",392 "description": "The canonical public representation of a session turn.",393 "fields": [394 {395 "name": "id",396 "type": "string",397 "required": true,398 "description": "The ID of the turn."399 },400 {401 "name": "object",402 "type": "TurnObjectResource",403 "required": true,404 "description": "The object type. Always `agent.session.turn`."405 },406 {407 "name": "session_id",408 "type": "string",409 "required": true,410 "description": "The ID of the session that owns the turn."411 },412 {413 "name": "agent_id",414 "type": "string",415 "required": true,416 "description": "The ID of the agent that ran the turn."417 },418 {419 "name": "subagent_id",420 "type": "string | null",421 "required": true,422 "description": "The ID of the subagent that ran the turn, if applicable."423 },424 {425 "name": "status",426 "type": "TurnStatusResource",427 "required": true,428 "description": "The current status of the turn.",429 "enum": [430 "queued",431 "in_progress",432 "waiting",433 "completed",434 "failed",435 "cancelled"436 ]437 },438 {439 "name": "created_at",440 "type": "integer",441 "required": true,442 "description": "The Unix timestamp, in seconds, used to order the turn by creation time. Subagent turns use their start time, falling back to completion time or the subagent opening time when the preceding timestamps are unavailable."443 },444 {445 "name": "started_at",446 "type": "integer | null",447 "required": true,448 "description": "The Unix timestamp, in seconds, when the turn started."449 },450 {451 "name": "completed_at",452 "type": "integer | null",453 "required": true,454 "description": "The Unix timestamp, in seconds, when the turn reached a terminal state."455 },456 {457 "name": "error",458 "type": "SessionTurnErrorResource | null",459 "required": true,460 "description": "A customer-safe error. Non-null only for a failed turn."461 },462 {463 "name": "usage",464 "type": "TokenUsageResource | null",465 "required": true,466 "description": "Best-effort token usage for the turn, or null if unknown. Recorded usage may change."467 }468 ],469 "status": [470 "DOCUMENTED",471 "BETA",472 "LIVE_VERIFIED"473 ],474 "example": {475 "id": "turn_0b52151131840c7d006aade8a3114c8195b6286aaca0730297",476 "object": "agent.session.turn",477 "session_id": "sess_0b52151131840c7d006aade89b61c88195a75804fb31b33990",478 "agent_id": "agent_f0363c606b6e418287a352178f20c141750d483e3399419c99",479 "subagent_id": null,480 "status": "completed",481 "created_at": 1789782177,482 "started_at": 1789782177,483 "completed_at": 1789782179,484 "error": null,485 "usage": {486 "input_tokens": 6087,487 "input_tokens_details": {488 "cached_tokens": 0489 },490 "output_tokens": 6,491 "output_tokens_details": {492 "reasoning_tokens": 0493 },494 "total_tokens": 6093495 }496 },497 "example_source": "live 2026-09-18",498 "sources": [499 {500 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",501 "retrieved_at": "2026-09-18T00:00:00Z"502 },503 {504 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",505 "retrieved_at": "2026-09-18T00:00:00Z"506 }507 ]508 },509 {510 "provider": "openai",511 "api_family": "agents-platform/agents",512 "name": "Subagent",513 "object": "agent.session.subagent",514 "schema_name": "SubagentResource",515 "description": "A subagent created within a session.",516 "fields": [517 {518 "name": "id",519 "type": "string",520 "required": true,521 "description": "The ID of the subagent."522 },523 {524 "name": "object",525 "type": "SubagentObjectResource",526 "required": true,527 "description": "The object type. Always `agent.session.subagent`."528 },529 {530 "name": "session_id",531 "type": "string",532 "required": true,533 "description": "The ID of the session that owns the subagent."534 },535 {536 "name": "name",537 "type": "string | null",538 "required": true,539 "description": "The runner-assigned nickname, or null when unavailable."540 },541 {542 "name": "instructions",543 "type": "array | null",544 "required": true,545 "description": "Initial task content, or null when unavailable. Text may contain placeholders for images or audio when only a preview is available."546 },547 {548 "name": "parent_agent_id",549 "type": "string",550 "required": true,551 "description": "The ID of the agent that created this subagent."552 },553 {554 "name": "status",555 "type": "SubagentStatusResource",556 "required": true,557 "description": "The current status of the subagent.",558 "enum": [559 "active",560 "closed"561 ]562 },563 {564 "name": "opened_at",565 "type": "integer",566 "required": true,567 "description": "The Unix timestamp, in seconds, when the subagent was first opened. Resuming does not change it."568 },569 {570 "name": "closed_at",571 "type": "integer | null",572 "required": true,573 "description": "The Unix timestamp, in seconds, when the subagent was closed. Null while active, including after resume."574 }575 ],576 "status": [577 "DOCUMENTED",578 "BETA"579 ],580 "example": null,581 "example_source": null,582 "sources": [583 {584 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",585 "retrieved_at": "2026-09-18T00:00:00Z"586 },587 {588 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",589 "retrieved_at": "2026-09-18T00:00:00Z"590 }591 ]592 },593 {594 "provider": "openai",595 "api_family": "agents-platform/agents",596 "name": "Artifact",597 "object": "agent.session.artifact",598 "schema_name": "SessionArtifactResource",599 "description": "An immutable file published by a completed hosted session turn.",600 "fields": [601 {602 "name": "id",603 "type": "string",604 "required": true,605 "description": "The immutable artifact ID."606 },607 {608 "name": "object",609 "type": "string",610 "required": true,611 "description": "The object type. Always `agent.session.artifact`."612 },613 {614 "name": "session_id",615 "type": "string",616 "required": true,617 "description": "The ID of the session that owns the artifact."618 },619 {620 "name": "environment_id",621 "type": "string",622 "required": true,623 "description": "The ID of the environment that produced the artifact."624 },625 {626 "name": "turn_id",627 "type": "string",628 "required": true,629 "description": "The ID of the completed turn that published the artifact."630 },631 {632 "name": "path",633 "type": "string",634 "required": true,635 "description": "The original absolute file path in the execution environment."636 },637 {638 "name": "size_bytes",639 "type": "integer",640 "required": true,641 "description": "The immutable artifact size in bytes."642 },643 {644 "name": "created_at",645 "type": "integer",646 "required": true,647 "description": "The Unix timestamp, in seconds, when the artifact was published."648 }649 ],650 "status": [651 "DOCUMENTED",652 "BETA"653 ],654 "example": null,655 "example_source": null,656 "sources": [657 {658 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",659 "retrieved_at": "2026-09-18T00:00:00Z"660 },661 {662 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",663 "retrieved_at": "2026-09-18T00:00:00Z"664 }665 ]666 },667 {668 "provider": "openai",669 "api_family": "agents-platform/agents",670 "name": "DeletedSessionArtifactResource",671 "object": "agent.session.artifact.deleted",672 "schema_name": "DeletedSessionArtifactResource",673 "description": "Confirmation that an immutable session artifact was deleted.",674 "fields": [675 {676 "name": "id",677 "type": "string",678 "required": true,679 "description": "The ID of the deleted session artifact."680 },681 {682 "name": "object",683 "type": "string",684 "required": true,685 "description": "The object type. Always `agent.session.artifact.deleted`."686 },687 {688 "name": "deleted",689 "type": "boolean",690 "required": true,691 "description": "Whether the session artifact was deleted. Always `true`."692 }693 ],694 "status": [695 "DOCUMENTED",696 "BETA"697 ],698 "example": null,699 "example_source": null,700 "sources": [701 {702 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",703 "retrieved_at": "2026-09-18T00:00:00Z"704 },705 {706 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",707 "retrieved_at": "2026-09-18T00:00:00Z"708 }709 ]710 },711 {712 "provider": "openai",713 "api_family": "agents-platform/agents",714 "name": "Environment (live execution environment)",715 "object": "agent.environment",716 "schema_name": "PublicEnvironmentResource",717 "description": "Safe metadata for a first-class execution environment.",718 "fields": [719 {720 "name": "id",721 "type": "string",722 "required": true,723 "description": "The ID of the environment."724 },725 {726 "name": "object",727 "type": "string",728 "required": true,729 "description": "The object type. Always `agent.environment`."730 },731 {732 "name": "type",733 "type": "EnvironmentTypeResource",734 "required": true,735 "description": "Whether the environment is hosted by OpenAI or by the application.",736 "enum": [737 "openai_hosted",738 "self_hosted"739 ],740 "const": "openai_hosted"741 },742 {743 "name": "status",744 "type": "EnvironmentStatusResource",745 "required": true,746 "description": "The current environment connection status.",747 "enum": [748 "pending",749 "connected",750 "disconnected",751 "expired",752 "failed"753 ]754 },755 {756 "name": "files",757 "type": "array<HostedEnvironmentFileResource>",758 "required": true,759 "description": "Files installed in the environment, without their contents."760 },761 {762 "name": "skills",763 "type": "array<HostedSkillResource>",764 "required": true,765 "description": "Skills installed in the environment, without their archive contents."766 },767 {768 "name": "plugins",769 "type": "array<HostedPluginResource>",770 "required": true,771 "description": "Plugins installed in the environment, without their archive contents."772 }773 ],774 "status": [775 "DOCUMENTED",776 "BETA"777 ],778 "example": null,779 "example_source": null,780 "sources": [781 {782 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",783 "retrieved_at": "2026-09-18T00:00:00Z"784 },785 {786 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",787 "retrieved_at": "2026-09-18T00:00:00Z"788 }789 ]790 },791 {792 "provider": "openai",793 "api_family": "agents-platform/agents",794 "name": "Environment file",795 "object": "agent.environment.file",796 "schema_name": "EnvironmentFileResource",797 "description": "A live file in an execution environment.",798 "fields": [799 {800 "name": "object",801 "type": "string",802 "required": true,803 "description": "The object type. Always `agent.environment.file`."804 },805 {806 "name": "environment_id",807 "type": "string",808 "required": true,809 "description": "The ID of the environment containing this file."810 },811 {812 "name": "path",813 "type": "string",814 "required": true,815 "description": "The absolute file path inside the environment's workspace."816 },817 {818 "name": "size_bytes",819 "type": "integer",820 "required": true,821 "description": "The file size in bytes."822 }823 ],824 "status": [825 "DOCUMENTED",826 "BETA"827 ],828 "example": null,829 "example_source": null,830 "sources": [831 {832 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",833 "retrieved_at": "2026-09-18T00:00:00Z"834 },835 {836 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",837 "retrieved_at": "2026-09-18T00:00:00Z"838 }839 ]840 },841 {842 "provider": "openai",843 "api_family": "agents-platform/agents",844 "name": "Environment template",845 "object": "agent.environment.template",846 "schema_name": "EnvironmentTemplateResource",847 "description": "Reusable configuration that provisions a fresh OpenAI-hosted environment for each session.",848 "fields": [849 {850 "name": "id",851 "type": "string",852 "required": true,853 "description": "The ID of the reusable environment template."854 },855 {856 "name": "name",857 "type": "string | null",858 "required": true,859 "description": "An optional human-readable display name for the template."860 },861 {862 "name": "object",863 "type": "string",864 "required": true,865 "description": "The object type. Always `agent.environment.template`."866 },867 {868 "name": "created_at",869 "type": "integer",870 "required": true,871 "description": "The Unix timestamp, in seconds, when the template was created."872 },873 {874 "name": "updated_at",875 "type": "integer",876 "required": true,877 "description": "The Unix timestamp, in seconds, when the template was last updated."878 },879 {880 "name": "packages",881 "type": "EnvironmentPackagesResource",882 "required": true,883 "description": "Packages installed in each fresh OpenAI-hosted environment."884 },885 {886 "name": "network",887 "type": "NetworkPolicyResource",888 "required": true,889 "description": "Runtime network access for each OpenAI-hosted environment."890 },891 {892 "name": "capability_directories",893 "type": "array<string>",894 "required": true,895 "description": "Directories that expose capabilities to the agent."896 },897 {898 "name": "skills",899 "type": "array<HostedTemplateSkillResource>",900 "required": true,901 "description": "Safe skill metadata, preserving unresolved version selectors."902 },903 {904 "name": "plugins",905 "type": "array<HostedPluginResource>",906 "required": true,907 "description": "Safe plugin metadata, excluding inline archive contents."908 },909 {910 "name": "files",911 "type": "array<HostedTemplateFileResource>",912 "required": true,913 "description": "Safe file metadata, excluding contents and session-scoped file IDs."914 }915 ],916 "status": [917 "DOCUMENTED",918 "BETA"919 ],920 "example": null,921 "example_source": null,922 "sources": [923 {924 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",925 "retrieved_at": "2026-09-18T00:00:00Z"926 },927 {928 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",929 "retrieved_at": "2026-09-18T00:00:00Z"930 }931 ]932 },933 {934 "provider": "openai",935 "api_family": "agents-platform/agents",936 "name": "DeletedEnvironmentTemplateResource",937 "object": "agent.environment.template.deleted",938 "schema_name": "DeletedEnvironmentTemplateResource",939 "description": "A deleted reusable environment template.",940 "fields": [941 {942 "name": "id",943 "type": "string",944 "required": true,945 "description": "The ID of the deleted environment template."946 },947 {948 "name": "object",949 "type": "string",950 "required": true,951 "description": "The object type. Always `agent.environment.template.deleted`."952 },953 {954 "name": "deleted",955 "type": "boolean",956 "required": true,957 "description": "Whether the environment template was deleted. Always `true`."958 }959 ],960 "status": [961 "DOCUMENTED",962 "BETA"963 ],964 "example": null,965 "example_source": null,966 "sources": [967 {968 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",969 "retrieved_at": "2026-09-18T00:00:00Z"970 },971 {972 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",973 "retrieved_at": "2026-09-18T00:00:00Z"974 }975 ]976 },977 {978 "provider": "openai",979 "api_family": "agents-platform/vaults",980 "name": "Vault",981 "object": "vault",982 "schema_name": "VaultResource",983 "description": "A collection of credentials for MCP servers and OpenAI-hosted environments.",984 "fields": [985 {986 "name": "id",987 "type": "string",988 "required": true,989 "description": "The ID of the vault."990 },991 {992 "name": "object",993 "type": "string",994 "required": true,995 "description": "The object type. Always `vault`."996 },997 {998 "name": "name",999 "type": "string | null",1000 "required": true,1001 "description": "The human-readable name of the vault, if set."1002 },1003 {1004 "name": "metadata",1005 "type": "object",1006 "required": true,1007 "description": "Key-value pairs associated with the vault, such as an application or team identifier."1008 },1009 {1010 "name": "created_at",1011 "type": "integer",1012 "required": true,1013 "description": "The Unix timestamp, in seconds, when the vault was created."1014 }1015 ],1016 "status": [1017 "DOCUMENTED",1018 "BETA"1019 ],1020 "example": null,1021 "example_source": null,1022 "sources": [1023 {1024 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1025 "retrieved_at": "2026-09-18T00:00:00Z"1026 },1027 {1028 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1029 "retrieved_at": "2026-09-18T00:00:00Z"1030 }1031 ]1032 },1033 {1034 "provider": "openai",1035 "api_family": "agents-platform/vaults",1036 "name": "DeletedVaultResource",1037 "object": "vault.deleted",1038 "schema_name": "DeletedVaultResource",1039 "description": "Confirmation that a vault was deleted.",1040 "fields": [1041 {1042 "name": "id",1043 "type": "string",1044 "required": true,1045 "description": "The ID of the deleted vault."1046 },1047 {1048 "name": "object",1049 "type": "string",1050 "required": true,1051 "description": "The object type. Always `vault.deleted`."1052 },1053 {1054 "name": "deleted",1055 "type": "boolean",1056 "required": true,1057 "description": "Whether the resource was deleted. Always `true`."1058 }1059 ],1060 "status": [1061 "DOCUMENTED",1062 "BETA"1063 ],1064 "example": null,1065 "example_source": null,1066 "sources": [1067 {1068 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1069 "retrieved_at": "2026-09-18T00:00:00Z"1070 },1071 {1072 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1073 "retrieved_at": "2026-09-18T00:00:00Z"1074 }1075 ]1076 },1077 {1078 "provider": "openai",1079 "api_family": "agents-platform/vaults",1080 "name": "Credential (secrets write-only)",1081 "object": "vault.credential",1082 "schema_name": "VaultCredentialResource",1083 "description": "Metadata for a stored credential. Secret values are never returned.",1084 "fields": [1085 {1086 "name": "id",1087 "type": "string",1088 "required": true,1089 "description": "The ID of the credential."1090 },1091 {1092 "name": "object",1093 "type": "string",1094 "required": true,1095 "description": "The object type. Always `vault.credential`."1096 },1097 {1098 "name": "vault_id",1099 "type": "string",1100 "required": true,1101 "description": "The ID of the vault containing this credential."1102 },1103 {1104 "name": "name",1105 "type": "string",1106 "required": true,1107 "description": "The human-readable name of the credential."1108 },1109 {1110 "name": "auth",1111 "type": "VaultCredentialAuthResource",1112 "required": true,1113 "description": "The authentication method and non-secret configuration of the credential."1114 },1115 {1116 "name": "created_at",1117 "type": "integer",1118 "required": true,1119 "description": "The Unix timestamp, in seconds, when the credential was created."1120 },1121 {1122 "name": "updated_at",1123 "type": "integer",1124 "required": true,1125 "description": "The Unix timestamp, in seconds, when the credential was last updated."1126 }1127 ],1128 "status": [1129 "DOCUMENTED",1130 "BETA"1131 ],1132 "example": null,1133 "example_source": null,1134 "sources": [1135 {1136 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1137 "retrieved_at": "2026-09-18T00:00:00Z"1138 },1139 {1140 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1141 "retrieved_at": "2026-09-18T00:00:00Z"1142 }1143 ]1144 },1145 {1146 "provider": "openai",1147 "api_family": "agents-platform/vaults",1148 "name": "DeletedVaultCredentialResource",1149 "object": "vault.credential.deleted",1150 "schema_name": "DeletedVaultCredentialResource",1151 "description": "Confirmation that a vault credential was deleted.",1152 "fields": [1153 {1154 "name": "id",1155 "type": "string",1156 "required": true,1157 "description": "The ID of the deleted credential."1158 },1159 {1160 "name": "object",1161 "type": "string",1162 "required": true,1163 "description": "The object type. Always `vault.credential.deleted`."1164 },1165 {1166 "name": "deleted",1167 "type": "boolean",1168 "required": true,1169 "description": "Whether the resource was deleted. Always `true`."1170 }1171 ],1172 "status": [1173 "DOCUMENTED",1174 "BETA"1175 ],1176 "example": null,1177 "example_source": null,1178 "sources": [1179 {1180 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1181 "retrieved_at": "2026-09-18T00:00:00Z"1182 },1183 {1184 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1185 "retrieved_at": "2026-09-18T00:00:00Z"1186 }1187 ]1188 },1189 {1190 "provider": "openai",1191 "api_family": "agents-platform/chatkit",1192 "name": "ChatKit session",1193 "object": "chatkit.session",1194 "schema_name": "ChatSessionResource",1195 "description": "Represents a ChatKit session and its resolved configuration.",1196 "fields": [1197 {1198 "name": "id",1199 "type": "string",1200 "required": true,1201 "description": "Identifier for the ChatKit session."1202 },1203 {1204 "name": "object",1205 "type": "string",1206 "required": true,1207 "description": "Type discriminator that is always `chatkit.session`."1208 },1209 {1210 "name": "expires_at",1211 "type": "integer",1212 "required": true,1213 "description": "Unix timestamp (in seconds) for when the session expires."1214 },1215 {1216 "name": "client_secret",1217 "type": "string",1218 "required": true,1219 "description": "Ephemeral client secret that authenticates session requests."1220 },1221 {1222 "name": "workflow",1223 "type": "ChatkitWorkflow",1224 "required": true,1225 "description": "Workflow metadata for the session."1226 },1227 {1228 "name": "user",1229 "type": "string",1230 "required": true,1231 "description": "User identifier associated with the session."1232 },1233 {1234 "name": "rate_limits",1235 "type": "ChatSessionRateLimits",1236 "required": true,1237 "description": "Resolved rate limit values."1238 },1239 {1240 "name": "max_requests_per_1_minute",1241 "type": "integer",1242 "required": true,1243 "description": "Convenience copy of the per-minute request limit."1244 },1245 {1246 "name": "status",1247 "type": "ChatSessionStatus",1248 "required": true,1249 "description": "Current lifecycle state of the session.",1250 "enum": [1251 "active",1252 "expired",1253 "cancelled"1254 ]1255 },1256 {1257 "name": "chatkit_configuration",1258 "type": "ChatSessionChatkitConfiguration",1259 "required": true,1260 "description": "Resolved ChatKit feature configuration for the session."1261 }1262 ],1263 "status": [1264 "DOCUMENTED",1265 "BETA"1266 ],1267 "example": null,1268 "example_source": null,1269 "sources": [1270 {1271 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",1272 "retrieved_at": "2026-09-18T00:00:00Z"1273 },1274 {1275 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1276 "retrieved_at": "2026-09-18T00:00:00Z"1277 }1278 ]1279 },1280 {1281 "provider": "openai",1282 "api_family": "agents-platform/chatkit",1283 "name": "ChatKit thread",1284 "object": "chatkit.thread",1285 "schema_name": "ThreadResource",1286 "description": "Represents a ChatKit thread and its current status.",1287 "fields": [1288 {1289 "name": "id",1290 "type": "string",1291 "required": true,1292 "description": "Identifier of the thread."1293 },1294 {1295 "name": "object",1296 "type": "string",1297 "required": true,1298 "description": "Type discriminator that is always `chatkit.thread`."1299 },1300 {1301 "name": "created_at",1302 "type": "integer",1303 "required": true,1304 "description": "Unix timestamp (in seconds) for when the thread was created."1305 },1306 {1307 "name": "title",1308 "type": "string | null",1309 "required": true,1310 "description": ""1311 },1312 {1313 "name": "status",1314 "type": "ActiveStatus | LockedStatus | ClosedStatus",1315 "required": true,1316 "description": "Current status for the thread. Defaults to `active` for newly created threads."1317 },1318 {1319 "name": "user",1320 "type": "string",1321 "required": true,1322 "description": "Free-form string that identifies your end user who owns the thread."1323 }1324 ],1325 "status": [1326 "DOCUMENTED",1327 "BETA"1328 ],1329 "example": null,1330 "example_source": null,1331 "sources": [1332 {1333 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",1334 "retrieved_at": "2026-09-18T00:00:00Z"1335 },1336 {1337 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1338 "retrieved_at": "2026-09-18T00:00:00Z"1339 }1340 ]1341 },1342 {1343 "provider": "openai",1344 "api_family": "agents-platform/chatkit",1345 "name": "DeletedThreadResource",1346 "object": "chatkit.thread.deleted",1347 "schema_name": "DeletedThreadResource",1348 "description": "Confirmation payload returned after deleting a thread.",1349 "fields": [1350 {1351 "name": "id",1352 "type": "string",1353 "required": true,1354 "description": "Identifier of the deleted thread."1355 },1356 {1357 "name": "object",1358 "type": "string",1359 "required": true,1360 "description": "Type discriminator that is always `chatkit.thread.deleted`."1361 },1362 {1363 "name": "deleted",1364 "type": "boolean",1365 "required": true,1366 "description": "Indicates that the thread has been deleted."1367 }1368 ],1369 "status": [1370 "DOCUMENTED",1371 "BETA"1372 ],1373 "example": null,1374 "example_source": null,1375 "sources": [1376 {1377 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit",1378 "retrieved_at": "2026-09-18T00:00:00Z"1379 },1380 {1381 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1382 "retrieved_at": "2026-09-18T00:00:00Z"1383 }1384 ]1385 },1386 {1387 "provider": "openai",1388 "api_family": "agents-platform/agents",1389 "name": "Session item: message",1390 "object": "agent.session.item[type=message]",1391 "schema_name": "MessageItemResource",1392 "description": "A user or assistant message recorded in a session.",1393 "fields": [1394 {1395 "name": "type",1396 "type": "string",1397 "required": true,1398 "description": "The item type. Always `message`.",1399 "enum": [1400 "message"1401 ],1402 "const": "message"1403 },1404 {1405 "name": "id",1406 "type": "string | null",1407 "required": true,1408 "description": "The ID of this item, or null for legacy user messages whose ID was not recorded."1409 },1410 {1411 "name": "turn_id",1412 "type": "string",1413 "required": true,1414 "description": "The ID of the turn that contains this item."1415 },1416 {1417 "name": "role",1418 "type": "SessionMessageRoleResource",1419 "required": true,1420 "description": "The role of the message author.",1421 "enum": [1422 "user",1423 "assistant"1424 ]1425 },1426 {1427 "name": "content",1428 "type": "array<MessageContentResource>",1429 "required": true,1430 "description": "The content of the message. User messages contain input text or images; assistant messages contain output text."1431 },1432 {1433 "name": "status",1434 "type": "OutputItemStatusResource",1435 "required": true,1436 "description": "The status of the message. User messages are always `completed`.",1437 "enum": [1438 "in_progress",1439 "completed",1440 "incomplete"1441 ]1442 },1443 {1444 "name": "phase",1445 "type": "MessagePhaseResource | null",1446 "required": true,1447 "description": "The phase of an assistant message. Null for user messages."1448 }1449 ],1450 "status": [1451 "DOCUMENTED",1452 "BETA",1453 "LIVE_VERIFIED"1454 ],1455 "example": [1456 {1457 "type": "message",1458 "id": "msg_a168d37c50fe59f871f0243a74cefcab58523253681a5ad41b",1459 "turn_id": "turn_0b52151131840c7d006aade8a3114c8195b6286aaca0730297",1460 "role": "user",1461 "content": [1462 {1463 "type": "input_text",1464 "text": "Reply with OK."1465 }1466 ],1467 "status": "completed",1468 "phase": null1469 },1470 {1471 "type": "message",1472 "id": "msg_04be7b73944e7645016aade8a1919087d1aa6bf202ab47a6f4",1473 "turn_id": "turn_0b52151131840c7d006aade8a3114c8195b6286aaca0730297",1474 "role": "assistant",1475 "content": [1476 {1477 "type": "output_text",1478 "text": "OK."1479 }1480 ],1481 "status": "completed",1482 "phase": "final_answer"1483 }1484 ],1485 "example_source": "live 2026-09-18 (user + assistant message, phase final_answer)",1486 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1487 "sources": [1488 {1489 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1490 "retrieved_at": "2026-09-18T00:00:00Z"1491 },1492 {1493 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1494 "retrieved_at": "2026-09-18T00:00:00Z"1495 }1496 ]1497 },1498 {1499 "provider": "openai",1500 "api_family": "agents-platform/agents",1501 "name": "Session item: reasoning",1502 "object": "agent.session.item[type=reasoning]",1503 "schema_name": "ReasoningItemResource",1504 "description": "A reasoning item produced by the agent.",1505 "fields": [1506 {1507 "name": "type",1508 "type": "string",1509 "required": true,1510 "description": "The item type. Always `reasoning`.",1511 "enum": [1512 "reasoning"1513 ],1514 "const": "reasoning"1515 },1516 {1517 "name": "id",1518 "type": "string",1519 "required": true,1520 "description": "The ID of the reasoning item."1521 },1522 {1523 "name": "turn_id",1524 "type": "string",1525 "required": true,1526 "description": "The ID of the turn that contains this item."1527 },1528 {1529 "name": "summary",1530 "type": "array<SummaryTextResource>",1531 "required": true,1532 "description": "The reasoning summaries produced by the agent."1533 },1534 {1535 "name": "status",1536 "type": "OutputItemStatusResource | null",1537 "required": true,1538 "description": "The status of the reasoning item."1539 }1540 ],1541 "status": [1542 "DOCUMENTED",1543 "BETA"1544 ],1545 "example": null,1546 "example_source": null,1547 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1548 "sources": [1549 {1550 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1551 "retrieved_at": "2026-09-18T00:00:00Z"1552 },1553 {1554 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1555 "retrieved_at": "2026-09-18T00:00:00Z"1556 }1557 ]1558 },1559 {1560 "provider": "openai",1561 "api_family": "agents-platform/agents",1562 "name": "Session item: function_call",1563 "object": "agent.session.item[type=function_call]",1564 "schema_name": "FunctionCallItemResource",1565 "description": "A function call produced by the agent.",1566 "fields": [1567 {1568 "name": "type",1569 "type": "string",1570 "required": true,1571 "description": "The item type. Always `function_call`.",1572 "enum": [1573 "function_call"1574 ],1575 "const": "function_call"1576 },1577 {1578 "name": "id",1579 "type": "string",1580 "required": true,1581 "description": "The ID of the function call item."1582 },1583 {1584 "name": "turn_id",1585 "type": "string",1586 "required": true,1587 "description": "The ID of the turn that contains this item."1588 },1589 {1590 "name": "call_id",1591 "type": "string",1592 "required": true,1593 "description": "The ID used to submit the function result."1594 },1595 {1596 "name": "name",1597 "type": "string",1598 "required": true,1599 "description": "The name of the function to call."1600 },1601 {1602 "name": "arguments",1603 "type": "any",1604 "required": true,1605 "description": "The arguments to pass to the function."1606 },1607 {1608 "name": "status",1609 "type": "FunctionCallStatusResource",1610 "required": true,1611 "description": "The status of the function call.",1612 "enum": [1613 "in_progress",1614 "completed",1615 "failed",1616 "incomplete"1617 ]1618 }1619 ],1620 "status": [1621 "DOCUMENTED",1622 "BETA"1623 ],1624 "example": null,1625 "example_source": null,1626 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1627 "sources": [1628 {1629 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1630 "retrieved_at": "2026-09-18T00:00:00Z"1631 },1632 {1633 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1634 "retrieved_at": "2026-09-18T00:00:00Z"1635 }1636 ]1637 },1638 {1639 "provider": "openai",1640 "api_family": "agents-platform/agents",1641 "name": "Session item: function_call_output",1642 "object": "agent.session.item[type=function_call_output]",1643 "schema_name": "FunctionCallOutputItemResource",1644 "description": "The result supplied for a function call.",1645 "fields": [1646 {1647 "name": "id",1648 "type": "string",1649 "required": true,1650 "description": "The ID of the function call output item."1651 },1652 {1653 "name": "turn_id",1654 "type": "string",1655 "required": true,1656 "description": "The ID of the turn that contains this item."1657 },1658 {1659 "name": "type",1660 "type": "string",1661 "required": true,1662 "description": "The item type. Always `function_call_output`.",1663 "enum": [1664 "function_call_output"1665 ],1666 "const": "function_call_output"1667 },1668 {1669 "name": "call_id",1670 "type": "string",1671 "required": true,1672 "description": "The ID of the function call that produced this output."1673 },1674 {1675 "name": "status",1676 "type": "FunctionCallStatusResource",1677 "required": true,1678 "description": "The status of the function call.",1679 "enum": [1680 "in_progress",1681 "completed",1682 "failed",1683 "incomplete"1684 ]1685 },1686 {1687 "name": "output",1688 "type": "FunctionCallOutputResource | null",1689 "required": true,1690 "description": "The function result, if the call succeeded."1691 },1692 {1693 "name": "error",1694 "type": "string | null",1695 "required": true,1696 "description": "The error message, if the call failed."1697 }1698 ],1699 "status": [1700 "DOCUMENTED",1701 "BETA"1702 ],1703 "example": null,1704 "example_source": null,1705 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1706 "sources": [1707 {1708 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1709 "retrieved_at": "2026-09-18T00:00:00Z"1710 },1711 {1712 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1713 "retrieved_at": "2026-09-18T00:00:00Z"1714 }1715 ]1716 },1717 {1718 "provider": "openai",1719 "api_family": "agents-platform/agents",1720 "name": "Session item: agent_message",1721 "object": "agent.session.item[type=agent_message]",1722 "schema_name": "AgentMessageItemResource",1723 "description": "A message exchanged between agent threads.",1724 "fields": [1725 {1726 "name": "id",1727 "type": "string",1728 "required": true,1729 "description": "The ID of the message."1730 },1731 {1732 "name": "turn_id",1733 "type": "string",1734 "required": true,1735 "description": "The ID of the turn that contains this item."1736 },1737 {1738 "name": "type",1739 "type": "string",1740 "required": true,1741 "description": "The item type. Always `agent_message`.",1742 "enum": [1743 "agent_message"1744 ],1745 "const": "agent_message"1746 },1747 {1748 "name": "sender_agent_id",1749 "type": "string",1750 "required": true,1751 "description": "The ID or name of the sending agent."1752 },1753 {1754 "name": "recipient_agent_id",1755 "type": "string",1756 "required": true,1757 "description": "The ID or name of the receiving agent."1758 },1759 {1760 "name": "content",1761 "type": "array<AgentContentResource>",1762 "required": true,1763 "description": "The content exchanged between the agents."1764 }1765 ],1766 "status": [1767 "DOCUMENTED",1768 "BETA"1769 ],1770 "example": null,1771 "example_source": null,1772 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1773 "sources": [1774 {1775 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1776 "retrieved_at": "2026-09-18T00:00:00Z"1777 },1778 {1779 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1780 "retrieved_at": "2026-09-18T00:00:00Z"1781 }1782 ]1783 },1784 {1785 "provider": "openai",1786 "api_family": "agents-platform/agents",1787 "name": "Session item: mcp_call",1788 "object": "agent.session.item[type=mcp_call]",1789 "schema_name": "McpCallItemResource",1790 "description": "A call to a tool on an MCP server.",1791 "fields": [1792 {1793 "name": "type",1794 "type": "string",1795 "required": true,1796 "description": "The item type. Always `mcp_call`.",1797 "enum": [1798 "mcp_call"1799 ],1800 "const": "mcp_call"1801 },1802 {1803 "name": "id",1804 "type": "string",1805 "required": true,1806 "description": "The ID of the MCP call item."1807 },1808 {1809 "name": "turn_id",1810 "type": "string",1811 "required": true,1812 "description": "The ID of the turn that contains this item."1813 },1814 {1815 "name": "server_label",1816 "type": "string",1817 "required": true,1818 "description": "The label of the MCP server."1819 },1820 {1821 "name": "name",1822 "type": "string",1823 "required": true,1824 "description": "The name of the MCP tool."1825 },1826 {1827 "name": "arguments",1828 "type": "any",1829 "required": true,1830 "description": "The arguments passed to the MCP tool."1831 },1832 {1833 "name": "status",1834 "type": "FunctionCallStatusResource",1835 "required": true,1836 "description": "The status of the MCP tool call.",1837 "enum": [1838 "in_progress",1839 "completed",1840 "failed",1841 "incomplete"1842 ]1843 },1844 {1845 "name": "output",1846 "type": "any | null",1847 "required": true,1848 "description": "The output returned by the MCP tool, if any."1849 },1850 {1851 "name": "error",1852 "type": "any | null",1853 "required": true,1854 "description": "The error returned by the MCP tool, if any."1855 }1856 ],1857 "status": [1858 "DOCUMENTED",1859 "BETA"1860 ],1861 "example": null,1862 "example_source": null,1863 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1864 "sources": [1865 {1866 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1867 "retrieved_at": "2026-09-18T00:00:00Z"1868 },1869 {1870 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1871 "retrieved_at": "2026-09-18T00:00:00Z"1872 }1873 ]1874 },1875 {1876 "provider": "openai",1877 "api_family": "agents-platform/agents",1878 "name": "Session item: web_search_call",1879 "object": "agent.session.item[type=web_search_call]",1880 "schema_name": "WebSearchCallItemResource",1881 "description": "A web search call produced by the agent.",1882 "fields": [1883 {1884 "name": "type",1885 "type": "string",1886 "required": true,1887 "description": "The item type. Always `web_search_call`.",1888 "enum": [1889 "web_search_call"1890 ],1891 "const": "web_search_call"1892 },1893 {1894 "name": "id",1895 "type": "string",1896 "required": true,1897 "description": "The ID of the web search call."1898 },1899 {1900 "name": "turn_id",1901 "type": "string",1902 "required": true,1903 "description": "The ID of the turn that contains this item."1904 },1905 {1906 "name": "status",1907 "type": "OutputItemStatusResource",1908 "required": true,1909 "description": "The status of the web search call.",1910 "enum": [1911 "in_progress",1912 "completed",1913 "incomplete"1914 ]1915 },1916 {1917 "name": "action",1918 "type": "WebSearchActionResource | null",1919 "required": true,1920 "description": "The action performed by the web search tool."1921 }1922 ],1923 "status": [1924 "DOCUMENTED",1925 "BETA"1926 ],1927 "example": null,1928 "example_source": null,1929 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",1930 "sources": [1931 {1932 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",1933 "retrieved_at": "2026-09-18T00:00:00Z"1934 },1935 {1936 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",1937 "retrieved_at": "2026-09-18T00:00:00Z"1938 }1939 ]1940 },1941 {1942 "provider": "openai",1943 "api_family": "agents-platform/agents",1944 "name": "Session item: command_execution",1945 "object": "agent.session.item[type=command_execution]",1946 "schema_name": "CommandExecutionItemResource",1947 "description": "A command execution produced by the agent.",1948 "fields": [1949 {1950 "name": "type",1951 "type": "string",1952 "required": true,1953 "description": "The item type. Always `command_execution`.",1954 "enum": [1955 "command_execution"1956 ],1957 "const": "command_execution"1958 },1959 {1960 "name": "id",1961 "type": "string",1962 "required": true,1963 "description": "The ID of the command execution item."1964 },1965 {1966 "name": "turn_id",1967 "type": "string",1968 "required": true,1969 "description": "The ID of the turn that contains this item."1970 },1971 {1972 "name": "command",1973 "type": "string",1974 "required": true,1975 "description": "The command that was executed."1976 },1977 {1978 "name": "cwd",1979 "type": "string | null",1980 "required": true,1981 "description": "The working directory used to execute the command."1982 },1983 {1984 "name": "status",1985 "type": "FunctionCallStatusResource",1986 "required": true,1987 "description": "The status of the command execution.",1988 "enum": [1989 "in_progress",1990 "completed",1991 "failed",1992 "incomplete"1993 ]1994 },1995 {1996 "name": "output",1997 "type": "string | null",1998 "required": true,1999 "description": "The command output, if available."2000 },2001 {2002 "name": "exit_code",2003 "type": "integer | null",2004 "required": true,2005 "description": "The process exit code, if the command completed."2006 },2007 {2008 "name": "duration_ms",2009 "type": "integer | null",2010 "required": true,2011 "description": "The command duration in milliseconds."2012 }2013 ],2014 "status": [2015 "DOCUMENTED",2016 "BETA"2017 ],2018 "example": null,2019 "example_source": null,2020 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2021 "sources": [2022 {2023 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2024 "retrieved_at": "2026-09-18T00:00:00Z"2025 },2026 {2027 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2028 "retrieved_at": "2026-09-18T00:00:00Z"2029 }2030 ]2031 },2032 {2033 "provider": "openai",2034 "api_family": "agents-platform/agents",2035 "name": "Session item: create_subagent_call",2036 "object": "agent.session.item[type=create_subagent_call]",2037 "schema_name": "CreateSubagentCallItemResource",2038 "description": "A request to spawn a subagent.",2039 "fields": [2040 {2041 "name": "type",2042 "type": "string",2043 "required": true,2044 "description": "The item type. Always `create_subagent_call`.",2045 "enum": [2046 "create_subagent_call"2047 ],2048 "const": "create_subagent_call"2049 },2050 {2051 "name": "id",2052 "type": "string",2053 "required": true,2054 "description": "The ID of the tool call item."2055 },2056 {2057 "name": "turn_id",2058 "type": "string",2059 "required": true,2060 "description": "The ID of the turn that contains this item."2061 },2062 {2063 "name": "status",2064 "type": "FunctionCallStatusResource",2065 "required": true,2066 "description": "The status of the tool call.",2067 "enum": [2068 "in_progress",2069 "completed",2070 "failed",2071 "incomplete"2072 ]2073 },2074 {2075 "name": "agent_id",2076 "type": "string",2077 "required": true,2078 "description": "The ID of the agent that requested the subagent."2079 },2080 {2081 "name": "content",2082 "type": "array<AgentContentResource>",2083 "required": true,2084 "description": "The task given to the spawned agent."2085 },2086 {2087 "name": "model",2088 "type": "string | null",2089 "required": true,2090 "description": "The model requested for the spawned agent."2091 },2092 {2093 "name": "reasoning_effort",2094 "type": "string | null",2095 "required": true,2096 "description": "The reasoning effort requested for the spawned agent."2097 }2098 ],2099 "status": [2100 "DOCUMENTED",2101 "BETA"2102 ],2103 "example": null,2104 "example_source": null,2105 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2106 "sources": [2107 {2108 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2109 "retrieved_at": "2026-09-18T00:00:00Z"2110 },2111 {2112 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2113 "retrieved_at": "2026-09-18T00:00:00Z"2114 }2115 ]2116 },2117 {2118 "provider": "openai",2119 "api_family": "agents-platform/agents",2120 "name": "Session item: send_subagent_input_call",2121 "object": "agent.session.item[type=send_subagent_input_call]",2122 "schema_name": "SendSubagentInputCallItemResource",2123 "description": "A request to send input to another agent.",2124 "fields": [2125 {2126 "name": "type",2127 "type": "string",2128 "required": true,2129 "description": "The item type. Always `send_subagent_input_call`.",2130 "enum": [2131 "send_subagent_input_call"2132 ],2133 "const": "send_subagent_input_call"2134 },2135 {2136 "name": "id",2137 "type": "string",2138 "required": true,2139 "description": "The ID of the tool call item."2140 },2141 {2142 "name": "turn_id",2143 "type": "string",2144 "required": true,2145 "description": "The ID of the turn that contains this item."2146 },2147 {2148 "name": "status",2149 "type": "FunctionCallStatusResource",2150 "required": true,2151 "description": "The status of the tool call.",2152 "enum": [2153 "in_progress",2154 "completed",2155 "failed",2156 "incomplete"2157 ]2158 },2159 {2160 "name": "sender_agent_id",2161 "type": "string",2162 "required": true,2163 "description": "The ID of the agent sending the input."2164 },2165 {2166 "name": "recipient_agent_id",2167 "type": "string",2168 "required": true,2169 "description": "The ID of the agent receiving the input."2170 },2171 {2172 "name": "content",2173 "type": "array<AgentContentResource>",2174 "required": true,2175 "description": "The input sent to the receiving agent."2176 }2177 ],2178 "status": [2179 "DOCUMENTED",2180 "BETA"2181 ],2182 "example": null,2183 "example_source": null,2184 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2185 "sources": [2186 {2187 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2188 "retrieved_at": "2026-09-18T00:00:00Z"2189 },2190 {2191 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2192 "retrieved_at": "2026-09-18T00:00:00Z"2193 }2194 ]2195 },2196 {2197 "provider": "openai",2198 "api_family": "agents-platform/agents",2199 "name": "Session item: resume_subagent_call",2200 "object": "agent.session.item[type=resume_subagent_call]",2201 "schema_name": "ResumeSubagentCallItemResource",2202 "description": "A request to resume a subagent.",2203 "fields": [2204 {2205 "name": "type",2206 "type": "string",2207 "required": true,2208 "description": "The item type. Always `resume_subagent_call`.",2209 "enum": [2210 "resume_subagent_call"2211 ],2212 "const": "resume_subagent_call"2213 },2214 {2215 "name": "id",2216 "type": "string",2217 "required": true,2218 "description": "The ID of the tool call item."2219 },2220 {2221 "name": "turn_id",2222 "type": "string",2223 "required": true,2224 "description": "The ID of the turn that contains this item."2225 },2226 {2227 "name": "status",2228 "type": "FunctionCallStatusResource",2229 "required": true,2230 "description": "The status of the tool call.",2231 "enum": [2232 "in_progress",2233 "completed",2234 "failed",2235 "incomplete"2236 ]2237 },2238 {2239 "name": "sender_agent_id",2240 "type": "string",2241 "required": true,2242 "description": "The ID of the agent requesting the resume."2243 },2244 {2245 "name": "recipient_agent_id",2246 "type": "string",2247 "required": true,2248 "description": "The ID of the agent to resume."2249 }2250 ],2251 "status": [2252 "DOCUMENTED",2253 "BETA"2254 ],2255 "example": null,2256 "example_source": null,2257 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2258 "sources": [2259 {2260 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2261 "retrieved_at": "2026-09-18T00:00:00Z"2262 },2263 {2264 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2265 "retrieved_at": "2026-09-18T00:00:00Z"2266 }2267 ]2268 },2269 {2270 "provider": "openai",2271 "api_family": "agents-platform/agents",2272 "name": "Session item: wait_for_subagents_call",2273 "object": "agent.session.item[type=wait_for_subagents_call]",2274 "schema_name": "WaitForSubagentsCallItemResource",2275 "description": "A request to wait for one or more subagents.",2276 "fields": [2277 {2278 "name": "type",2279 "type": "string",2280 "required": true,2281 "description": "The item type. Always `wait_for_subagents_call`.",2282 "enum": [2283 "wait_for_subagents_call"2284 ],2285 "const": "wait_for_subagents_call"2286 },2287 {2288 "name": "id",2289 "type": "string",2290 "required": true,2291 "description": "The ID of the tool call item."2292 },2293 {2294 "name": "turn_id",2295 "type": "string",2296 "required": true,2297 "description": "The ID of the turn that contains this item."2298 },2299 {2300 "name": "status",2301 "type": "FunctionCallStatusResource",2302 "required": true,2303 "description": "The status of the tool call.",2304 "enum": [2305 "in_progress",2306 "completed",2307 "failed",2308 "incomplete"2309 ]2310 },2311 {2312 "name": "sender_agent_id",2313 "type": "string",2314 "required": true,2315 "description": "The ID of the agent waiting for results."2316 },2317 {2318 "name": "recipient_agent_ids",2319 "type": "array<string>",2320 "required": true,2321 "description": "The IDs of the agents to wait for."2322 }2323 ],2324 "status": [2325 "DOCUMENTED",2326 "BETA"2327 ],2328 "example": null,2329 "example_source": null,2330 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2331 "sources": [2332 {2333 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2334 "retrieved_at": "2026-09-18T00:00:00Z"2335 },2336 {2337 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2338 "retrieved_at": "2026-09-18T00:00:00Z"2339 }2340 ]2341 },2342 {2343 "provider": "openai",2344 "api_family": "agents-platform/agents",2345 "name": "Session item: interrupt_subagent_call",2346 "object": "agent.session.item[type=interrupt_subagent_call]",2347 "schema_name": "InterruptSubagentCallItemResource",2348 "description": "A request to interrupt a subagent's current turn. The subagent remains available.",2349 "fields": [2350 {2351 "name": "type",2352 "type": "string",2353 "required": true,2354 "description": "The item type. Always `interrupt_subagent_call`.",2355 "enum": [2356 "interrupt_subagent_call"2357 ],2358 "const": "interrupt_subagent_call"2359 },2360 {2361 "name": "id",2362 "type": "string",2363 "required": true,2364 "description": "The ID of the tool call item."2365 },2366 {2367 "name": "turn_id",2368 "type": "string",2369 "required": true,2370 "description": "The ID of the turn that contains this item."2371 },2372 {2373 "name": "status",2374 "type": "FunctionCallStatusResource",2375 "required": true,2376 "description": "The status of the tool call.",2377 "enum": [2378 "in_progress",2379 "completed",2380 "failed",2381 "incomplete"2382 ]2383 },2384 {2385 "name": "sender_agent_id",2386 "type": "string",2387 "required": true,2388 "description": "The ID of the agent requesting the interrupt."2389 },2390 {2391 "name": "recipient_agent_id",2392 "type": "string",2393 "required": true,2394 "description": "The ID of the agent to interrupt."2395 }2396 ],2397 "status": [2398 "DOCUMENTED",2399 "BETA"2400 ],2401 "example": null,2402 "example_source": null,2403 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2404 "sources": [2405 {2406 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2407 "retrieved_at": "2026-09-18T00:00:00Z"2408 },2409 {2410 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2411 "retrieved_at": "2026-09-18T00:00:00Z"2412 }2413 ]2414 },2415 {2416 "provider": "openai",2417 "api_family": "agents-platform/agents",2418 "name": "Session item: close_subagent_call",2419 "object": "agent.session.item[type=close_subagent_call]",2420 "schema_name": "CloseSubagentCallItemResource",2421 "description": "A request to close a subagent.",2422 "fields": [2423 {2424 "name": "type",2425 "type": "string",2426 "required": true,2427 "description": "The item type. Always `close_subagent_call`.",2428 "enum": [2429 "close_subagent_call"2430 ],2431 "const": "close_subagent_call"2432 },2433 {2434 "name": "id",2435 "type": "string",2436 "required": true,2437 "description": "The ID of the tool call item."2438 },2439 {2440 "name": "turn_id",2441 "type": "string",2442 "required": true,2443 "description": "The ID of the turn that contains this item."2444 },2445 {2446 "name": "status",2447 "type": "FunctionCallStatusResource",2448 "required": true,2449 "description": "The status of the tool call.",2450 "enum": [2451 "in_progress",2452 "completed",2453 "failed",2454 "incomplete"2455 ]2456 },2457 {2458 "name": "sender_agent_id",2459 "type": "string",2460 "required": true,2461 "description": "The ID of the agent requesting the close."2462 },2463 {2464 "name": "recipient_agent_id",2465 "type": "string",2466 "required": true,2467 "description": "The ID of the agent to close."2468 }2469 ],2470 "status": [2471 "DOCUMENTED",2472 "BETA"2473 ],2474 "example": null,2475 "example_source": null,2476 "union": "SessionTurnItemResource (GET /items, /subagents/{id}/items, event item.added); AgentOutputItemResource subset for item.done",2477 "sources": [2478 {2479 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/agents",2480 "retrieved_at": "2026-09-18T00:00:00Z"2481 },2482 {2483 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2484 "retrieved_at": "2026-09-18T00:00:00Z"2485 }2486 ]2487 },2488 {2489 "provider": "openai",2490 "api_family": "agents-platform/agents",2491 "name": "Message content part: MessageContentResourceInputText",2492 "object": "agent.session.item[type=message].content[]",2493 "schema_name": "MessageContentResourceInputText",2494 "description": "Text supplied by the user.",2495 "fields": [2496 {2497 "name": "type",2498 "type": "string",2499 "required": true,2500 "description": "The type of the object. Always `input_text`.",2501 "enum": [2502 "input_text"2503 ],2504 "const": "input_text"2505 },2506 {2507 "name": "text",2508 "type": "string",2509 "required": true,2510 "description": "The text supplied by the user."2511 }2512 ],2513 "status": [2514 "DOCUMENTED",2515 "BETA",2516 "LIVE_VERIFIED"2517 ],2518 "example": null,2519 "sources": [2520 {2521 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2522 "retrieved_at": "2026-09-18T00:00:00Z"2523 }2524 ]2525 },2526 {2527 "provider": "openai",2528 "api_family": "agents-platform/agents",2529 "name": "Message content part: MessageContentResourceInputImage",2530 "object": "agent.session.item[type=message].content[]",2531 "schema_name": "MessageContentResourceInputImage",2532 "description": "An image supplied by the user.",2533 "fields": [2534 {2535 "name": "type",2536 "type": "string",2537 "required": true,2538 "description": "The type of the object. Always `input_image`.",2539 "enum": [2540 "input_image"2541 ],2542 "const": "input_image"2543 },2544 {2545 "name": "image_url",2546 "type": "string",2547 "required": true,2548 "description": "The URL of the image supplied by the user, which may be a base64-encoded data URL."2549 }2550 ],2551 "status": [2552 "DOCUMENTED",2553 "BETA",2554 "LIVE_VERIFIED"2555 ],2556 "example": null,2557 "sources": [2558 {2559 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2560 "retrieved_at": "2026-09-18T00:00:00Z"2561 }2562 ]2563 },2564 {2565 "provider": "openai",2566 "api_family": "agents-platform/agents",2567 "name": "Message content part: MessageContentResourceOutputText",2568 "object": "agent.session.item[type=message].content[]",2569 "schema_name": "MessageContentResourceOutputText",2570 "description": "Text produced by the assistant.",2571 "fields": [2572 {2573 "name": "type",2574 "type": "string",2575 "required": true,2576 "description": "The type of the object. Always `output_text`.",2577 "enum": [2578 "output_text"2579 ],2580 "const": "output_text"2581 },2582 {2583 "name": "text",2584 "type": "string",2585 "required": true,2586 "description": "The text produced by the assistant."2587 }2588 ],2589 "status": [2590 "DOCUMENTED",2591 "BETA",2592 "LIVE_VERIFIED"2593 ],2594 "example": null,2595 "sources": [2596 {2597 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2598 "retrieved_at": "2026-09-18T00:00:00Z"2599 }2600 ]2601 },2602 {2603 "provider": "openai",2604 "api_family": "agents-platform/agents",2605 "name": "SessionAgentResource",2606 "object": null,2607 "schema_name": "SessionAgentResource",2608 "description": "The effective agent configuration for a session.",2609 "fields": [2610 {2611 "name": "id",2612 "type": "string",2613 "required": true,2614 "description": "The ID of the agent."2615 },2616 {2617 "name": "name",2618 "type": "string | null",2619 "required": true,2620 "description": "The reusable agent's name when the session was created, or null if no name was saved. Later changes to the agent's name do not affect this value."2621 },2622 {2623 "name": "model",2624 "type": "string",2625 "required": true,2626 "description": "The model used by the agent."2627 },2628 {2629 "name": "reasoning",2630 "type": "ReasoningResource",2631 "required": true,2632 "description": "The agent's reasoning configuration."2633 },2634 {2635 "name": "text",2636 "type": "TextResource",2637 "required": true,2638 "description": "Configuration for text generated by the agent."2639 },2640 {2641 "name": "service_tier",2642 "type": "ServiceTierResource",2643 "required": true,2644 "description": "The effective service-tier policy for model requests. Defaults to `auto`.",2645 "enum": [2646 "auto",2647 "default",2648 "flex",2649 "priority",2650 "fast"2651 ]2652 },2653 {2654 "name": "instructions",2655 "type": "string | null",2656 "required": true,2657 "description": "Custom instructions appended to the agent's default base instructions."2658 },2659 {2660 "name": "tools",2661 "type": "array<AgentToolResource>",2662 "required": true,2663 "description": "Tools available to the agent."2664 },2665 {2666 "name": "multi_agent",2667 "type": "MultiAgentConfigResource",2668 "required": true,2669 "description": "Configuration for creating and coordinating subagents."2670 }2671 ],2672 "status": [2673 "DOCUMENTED",2674 "BETA"2675 ],2676 "example": null,2677 "sources": [2678 {2679 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2680 "retrieved_at": "2026-09-18T00:00:00Z"2681 }2682 ]2683 },2684 {2685 "provider": "openai",2686 "api_family": "agents-platform/agents",2687 "name": "EnvironmentResourceNone",2688 "object": null,2689 "schema_name": "EnvironmentResourceNone",2690 "description": "The session talks to CCA without selecting or provisioning an execution environment.",2691 "fields": [2692 {2693 "name": "type",2694 "type": "string",2695 "required": true,2696 "description": "The type of the object. Always `none`.",2697 "enum": [2698 "none"2699 ],2700 "const": "none"2701 }2702 ],2703 "status": [2704 "DOCUMENTED",2705 "BETA"2706 ],2707 "example": null,2708 "sources": [2709 {2710 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2711 "retrieved_at": "2026-09-18T00:00:00Z"2712 }2713 ]2714 },2715 {2716 "provider": "openai",2717 "api_family": "agents-platform/agents",2718 "name": "EnvironmentResourceOpenaiHosted",2719 "object": null,2720 "schema_name": "EnvironmentResourceOpenaiHosted",2721 "description": "An environment hosted by OpenAI.",2722 "fields": [2723 {2724 "name": "type",2725 "type": "string",2726 "required": true,2727 "description": "The type of the object. Always `openai_hosted`.",2728 "enum": [2729 "openai_hosted"2730 ],2731 "const": "openai_hosted"2732 },2733 {2734 "name": "id",2735 "type": "string",2736 "required": true,2737 "description": "The public ID of the environment."2738 },2739 {2740 "name": "packages",2741 "type": "EnvironmentPackagesResource",2742 "required": true,2743 "description": "Packages installed in the environment."2744 },2745 {2746 "name": "network",2747 "type": "NetworkPolicyResource",2748 "required": true,2749 "description": "The effective network access policy for the environment."2750 },2751 {2752 "name": "capability_directories",2753 "type": "array<string>",2754 "required": true,2755 "description": "Directories that contain capabilities exposed to the agent."2756 },2757 {2758 "name": "skills",2759 "type": "array<HostedSkillResource>",2760 "required": true,2761 "description": "Skills installed in the environment, excluding their archive contents."2762 },2763 {2764 "name": "plugins",2765 "type": "array<HostedPluginResource>",2766 "required": true,2767 "description": "Plugins installed in the environment, excluding their archive contents."2768 },2769 {2770 "name": "files",2771 "type": "array<HostedEnvironmentFileResource>",2772 "required": true,2773 "description": "Files available in the environment, excluding their contents."2774 }2775 ],2776 "status": [2777 "DOCUMENTED",2778 "BETA"2779 ],2780 "example": null,2781 "sources": [2782 {2783 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2784 "retrieved_at": "2026-09-18T00:00:00Z"2785 }2786 ]2787 },2788 {2789 "provider": "openai",2790 "api_family": "agents-platform/agents",2791 "name": "EnvironmentResourceSelfHosted",2792 "object": null,2793 "schema_name": "EnvironmentResourceSelfHosted",2794 "description": "An environment hosted by the application.",2795 "fields": [2796 {2797 "name": "type",2798 "type": "string",2799 "required": true,2800 "description": "The type of the object. Always `self_hosted`.",2801 "enum": [2802 "self_hosted"2803 ],2804 "const": "self_hosted"2805 },2806 {2807 "name": "remote_url",2808 "type": "string",2809 "required": true,2810 "description": "Pass this URL unchanged to `codex exec-server --remote` when connecting this environment."2811 },2812 {2813 "name": "id",2814 "type": "string",2815 "required": true,2816 "description": "The public ID of the environment."2817 },2818 {2819 "name": "workspace_directory",2820 "type": "string",2821 "required": true,2822 "description": "The absolute project directory inside the environment. Defaults to `/workspace`."2823 },2824 {2825 "name": "capability_directories",2826 "type": "array<string>",2827 "required": true,2828 "description": "Directories that contain capabilities exposed to the agent."2829 }2830 ],2831 "status": [2832 "DOCUMENTED",2833 "BETA"2834 ],2835 "example": null,2836 "sources": [2837 {2838 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2839 "retrieved_at": "2026-09-18T00:00:00Z"2840 }2841 ]2842 },2843 {2844 "provider": "openai",2845 "api_family": "agents-platform/agents",2846 "name": "SessionRequiredActionResourceFunctionCall",2847 "object": null,2848 "schema_name": "SessionRequiredActionResourceFunctionCall",2849 "description": "Run a function tool and submit its result.",2850 "fields": [2851 {2852 "name": "type",2853 "type": "string",2854 "required": true,2855 "description": "The type of the object. Always `function_call`.",2856 "enum": [2857 "function_call"2858 ],2859 "const": "function_call"2860 },2861 {2862 "name": "turn_id",2863 "type": "string",2864 "required": true,2865 "description": "The ID of the turn that requested the function call."2866 },2867 {2868 "name": "call_id",2869 "type": "string",2870 "required": true,2871 "description": "The ID to include when submitting the function result."2872 },2873 {2874 "name": "name",2875 "type": "string",2876 "required": true,2877 "description": "The function name."2878 },2879 {2880 "name": "arguments",2881 "type": "any",2882 "required": true,2883 "description": "The arguments supplied by the model."2884 }2885 ],2886 "status": [2887 "DOCUMENTED",2888 "BETA"2889 ],2890 "example": null,2891 "sources": [2892 {2893 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2894 "retrieved_at": "2026-09-18T00:00:00Z"2895 }2896 ]2897 },2898 {2899 "provider": "openai",2900 "api_family": "agents-platform/agents",2901 "name": "SessionRequiredActionResourceEnvironmentConnection",2902 "object": null,2903 "schema_name": "SessionRequiredActionResourceEnvironmentConnection",2904 "description": "Reconnect a session environment.",2905 "fields": [2906 {2907 "name": "type",2908 "type": "string",2909 "required": true,2910 "description": "The type of the object. Always `environment_connection`.",2911 "enum": [2912 "environment_connection"2913 ],2914 "const": "environment_connection"2915 },2916 {2917 "name": "environment_id",2918 "type": "string",2919 "required": true,2920 "description": "The ID of the environment to reconnect."2921 }2922 ],2923 "status": [2924 "DOCUMENTED",2925 "BETA"2926 ],2927 "example": null,2928 "sources": [2929 {2930 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2931 "retrieved_at": "2026-09-18T00:00:00Z"2932 }2933 ]2934 },2935 {2936 "provider": "openai",2937 "api_family": "agents-platform/agents",2938 "name": "TokenUsageResource",2939 "object": null,2940 "schema_name": "TokenUsageResource",2941 "description": "Recorded token usage for a session or turn. Usage is best effort and may change.",2942 "fields": [2943 {2944 "name": "input_tokens",2945 "type": "integer",2946 "required": true,2947 "description": "The number of input tokens used by the agent."2948 },2949 {2950 "name": "input_tokens_details",2951 "type": "InputTokensDetailsResource",2952 "required": true,2953 "description": "A breakdown of the agent's input token usage."2954 },2955 {2956 "name": "output_tokens",2957 "type": "integer",2958 "required": true,2959 "description": "The number of output tokens generated by the agent."2960 },2961 {2962 "name": "output_tokens_details",2963 "type": "OutputTokensDetailsResource",2964 "required": true,2965 "description": "A breakdown of the agent's output token usage."2966 },2967 {2968 "name": "total_tokens",2969 "type": "integer",2970 "required": true,2971 "description": "The total number of input and output tokens used by the agent."2972 }2973 ],2974 "status": [2975 "DOCUMENTED",2976 "BETA"2977 ],2978 "example": null,2979 "sources": [2980 {2981 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",2982 "retrieved_at": "2026-09-18T00:00:00Z"2983 }2984 ]2985 },2986 {2987 "provider": "openai",2988 "api_family": "agents-platform/agents",2989 "name": "SessionTurnErrorResource",2990 "object": null,2991 "schema_name": "SessionTurnErrorResource",2992 "description": "A customer-safe error describing why a session request failed.",2993 "fields": [2994 {2995 "name": "code",2996 "type": "SessionTurnErrorCodeResource",2997 "required": true,2998 "description": "A stable, machine-readable failure category.",2999 "enum": [3000 "context_length_exceeded",3001 "session_budget_exceeded",3002 "usage_limit_exceeded",3003 "credit_balance_exhausted",3004 "rate_limit_exceeded",3005 "server_overloaded",3006 "cyber_policy",3007 "connection_failed",3008 "server_error",3009 "authentication_error",3010 "invalid_request",3011 "resource_not_found",3012 "sandbox_error",3013 "executor_version_incompatible",3014 "active_turn_not_steerable",3015 "request_timeout",3016 "internal_error"3017 ]3018 },3019 {3020 "name": "message",3021 "type": "string",3022 "required": true,3023 "description": "A customer-safe explanation of the failure."3024 }3025 ],3026 "status": [3027 "DOCUMENTED",3028 "BETA"3029 ],3030 "example": null,3031 "sources": [3032 {3033 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3034 "retrieved_at": "2026-09-18T00:00:00Z"3035 }3036 ]3037 },3038 {3039 "provider": "openai",3040 "api_family": "agents-platform/agents",3041 "name": "ReasoningResource",3042 "object": null,3043 "schema_name": "ReasoningResource",3044 "description": "The reasoning configuration used by an agent.",3045 "fields": [3046 {3047 "name": "effort",3048 "type": "ReasoningEffortResource | null",3049 "required": true,3050 "description": "The requested reasoning effort, or `null` when the model selects its own default."3051 },3052 {3053 "name": "summary",3054 "type": "ReasoningSummaryResource | null",3055 "required": true,3056 "description": "The requested reasoning summary format, or `null` when summaries are disabled."3057 }3058 ],3059 "status": [3060 "DOCUMENTED",3061 "BETA"3062 ],3063 "example": null,3064 "sources": [3065 {3066 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3067 "retrieved_at": "2026-09-18T00:00:00Z"3068 }3069 ]3070 },3071 {3072 "provider": "openai",3073 "api_family": "agents-platform/agents",3074 "name": "TextResource",3075 "object": null,3076 "schema_name": "TextResource",3077 "description": "The text configuration used by an agent.",3078 "fields": [3079 {3080 "name": "format",3081 "type": "TextFormatResource",3082 "required": true,3083 "description": "The effective output format. Defaults to ordinary text."3084 },3085 {3086 "name": "verbosity",3087 "type": "VerbosityResource",3088 "required": true,3089 "description": "The amount of text produced by the agent. Defaults to `medium`.",3090 "enum": [3091 "low",3092 "medium",3093 "high"3094 ]3095 }3096 ],3097 "status": [3098 "DOCUMENTED",3099 "BETA"3100 ],3101 "example": null,3102 "sources": [3103 {3104 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3105 "retrieved_at": "2026-09-18T00:00:00Z"3106 }3107 ]3108 },3109 {3110 "provider": "openai",3111 "api_family": "agents-platform/agents",3112 "name": "MultiAgentConfigResource",3113 "object": null,3114 "schema_name": "MultiAgentConfigResource",3115 "description": "The resolved configuration for creating and coordinating subagents.",3116 "fields": [3117 {3118 "name": "enabled",3119 "type": "boolean",3120 "required": true,3121 "description": "Whether subagent tools are enabled. Defaults to false."3122 },3123 {3124 "name": "max_concurrent_subagents",3125 "type": "integer | null",3126 "required": true,3127 "description": "Maximum number of subagents that may run concurrently, or null when disabled. Defaults to 6 when enabled."3128 }3129 ],3130 "status": [3131 "DOCUMENTED",3132 "BETA"3133 ],3134 "example": null,3135 "sources": [3136 {3137 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3138 "retrieved_at": "2026-09-18T00:00:00Z"3139 }3140 ]3141 },3142 {3143 "provider": "openai",3144 "api_family": "agents-platform/agents",3145 "name": "NetworkPolicyResource",3146 "object": null,3147 "schema_name": "NetworkPolicyResource",3148 "description": "Network access for an OpenAI-hosted environment.",3149 "fields": [3150 {3151 "name": "access",3152 "type": "NetworkAccessResource",3153 "required": true,3154 "description": "The environment's network access mode.",3155 "enum": [3156 "enabled",3157 "disabled",3158 "restricted"3159 ]3160 },3161 {3162 "name": "allowed_domains",3163 "type": "array<string>",3164 "required": true,3165 "description": "Domains the environment may access when network access is restricted."3166 }3167 ],3168 "status": [3169 "DOCUMENTED",3170 "BETA"3171 ],3172 "example": null,3173 "sources": [3174 {3175 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3176 "retrieved_at": "2026-09-18T00:00:00Z"3177 }3178 ]3179 },3180 {3181 "provider": "openai",3182 "api_family": "agents-platform/agents",3183 "name": "EnvironmentPackagesResource",3184 "object": null,3185 "schema_name": "EnvironmentPackagesResource",3186 "description": "Packages installed in an OpenAI-hosted environment.",3187 "fields": [3188 {3189 "name": "python",3190 "type": "array<string>",3191 "required": true,3192 "description": "Python packages installed in the environment."3193 },3194 {3195 "name": "system",3196 "type": "array<string>",3197 "required": true,3198 "description": "System packages installed in the environment."3199 },3200 {3201 "name": "npm",3202 "type": "array<string>",3203 "required": true,3204 "description": "npm packages installed globally in the environment."3205 }3206 ],3207 "status": [3208 "DOCUMENTED",3209 "BETA"3210 ],3211 "example": null,3212 "sources": [3213 {3214 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3215 "retrieved_at": "2026-09-18T00:00:00Z"3216 }3217 ]3218 },3219 {3220 "provider": "openai",3221 "api_family": "agents-platform/vaults",3222 "name": "VaultCredentialAuthResourceStaticBearer",3223 "object": null,3224 "schema_name": "VaultCredentialAuthResourceStaticBearer",3225 "description": "Metadata for a bearer-token credential, without automatic OAuth refresh.",3226 "fields": [3227 {3228 "name": "type",3229 "type": "string",3230 "required": true,3231 "description": "The type of the object. Always `static_bearer`.",3232 "enum": [3233 "static_bearer"3234 ],3235 "const": "static_bearer"3236 },3237 {3238 "name": "mcp_server_url",3239 "type": "string",3240 "required": true,3241 "description": "The HTTPS MCP server URL authorized by this credential."3242 }3243 ],3244 "status": [3245 "DOCUMENTED",3246 "BETA"3247 ],3248 "example": null,3249 "sources": [3250 {3251 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3252 "retrieved_at": "2026-09-18T00:00:00Z"3253 }3254 ]3255 },3256 {3257 "provider": "openai",3258 "api_family": "agents-platform/vaults",3259 "name": "VaultCredentialAuthResourceMcpOauth",3260 "object": null,3261 "schema_name": "VaultCredentialAuthResourceMcpOauth",3262 "description": "Public metadata for an OAuth credential; tokens and client secrets are never returned.",3263 "fields": [3264 {3265 "name": "type",3266 "type": "string",3267 "required": true,3268 "description": "The type of the object. Always `mcp_oauth`.",3269 "enum": [3270 "mcp_oauth"3271 ],3272 "const": "mcp_oauth"3273 },3274 {3275 "name": "mcp_server_url",3276 "type": "string",3277 "required": true,3278 "description": "The HTTPS MCP server URL authorized by this credential."3279 },3280 {3281 "name": "expires_at",3282 "type": "string | null",3283 "required": true,3284 "description": "When the OAuth access token expires, as an RFC 3339 timestamp, if known."3285 },3286 {3287 "name": "refresh",3288 "type": "McpOauthRefreshResource | null",3289 "required": true,3290 "description": "Public refresh metadata without refresh tokens or OAuth client secrets."3291 }3292 ],3293 "status": [3294 "DOCUMENTED",3295 "BETA"3296 ],3297 "example": null,3298 "sources": [3299 {3300 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3301 "retrieved_at": "2026-09-18T00:00:00Z"3302 }3303 ]3304 },3305 {3306 "provider": "openai",3307 "api_family": "agents-platform/vaults",3308 "name": "VaultCredentialAuthResourceEnvironmentVariable",3309 "object": null,3310 "schema_name": "VaultCredentialAuthResourceEnvironmentVariable",3311 "description": "Metadata for an HTTP credential used only in OpenAI-hosted environments. Sandbox code receives a placeholder. The proxy substitutes the secret for allowed HTTPS destinations on ports 443 and 8443. The real secret is not available to sandbox code for local computation and is never returned in this resource.",3312 "fields": [3313 {3314 "name": "type",3315 "type": "string",3316 "required": true,3317 "description": "The type of the object. Always `environment_variable`.",3318 "enum": [3319 "environment_variable"3320 ],3321 "const": "environment_variable"3322 },3323 {3324 "name": "secret_name",3325 "type": "string",3326 "required": true,3327 "description": "The environment variable name that receives the placeholder in the sandbox."3328 },3329 {3330 "name": "networking",3331 "type": "VaultCredentialNetworkingResource",3332 "required": true,3333 "description": "The destinations where the proxy can substitute the secret, subject to the environment network policy."3334 }3335 ],3336 "status": [3337 "DOCUMENTED",3338 "BETA"3339 ],3340 "example": null,3341 "sources": [3342 {3343 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3344 "retrieved_at": "2026-09-18T00:00:00Z"3345 }3346 ]3347 },3348 {3349 "provider": "openai",3350 "api_family": "agents-platform/agents",3351 "name": "SessionEnvironmentStateResource",3352 "object": null,3353 "schema_name": "SessionEnvironmentStateResource",3354 "description": "The current state of a session environment.",3355 "fields": [3356 {3357 "name": "id",3358 "type": "string",3359 "required": true,3360 "description": "The public ID of the environment."3361 },3362 {3363 "name": "type",3364 "type": "string",3365 "required": true,3366 "description": "The environment type."3367 },3368 {3369 "name": "status",3370 "type": "SessionEnvironmentStatusResource",3371 "required": true,3372 "description": "The environment's connection status.",3373 "enum": [3374 "pending",3375 "ready",3376 "connected",3377 "disconnected",3378 "failed"3379 ]3380 },3381 {3382 "name": "error",3383 "type": "SessionEnvironmentErrorResource | null",3384 "required": true,3385 "description": "The error reported while preparing the environment, if any."3386 }3387 ],3388 "status": [3389 "DOCUMENTED",3390 "BETA"3391 ],3392 "example": null,3393 "sources": [3394 {3395 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3396 "retrieved_at": "2026-09-18T00:00:00Z"3397 }3398 ]3399 },3400 {3401 "provider": "openai",3402 "api_family": "agents-platform/chatkit",3403 "name": "ChatKit thread item: chatkit.user_message",3404 "object": "chatkit.thread_item",3405 "schema_name": "UserMessageItem",3406 "description": "User-authored messages within a thread.",3407 "fields": [3408 {3409 "name": "id",3410 "type": "string",3411 "required": true,3412 "description": "Identifier of the thread item."3413 },3414 {3415 "name": "object",3416 "type": "string",3417 "required": true,3418 "description": "Type discriminator that is always `chatkit.thread_item`."3419 },3420 {3421 "name": "created_at",3422 "type": "integer",3423 "required": true,3424 "description": "Unix timestamp (in seconds) for when the item was created."3425 },3426 {3427 "name": "thread_id",3428 "type": "string",3429 "required": true,3430 "description": "Identifier of the parent thread."3431 },3432 {3433 "name": "type",3434 "type": "string",3435 "required": true,3436 "description": "",3437 "enum": [3438 "chatkit.user_message"3439 ],3440 "const": "chatkit.user_message"3441 },3442 {3443 "name": "content",3444 "type": "array<UserMessageInputText | UserMessageQuotedText>",3445 "required": true,3446 "description": "Ordered content elements supplied by the user."3447 },3448 {3449 "name": "attachments",3450 "type": "array<Attachment>",3451 "required": true,3452 "description": "Attachments associated with the user message. Defaults to an empty list."3453 },3454 {3455 "name": "inference_options",3456 "type": "InferenceOptions | null",3457 "required": true,3458 "description": ""3459 }3460 ],3461 "status": [3462 "DOCUMENTED",3463 "BETA"3464 ],3465 "example": null,3466 "sources": [3467 {3468 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads",3469 "retrieved_at": "2026-09-18T00:00:00Z"3470 },3471 {3472 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3473 "retrieved_at": "2026-09-18T00:00:00Z"3474 }3475 ]3476 },3477 {3478 "provider": "openai",3479 "api_family": "agents-platform/chatkit",3480 "name": "ChatKit thread item: chatkit.assistant_message",3481 "object": "chatkit.thread_item",3482 "schema_name": "AssistantMessageItem",3483 "description": "Assistant-authored message within a thread.",3484 "fields": [3485 {3486 "name": "id",3487 "type": "string",3488 "required": true,3489 "description": "Identifier of the thread item."3490 },3491 {3492 "name": "object",3493 "type": "string",3494 "required": true,3495 "description": "Type discriminator that is always `chatkit.thread_item`."3496 },3497 {3498 "name": "created_at",3499 "type": "integer",3500 "required": true,3501 "description": "Unix timestamp (in seconds) for when the item was created."3502 },3503 {3504 "name": "thread_id",3505 "type": "string",3506 "required": true,3507 "description": "Identifier of the parent thread."3508 },3509 {3510 "name": "type",3511 "type": "string",3512 "required": true,3513 "description": "Type discriminator that is always `chatkit.assistant_message`.",3514 "enum": [3515 "chatkit.assistant_message"3516 ],3517 "const": "chatkit.assistant_message"3518 },3519 {3520 "name": "content",3521 "type": "array<ResponseOutputText>",3522 "required": true,3523 "description": "Ordered assistant response segments."3524 }3525 ],3526 "status": [3527 "DOCUMENTED",3528 "BETA"3529 ],3530 "example": null,3531 "sources": [3532 {3533 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads",3534 "retrieved_at": "2026-09-18T00:00:00Z"3535 },3536 {3537 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3538 "retrieved_at": "2026-09-18T00:00:00Z"3539 }3540 ]3541 },3542 {3543 "provider": "openai",3544 "api_family": "agents-platform/chatkit",3545 "name": "ChatKit thread item: chatkit.widget",3546 "object": "chatkit.thread_item",3547 "schema_name": "WidgetMessageItem",3548 "description": "Thread item that renders a widget payload.",3549 "fields": [3550 {3551 "name": "id",3552 "type": "string",3553 "required": true,3554 "description": "Identifier of the thread item."3555 },3556 {3557 "name": "object",3558 "type": "string",3559 "required": true,3560 "description": "Type discriminator that is always `chatkit.thread_item`."3561 },3562 {3563 "name": "created_at",3564 "type": "integer",3565 "required": true,3566 "description": "Unix timestamp (in seconds) for when the item was created."3567 },3568 {3569 "name": "thread_id",3570 "type": "string",3571 "required": true,3572 "description": "Identifier of the parent thread."3573 },3574 {3575 "name": "type",3576 "type": "string",3577 "required": true,3578 "description": "Type discriminator that is always `chatkit.widget`.",3579 "enum": [3580 "chatkit.widget"3581 ],3582 "const": "chatkit.widget"3583 },3584 {3585 "name": "widget",3586 "type": "string",3587 "required": true,3588 "description": "Serialized widget payload rendered in the UI."3589 }3590 ],3591 "status": [3592 "DOCUMENTED",3593 "BETA"3594 ],3595 "example": null,3596 "sources": [3597 {3598 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads",3599 "retrieved_at": "2026-09-18T00:00:00Z"3600 },3601 {3602 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3603 "retrieved_at": "2026-09-18T00:00:00Z"3604 }3605 ]3606 },3607 {3608 "provider": "openai",3609 "api_family": "agents-platform/chatkit",3610 "name": "ChatKit thread item: chatkit.client_tool_call",3611 "object": "chatkit.thread_item",3612 "schema_name": "ClientToolCallItem",3613 "description": "Record of a client side tool invocation initiated by the assistant.",3614 "fields": [3615 {3616 "name": "id",3617 "type": "string",3618 "required": true,3619 "description": "Identifier of the thread item."3620 },3621 {3622 "name": "object",3623 "type": "string",3624 "required": true,3625 "description": "Type discriminator that is always `chatkit.thread_item`."3626 },3627 {3628 "name": "created_at",3629 "type": "integer",3630 "required": true,3631 "description": "Unix timestamp (in seconds) for when the item was created."3632 },3633 {3634 "name": "thread_id",3635 "type": "string",3636 "required": true,3637 "description": "Identifier of the parent thread."3638 },3639 {3640 "name": "type",3641 "type": "string",3642 "required": true,3643 "description": "Type discriminator that is always `chatkit.client_tool_call`.",3644 "enum": [3645 "chatkit.client_tool_call"3646 ],3647 "const": "chatkit.client_tool_call"3648 },3649 {3650 "name": "status",3651 "type": "ClientToolCallStatus",3652 "required": true,3653 "description": "Execution status for the tool call.",3654 "enum": [3655 "in_progress",3656 "completed"3657 ]3658 },3659 {3660 "name": "call_id",3661 "type": "string",3662 "required": true,3663 "description": "Identifier for the client tool call."3664 },3665 {3666 "name": "name",3667 "type": "string",3668 "required": true,3669 "description": "Tool name that was invoked."3670 },3671 {3672 "name": "arguments",3673 "type": "string",3674 "required": true,3675 "description": "JSON-encoded arguments that were sent to the tool."3676 },3677 {3678 "name": "output",3679 "type": "string | null",3680 "required": true,3681 "description": ""3682 }3683 ],3684 "status": [3685 "DOCUMENTED",3686 "BETA"3687 ],3688 "example": null,3689 "sources": [3690 {3691 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads",3692 "retrieved_at": "2026-09-18T00:00:00Z"3693 },3694 {3695 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3696 "retrieved_at": "2026-09-18T00:00:00Z"3697 }3698 ]3699 },3700 {3701 "provider": "openai",3702 "api_family": "agents-platform/chatkit",3703 "name": "ChatKit thread item: chatkit.task",3704 "object": "chatkit.thread_item",3705 "schema_name": "TaskItem",3706 "description": "Task emitted by the workflow to show progress and status updates.",3707 "fields": [3708 {3709 "name": "id",3710 "type": "string",3711 "required": true,3712 "description": "Identifier of the thread item."3713 },3714 {3715 "name": "object",3716 "type": "string",3717 "required": true,3718 "description": "Type discriminator that is always `chatkit.thread_item`."3719 },3720 {3721 "name": "created_at",3722 "type": "integer",3723 "required": true,3724 "description": "Unix timestamp (in seconds) for when the item was created."3725 },3726 {3727 "name": "thread_id",3728 "type": "string",3729 "required": true,3730 "description": "Identifier of the parent thread."3731 },3732 {3733 "name": "type",3734 "type": "string",3735 "required": true,3736 "description": "Type discriminator that is always `chatkit.task`.",3737 "enum": [3738 "chatkit.task"3739 ],3740 "const": "chatkit.task"3741 },3742 {3743 "name": "task_type",3744 "type": "TaskType",3745 "required": true,3746 "description": "Subtype for the task.",3747 "enum": [3748 "custom",3749 "thought"3750 ]3751 },3752 {3753 "name": "heading",3754 "type": "string | null",3755 "required": true,3756 "description": ""3757 },3758 {3759 "name": "summary",3760 "type": "string | null",3761 "required": true,3762 "description": ""3763 }3764 ],3765 "status": [3766 "DOCUMENTED",3767 "BETA"3768 ],3769 "example": null,3770 "sources": [3771 {3772 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads",3773 "retrieved_at": "2026-09-18T00:00:00Z"3774 },3775 {3776 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3777 "retrieved_at": "2026-09-18T00:00:00Z"3778 }3779 ]3780 },3781 {3782 "provider": "openai",3783 "api_family": "agents-platform/chatkit",3784 "name": "ChatKit thread item: chatkit.task_group",3785 "object": "chatkit.thread_item",3786 "schema_name": "TaskGroupItem",3787 "description": "Collection of workflow tasks grouped together in the thread.",3788 "fields": [3789 {3790 "name": "id",3791 "type": "string",3792 "required": true,3793 "description": "Identifier of the thread item."3794 },3795 {3796 "name": "object",3797 "type": "string",3798 "required": true,3799 "description": "Type discriminator that is always `chatkit.thread_item`."3800 },3801 {3802 "name": "created_at",3803 "type": "integer",3804 "required": true,3805 "description": "Unix timestamp (in seconds) for when the item was created."3806 },3807 {3808 "name": "thread_id",3809 "type": "string",3810 "required": true,3811 "description": "Identifier of the parent thread."3812 },3813 {3814 "name": "type",3815 "type": "string",3816 "required": true,3817 "description": "Type discriminator that is always `chatkit.task_group`.",3818 "enum": [3819 "chatkit.task_group"3820 ],3821 "const": "chatkit.task_group"3822 },3823 {3824 "name": "tasks",3825 "type": "array<TaskGroupTask>",3826 "required": true,3827 "description": "Tasks included in the group."3828 }3829 ],3830 "status": [3831 "DOCUMENTED",3832 "BETA"3833 ],3834 "example": null,3835 "sources": [3836 {3837 "url": "https://developers.openai.com/api/reference/resources/beta/subresources/chatkit/subresources/threads",3838 "retrieved_at": "2026-09-18T00:00:00Z"3839 },3840 {3841 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3842 "retrieved_at": "2026-09-18T00:00:00Z"3843 }3844 ]3845 },3846 {3847 "provider": "openai",3848 "api_family": "agents-platform",3849 "name": "enum SessionStatusResource",3850 "object": null,3851 "schema_name": "SessionStatusResource",3852 "description": "The current status of a session.",3853 "enum": [3854 "idle",3855 "in_progress",3856 "requires_action",3857 "failed"3858 ],3859 "fields": [],3860 "status": [3861 "DOCUMENTED",3862 "BETA"3863 ],3864 "sources": [3865 {3866 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3867 "retrieved_at": "2026-09-18T00:00:00Z"3868 }3869 ]3870 },3871 {3872 "provider": "openai",3873 "api_family": "agents-platform",3874 "name": "enum TurnStatusResource",3875 "object": null,3876 "schema_name": "TurnStatusResource",3877 "description": "The current status of a turn.",3878 "enum": [3879 "queued",3880 "in_progress",3881 "waiting",3882 "completed",3883 "failed",3884 "cancelled"3885 ],3886 "fields": [],3887 "status": [3888 "DOCUMENTED",3889 "BETA"3890 ],3891 "sources": [3892 {3893 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3894 "retrieved_at": "2026-09-18T00:00:00Z"3895 }3896 ]3897 },3898 {3899 "provider": "openai",3900 "api_family": "agents-platform",3901 "name": "enum SubagentStatusResource",3902 "object": null,3903 "schema_name": "SubagentStatusResource",3904 "description": "The current status of a subagent.",3905 "enum": [3906 "active",3907 "closed"3908 ],3909 "fields": [],3910 "status": [3911 "DOCUMENTED",3912 "BETA"3913 ],3914 "sources": [3915 {3916 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3917 "retrieved_at": "2026-09-18T00:00:00Z"3918 }3919 ]3920 },3921 {3922 "provider": "openai",3923 "api_family": "agents-platform",3924 "name": "enum EnvironmentStatusResource",3925 "object": null,3926 "schema_name": "EnvironmentStatusResource",3927 "description": "The public lifecycle status of an execution environment.",3928 "enum": [3929 "pending",3930 "connected",3931 "disconnected",3932 "expired",3933 "failed"3934 ],3935 "fields": [],3936 "status": [3937 "DOCUMENTED",3938 "BETA"3939 ],3940 "sources": [3941 {3942 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3943 "retrieved_at": "2026-09-18T00:00:00Z"3944 }3945 ]3946 },3947 {3948 "provider": "openai",3949 "api_family": "agents-platform",3950 "name": "enum SessionEnvironmentStatusResource",3951 "object": null,3952 "schema_name": "SessionEnvironmentStatusResource",3953 "description": "The connection status of a session environment.",3954 "enum": [3955 "pending",3956 "ready",3957 "connected",3958 "disconnected",3959 "failed"3960 ],3961 "fields": [],3962 "status": [3963 "DOCUMENTED",3964 "BETA"3965 ],3966 "sources": [3967 {3968 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",3969 "retrieved_at": "2026-09-18T00:00:00Z"3970 }3971 ]3972 },3973 {3974 "provider": "openai",3975 "api_family": "agents-platform",3976 "name": "enum SessionTurnErrorCodeResource",3977 "object": null,3978 "schema_name": "SessionTurnErrorCodeResource",3979 "description": "Stable public categories for session request failures.",3980 "enum": [3981 "context_length_exceeded",3982 "session_budget_exceeded",3983 "usage_limit_exceeded",3984 "credit_balance_exhausted",3985 "rate_limit_exceeded",3986 "server_overloaded",3987 "cyber_policy",3988 "connection_failed",3989 "server_error",3990 "authentication_error",3991 "invalid_request",3992 "resource_not_found",3993 "sandbox_error",3994 "executor_version_incompatible",3995 "active_turn_not_steerable",3996 "request_timeout",3997 "internal_error"3998 ],3999 "fields": [],4000 "status": [4001 "DOCUMENTED",4002 "BETA"4003 ],4004 "sources": [4005 {4006 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4007 "retrieved_at": "2026-09-18T00:00:00Z"4008 }4009 ]4010 },4011 {4012 "provider": "openai",4013 "api_family": "agents-platform",4014 "name": "enum FunctionCallStatusResource",4015 "object": null,4016 "schema_name": "FunctionCallStatusResource",4017 "description": "The status of a tool call.",4018 "enum": [4019 "in_progress",4020 "completed",4021 "failed",4022 "incomplete"4023 ],4024 "fields": [],4025 "status": [4026 "DOCUMENTED",4027 "BETA"4028 ],4029 "sources": [4030 {4031 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4032 "retrieved_at": "2026-09-18T00:00:00Z"4033 }4034 ]4035 },4036 {4037 "provider": "openai",4038 "api_family": "agents-platform",4039 "name": "enum OutputItemStatusResource",4040 "object": null,4041 "schema_name": "OutputItemStatusResource",4042 "description": "The status of an agent output item.",4043 "enum": [4044 "in_progress",4045 "completed",4046 "incomplete"4047 ],4048 "fields": [],4049 "status": [4050 "DOCUMENTED",4051 "BETA"4052 ],4053 "sources": [4054 {4055 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4056 "retrieved_at": "2026-09-18T00:00:00Z"4057 }4058 ]4059 },4060 {4061 "provider": "openai",4062 "api_family": "agents-platform",4063 "name": "enum MessagePhaseResource",4064 "object": null,4065 "schema_name": "MessagePhaseResource",4066 "description": "The phase of an assistant message.",4067 "enum": [4068 "commentary",4069 "final_answer"4070 ],4071 "fields": [],4072 "status": [4073 "DOCUMENTED",4074 "BETA"4075 ],4076 "sources": [4077 {4078 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4079 "retrieved_at": "2026-09-18T00:00:00Z"4080 }4081 ]4082 },4083 {4084 "provider": "openai",4085 "api_family": "agents-platform",4086 "name": "enum ReasoningEffortParam",4087 "object": null,4088 "schema_name": "ReasoningEffortParam",4089 "description": "The amount of reasoning effort the model should use.",4090 "enum": [4091 "none",4092 "minimal",4093 "low",4094 "medium",4095 "high",4096 "xhigh",4097 "max"4098 ],4099 "fields": [],4100 "status": [4101 "DOCUMENTED",4102 "BETA"4103 ],4104 "sources": [4105 {4106 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4107 "retrieved_at": "2026-09-18T00:00:00Z"4108 }4109 ]4110 },4111 {4112 "provider": "openai",4113 "api_family": "agents-platform",4114 "name": "enum ServiceTierParam",4115 "object": null,4116 "schema_name": "ServiceTierParam",4117 "description": "The service tier used for model requests.",4118 "enum": [4119 "auto",4120 "default",4121 "flex",4122 "priority",4123 "fast"4124 ],4125 "fields": [],4126 "status": [4127 "DOCUMENTED",4128 "BETA"4129 ],4130 "sources": [4131 {4132 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4133 "retrieved_at": "2026-09-18T00:00:00Z"4134 }4135 ]4136 },4137 {4138 "provider": "openai",4139 "api_family": "agents-platform",4140 "name": "enum NetworkAccessParam",4141 "object": null,4142 "schema_name": "NetworkAccessParam",4143 "description": "The network access mode for an OpenAI-hosted environment.",4144 "enum": [4145 "enabled",4146 "disabled",4147 "restricted"4148 ],4149 "fields": [],4150 "status": [4151 "DOCUMENTED",4152 "BETA"4153 ],4154 "sources": [4155 {4156 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4157 "retrieved_at": "2026-09-18T00:00:00Z"4158 }4159 ]4160 },4161 {4162 "provider": "openai",4163 "api_family": "agents-platform",4164 "name": "enum McpConnectionOriginParam",4165 "object": null,4166 "schema_name": "McpConnectionOriginParam",4167 "description": "Where outbound MCP HTTP connections originate.",4168 "enum": [4169 "service",4170 "environment"4171 ],4172 "fields": [],4173 "status": [4174 "DOCUMENTED",4175 "BETA"4176 ],4177 "sources": [4178 {4179 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4180 "retrieved_at": "2026-09-18T00:00:00Z"4181 }4182 ]4183 },4184 {4185 "provider": "openai",4186 "api_family": "agents-platform",4187 "name": "enum WebSearchModeParam",4188 "object": null,4189 "schema_name": "WebSearchModeParam",4190 "description": "The source used for web search results.",4191 "enum": [4192 "disabled",4193 "cached",4194 "live"4195 ],4196 "fields": [],4197 "status": [4198 "DOCUMENTED",4199 "BETA"4200 ],4201 "sources": [4202 {4203 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4204 "retrieved_at": "2026-09-18T00:00:00Z"4205 }4206 ]4207 },4208 {4209 "provider": "openai",4210 "api_family": "agents-platform",4211 "name": "enum VaultStatusParam",4212 "object": null,4213 "schema_name": "VaultStatusParam",4214 "description": "Whether a vault or credential is active or archived.",4215 "enum": [4216 "active",4217 "archived"4218 ],4219 "fields": [],4220 "status": [4221 "DOCUMENTED",4222 "BETA"4223 ],4224 "sources": [4225 {4226 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4227 "retrieved_at": "2026-09-18T00:00:00Z"4228 }4229 ]4230 },4231 {4232 "provider": "openai",4233 "api_family": "agents-platform",4234 "name": "enum ChatSessionStatus",4235 "object": null,4236 "schema_name": "ChatSessionStatus",4237 "description": "",4238 "enum": [4239 "active",4240 "expired",4241 "cancelled"4242 ],4243 "fields": [],4244 "status": [4245 "DOCUMENTED",4246 "BETA"4247 ],4248 "sources": [4249 {4250 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4251 "retrieved_at": "2026-09-18T00:00:00Z"4252 }4253 ]4254 },4255 {4256 "provider": "openai",4257 "api_family": "agents-platform/workspace-agents",4258 "name": "Workspace agent trigger run",4259 "object": "workspace_agent.trigger_run",4260 "schema_name": null,4261 "description": "Status of a trigger run on api.chatgpt.com (beta; requires OpenAI-Beta: workspace_agent_runs=v1).",4262 "fields": [4263 {4264 "name": "object",4265 "type": "\"workspace_agent.trigger_run\"",4266 "required": true,4267 "description": ""4268 },4269 {4270 "name": "id",4271 "type": "string (apirun_…)",4272 "required": true,4273 "description": ""4274 },4275 {4276 "name": "status",4277 "type": "queued|in_progress|suspended|completed|failed",4278 "required": true,4279 "description": "completed/failed terminal"4280 },4281 {4282 "name": "created_at",4283 "type": "integer",4284 "required": true,4285 "description": ""4286 },4287 {4288 "name": "agent_id",4289 "type": "string (agt_…)",4290 "required": true,4291 "description": ""4292 },4293 {4294 "name": "api_trigger_id",4295 "type": "string (agtch_…)",4296 "required": true,4297 "description": ""4298 },4299 {4300 "name": "conversation_url",4301 "type": "string",4302 "required": true,4303 "description": "https://chatgpt.com/c/…"4304 },4305 {4306 "name": "error",4307 "type": "null | {code: dispatch_failed|run_failed}",4308 "required": true,4309 "description": ""4310 }4311 ],4312 "status": [4313 "DOCUMENTED",4314 "BETA",4315 "UNVERIFIED"4316 ],4317 "example": {4318 "object": "workspace_agent.trigger_run",4319 "id": "apirun_123",4320 "status": "in_progress",4321 "created_at": 1784763880,4322 "agent_id": "agt_123",4323 "api_trigger_id": "agtch_123",4324 "conversation_url": "https://chatgpt.com/c/123",4325 "error": null4326 },4327 "sources": [4328 {4329 "url": "https://developers.openai.com/workspace-agents/trigger-runs",4330 "retrieved_at": "2026-09-18T00:00:00Z"4331 }4332 ]4333 },4334 {4335 "provider": "openai",4336 "api_family": "agents-platform/assistants",4337 "name": "assistant (RETIRED 2026-08-26)",4338 "object": "assistant",4339 "schema_name": "AssistantObject",4340 "description": "Represents an `assistant` that can call the model and use tools.",4341 "fields": [4342 {4343 "name": "id"4344 },4345 {4346 "name": "object"4347 },4348 {4349 "name": "created_at"4350 },4351 {4352 "name": "name"4353 },4354 {4355 "name": "description"4356 },4357 {4358 "name": "model"4359 },4360 {4361 "name": "instructions"4362 },4363 {4364 "name": "tools"4365 },4366 {4367 "name": "tool_resources"4368 },4369 {4370 "name": "metadata"4371 },4372 {4373 "name": "temperature"4374 },4375 {4376 "name": "top_p"4377 },4378 {4379 "name": "response_format"4380 }4381 ],4382 "status": [4383 "RETIRED",4384 "DOCUMENTED"4385 ],4386 "replacement": "Prompt (dashboard) / Agent",4387 "sources": [4388 {4389 "url": "https://developers.openai.com/api/docs/assistants/migration",4390 "retrieved_at": "2026-09-18T00:00:00Z"4391 },4392 {4393 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4394 "retrieved_at": "2026-09-18T00:00:00Z"4395 }4396 ]4397 },4398 {4399 "provider": "openai",4400 "api_family": "agents-platform/assistants",4401 "name": "thread (RETIRED 2026-08-26)",4402 "object": "thread",4403 "schema_name": "ThreadObject",4404 "description": "Represents a thread that contains [messages](https://developers.openai.com/api/docs/assistants/migration).",4405 "fields": [4406 {4407 "name": "id"4408 },4409 {4410 "name": "object"4411 },4412 {4413 "name": "created_at"4414 },4415 {4416 "name": "tool_resources"4417 },4418 {4419 "name": "metadata"4420 }4421 ],4422 "status": [4423 "RETIRED",4424 "DOCUMENTED"4425 ],4426 "replacement": "Conversation",4427 "sources": [4428 {4429 "url": "https://developers.openai.com/api/docs/assistants/migration",4430 "retrieved_at": "2026-09-18T00:00:00Z"4431 },4432 {4433 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4434 "retrieved_at": "2026-09-18T00:00:00Z"4435 }4436 ]4437 },4438 {4439 "provider": "openai",4440 "api_family": "agents-platform/assistants",4441 "name": "thread.message (RETIRED 2026-08-26)",4442 "object": "thread.message",4443 "schema_name": "MessageObject",4444 "description": "Represents a message within a [thread](https://developers.openai.com/api/docs/assistants/migration).",4445 "fields": [4446 {4447 "name": "id"4448 },4449 {4450 "name": "object"4451 },4452 {4453 "name": "created_at"4454 },4455 {4456 "name": "thread_id"4457 },4458 {4459 "name": "status"4460 },4461 {4462 "name": "incomplete_details"4463 },4464 {4465 "name": "completed_at"4466 },4467 {4468 "name": "incomplete_at"4469 },4470 {4471 "name": "role"4472 },4473 {4474 "name": "content"4475 },4476 {4477 "name": "assistant_id"4478 },4479 {4480 "name": "run_id"4481 },4482 {4483 "name": "attachments"4484 },4485 {4486 "name": "metadata"4487 }4488 ],4489 "status": [4490 "RETIRED",4491 "DOCUMENTED"4492 ],4493 "replacement": "Conversation item",4494 "sources": [4495 {4496 "url": "https://developers.openai.com/api/docs/assistants/migration",4497 "retrieved_at": "2026-09-18T00:00:00Z"4498 },4499 {4500 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4501 "retrieved_at": "2026-09-18T00:00:00Z"4502 }4503 ]4504 },4505 {4506 "provider": "openai",4507 "api_family": "agents-platform/assistants",4508 "name": "thread.run (RETIRED 2026-08-26)",4509 "object": "thread.run",4510 "schema_name": "RunObject",4511 "description": "Represents an execution run on a [thread](https://developers.openai.com/api/docs/assistants/migration).",4512 "fields": [4513 {4514 "name": "id"4515 },4516 {4517 "name": "object"4518 },4519 {4520 "name": "created_at"4521 },4522 {4523 "name": "thread_id"4524 },4525 {4526 "name": "assistant_id"4527 },4528 {4529 "name": "status"4530 },4531 {4532 "name": "required_action"4533 },4534 {4535 "name": "last_error"4536 },4537 {4538 "name": "expires_at"4539 },4540 {4541 "name": "started_at"4542 },4543 {4544 "name": "cancelled_at"4545 },4546 {4547 "name": "failed_at"4548 },4549 {4550 "name": "completed_at"4551 },4552 {4553 "name": "incomplete_details"4554 },4555 {4556 "name": "model"4557 },4558 {4559 "name": "instructions"4560 },4561 {4562 "name": "tools"4563 },4564 {4565 "name": "metadata"4566 },4567 {4568 "name": "usage"4569 },4570 {4571 "name": "temperature"4572 },4573 {4574 "name": "top_p"4575 },4576 {4577 "name": "max_prompt_tokens"4578 },4579 {4580 "name": "max_completion_tokens"4581 },4582 {4583 "name": "truncation_strategy"4584 },4585 {4586 "name": "tool_choice"4587 },4588 {4589 "name": "parallel_tool_calls"4590 },4591 {4592 "name": "response_format"4593 }4594 ],4595 "status": [4596 "RETIRED",4597 "DOCUMENTED"4598 ],4599 "replacement": "Response",4600 "sources": [4601 {4602 "url": "https://developers.openai.com/api/docs/assistants/migration",4603 "retrieved_at": "2026-09-18T00:00:00Z"4604 },4605 {4606 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4607 "retrieved_at": "2026-09-18T00:00:00Z"4608 }4609 ]4610 },4611 {4612 "provider": "openai",4613 "api_family": "agents-platform/assistants",4614 "name": "thread.run.step (RETIRED 2026-08-26)",4615 "object": "thread.run.step",4616 "schema_name": "RunStepObject",4617 "description": "Represents a step in execution of a run.",4618 "fields": [4619 {4620 "name": "id"4621 },4622 {4623 "name": "object"4624 },4625 {4626 "name": "created_at"4627 },4628 {4629 "name": "assistant_id"4630 },4631 {4632 "name": "thread_id"4633 },4634 {4635 "name": "run_id"4636 },4637 {4638 "name": "type"4639 },4640 {4641 "name": "status"4642 },4643 {4644 "name": "step_details"4645 },4646 {4647 "name": "last_error"4648 },4649 {4650 "name": "expired_at"4651 },4652 {4653 "name": "cancelled_at"4654 },4655 {4656 "name": "failed_at"4657 },4658 {4659 "name": "completed_at"4660 },4661 {4662 "name": "metadata"4663 },4664 {4665 "name": "usage"4666 }4667 ],4668 "status": [4669 "RETIRED",4670 "DOCUMENTED"4671 ],4672 "replacement": "Response output item",4673 "sources": [4674 {4675 "url": "https://developers.openai.com/api/docs/assistants/migration",4676 "retrieved_at": "2026-09-18T00:00:00Z"4677 },4678 {4679 "url": "https://github.com/openai/openai-openapi (openapi-master.yaml)",4680 "retrieved_at": "2026-09-18T00:00:00Z"4681 }4682 ]4683 }4684 ]4685}