Skip to content

OpenAI

Updated View as Markdown

Use the official OpenAI REST API for non-streaming Responses, chat completions, embeddings, model discovery, files, vector stores and supported administration operations. Each command preserves its native JSON request and result, including usage.

Example workflows

Copy a prompt into your connected AI client after connecting this integration. Choose resources you can access and review the supported command before running it.

List voice consents

Help me with this task in OpenAI: List voice consents. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.

Explore this command: openai.listvoiceconsents

Help me with this task in OpenAI: Retrieve voice consent. Ask me for any required inputs and confirm the resources and scope before calling the command. Read one response page. Turn the returned data into a concise working summary with original IDs, dates and source links when available. Separate missing information from confirmed results and tell me whether more pages remain. Do not invent fields or change data.

Explore this command: openai.getvoiceconsent

What you can do (331)

What you can do

Available commands: 331 (148 read, 183 write). Enable only the commands your application needs.

Command Effect
List voice consents — openai.listvoiceconsents Read
Retrieve voice consent — openai.getvoiceconsent Read
Update voice consent — openai.updatevoiceconsent Write
Delete voice consent — openai.deletevoiceconsent Write
Create voice — openai.createvoice Write
Delete voice — openai.deletevoice Write
Create batch — openai.createbatch Write
List batches — openai.listbatches Read
Retrieve batch — openai.retrievebatch Read
Cancel batch — openai.cancelbatch Write
List Chat Completions — openai.listchatcompletions Read
Create chat completion — openai.createchatcompletion Write
Get chat completion — openai.getchatcompletion Read
Update chat completion — openai.updatechatcompletion Write
Delete chat completion — openai.deletechatcompletion Write
Get chat messages — openai.getchatcompletionmessages Read
Create completion — openai.createcompletion Write
List containers — openai.listcontainers Read
Create container — openai.createcontainer Write
Retrieve container — openai.retrievecontainer Read
Delete a container — openai.deletecontainer Write
List container files — openai.listcontainerfiles Read
Retrieve container file — openai.retrievecontainerfile Read
Delete a container file — openai.deletecontainerfile Write
Create items — openai.createconversationitems Write
List items — openai.listconversationitems Read
Retrieve an item — openai.getconversationitem Read
Delete an item — openai.deleteconversationitem Write
Create embeddings — openai.createembedding Write
List evals — openai.listevals Read
Get an eval — openai.geteval Read
Update an eval — openai.updateeval Write
Delete an eval — openai.deleteeval Write
Get eval runs — openai.getevalruns Read
Create eval run — openai.createevalrun Write
Get an eval run — openai.getevalrun Read
Delete eval run — openai.deleteevalrun Write
Cancel eval run — openai.cancelevalrun Write
Get eval run output items — openai.getevalrunoutputitems Read
Get an output item of an eval run — openai.getevalrunoutputitem Read
List files — openai.listfiles Read
Delete file — openai.deletefile Write
Retrieve file — openai.retrievefile Read
Run grader — openai.rungrader Write
Validate grader — openai.validategrader Write
List checkpoint permissions — openai.listfinetuningcheckpointpermissions Read
Create checkpoint permissions — openai.createfinetuningcheckpointpermission Write
Delete checkpoint permission — openai.deletefinetuningcheckpointpermission Write
Create fine-tuning job — openai.createfinetuningjob Write
Retrieve fine-tuning job — openai.retrievefinetuningjob Read
Cancel fine-tuning — openai.cancelfinetuningjob Write
List fine-tuning checkpoints — openai.listfinetuningjobcheckpoints Read
List fine-tuning events — openai.listfinetuningevents Read
Pause fine-tuning — openai.pausefinetuningjob Write
Resume fine-tuning — openai.resumefinetuningjob Write
Create image edit — openai.createimageedit Write
Create image — openai.createimage Write
Create session — openai.create-live Write
Accept call — openai.accept-live-session Write
Fork session — openai.fork-live-session Write
Hang up session — openai.hangup-live-session Write
Transfer call — openai.refer-live-session Write
Reject call — openai.reject-live-session Write
List models — openai.listmodels Read
Retrieve model — openai.retrievemodel Read
Delete a fine-tuned model — openai.deletemodel Write
Create moderation — openai.createmoderation Write
List all organization and project API keys. — openai.admin-api-keys-list Read
Create admin API key — openai.admin-api-keys-create Write
Retrieve admin API key — openai.admin-api-keys-get Read
Delete admin API key — openai.admin-api-keys-delete Write
List audit logs — openai.list-audit-logs Read
List organization certificates — openai.listorganizationcertificates Read
Upload certificate — openai.uploadcertificate Write
Activate certificates for organization — openai.activateorganizationcertificates Write
Deactivate certificates for organization — openai.deactivateorganizationcertificates Write
Get certificate — openai.getcertificate Read
Modify certificate — openai.modifycertificate Write
Delete certificate — openai.deletecertificate Write
Costs — openai.usage-costs Read
Retrieve organization data retention — openai.retrieve-organization-data-retention Read
Update organization data retention — openai.update-organization-data-retention Write
List groups — openai.list-groups Read
Create group — openai.create-group Write
Retrieve group — openai.retrieve-group Read
Update group — openai.update-group Write
Delete group — openai.delete-group Write
List group organization role assignments — openai.list-group-role-assignments Read
Assign organization role to group — openai.assign-group-role Write
Retrieve group organization role — openai.retrieve-group-role Read
Unassign organization role from group — openai.unassign-group-role Write
List group users — openai.list-group-users Read
Add group user — openai.add-group-user Write
Retrieve group user — openai.retrieve-group-user Read
Remove group user — openai.remove-group-user Write
List invites — openai.list-invites Read
Create invite — openai.inviteuser Write
Retrieve invite — openai.retrieve-invite Read
Delete invite — openai.delete-invite Write
List projects — openai.list-projects Read
Create project — openai.create-project Write
Retrieve project — openai.retrieve-project Read
Modify project — openai.modify-project Write
List project API keys — openai.list-project-api-keys Read
Retrieve project API key — openai.retrieve-project-api-key Read
Delete project API key — openai.delete-project-api-key Write
Update project API key — openai.update-project-api-key Write
Archive project — openai.archive-project Write
List project certificates — openai.listprojectcertificates Read
Activate certificates for project — openai.activateprojectcertificates Write
Deactivate certificates for project — openai.deactivateprojectcertificates Write
Retrieve project data retention — openai.retrieve-project-data-retention Read
Update project data retention — openai.update-project-data-retention Write
List project groups — openai.list-project-groups Read
Add project group — openai.add-project-group Write
Retrieve project group — openai.retrieve-project-group Read
Remove project group — openai.remove-project-group Write
Retrieve project hosted tool permissions — openai.retrieve-project-hosted-tool-permissions Read
Modify project hosted tool permissions — openai.update-project-hosted-tool-permissions Write
Retrieve project model permissions — openai.retrieve-project-model-permissions Read
Modify project model permissions — openai.update-project-model-permissions Write
Delete project model permissions — openai.delete-project-model-permissions Write
List project rate limits — openai.list-project-rate-limits Read
Modify project rate limit — openai.update-project-rate-limits Write
List project service accounts — openai.list-project-service-accounts Read
Create project service account — openai.create-project-service-account Write
Retrieve project service account — openai.retrieve-project-service-account Read
Update project service account — openai.update-project-service-account Write
Delete project service account — openai.delete-project-service-account Write
List project spend alerts — openai.list-project-spend-alerts Read
Create project spend alert — openai.create-project-spend-alert Write
Retrieve project spend alert — openai.retrieve-project-spend-alert Read
Update project spend alert — openai.update-project-spend-alert Write
Delete project spend alert — openai.delete-project-spend-alert Write
List project users — openai.list-project-users Read
Create project user — openai.create-project-user Write
Retrieve project user — openai.retrieve-project-user Read
Modify project user — openai.modify-project-user Write
Delete project user — openai.delete-project-user Write
List organization roles — openai.list-roles Read
Create organization role — openai.create-role Write
Retrieve organization role — openai.retrieve-role Read
Update organization role — openai.update-role Write
Delete organization role — openai.delete-role Write
List organization spend alerts — openai.list-organization-spend-alerts Read
Create organization spend alert — openai.create-organization-spend-alert Write
Retrieve organization spend alert — openai.retrieve-organization-spend-alert Read
Update organization spend alert — openai.update-organization-spend-alert Write
Delete organization spend alert — openai.delete-organization-spend-alert Write
Audio speeches — openai.usage-audio-speeches Read
Audio transcriptions — openai.usage-audio-transcriptions Read
Code interpreter sessions — openai.usage-code-interpreter-sessions Read
Completions — openai.usage-completions Read
Embeddings — openai.usage-embeddings Read
File search calls — openai.usage-file-search-calls Read
Images — openai.usage-images Read
Moderations — openai.usage-moderations Read
Vector stores — openai.usage-vector-stores Read
Web search calls — openai.usage-web-search-calls Read
List users — openai.list-users Read
Retrieve user — openai.retrieve-user Read
Modify user — openai.modify-user Write
Delete user — openai.delete-user Write
List user organization role assignments — openai.list-user-role-assignments Read
Assign organization role to user — openai.assign-user-role Write
Retrieve user organization role — openai.retrieve-user-role Read
Unassign organization role from user — openai.unassign-user-role Write
List project group role assignments — openai.list-project-group-role-assignments Read
Assign project role to group — openai.assign-project-group-role Write
Retrieve project group role — openai.retrieve-project-group-role Read
Unassign project role from group — openai.unassign-project-group-role Write
List project roles — openai.list-project-roles Read
Create project role — openai.create-project-role Write
Retrieve project role — openai.retrieve-project-role Read
Update project role — openai.update-project-role Write
Delete project role — openai.delete-project-role Write
List project user role assignments — openai.list-project-user-role-assignments Read
Assign project role to user — openai.assign-project-user-role Write
Retrieve project user role — openai.retrieve-project-user-role Read
Unassign project role from user — openai.unassign-project-user-role Write
Accept call — openai.accept-realtime-call Write
Hang up call — openai.hangup-realtime-call Write
Refer call — openai.refer-realtime-call Write
Reject call — openai.reject-realtime-call Write
Create client secret — openai.create-realtime-client-secret Write
Create session — openai.create-realtime-session Write
Create transcription session — openai.create-realtime-transcription-session Write
Create translation client secret — openai.create-realtime-translation-client-secret Write
Create a model response — openai.createresponse Write
Get a model response — openai.getresponse Read
Delete a model response — openai.deleteresponse Write
Cancel a response — openai.cancelresponse Write
List input items — openai.listinputitems Read
Create thread — openai.createthread Write
Create thread and run — openai.createthreadandrun Write
Retrieve thread — openai.getthread Read
Modify thread — openai.modifythread Write
Delete thread — openai.deletethread Write
List messages — openai.listmessages Read
Create message — openai.createmessage Write
Retrieve message — openai.getmessage Read
Modify message — openai.modifymessage Write
Delete message — openai.deletemessage Write
List runs — openai.listruns Read
Create run — openai.createrun Write
Retrieve run — openai.getrun Read
Modify run — openai.modifyrun Write
Cancel a run — openai.cancelrun Write
List run steps — openai.listrunsteps Read
Retrieve run step — openai.getrunstep Read
Submit tool outputs to run — openai.submittoolouputstorun Write
Create upload — openai.createupload Write
Cancel upload — openai.cancelupload Write
Complete upload — openai.completeupload Write
List vector stores — openai.listvectorstores Read
Create vector store — openai.createvectorstore Write
Retrieve vector store — openai.getvectorstore Read
Modify vector store — openai.modifyvectorstore Write
Delete vector store — openai.deletevectorstore Write
Create vector store file batch — openai.createvectorstorefilebatch Write
Retrieve vector store file batch — openai.getvectorstorefilebatch Read
Cancel vector store file batch — openai.cancelvectorstorefilebatch Write
List vector store files in a batch — openai.listfilesinvectorstorebatch Read
List vector store files — openai.listvectorstorefiles Read
Create vector store file — openai.createvectorstorefile Write
Retrieve vector store file — openai.getvectorstorefile Read
Delete vector store file — openai.deletevectorstorefile Write
Update vector store file attributes — openai.updatevectorstorefileattributes Write
Retrieve vector store file content — openai.retrievevectorstorefilecontent Read
Search vector store — openai.searchvectorstore Write
Create a conversation — openai.createconversation Write
Retrieve a conversation — openai.getconversation Read
Delete a conversation — openai.deleteconversation Write
Update a conversation — openai.updateconversation Write
Get safety case — openai.getsafetycase Read
Get project safety alert — openai.getprojectsafetyalert Read
List the external key configs registered on the user's organization — openai.listtheexternalkeyconfigsregisteredontheuser-sorganization Read
Retrieve an external key registration — openai.retrieveanexternalkeyregistration Read
Delete an external key config for the user's organization — openai.deleteanexternalkeyconfigfortheuser-sorganization Write
Validate an external key config for the user's organization — openai.validateanexternalkeyconfigfortheuser-sorganization Write
Decisions — openai.organizationdecisionsusage Read
List external storage configurations — openai.listexternalstorageconfigurations Read
Create an external storage configuration — openai.createanexternalstorageconfiguration Write
Get an external storage configuration — openai.getanexternalstorageconfiguration Read
Delete an external storage configuration — openai.deleteanexternalstorageconfiguration Write
Validate an external storage configuration — openai.validateanexternalstorageconfiguration Write
Get organization spend limit — openai.getorganizationspendlimit Read
Update organization spend limit — openai.updateorganizationspendlimit Write
Delete organization spend limit — openai.deleteorganizationspendlimit Write
Get project spend limit — openai.getprojectspendlimit Read
Delete project spend limit — openai.deleteprojectspendlimit Write
Update project spend limit — openai.updateprojectspendlimit Write
Create an API key for a service account — openai.createanapikeyforaserviceaccount Write
Get input token counts — openai.getinputtokencounts Write
Compact conversation — openai.compactconversation Write
List Skills — openai.listskills Read
Delete Skill — openai.deleteskill Write
Get Skill — openai.getskill Read
Update Skill Default Version — openai.updateskilldefaultversion Write
Get Skill Content — openai.getskillcontent Read
List Skill Versions — openai.listskillversions Read
Get Skill Version — openai.getskillversion Read
Delete Skill Version — openai.deleteskillversion Write
Get Skill Version Content — openai.getskillversioncontent Read
Cancel a ChatKit session — openai.cancelchatsessionmethod Write
Create a ChatKit session — openai.createchatsessionmethod Write
List ChatKit thread items — openai.listthreaditemsmethod Read
Retrieve a ChatKit thread — openai.getthreadmethod Read
Delete a ChatKit thread — openai.deletethreadmethod Write
List ChatKit threads — openai.listthreadsmethod Read
Create a decision — openai.createdecision Write
Create an automation — openai.createagentautomation Write
List automations — openai.listagentautomations Read
Get an automation — openai.getagentautomation Read
Update an automation — openai.updateagentautomation Write
Delete an automation — openai.deleteagentautomation Write
Pause an automation — openai.pauseagentautomation Write
Resume an automation — openai.resumeagentautomation Write
Invoke an automation — openai.createagentautomationinvocation Write
List automation invocations — openai.listagentautomationinvocations Read
Get an automation invocation — openai.getagentautomationinvocation Read
List agent environments — openai.listagentenvironments Read
Create an agent environment — openai.createagentenvironment Write
Retrieve an agent environment — openai.retrieveagentenvironment Read
List agent environment files — openai.listagentenvironmentfiles Read
Write an agent environment file — openai.createagentenvironmentfile Write
List session subagents — openai.listagentsessionsubagents Read
Retrieve a session subagent — openai.retrieveagentsessionsubagent Read
List subagent items — openai.listagentsessionsubagentitems Read
List subagent turns — openai.listagentsessionsubagentturns Read
Retrieve a subagent turn — openai.retrieveagentsessionsubagentturn Read
List subagent turn items — openai.listagentsessionsubagentturnitems Read
List agents — openai.listagents Read
Create an agent — openai.createagent Write
Retrieve an agent — openai.retrieveagent Read
Update an agent — openai.updateagent Write
Delete an agent — openai.deleteagent Write
List agent environment templates — openai.listagentenvironmenttemplates Read
Create an agent environment template — openai.createagentenvironmenttemplate Write
Retrieve an agent environment template — openai.retrieveagentenvironmenttemplate Read
Update an agent environment template — openai.updateagentenvironmenttemplate Write
Delete an agent environment template — openai.deleteagentenvironmenttemplate Write
Create an agent session — openai.createagentsession Write
Retrieve an agent session — openai.retrieveagentsession Read
Update an agent session — openai.updateagentsession Write
Delete an agent session — openai.deleteagentsession Write
List agent session artifacts — openai.listagentsessionartifacts Read
Retrieve an agent session artifact — openai.retrieveagentsessionartifact Read
Delete an agent session artifact — openai.deleteagentsessionartifact Write
Create agent session input events — openai.createagentsessionevents Write
List agent session items — openai.listagentsessionitems Read
List agent session traces — openai.listagentsessiontraces Read
List agent session turns — openai.listagentsessionturns Read
Retrieve an agent session turn — openai.retrieveagentsessionturn Read
List agent session turn items — openai.listagentsessionturnitems Read
Create a vault — openai.createvault Write
Retrieve a vault — openai.retrievevault Read
Update a vault — openai.updatevault Write
Delete a vault — openai.deletevault Write
Create a vault credential — openai.createvaultcredential Write
Retrieve a vault credential — openai.retrievevaultcredential Read
Update a vault credential — openai.rotatevaultcredential Write
Delete a vault credential — openai.deletevaultcredential Write
List Webhook Endpoints — openai.listwebhookendpoints Read
Create Webhook Endpoint — openai.createwebhookendpoint Write
Retrieve Webhook Endpoint — openai.retrievewebhookendpoint Read
Update Webhook Endpoint — openai.updatewebhookendpoint Write
Delete Webhook Endpoint — openai.deletewebhookendpoint Write
Rotate Webhook Endpoint Signing Secret — openai.rotatewebhookendpointsigningsecret Write
Test Webhook Endpoint — openai.testwebhookendpoint Write
List Webhook Event Types — openai.listwebhookeventtypes Read

Connect and use

Connect and use

This connection uses your provider account.

Connect this integration, enter your provider credentials, choose commands and save. Complete provider authorization if prompted.

Get your provider credentials

Follow these steps for OpenAI, then enter the issued values in the connection form below.

  1. In the OpenAI API platform, select the intended project and create a restricted project API key in API Keys. Configure project budgets, usage alerts and endpoint permissions. ChatGPT subscriptions do not provide API credits. Paste the key into this connection’s OpenAI project API key field and save selected commands. Use listmodels to choose an accessible model; non-streaming Responses calls should specify a small max_output_tokens ceiling. Streaming, binary uploads and other excluded contracts are unavailable. Some imported commands have beta, plan or role requirements; inspect their parameters before use. Create a separate scoped Tooluse.net API key for your AI client and keep the OpenAI key out of the MCP URL.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
OpenAI project API key Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

List voice consents — openai.listvoiceconsents

Returns a list of voice consent recordings.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve voice consent — openai.getvoiceconsent

Retrieves a voice consent recording.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.consent_id string Required The ID of the consent recording to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "consent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update voice consent — openai.updatevoiceconsent

Updates a voice consent recording (metadata only).

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.consent_id string Required The ID of the consent recording to update.
body — Required $ref: "#/definitions/UpdateVoiceConsentRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "consent_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete voice consent — openai.deletevoiceconsent

Deletes a voice consent recording.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.consent_id string Required The ID of the consent recording to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "consent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create voice — openai.createvoice

Creates a voice from a text prompt or from a consent recording and an audio sample.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateVoicePromptRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "type": "prompt",
    "name": "example",
    "prompt": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete voice — openai.deletevoice

Deletes a voice created from a text prompt or an audio sample.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.voice_id string Required The ID of the voice to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "voice_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create batch — openai.createbatch

Creates and executes a batch from an uploaded file of requests

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateBatchRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "input_file_id": "example",
    "endpoint": "/v1/responses",
    "completion_window": "24h"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List batches — openai.listbatches

List your organization's batches.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve batch — openai.retrievebatch

Retrieves a batch.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.batch_id string Required The ID of the batch to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel batch — openai.cancelbatch

Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.batch_id string Required The ID of the batch to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List Chat Completions — openai.listchatcompletions

List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.model string Optional The model used to generate the Chat Completions.
query.metadata — Optional A list of metadata keys to filter the Chat Completions by. Example: metadata[key1]=value1&metadata[key2]=value2 $ref: "#/definitions/Metadata"
query.after string Optional Identifier for the last chat completion from the previous pagination request.
query.limit integer Optional Number of Chat Completions to retrieve. default: 20
query.order string Optional Sort order for Chat Completions by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create chat completion — openai.createchatcompletion

Starting a new project? We recommend trying Responses to take advantage of the latest OpenAI platform features. Compare Chat Completions with Responses.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateChatCompletionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "model": "gpt-6-astra",
    "messages": [
      {
        "content": "example",
        "role": "developer"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get chat completion — openai.getchatcompletion

Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.completion_id string Required The ID of the chat completion to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "completion_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update chat completion — openai.updatechatcompletion

Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.completion_id string Required The ID of the chat completion to update.
body object Required
body.metadata — Required $ref: "#/definitions/Metadata"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "completion_id": "example"
  },
  "body": {
    "metadata": {}
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete chat completion — openai.deletechatcompletion

Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.completion_id string Required The ID of the chat completion to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "completion_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get chat messages — openai.getchatcompletionmessages

Get the messages in a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.completion_id string Required The ID of the chat completion to retrieve messages from.
query object Optional additionalProperties: false
query.after string Optional Identifier for the last message from the previous pagination request.
query.limit integer Optional Number of messages to retrieve. default: 20
query.order string Optional Sort order for messages by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "completion_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create completion — openai.createcompletion

Creates a completion for the provided prompt and parameters.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateCompletionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "model": "example",
    "prompt": "<|endoftext|>"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List containers — openai.listcontainers

List Containers

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.name string Optional Filter results by container name.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create container — openai.createcontainer

Create Container

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateContainerBody"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve container — openai.retrievecontainer

Retrieve Container

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.container_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "container_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a container — openai.deletecontainer

Delete Container

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.container_id string Required The ID of the container to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "container_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List container files — openai.listcontainerfiles

List Container files

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.container_id string Required
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "container_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve container file — openai.retrievecontainerfile

Retrieve Container File

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.container_id string Required
path.file_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "container_id": "example",
    "file_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a container file — openai.deletecontainerfile

Delete Container File

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.container_id string Required
path.file_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "container_id": "example",
    "file_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create items — openai.createconversationitems

Create items in a conversation with the given ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation to add the item to.
query object Optional additionalProperties: false
query.include array Optional Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.
query.include[] — Optional $ref: "#/definitions/IncludeEnum"
body object Required
body.items array Required The items to add to the conversation. You may add up to 20 items at a time. maxItems: 20
body.items[] — Optional $ref: "#/definitions/InputItem"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123"
  },
  "body": {
    "items": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List items — openai.listconversationitems

List all items for a conversation with the given ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation to list items for.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional The order to return the input items in. Default is desc. - asc: Return the input items in ascending order. - desc: Return the input items in descending order. enum: ["asc","desc"]
query.after string Optional An item ID to list items after, used in pagination.
query.include array Optional Specify additional output data to include in the model response. Currently supported values are: - web_search_call.action.sources: Include the sources of the web search tool call. - code_interpreter_call.outputs: Includes the outputs of python code execution in code interpreter tool call items. - computer_call_output.output.image_url: Include image urls from the computer call output. - file_search_call.results: Include the search results of the file search tool call. - message.input_image.image_url: Include image urls from the input message. - message.output_text.logprobs: Include logprobs with assistant messages. - reasoning.encrypted_content: Includes an encrypted version of reasoning tokens in reasoning item outputs. This enables reasoning items to be used in multi-turn conversations when using the Responses API statelessly (like when the store parameter is set to false, or when an organization is enrolled in the zero data retention program).
query.include[] — Optional $ref: "#/definitions/IncludeEnum"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an item — openai.getconversationitem

Get a single item from a conversation with the given IDs.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation that contains the item.
path.item_id string Required The ID of the item to retrieve.
query object Optional additionalProperties: false
query.include array Optional Additional fields to include in the response. See the include parameter for listing Conversation items above for more information.
query.include[] — Optional $ref: "#/definitions/IncludeEnum"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123",
    "item_id": "msg_abc"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an item — openai.deleteconversationitem

Delete an item from a conversation with the given IDs.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation that contains the item.
path.item_id string Required The ID of the item to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123",
    "item_id": "msg_abc"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create embeddings — openai.createembedding

Creates an embedding vector representing the input text.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateEmbeddingRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "model": "text-embedding-3-small",
    "input": "The quick brown fox jumped over the lazy dog"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List evals — openai.listevals

List evaluations for a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.after string Optional Identifier for the last eval from the previous pagination request.
query.limit integer Optional Number of evals to retrieve. default: 20
query.order string Optional Sort order for evals by timestamp. Use asc for ascending order or desc for descending order. enum: ["asc","desc"]; default: "asc"
query.order_by string Optional Evals can be ordered by creation time or last updated time. Use created_at for creation time or updated_at for last updated time. enum: ["created_at","updated_at"]; default: "created_at"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get an eval — openai.geteval

Get an evaluation by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update an eval — openai.updateeval

Update certain properties of an evaluation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to update.
body object Required
body.name string Optional Rename the evaluation.
body.metadata — Optional $ref: "#/definitions/Metadata"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an eval — openai.deleteeval

Delete an evaluation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get eval runs — openai.getevalruns

Get a list of runs for an evaluation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to retrieve runs for.
query object Optional additionalProperties: false
query.after string Optional Identifier for the last run from the previous pagination request.
query.limit integer Optional Number of runs to retrieve. default: 20
query.order string Optional Sort order for runs by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. enum: ["asc","desc"]; default: "asc"
query.status string Optional Filter runs by status. One of queued | in_progress | failed | completed | canceled. enum: ["queued","in_progress","completed","canceled","failed"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create eval run — openai.createevalrun

Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to create a run for.
body — Required $ref: "#/definitions/CreateEvalRunRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example"
  },
  "body": {
    "data_source": {
      "type": "jsonl",
      "source": {
        "type": "file_content",
        "content": []
      }
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get an eval run — openai.getevalrun

Get an evaluation run by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to retrieve runs for.
path.run_id string Required The ID of the run to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete eval run — openai.deleteevalrun

Delete an eval run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to delete the run from.
path.run_id string Required The ID of the run to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel eval run — openai.cancelevalrun

Cancel an ongoing evaluation run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation whose run you want to cancel.
path.run_id string Required The ID of the run to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get eval run output items — openai.getevalrunoutputitems

Get a list of output items for an evaluation run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to retrieve runs for.
path.run_id string Required The ID of the run to retrieve output items for.
query object Optional additionalProperties: false
query.after string Optional Identifier for the last output item from the previous pagination request.
query.limit integer Optional Number of output items to retrieve. default: 20
query.status string Optional Filter output items by status. Use failed to filter by failed output items or pass to filter by passed output items. enum: ["fail","pass"]
query.order string Optional Sort order for output items by timestamp. Use asc for ascending order or desc for descending order. Defaults to asc. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get an output item of an eval run — openai.getevalrunoutputitem

Get an evaluation run output item by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.eval_id string Required The ID of the evaluation to retrieve runs for.
path.run_id string Required The ID of the run to retrieve.
path.output_item_id string Required The ID of the output item to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "eval_id": "example",
    "run_id": "example",
    "output_item_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List files — openai.listfiles

Returns a list of files.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.purpose string Optional Only return files with the given purpose.
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000. default: 10000
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete file — openai.deletefile

Delete a file and remove it from all vector stores.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.file_id string Required The ID of the file to use for this request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "file_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve file — openai.retrievefile

Returns information about a specific file.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.file_id string Required The ID of the file to use for this request.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "file_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Run grader — openai.rungrader

Run a grader.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/RunGraderRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "grader": {
      "type": "string_check",
      "name": "example",
      "input": "example",
      "reference": "example",
      "operation": "eq"
    },
    "model_sample": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Validate grader — openai.validategrader

Validate a grader.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/ValidateGraderRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "grader": {
      "type": "string_check",
      "name": "example",
      "input": "example",
      "reference": "example",
      "operation": "eq"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List checkpoint permissions — openai.listfinetuningcheckpointpermissions

NOTE: This endpoint requires an admin API key.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuned_model_checkpoint string Required The ID of the fine-tuned model checkpoint to get permissions for.
query object Optional additionalProperties: false
query.project_id string Optional The ID of the project to get permissions for.
query.after string Optional Identifier for the last permission ID from the previous pagination request.
query.limit integer Optional Number of permissions to retrieve. default: 10
query.order string Optional The order in which to retrieve permissions. enum: ["ascending","descending"]; default: "descending"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuned_model_checkpoint": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create checkpoint permissions — openai.createfinetuningcheckpointpermission

NOTE: Calling this endpoint requires an admin API key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuned_model_checkpoint string Required The ID of the fine-tuned model checkpoint to create a permission for.
body — Required $ref: "#/definitions/CreateFineTuningCheckpointPermissionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuned_model_checkpoint": "ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd"
  },
  "body": {
    "project_ids": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete checkpoint permission — openai.deletefinetuningcheckpointpermission

NOTE: This endpoint requires an admin API key.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuned_model_checkpoint string Required The ID of the fine-tuned model checkpoint to delete a permission for.
path.permission_id string Required The ID of the fine-tuned model checkpoint permission to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuned_model_checkpoint": "ft:gpt-4o-mini-2024-07-18:org:weather:B7R9VjQd",
    "permission_id": "cp_zc4Q7MP6XxulcVzj4MZdwsAB"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create fine-tuning job — openai.createfinetuningjob

Creates a fine-tuning job which begins the process of creating a new model from a given dataset.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateFineTuningJobRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "model": "gpt-4o-mini",
    "training_file": "file-abc123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve fine-tuning job — openai.retrievefinetuningjob

Get info about a fine-tuning job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuning_job_id string Required The ID of the fine-tuning job.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuning_job_id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel fine-tuning — openai.cancelfinetuningjob

Immediately cancel a fine-tune job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuning_job_id string Required The ID of the fine-tuning job to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuning_job_id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List fine-tuning checkpoints — openai.listfinetuningjobcheckpoints

List checkpoints for a fine-tuning job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuning_job_id string Required The ID of the fine-tuning job to get checkpoints for.
query object Optional additionalProperties: false
query.after string Optional Identifier for the last checkpoint ID from the previous pagination request.
query.limit integer Optional Number of checkpoints to retrieve. default: 10

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuning_job_id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List fine-tuning events — openai.listfinetuningevents

Get status updates for a fine-tuning job.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuning_job_id string Required The ID of the fine-tuning job to get events for.
query object Optional additionalProperties: false
query.after string Optional Identifier for the last event from the previous pagination request.
query.limit integer Optional Number of events to retrieve. default: 20

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuning_job_id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Pause fine-tuning — openai.pausefinetuningjob

Pause a fine-tune job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuning_job_id string Required The ID of the fine-tuning job to pause.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuning_job_id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Resume fine-tuning — openai.resumefinetuningjob

Resume a fine-tune job.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.fine_tuning_job_id string Required The ID of the fine-tuning job to resume.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "fine_tuning_job_id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create image edit — openai.createimageedit

Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/EditImageBodyJsonParam"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "images": [
      {
        "image_url": "https://example.com/source-image.png"
      }
    ],
    "prompt": "Add a watercolor effect and keep the subject centered"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create image — openai.createimage

Creates an image given a prompt using a GPT Image model. Learn more.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateImageRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "model": "gpt-image-2.5-flare",
    "prompt": "A cute baby sea otter"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create session — openai.create-live

Create a Live WebRTC session or place an outbound SIP call. Start with the Live prompting guide for session configuration and Telephony and SIP for trunk setup and call monitoring.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/LiveSessionCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "session": {
      "model": "gpt-live-1"
    },
    "transport": {
      "type": "webrtc",
      "sdp": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Accept call — openai.accept-live-session

Accept an incoming SIP call. Supply session with type live, the model, and startup configuration. Before accepting calls, follow the Live prompting guide to write frontend conversation instructions and a separate backend prompt. SIP media format is negotiated; omit audio.format.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix.
body — Required $ref: "#/definitions/LiveCallAcceptRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  },
  "body": {
    "session": {
      "model": "gpt-live-1",
      "type": "live"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Fork session — openai.fork-live-session

Fork a stored Live session onto a new WebRTC connection.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the stored Live session to fork.
body — Required $ref: "#/definitions/LiveForkRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  },
  "body": {
    "transport": {
      "type": "webrtc",
      "sdp": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Hang up session — openai.hangup-live-session

End a SIP call identified by session_id.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Transfer call — openai.refer-live-session

Transfer a SIP call to another destination. Supply a nonblank target_uri for the SIP Refer-To header.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix.
body — Required $ref: "#/definitions/LiveCallReferRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  },
  "body": {
    "target_uri": "tel:+14155550123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Reject call — openai.reject-live-session

Reject an incoming SIP call. Send a required SIP rejection status_code between 300 and 699.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Opaque Live session identifier from the creation response or incoming-call webhook. Preserve the returned value unchanged, including its prefix.
body — Required $ref: "#/definitions/LiveCallRejectRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  },
  "body": {
    "status_code": 486
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List models — openai.listmodels

Lists the currently available models, and provides basic information about each one such as the owner and availability.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve model — openai.retrievemodel

Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.model string Required The ID of the model to use for this request

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "model": "gpt-6-astra"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a fine-tuned model — openai.deletemodel

Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.model string Required The model to delete

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "model": "ft:gpt-4o-mini:acemeco:suffix:abc123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create moderation — openai.createmoderation

Classifies if text and/or image inputs are potentially harmful. Learn more in the moderation guide.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateModerationRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "input": "...text to classify goes here..."
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List all organization and project API keys. — openai.admin-api-keys-list

List organization API keys

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.after string | null Optional Return keys with IDs that come after this ID in the pagination order.
query.order string Optional Order results by creation time, ascending or descending. enum: ["asc","desc"]; default: "asc"
query.limit integer Optional Maximum number of keys to return. default: 20

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create admin API key — openai.admin-api-keys-create

Create an organization admin API key

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body object Required
body.name string Required
body.expires_in_seconds integer Optional The number of seconds until the API key expires. Omit this field for a key that does not expire. minimum: 1; maximum: 31536000

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "New Admin Key"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve admin API key — openai.admin-api-keys-get

Retrieve a single organization API key

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required The ID of the API key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete admin API key — openai.admin-api-keys-delete

Delete an organization admin API key

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.key_id string Required The ID of the API key to be deleted.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List audit logs — openai.list-audit-logs

List user actions and configuration changes within this organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.effective_at object Optional Return only events whose effective_at (Unix seconds) is in this range.
query.effective_at.gt integer Optional Return only events whose effective_at (Unix seconds) is greater than this value.
query.effective_at.gte integer Optional Return only events whose effective_at (Unix seconds) is greater than or equal to this value.
query.effective_at.lt integer Optional Return only events whose effective_at (Unix seconds) is less than this value.
query.effective_at.lte integer Optional Return only events whose effective_at (Unix seconds) is less than or equal to this value.
query.project_ids[] array Optional Return only events for these projects.
query.project_ids[][] string Optional
query.event_types[] array Optional Return only events with a type in one of these values. For example, project.created. For all options, see the documentation for the audit log object.
query.event_types[][] — Optional $ref: "#/definitions/AuditLogEventType"
query.actor_ids[] array Optional Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.
query.actor_ids[][] string Optional
query.actor_emails[] array Optional Return only events performed by users with these emails.
query.actor_emails[][] string Optional
query.resource_ids[] array Optional Return only events performed on these targets. For example, a project ID updated. For ChatGPT connector role events, use the workspace connector resource ID shown in details.id, such as &lt;workspace_id&gt;__&lt;connector_id&gt;.
query.resource_ids[][] string Optional
query.tenant_only boolean Optional Return only tenant-scoped events associated with this organization. Required for tenant-scoped events such as role.bound_to_resource and role.unbound_from_resource. When true, all supplied event types must be tenant-scoped. default: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

List organization certificates — openai.listorganizationcertificates

List uploaded certificates for this organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Upload certificate — openai.uploadcertificate

Upload a certificate to the organization. This does not automatically activate the certificate.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/UploadCertificateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "certificate": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Activate certificates for organization — openai.activateorganizationcertificates

Activate certificates at the organization level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/ToggleCertificatesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "certificate_ids": [
      "cert_abc"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Deactivate certificates for organization — openai.deactivateorganizationcertificates

Deactivate certificates at the organization level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/ToggleCertificatesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "certificate_ids": [
      "cert_abc"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get certificate — openai.getcertificate

Get a certificate that has been uploaded to the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id string Required Unique ID of the certificate to retrieve.
query object Optional additionalProperties: false
query.include array Optional A list of additional fields to include in the response. Currently the only supported value is content to fetch the PEM content of the certificate.
query.include[] string Optional enum: ["content"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify certificate — openai.modifycertificate

Modify a certificate. Note that only the name can be modified.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id string Required Unique ID of the certificate to modify.
body — Required $ref: "#/definitions/ModifyCertificateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete certificate — openai.deletecertificate

Delete a certificate from the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.certificate_id string Required Unique ID of the certificate to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "certificate_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Costs — openai.usage-costs

Get costs details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently only 1d is supported, default to 1d. enum: ["1d"]; default: "1d"
query.project_ids array Optional Return only costs for these projects.
query.project_ids[] string Optional
query.api_key_ids array Optional Return only costs for these API keys.
query.api_key_ids[] string Optional
query.line_items array Optional Return only costs for these exact line item names. Each value must match the complete line_item value, for example gpt-6-astra, input_tokens.
query.line_items[] string Optional
query.group_by array Optional Group the costs by the specified fields. Supported fields include project_id, user_id, line_item, api_key_id, and api_source. Support for combining user_id with project_id grouping or the project_ids filter depends on the organization and requested time range. Unsupported combinations return HTTP 400. When grouped by api_source, results use agents_api for attributed Agents API activity and unlabeled for all other activity. Without source grouping, api_source is null.
query.group_by[] string Optional enum: ["project_id","user_id","line_item","api_key_id","api_source"]
query.limit integer Optional A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7. default: 7
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve organization data retention — openai.retrieve-organization-data-retention

Retrieves organization data retention controls.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update organization data retention — openai.update-organization-data-retention

Updates organization data retention controls.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/UpdateOrganizationDataRetentionBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "retention_type": "zero_data_retention"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List groups — openai.list-groups

Lists all groups in the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of groups to be returned. Limit can range between 0 and 1000, and the default is 100. default: 100; minimum: 0; maximum: 1000
query.after string Optional A cursor for use in pagination. after is a group ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with group_abc, your subsequent call can include after=group_abc in order to fetch the next page of the list.
query.order string Optional Specifies the sort order of the returned groups. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create group — openai.create-group

Creates a new group in the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateGroupBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve group — openai.retrieve-group

Retrieves a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update group — openai.update-group

Updates a group's information.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to update.
body — Required $ref: "#/definitions/UpdateGroupBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete group — openai.delete-group

Deletes a group from the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List group organization role assignments — openai.list-group-role-assignments

Lists the organization roles assigned to a group within the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group whose organization role assignments you want to list.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of organization role assignments to return. minimum: 0; maximum: 1000
query.after string Optional Cursor for pagination. Provide the value from the previous response's next field to continue listing organization roles.
query.order string Optional Sort order for the returned organization roles. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Assign organization role to group — openai.assign-group-role

Assigns an organization role to a group within the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group that should receive the organization role.
body — Required $ref: "#/definitions/PublicAssignOrganizationGroupRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  },
  "body": {
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve group organization role — openai.retrieve-group-role

Retrieves an organization role assigned to a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to inspect.
path.role_id string Required The ID of the organization role to retrieve for the group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Unassign organization role from group — openai.unassign-group-role

Unassigns an organization role from a group within the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to modify.
path.role_id string Required The ID of the organization role to remove from the group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List group users — openai.list-group-users

Lists the users assigned to a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of users to be returned. Limit can range between 0 and 1000, and the default is 100. default: 100; minimum: 0; maximum: 1000
query.after string Optional A cursor for use in pagination. Provide the ID of the last user from the previous list response to retrieve the next page.
query.order string Optional Specifies the sort order of users in the list. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Add group user — openai.add-group-user

Adds a user to a group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to update.
body — Required $ref: "#/definitions/CreateGroupUserBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example"
  },
  "body": {
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve group user — openai.retrieve-group-user

Retrieves a user in a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to inspect.
path.user_id string Required The ID of the user to retrieve from the group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Remove group user — openai.remove-group-user

Removes a user from a group.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.group_id string Required The ID of the group to update.
path.user_id string Required The ID of the user to remove from the group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "group_id": "example",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List invites — openai.list-invites

Returns a list of invites in the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create invite — openai.inviteuser

Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/InviteRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "email": "example",
    "role": "reader"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve invite — openai.retrieve-invite

Retrieves an invite.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.invite_id string Required The ID of the invite to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "invite_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete invite — openai.delete-invite

Delete an invite. If the invite has already been accepted, it cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.invite_id string Required The ID of the invite to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "invite_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List projects — openai.list-projects

Returns a list of projects.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.include_archived boolean Optional If true returns all projects including those that have been archived. Archived projects are not included by default. default: false

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create project — openai.create-project

Create a new project in the organization. Projects can be created and archived, but cannot be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/ProjectCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project — openai.retrieve-project

Retrieves a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify project — openai.modify-project

Modifies a project in the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ProjectUpdateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project API keys — openai.list-project-api-keys

Returns a list of API keys in the project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.owner_project_access string Optional Filter API keys by whether the owner currently has effective access to the project. Use active for owners with access, inactive for owners without access, or any for all enabled project API keys. If omitted, the endpoint applies its existing membership-based visibility rules, which may exclude some enabled keys. enum: ["active","inactive","any"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project API key — openai.retrieve-project-api-key

Retrieves an API key in the project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.api_key_id string Required The ID of the API key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "api_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project API key — openai.delete-project-api-key

Deletes an API key from the project, including keys owned by service accounts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.api_key_id string Required The ID of the API key.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "api_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update project API key — openai.update-project-api-key

Updates the scopes and/or expiration of an existing API key in the project, including a service-account-owned key. Requires permission to write project API keys.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.api_key_id string Required The ID of the API key.
body — Required $ref: "#/definitions/UpdateProjectApiKeyBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "api_key_id": "example"
  },
  "body": {
    "scopes": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Archive project — openai.archive-project

Archives a project in the organization. Archived projects cannot be used or updated.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project certificates — openai.listprojectcertificates

List certificates for this project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Activate certificates for project — openai.activateprojectcertificates

Activate certificates at the project level.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ToggleCertificatesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "certificate_ids": [
      "cert_abc"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Deactivate certificates for project — openai.deactivateprojectcertificates

Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ToggleCertificatesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "certificate_ids": [
      "cert_abc"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project data retention — openai.retrieve-project-data-retention

Retrieves project data retention controls.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update project data retention — openai.update-project-data-retention

Updates project data retention controls.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
body — Required $ref: "#/definitions/UpdateProjectDataRetentionBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "retention_type": "organization_default"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project groups — openai.list-project-groups

Lists the groups that have access to a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of project groups to return. Defaults to 20. default: 20; minimum: 0; maximum: 100
query.after string Optional Cursor for pagination. Provide the ID of the last group from the previous response to fetch the next page.
query.order string Optional Sort order for the returned groups. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Add project group — openai.add-project-group

Grants a group access to a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
body — Required $ref: "#/definitions/InviteProjectGroupBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "group_id": "example",
    "role": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project group — openai.retrieve-project-group

Retrieves a project's group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
path.group_id string Required The ID of the group to retrieve.
query object Optional additionalProperties: false
query.group_type string Optional The type of group to retrieve. enum: ["group","tenant_group"]; default: "group"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Remove project group — openai.remove-project-group

Revokes a group's access to a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.group_id string Required The ID of the group to remove from the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project hosted tool permissions — openai.retrieve-project-hosted-tool-permissions

Returns hosted tool permissions for a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify project hosted tool permissions — openai.update-project-hosted-tool-permissions

Updates hosted tool permissions for a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ProjectHostedToolPermissionsUpdateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project model permissions — openai.retrieve-project-model-permissions

Returns model permissions for a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify project model permissions — openai.update-project-model-permissions

Updates model permissions for a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ProjectModelPermissionsUpdateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "mode": "allow_list",
    "model_ids": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project model permissions — openai.delete-project-model-permissions

Deletes model permissions for a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project rate limits — openai.list-project-rate-limits

Returns the rate limits per model for a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. The default is 100. default: 100
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, beginning with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify project rate limit — openai.update-project-rate-limits

Updates a project rate limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.rate_limit_id string Required The ID of the rate limit.
body — Required $ref: "#/definitions/ProjectRateLimitUpdateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "rate_limit_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project service accounts — openai.list-project-service-accounts

Returns a list of service accounts in the project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create project service account — openai.create-project-service-account

Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ProjectServiceAccountCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "name": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project service account — openai.retrieve-project-service-account

Retrieves a service account in the project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.service_account_id string Required The ID of the service account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "service_account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update project service account — openai.update-project-service-account

Updates a service account in the project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.service_account_id string Required The ID of the service account.
body — Required $ref: "#/definitions/UpdateProjectServiceAccountBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "service_account_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project service account — openai.delete-project-service-account

Deletes a service account from the project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.service_account_id string Required The ID of the service account.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "service_account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project spend alerts — openai.list-project-spend-alerts

Lists project spend alerts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of spend alerts to return. Defaults to 20. minimum: 0; maximum: 100
query.order string Optional Sort order for the returned spend alerts. enum: ["asc","desc"]; default: "asc"
query.after string Optional Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page.
query.before string Optional Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create project spend alert — openai.create-project-spend-alert

Creates a project spend alert.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
body — Required $ref: "#/definitions/CreateSpendAlertBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "threshold_amount": 1,
    "currency": "USD",
    "interval": "month",
    "notification_channel": {
      "type": "email",
      "recipients": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project spend alert — openai.retrieve-project-spend-alert

Retrieves a project spend alert.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.alert_id string Required The ID of the spend alert to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "alert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update project spend alert — openai.update-project-spend-alert

Updates a project spend alert.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.alert_id string Required The ID of the spend alert to update.
body — Required $ref: "#/definitions/CreateSpendAlertBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "alert_id": "example"
  },
  "body": {
    "threshold_amount": 1,
    "currency": "USD",
    "interval": "month",
    "notification_channel": {
      "type": "email",
      "recipients": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project spend alert — openai.delete-project-spend-alert

Deletes a project spend alert.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.alert_id string Required The ID of the spend alert to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "alert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project users — openai.list-project-users

Returns a list of users in the project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create project user — openai.create-project-user

Adds a user to the project. Users must already be members of the organization to be added to a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
body — Required $ref: "#/definitions/ProjectUserCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "role": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project user — openai.retrieve-project-user

Retrieves a user in the project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.user_id string Required The ID of the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify project user — openai.modify-project-user

Modifies a user's role in the project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.user_id string Required The ID of the user.
body — Required $ref: "#/definitions/ProjectUserUpdateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project user — openai.delete-project-user

Deletes a user from the project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.user_id string Required The ID of the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List organization roles — openai.list-roles

Lists the roles configured for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of roles to return. Defaults to 1000. default: 1000; minimum: 0; maximum: 1000
query.after string Optional Cursor for pagination. Provide the value from the previous response's next field to continue listing roles.
query.order string Optional Sort order for the returned roles. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create organization role — openai.create-role

Creates a custom role for the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/PublicCreateOrganizationRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "role_name": "example",
    "permissions": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve organization role — openai.retrieve-role

Retrieves an organization role.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.role_id string Required The ID of the role to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update organization role — openai.update-role

Updates an existing organization role.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.role_id string Required The ID of the role to update.
body — Required $ref: "#/definitions/PublicUpdateOrganizationRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "role_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete organization role — openai.delete-role

Deletes a custom role from the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.role_id string Required The ID of the role to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List organization spend alerts — openai.list-organization-spend-alerts

Lists organization spend alerts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of spend alerts to return. Defaults to 20. minimum: 0; maximum: 100
query.order string Optional Sort order for the returned spend alerts. enum: ["asc","desc"]; default: "asc"
query.after string Optional Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page.
query.before string Optional Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create organization spend alert — openai.create-organization-spend-alert

Creates an organization spend alert.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateSpendAlertBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "threshold_amount": 1,
    "currency": "USD",
    "interval": "month",
    "notification_channel": {
      "type": "email",
      "recipients": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve organization spend alert — openai.retrieve-organization-spend-alert

Retrieves an organization spend alert.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alert_id string Required The ID of the spend alert to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update organization spend alert — openai.update-organization-spend-alert

Updates an organization spend alert.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alert_id string Required The ID of the spend alert to update.
body — Required $ref: "#/definitions/CreateSpendAlertBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alert_id": "example"
  },
  "body": {
    "threshold_amount": 1,
    "currency": "USD",
    "interval": "month",
    "notification_channel": {
      "type": "email",
      "recipients": []
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete organization spend alert — openai.delete-organization-spend-alert

Deletes an organization spend alert.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.alert_id string Required The ID of the spend alert to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "alert_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Audio speeches — openai.usage-audio-speeches

Get audio speeches usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Audio transcriptions — openai.usage-audio-transcriptions

Get audio transcriptions usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Code interpreter sessions — openai.usage-code-interpreter-sessions

Get code interpreter sessions usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id.
query.group_by[] string Optional enum: ["project_id"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Completions — openai.usage-completions

Get completions usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.batch boolean Optional If true, return batch jobs only. If false, return non-batch jobs only. By default, return both.
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, batch, service_tier, api_source or any combination of them. When grouped by api_source, results use agents_api for attributed Agents API activity and unlabeled for all other activity. Without source grouping, api_source is null.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model","batch","service_tier","api_source"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Embeddings — openai.usage-embeddings

Get embeddings usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

File search calls — openai.usage-file-search-calls

Get file search calls usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.vector_store_ids array Optional Return only usage for these vector stores.
query.vector_store_ids[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, vector_store_id or any combination of them.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","vector_store_id"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Images — openai.usage-images

Get images usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.sources array Optional Return only usages for these sources. Possible values are image.generation, image.edit, image.variation or any combination of them.
query.sources[] string Optional enum: ["image.generation","image.edit","image.variation"]
query.sizes array Optional Return only usages for these image sizes. Possible values are 256x256, 512x512, 1024x1024, 1792x1792, 1024x1792 or any combination of them.
query.sizes[] string Optional enum: ["256x256","512x512","1024x1024","1792x1792","1024x1792"]
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, size, source or any combination of them.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model","size","source"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Moderations — openai.usage-moderations

Get moderations usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Vector stores — openai.usage-vector-stores

Get vector stores usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id.
query.group_by[] string Optional enum: ["project_id"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Web search calls — openai.usage-web-search-calls

Get web search calls usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time integer Optional End time (Unix seconds) of the query time range, exclusive.
query.bucket_width string Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. enum: ["1m","1h","1d"]; default: "1d"
query.project_ids array Optional Return only usage for these projects.
query.project_ids[] string Optional
query.user_ids array Optional Return only usage for these users.
query.user_ids[] string Optional
query.api_key_ids array Optional Return only usage for these API keys.
query.api_key_ids[] string Optional
query.models array Optional Return only usage for these models.
query.models[] string Optional
query.context_levels array Optional Return only web search usage for these context levels.
query.context_levels[] string Optional enum: ["low","medium","high"]
query.group_by array Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, context_level, api_source or any combination of them. When grouped by api_source, results use agents_api for attributed Agents API activity and unlabeled for all other activity. Without source grouping, api_source is null.
query.group_by[] string Optional enum: ["project_id","user_id","api_key_id","model","context_level","api_source"]
query.limit integer Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List users — openai.list-users

Lists all of the users in the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.emails array Optional Filter by the email address of users.
query.emails[] string Optional

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve user — openai.retrieve-user

Retrieves a user by their identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify user — openai.modify-user

Modifies a user's role in the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user.
body — Required $ref: "#/definitions/UserRoleUpdateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete user — openai.delete-user

Deletes a user from the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List user organization role assignments — openai.list-user-role-assignments

Lists the organization roles assigned to a user within the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of organization role assignments to return. minimum: 0; maximum: 1000
query.after string Optional Cursor for pagination. Provide the value from the previous response's next field to continue listing organization roles.
query.order string Optional Sort order for the returned organization roles. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Assign organization role to user — openai.assign-user-role

Assigns an organization role to a user within the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user that should receive the organization role.
body — Required $ref: "#/definitions/PublicAssignOrganizationGroupRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example"
  },
  "body": {
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve user organization role — openai.retrieve-user-role

Retrieves an organization role assigned to a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user to inspect.
path.role_id string Required The ID of the organization role to retrieve for the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Unassign organization role from user — openai.unassign-user-role

Unassigns an organization role from a user within the organization.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.user_id string Required The ID of the user to modify.
path.role_id string Required The ID of the organization role to remove from the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "user_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project group role assignments — openai.list-project-group-role-assignments

Lists the project roles assigned to a group within a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
path.group_id string Required The ID of the group to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of project role assignments to return. minimum: 0; maximum: 1000
query.after string Optional Cursor for pagination. Provide the value from the previous response's next field to continue listing project roles.
query.order string Optional Sort order for the returned project roles. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "group_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Assign project role to group — openai.assign-project-group-role

Assigns a project role to a group within a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.group_id string Required The ID of the group that should receive the project role.
body — Required $ref: "#/definitions/PublicAssignOrganizationGroupRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "group_id": "example"
  },
  "body": {
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project group role — openai.retrieve-project-group-role

Retrieves a project role assigned to a group.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
path.group_id string Required The ID of the group to inspect.
path.role_id string Required The ID of the project role to retrieve for the group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "group_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Unassign project role from group — openai.unassign-project-group-role

Unassigns a project role from a group within a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to modify.
path.group_id string Required The ID of the group whose project role assignment should be removed.
path.role_id string Required The ID of the project role to remove from the group.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "group_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project roles — openai.list-project-roles

Lists the roles configured for a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of roles to return. Defaults to 1000. default: 1000; minimum: 0; maximum: 1000
query.after string Optional Cursor for pagination. Provide the value from the previous response's next field to continue listing roles.
query.order string Optional Sort order for the returned roles. enum: ["asc","desc"]; default: "asc"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create project role — openai.create-project-role

Creates a custom role for a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
body — Required $ref: "#/definitions/PublicCreateOrganizationRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example"
  },
  "body": {
    "role_name": "example",
    "permissions": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project role — openai.retrieve-project-role

Retrieves a project role.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.role_id string Required The ID of the role to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update project role — openai.update-project-role

Updates an existing project role.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.role_id string Required The ID of the role to update.
body — Required $ref: "#/definitions/PublicUpdateOrganizationRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "role_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project role — openai.delete-project-role

Deletes a custom role from a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.role_id string Required The ID of the role to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List project user role assignments — openai.list-project-user-role-assignments

Lists the project roles assigned to a user within a project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
path.user_id string Required The ID of the user to inspect.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of project role assignments to return. minimum: 0; maximum: 1000
query.after string Optional Cursor for pagination. Provide the value from the previous response's next field to continue listing project roles.
query.order string Optional Sort order for the returned project roles. enum: ["asc","desc"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Assign project role to user — openai.assign-project-user-role

Assigns a project role to a user within a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to update.
path.user_id string Required The ID of the user that should receive the project role.
body — Required $ref: "#/definitions/PublicAssignOrganizationGroupRoleBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example"
  },
  "body": {
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve project user role — openai.retrieve-project-user-role

Retrieves a project role assigned to a user.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to inspect.
path.user_id string Required The ID of the user to inspect.
path.role_id string Required The ID of the project role to retrieve for the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Unassign project role from user — openai.unassign-project-user-role

Unassigns a project role from a user within a project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project to modify.
path.user_id string Required The ID of the user whose project role assignment should be removed.
path.role_id string Required The ID of the project role to remove from the user.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "user_id": "example",
    "role_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Accept call — openai.accept-realtime-call

Accept an incoming SIP call and configure the realtime session that will handle it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.call_id string Required The identifier for the call provided in the realtime.call.incoming webhook.
body — Required $ref: "#/definitions/RealtimeSessionCreateRequestGA"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "call_id": "example"
  },
  "body": {
    "type": "realtime"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Hang up call — openai.hangup-realtime-call

End an active Realtime API call, whether it was initiated over SIP or WebRTC.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.call_id string Required The identifier for the call. For SIP calls, use the value provided in the realtime.call.incoming webhook. For WebRTC sessions, reuse the call ID returned in the Location header when creating the call with POST /v1/realtime/calls.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "call_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Refer call — openai.refer-realtime-call

Transfer an active SIP call to a new destination using the SIP REFER verb.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.call_id string Required The identifier for the call provided in the realtime.call.incoming webhook.
body — Required $ref: "#/definitions/RealtimeCallReferRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "call_id": "example"
  },
  "body": {
    "target_uri": "tel:+14155550123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Reject call — openai.reject-realtime-call

Decline an incoming SIP call by returning a SIP status code to the caller.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.call_id string Required The identifier for the call provided in the realtime.call.incoming webhook.
body — Optional $ref: "#/definitions/RealtimeCallRejectRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "call_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create client secret — openai.create-realtime-client-secret

Create a Realtime client secret with an associated session configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/RealtimeCreateClientSecretRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create session — openai.create-realtime-session

Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the session.update client event.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/RealtimeSessionCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "client_secret": {
      "value": "example",
      "expires_at": 1
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create transcription session — openai.create-realtime-transcription-session

Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the transcription_session.update client event.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/RealtimeTranscriptionSessionCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create translation client secret — openai.create-realtime-translation-client-secret

Create a Realtime translation client secret with an associated translation session configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/RealtimeTranslationClientSecretCreateRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "session": {
      "model": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create a model response — openai.createresponse

Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateResponse"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get a model response — openai.getresponse

Retrieves a model response with the given ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.response_id string Required The ID of the response to retrieve.
query object Optional additionalProperties: false
query.include array Optional Additional fields to include in the response. See the include parameter for Response creation above for more information.
query.include[] — Optional $ref: "#/definitions/IncludeEnum"
query.stream boolean Optional If set to true, the model response data will be streamed to the client as it is generated using server-sent events. See the Streaming section below for more information. enum: [false,null]
query.starting_after integer Optional The sequence number of the event after which to start streaming.
query.include_obfuscation boolean Optional When true, stream obfuscation will be enabled. Stream obfuscation adds random characters to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation to certain side-channel attacks. These obfuscation fields are included by default, but add a small amount of overhead to the data stream. You can set include_obfuscation to false to optimize for bandwidth if you trust the network links between your application and the OpenAI API.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "response_id": "resp_677efb5139a88190b512bc3fef8e535d"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a model response — openai.deleteresponse

Deletes a model response with the given ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.response_id string Required The ID of the response to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "response_id": "resp_677efb5139a88190b512bc3fef8e535d"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel a response — openai.cancelresponse

Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.response_id string Required The ID of the response to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "response_id": "resp_677efb5139a88190b512bc3fef8e535d"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List input items — openai.listinputitems

Returns a list of input items for a given response.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.response_id string Required The ID of the response to retrieve input items for.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional The order to return the input items in. Default is desc. - asc: Return the input items in ascending order. - desc: Return the input items in descending order. enum: ["asc","desc"]
query.after string Optional An item ID to list items after, used in pagination.
query.include array Optional Additional fields to include in the response. See the include parameter for Response creation above for more information.
query.include[] — Optional $ref: "#/definitions/IncludeEnum"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "response_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create thread — openai.createthread

Create a thread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateThreadRequest"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create thread and run — openai.createthreadandrun

Create a thread and run it in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateThreadAndRunRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "assistant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve thread — openai.getthread

Retrieves a thread.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify thread — openai.modifythread

Modifies a thread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to modify. Only the metadata can be modified.
body — Required $ref: "#/definitions/ModifyThreadRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete thread — openai.deletethread

Delete a thread.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List messages — openai.listmessages

Returns a list of messages for a given thread.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread the messages belong to.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
query.run_id string Optional Filter messages by the run ID that generated them.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create message — openai.createmessage

Create a message.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to create a message for.
body — Required $ref: "#/definitions/CreateMessageRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  },
  "body": {
    "role": "user",
    "content": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve message — openai.getmessage

Retrieve a message.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to which this message belongs.
path.message_id string Required The ID of the message to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "message_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify message — openai.modifymessage

Modifies a message.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to which this message belongs.
path.message_id string Required The ID of the message to modify.
body — Required $ref: "#/definitions/ModifyMessageRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "message_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete message — openai.deletemessage

Deletes a message.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to which this message belongs.
path.message_id string Required The ID of the message to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "message_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List runs — openai.listruns

Returns a list of runs belonging to a thread.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread the run belongs to.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create run — openai.createrun

Create a run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to run.
query object Optional additionalProperties: false
query.include[] array Optional A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content. See the file search tool documentation for more information.
query.include[][] string Optional enum: ["step_details.tool_calls[*].file_search.results[*].content"]
body — Required $ref: "#/definitions/CreateRunRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example"
  },
  "body": {
    "assistant_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve run — openai.getrun

Retrieves a run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread that was run.
path.run_id string Required The ID of the run to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify run — openai.modifyrun

Modifies a run.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread that was run.
path.run_id string Required The ID of the run to modify.
body — Required $ref: "#/definitions/ModifyRunRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "run_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel a run — openai.cancelrun

Cancels a run that is in_progress.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to which this run belongs.
path.run_id string Required The ID of the run to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List run steps — openai.listrunsteps

Returns a list of run steps belonging to a run.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread the run and run steps belong to.
path.run_id string Required The ID of the run the run steps belong to.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
query.include[] array Optional A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content. See the file search tool documentation for more information.
query.include[][] string Optional enum: ["step_details.tool_calls[*].file_search.results[*].content"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "run_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve run step — openai.getrunstep

Retrieves a run step.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to which the run and run step belongs.
path.run_id string Required The ID of the run to which the run step belongs.
path.step_id string Required The ID of the run step to retrieve.
query object Optional additionalProperties: false
query.include[] array Optional A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content. See the file search tool documentation for more information.
query.include[][] string Optional enum: ["step_details.tool_calls[*].file_search.results[*].content"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "run_id": "example",
    "step_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Submit tool outputs to run — openai.submittoolouputstorun

When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required The ID of the thread to which this run belongs.
path.run_id string Required The ID of the run that requires the tool output submission.
body — Required $ref: "#/definitions/SubmitToolOutputsRunRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "example",
    "run_id": "example"
  },
  "body": {
    "tool_outputs": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create upload — openai.createupload

Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateUploadRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "filename": "example",
    "purpose": "assistants",
    "bytes": 1,
    "mime_type": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel upload — openai.cancelupload

Cancels the Upload. No Parts may be added after an Upload is cancelled.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.upload_id string Required The ID of the Upload.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "upload_id": "upload_abc123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Complete upload — openai.completeupload

Completes the Upload.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.upload_id string Required The ID of the Upload.
body — Required $ref: "#/definitions/CompleteUploadRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "upload_id": "upload_abc123"
  },
  "body": {
    "part_ids": []
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List vector stores — openai.listvectorstores

Returns a list of vector stores.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create vector store — openai.createvectorstore

Create a vector store.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateVectorStoreRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve vector store — openai.getvectorstore

Retrieves a vector store.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Modify vector store — openai.modifyvectorstore

Modifies a vector store.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store to modify.
body — Required $ref: "#/definitions/UpdateVectorStoreRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete vector store — openai.deletevectorstore

Delete a vector store.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create vector store file batch — openai.createvectorstorefilebatch

Create a vector store file batch.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store for which to create a File Batch.
body — Required $ref: "#/definitions/CreateVectorStoreFileBatchRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123"
  },
  "body": {
    "file_ids": [
      "example"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve vector store file batch — openai.getvectorstorefilebatch

Retrieves a vector store file batch.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store that the file batch belongs to.
path.batch_id string Required The ID of the file batch being retrieved.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123",
    "batch_id": "vsfb_abc123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel vector store file batch — openai.cancelvectorstorefilebatch

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store that the file batch belongs to.
path.batch_id string Required The ID of the file batch to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example",
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List vector store files in a batch — openai.listfilesinvectorstorebatch

Returns a list of vector store files in a batch.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store that the files belong to.
path.batch_id string Required The ID of the file batch that the files belong to.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
query.filter string Optional Filter by file status. One of in_progress, completed, failed, cancelled. enum: ["in_progress","completed","failed","cancelled"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example",
    "batch_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List vector store files — openai.listvectorstorefiles

Returns a list of vector store files.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store that the files belong to.
query object Optional additionalProperties: false
query.limit integer Optional A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. default: 20
query.order string Optional Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. enum: ["asc","desc"]; default: "desc"
query.after string Optional A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
query.before string Optional A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
query.filter string Optional Filter by file status. One of in_progress, completed, failed, cancelled. enum: ["in_progress","completed","failed","cancelled"]

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create vector store file — openai.createvectorstorefile

Create a vector store file by attaching a File to a vector store.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store for which to create a File.
body — Required $ref: "#/definitions/CreateVectorStoreFileRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123"
  },
  "body": {
    "file_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve vector store file — openai.getvectorstorefile

Retrieves a vector store file.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store that the file belongs to.
path.file_id string Required The ID of the file being retrieved.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123",
    "file_id": "file-abc123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete vector store file — openai.deletevectorstorefile

Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store that the file belongs to.
path.file_id string Required The ID of the file to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "example",
    "file_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update vector store file attributes — openai.updatevectorstorefileattributes

Update attributes on a vector store file.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store the file belongs to.
path.file_id string Required The ID of the file to update attributes.
body — Required $ref: "#/definitions/UpdateVectorStoreFileAttributesRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123",
    "file_id": "file-abc123"
  },
  "body": {
    "attributes": {}
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve vector store file content — openai.retrievevectorstorefilecontent

Retrieve the parsed contents of a vector store file.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store.
path.file_id string Required The ID of the file within the vector store.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123",
    "file_id": "file-abc123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Search vector store — openai.searchvectorstore

Search a vector store for relevant chunks based on a query and file attributes filter.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vector_store_id string Required The ID of the vector store to search.
body — Required $ref: "#/definitions/VectorStoreSearchRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vector_store_id": "vs_abc123"
  },
  "body": {
    "query": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create a conversation — openai.createconversation

Create a conversation.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateConversationBody"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve a conversation — openai.getconversation

Get a conversation

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a conversation — openai.deleteconversation

Delete a conversation. Items in the conversation will not be deleted.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update a conversation — openai.updateconversation

Update a conversation

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.conversation_id string Required The ID of the conversation to update.
body — Optional $ref: "#/definitions/UpdateConversationBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "conversation_id": "conv_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get safety case — openai.getsafetycase

Get a safety case by ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Safety case ID maxLength: 128

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get project safety alert — openai.getprojectsafetyalert

Get a safety alert belonging to the authenticated API project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.id string Required Project safety alert ID maxLength: 38

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List the external key configs registered on the user's organization — openai.listtheexternalkeyconfigsregisteredontheuser-sorganization

List the external key configs registered on the user's organization

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional minimum: 0; maximum: 100
query.order — Optional $ref: "#/definitions/OrderEnum"
query.after — Optional
query.after string Optional anyOf[1]
query.after null Optional anyOf[2]
query.purpose — Optional Filter by key purpose. When omitted, returns keys of all purposes. $ref: "#/definitions/ExternalKeyPurpose"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an external key registration — openai.retrieveanexternalkeyregistration

Retrieve a stored external key registration for the user's organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.external_key_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "external_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an external key config for the user's organization — openai.deleteanexternalkeyconfigfortheuser-sorganization

Delete an external key config for the user's organization

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.external_key_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "external_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Validate an external key config for the user's organization — openai.validateanexternalkeyconfigfortheuser-sorganization

Validate an external key config for the user's organization

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.external_key_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "external_key_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Decisions — openai.organizationdecisionsusage

Get Decisions API usage details for the organization.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Required additionalProperties: false
query.start_time integer Required Start time (Unix seconds) of the query time range, inclusive.
query.end_time — Optional End time (Unix seconds) of the query time range, exclusive.
query.end_time integer Optional anyOf[1]
query.end_time null Optional anyOf[2]
query.bucket_width — Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.
query.bucket_width — Optional Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d. anyOf[1]
query.bucket_width — Optional anyOf[1]; oneOf[1]; $ref: "#/definitions/DecisionsUsageBucketWidth"
query.bucket_width null Optional anyOf[2]
query.limit — Optional Specifies the number of buckets to return. - bucket_width=1d: default: 7, max: 31 - bucket_width=1h: default: 24, max: 168 - bucket_width=1m: default: 60, max: 1440
query.limit integer Optional anyOf[1]
query.limit null Optional anyOf[2]
query.page — Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response.
query.page string Optional A cursor for use in pagination. Corresponding to the next_page field from the previous response. anyOf[1]
query.page null Optional anyOf[2]
query.project_ids — Optional Return only usage for these projects.
query.project_ids — Optional Return only usage for these projects. anyOf[1]
query.project_ids array Optional anyOf[1]; oneOf[1]
query.project_ids[] string Optional anyOf[1]; oneOf[1]
query.project_ids null Optional anyOf[2]
query.group_by — Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, batch, service_tier, api_source or any combination of them. When grouped by api_source, results use agents_api for attributed Agents API activity and unlabeled for all other activity. Without source grouping, api_source is null.
query.group_by — Optional Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, batch, service_tier, api_source or any combination of them. When grouped by api_source, results use agents_api for attributed Agents API activity and unlabeled for all other activity. Without source grouping, api_source is null. anyOf[1]
query.group_by array Optional anyOf[1]; oneOf[1]
query.group_by[] — Optional anyOf[1]; oneOf[1]; $ref: "#/definitions/DecisionsUsageGroupBy"
query.group_by null Optional anyOf[2]
query.user_ids — Optional Return only usage for these users.
query.user_ids — Optional Return only usage for these users. anyOf[1]
query.user_ids array Optional anyOf[1]; oneOf[1]
query.user_ids[] string Optional anyOf[1]; oneOf[1]
query.user_ids null Optional anyOf[2]
query.api_key_ids — Optional Return only usage for these API keys.
query.api_key_ids — Optional Return only usage for these API keys. anyOf[1]
query.api_key_ids array Optional anyOf[1]; oneOf[1]
query.api_key_ids[] string Optional anyOf[1]; oneOf[1]
query.api_key_ids null Optional anyOf[2]
query.models — Optional Return only usage for these models.
query.models — Optional Return only usage for these models. anyOf[1]
query.models array Optional anyOf[1]; oneOf[1]
query.models[] string Optional anyOf[1]; oneOf[1]
query.models null Optional anyOf[2]
query.batch — Optional If true, return batch jobs only. If false, return non-batch jobs only. By default, return both.
query.batch boolean Optional anyOf[1]
query.batch null Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{
  "query": {
    "start_time": 1
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List external storage configurations — openai.listexternalstorageconfigurations

List the organization's customer-managed external storage configurations.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.project_id — Optional
query.project_id string Optional anyOf[1]
query.project_id null Optional anyOf[2]
query.after — Optional Return external storage configurations after this ID.
query.after string Optional Return external storage configurations after this ID. anyOf[1]
query.after null Optional anyOf[2]
query.order — Optional $ref: "#/definitions/ExternalStorageOrder"
query.limit integer Optional minimum: 1; maximum: 100

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an external storage configuration — openai.createanexternalstorageconfiguration

Register one customer-managed external storage configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateExternalStorageBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "project_id": "proj_123",
    "provider": {
      "type": "aws",
      "bucket": "example",
      "role_arn": "example"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get an external storage configuration — openai.getanexternalstorageconfiguration

Get one customer-managed external storage configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.external_storage_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "external_storage_id": "extstorage_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an external storage configuration — openai.deleteanexternalstorageconfiguration

Disconnect a customer-managed external storage configuration. Removing the project's last configuration restores organization-default retention if customer-managed retention was active. Repeating a deletion also completes any interrupted retention update. Cloud storage is unchanged.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.external_storage_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "external_storage_id": "extstorage_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Validate an external storage configuration — openai.validateanexternalstorageconfiguration

Validate one customer-managed external storage configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.external_storage_id string Required

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "external_storage_id": "extstorage_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get organization spend limit — openai.getorganizationspendlimit

Get the organization's hard spend limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update organization spend limit — openai.updateorganizationspendlimit

Create or replace the organization's hard spend limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/UpdateOrganizationSpendLimitBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "threshold_amount": 1,
    "currency": "USD",
    "interval": "month"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete organization spend limit — openai.deleteorganizationspendlimit

Delete the organization's hard spend limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get project spend limit — openai.getprojectspendlimit

Get a project's hard spend limit.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project whose hard spend limit is being managed.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "proj_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete project spend limit — openai.deleteprojectspendlimit

Delete a project's hard spend limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project whose hard spend limit is being managed.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "proj_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update project spend limit — openai.updateprojectspendlimit

Create or replace a project's hard spend limit.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project whose hard spend limit is being managed.
body — Required $ref: "#/definitions/UpdateProjectSpendLimitBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "proj_123"
  },
  "body": {
    "threshold_amount": 1,
    "currency": "USD",
    "interval": "month"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an API key for a service account — openai.createanapikeyforaserviceaccount

Creates an API key for a service account in the project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.project_id string Required The ID of the project.
path.service_account_id string Required The ID of the service account.
body — Optional $ref: "#/definitions/CreateProjectServiceAccountApiKeyBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "project_id": "example",
    "service_account_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get input token counts — openai.getinputtokencounts

Returns input token counts of the request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/TokenCountsBody"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Compact conversation — openai.compactconversation

Compact a conversation. Returns a compacted response object.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CompactResponseMethodPublicBody"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

List Skills — openai.listskills

List all skills for the current project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Number of items to retrieve minimum: 0; maximum: 100
query.order — Optional Sort order of results by timestamp. Use asc for ascending order or desc for descending order. $ref: "#/definitions/OrderEnum"
query.after string Optional Identifier for the last item from the previous pagination request

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete Skill — openai.deleteskill

Delete a skill by its ID.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get Skill — openai.getskill

Get a skill by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update Skill Default Version — openai.updateskilldefaultversion

Update the default version pointer for a skill.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill.
body — Optional $ref: "#/definitions/SetDefaultSkillVersionBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get Skill Content — openai.getskillcontent

Download a skill zip bundle by its ID.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill to download.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List Skill Versions — openai.listskillversions

List skill versions for a skill.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill.
query object Optional additionalProperties: false
query.limit integer Optional Number of versions to retrieve. minimum: 0; maximum: 100
query.order — Optional Sort order of results by version number. $ref: "#/definitions/OrderEnum"
query.after string Optional The skill version ID to start after.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get Skill Version — openai.getskillversion

Get a specific skill version.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill.
path.version string Required The version number to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123",
    "version": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete Skill Version — openai.deleteskillversion

Delete a skill version.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill.
path.version string Required The skill version number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123",
    "version": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get Skill Version Content — openai.getskillversioncontent

Download a skill version zip bundle.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.skill_id string Required The identifier of the skill.
path.version string Required The skill version number.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "skill_id": "skill_123",
    "version": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Cancel a ChatKit session — openai.cancelchatsessionmethod

Cancel an active ChatKit session and return its most recent metadata.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required Unique identifier for the ChatKit session to cancel.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "cksess_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create a ChatKit session — openai.createchatsessionmethod

Create a ChatKit session.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateChatSessionBody"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

List ChatKit thread items — openai.listthreaditemsmethod

List items that belong to a ChatKit thread.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required Identifier of the ChatKit thread whose items are requested.
query object Optional additionalProperties: false
query.limit integer Optional Maximum number of thread items to return. Defaults to 20. minimum: 0; maximum: 100
query.order — Optional Sort order for results by creation time. Defaults to desc. $ref: "#/definitions/OrderEnum"
query.after string Optional List items created after this thread item ID. Defaults to null for the first page.
query.before string Optional List items created before this thread item ID. Defaults to null for the newest results.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "cthr_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve a ChatKit thread — openai.getthreadmethod

Retrieve a ChatKit thread by its identifier.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required Identifier of the ChatKit thread to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "cthr_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a ChatKit thread — openai.deletethreadmethod

Delete a ChatKit thread along with its items and stored attachments.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.thread_id string Required Identifier of the ChatKit thread to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "thread_id": "cthr_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List ChatKit threads — openai.listthreadsmethod

List ChatKit threads with optional pagination and user filters.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Maximum number of thread items to return. Defaults to 20. minimum: 0; maximum: 100
query.order — Optional Sort order for results by creation time. Defaults to desc. $ref: "#/definitions/OrderEnum"
query.after string Optional List items created after this thread item ID. Defaults to null for the first page.
query.before string Optional List items created before this thread item ID. Defaults to null for the newest results.
query.user string Optional Filter threads that belong to this user identifier. Defaults to null to return all users. minLength: 1; maxLength: 512

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create a decision — openai.createdecision

Use this endpoint to quickly answer classification or scoring questions about some input. You can ask multiple questions in one request.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/DecisionRequest"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "model": "example",
    "input": "example",
    "questions": [
      {
        "type": "predicate",
        "instructions": "example"
      }
    ]
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an automation — openai.createagentautomation

Saves an active automation without invoking it immediately.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Required $ref: "#/definitions/CreateAutomationParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "type": "periodic",
    "name": "example",
    "target": {
      "type": "new_session",
      "environment": {
        "type": "none"
      },
      "input": []
    },
    "expression": "example",
    "timezone": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List automations — openai.listagentautomations

Lists project-owned automations, optionally filtered by target session.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576
query.session_id string Optional Matches existing-session targets, including agent-created automations. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get an automation — openai.getagentautomation

Retrieves a project-owned automation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update an automation — openai.updateagentautomation

Updates supplied fields; target and metadata replace the whole field.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576
body — Required $ref: "#/definitions/UpdateAutomationParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an automation — openai.deleteagentautomation

Deletes the automation and prevents future invocations without deleting its target session.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Pause an automation — openai.pauseagentautomation

Pauses future scheduled delivery without stopping an active session.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Resume an automation — openai.resumeagentautomation

Resumes scheduled delivery; one-time automations without a pending invocation require a future run_at.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Invoke an automation — openai.createagentautomationinvocation

Queues a manual delivery without changing the saved schedule.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List automation invocations — openai.listagentautomationinvocations

Lists delivery records for a project-owned automation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Get an automation invocation — openai.getagentautomationinvocation

Retrieves a delivery record for a project-owned automation.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.automation_id string Required minLength: 0; maxLength: 1048576
path.invocation_id string Required minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "automation_id": "example",
    "invocation_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent environments — openai.listagentenvironments

Lists OpenAI-hosted environments owned by the authenticated principal. Requires access to the prewarming beta.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576
query.type — Optional The hosting type to list. Defaults to openai_hosted. $ref: "#/definitions/EnvironmentTypeParam"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an agent environment — openai.createagentenvironment

Creates an OpenAI-hosted environment before creating a session. Requires access to the prewarming beta.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
headers object Optional additionalProperties: false
headers.Idempotency-Key string Optional Deduplicates creation for 24 hours within the authenticated organization, project, and creator. Retry the same JSON parameters with the same key to retrieve the original environment in its current state. Different parameters or an incomplete hosted creation return 409. Deleted environments are not recreated. After retention expires, the key may create a new environment. Without this header, each request creates a new environment. minLength: 1; maxLength: 256
body — Required $ref: "#/definitions/CreateAgentEnvironmentParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "body": {
    "environment": {
      "type": "openai_hosted"
    }
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an agent environment — openai.retrieveagentenvironment

Retrieves an execution environment's connection status and safe installed metadata. See environment lifecycle.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_id string Required The ID of the environment. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent environment files — openai.listagentenvironmentfiles

Lists live files on a connected execution environment with optional directory filtering and opaque cursor pagination. See environment files.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_id string Required The ID of the environment. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.path string | null Optional Restrict the listing to this absolute workspace directory. minLength: 0; maxLength: 1048576
query.limit integer | null Optional The maximum number of files to return, between 1 and 100. minimum: 1; maximum: 100
query.order — Optional Sort by case-sensitive path components. Defaults to descending. $ref: "#/definitions/ListOrderParam"
query.page string Optional The opaque token from the previous page. Keep the same path, order, and limit. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Write an agent environment file — openai.createagentenvironmentfile

Copies inline bytes or a Files API file into a connected execution environment, replacing an existing regular file at the same path. Upload between turns and wait for success before starting the next turn. See environment files.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_id string Required The ID of the environment. minLength: 0; maxLength: 1048576
body — Optional $ref: "#/definitions/HostedEnvironmentFileParam"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List session subagents — openai.listagentsessionsubagents

Lists subagents in a session, including nested and closed subagents. See subagent workflows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve a session subagent — openai.retrieveagentsessionsubagent

Retrieves a subagent belonging to this session. See subagent workflows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
path.subagent_id string Required The ID of the subagent in this session. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "subagent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List subagent items — openai.listagentsessionsubagentitems

Lists this subagent's own items across all of its turns. See subagent workflows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
path.subagent_id string Required The ID of the subagent in this session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "subagent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List subagent turns — openai.listagentsessionsubagentturns

Lists all turns of this subagent, including turns after a resume. See subagent workflows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
path.subagent_id string Required The ID of the subagent in this session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "subagent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve a subagent turn — openai.retrieveagentsessionsubagentturn

Retrieves a turn belonging to this subagent. See subagent workflows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
path.subagent_id string Required The ID of the subagent in this session. minLength: 0; maxLength: 1048576
path.turn_id string Required The ID of a turn belonging to this subagent. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "subagent_id": "example",
    "turn_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List subagent turn items — openai.listagentsessionsubagentturnitems

Lists items belonging to one turn of this subagent. See subagent workflows.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
path.subagent_id string Required The ID of the subagent in this session. minLength: 0; maxLength: 1048576
path.turn_id string Required The ID of a turn belonging to this subagent. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "subagent_id": "example",
    "turn_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agents — openai.listagents

Lists reusable agents in the current project. See agent configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an agent — openai.createagent

Creates a reusable agent without storing credentials. See agent configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateAgentParams"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an agent — openai.retrieveagent

Retrieves a reusable agent by ID. See agent configuration.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_id string Required The ID of the reusable agent. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update an agent — openai.updateagent

Updates a reusable agent. See agent configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_id string Required The ID of the reusable agent. minLength: 0; maxLength: 1048576
body — Optional $ref: "#/definitions/UpdateAgentParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an agent — openai.deleteagent

Deletes a reusable agent. See agent configuration.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.agent_id string Required The ID of the reusable agent. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "agent_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent environment templates — openai.listagentenvironmenttemplates

Lists reusable environment templates without returning confidential values. See reusing a hosted setup.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an agent environment template — openai.createagentenvironmenttemplate

Creates reusable environment configuration without returning confidential setup commands or environment values. See reusing a hosted setup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateEnvironmentTemplateParams"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an agent environment template — openai.retrieveagentenvironmenttemplate

Retrieves reusable environment configuration without returning confidential values. See reusing a hosted setup.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_template_id string Required The ID of the reusable environment template. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update an agent environment template — openai.updateagentenvironmenttemplate

Updates reusable environment configuration without returning confidential values. See reusing a hosted setup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_template_id string Required The ID of the reusable environment template. minLength: 0; maxLength: 1048576
body — Optional $ref: "#/definitions/UpdateEnvironmentTemplateParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an agent environment template — openai.deleteagentenvironmenttemplate

Deletes reusable environment configuration and all confidential template inputs. See reusing a hosted setup.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.environment_template_id string Required The ID of the reusable environment template. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "environment_template_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create an agent session — openai.createagentsession

Creates a managed agent session, optionally submits initial input, and returns the session or streams its events when stream is true. See running sessions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateAgentSessionParams"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an agent session — openai.retrieveagentsession

Retrieves the current state of a managed agent session. See managing sessions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update an agent session — openai.updateagentsession

Updates session tools, metadata, model, reasoning effort, or service tier. Model settings apply to subsequent turns. Omitted fields are unchanged. See managing sessions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
body — Optional $ref: "#/definitions/UpdateAgentSessionParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an agent session — openai.deleteagentsession

Removes a managed agent session from the public API and returns a deletion confirmation. If backend execution has ended, deletion can cancel a still-open public turn and abandon unpublished outputs. Running execution must be cancelled first. Physical cleanup may continue asynchronously. See managing sessions.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent session artifacts — openai.listagentsessionartifacts

Lists immutable artifacts published by completed hosted session turns. See session artifacts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576
query.environment_id string | null Optional Restrict the listing to artifacts produced by this environment. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an agent session artifact — openai.retrieveagentsessionartifact

Retrieves immutable metadata for one durable session artifact. See session artifacts.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session that owns the artifact. minLength: 0; maxLength: 1048576
path.artifact_id string Required The immutable session artifact ID. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "artifact_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete an agent session artifact — openai.deleteagentsessionartifact

Deletes an immutable session artifact without deleting its live environment file or original Files API object. See session artifacts.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session that owns the artifact. minLength: 0; maxLength: 1048576
path.artifact_id string Required The immutable session artifact ID. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "artifact_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create agent session input events — openai.createagentsessionevents

Submits message, cancellation, tool-result, or computer-use approval-response events to a managed agent session. Cancellation can recover a still-open turn whose backend execution has ended by marking it cancelled and abandoning unpublished outputs. Saved results, published files, and existing terminal outcomes are preserved. HTTP 202 confirms acceptance, not durable completion. See session events.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
headers object Optional additionalProperties: false
headers.Idempotency-Key string Optional An optional client-generated key that makes retries of submitted messages idempotent. minLength: 1; maxLength: 256
body — Optional $ref: "#/definitions/CreateSessionEventsParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent session items — openai.listagentsessionitems

Lists items produced by the session's root agent, including its interactions with subagents. Each subagent has its own item history. See inspecting agent output.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent session traces — openai.listagentsessiontraces

Lists published root-turn traces as OTLP JSON, ordered by turn creation time and ID. Unpublished traces are skipped. Each page returns data available when read; it does not wait for late traces. Trace reads and the JSON response are limited to 16 MiB per request. If the limit is exceeded, request fewer traces.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent session turns — openai.listagentsessionturns

Lists turns by creation time and turn ID. The after cursor is exclusive in the selected order. See session turns.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve an agent session turn — openai.retrieveagentsessionturn

Retrieves a turn's current status, timestamps, usage, and error. Returns 404 if the turn does not belong to the session. See session turns.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session that owns the turn. minLength: 0; maxLength: 1048576
path.turn_id string Required The ID of the turn. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "turn_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List agent session turn items — openai.listagentsessionturnitems

Lists items belonging to one root-agent turn, including its interactions with subagents. See inspecting agent output.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.session_id string Required The ID of the session that owns the turn. minLength: 0; maxLength: 1048576
path.turn_id string Required The ID of the turn. minLength: 0; maxLength: 1048576
query object Optional additionalProperties: false
query.limit integer Optional The maximum number of resources to return, between 1 and 100. Defaults to 20. default: 20; minimum: 1; maximum: 100
query.order — Optional The order in which resources are returned. Defaults to desc.
query.order — Optional allOf[1]; $ref: "#/definitions/ListOrderParam"
query.order — Optional allOf[2]; default: "desc"
query.after string Optional Return resources after this resource ID in the selected order. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "session_id": "example",
    "turn_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create a vault — openai.createvault

Creates a vault for the current project. See vaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/CreateVaultParams"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve a vault — openai.retrievevault

Retrieves a vault by its ID. See vaults.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update a vault — openai.updatevault

Updates the name or metadata of an active vault. Omitted fields remain unchanged. See vaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576
body — Required $ref: "#/definitions/UpdateVaultParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example"
  },
  "body": {}
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a vault — openai.deletevault

Deletes a vault and all its credentials. See vaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create a vault credential — openai.createvaultcredential

Creates a vault credential. Secret values are write-only and are never returned. See vaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576
body — Optional $ref: "#/definitions/CreateVaultCredentialParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve a vault credential — openai.retrievevaultcredential

Retrieves vault credential metadata without returning secret values. See vaults.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576
path.credential_id string Required The ID of the vault credential. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example",
    "credential_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update a vault credential — openai.rotatevaultcredential

Updates credential metadata or rotates its write-only secret. See vaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576
path.credential_id string Required The ID of the vault credential. minLength: 0; maxLength: 1048576
body — Required $ref: "#/definitions/RotateVaultCredentialParams"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example",
    "credential_id": "example"
  },
  "body": {
    "metadata": {}
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete a vault credential — openai.deletevaultcredential

Deletes a vault credential. See vaults.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.vault_id string Required The ID of the vault. minLength: 0; maxLength: 1048576
path.credential_id string Required The ID of the vault credential. minLength: 0; maxLength: 1048576

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "vault_id": "example",
    "credential_id": "example"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List Webhook Endpoints — openai.listwebhookendpoints

Returns webhook endpoints for the authenticated project in newest-first order.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
query object Optional additionalProperties: false
query.limit integer Optional Maximum number of webhook endpoints to return. Defaults to 20. minimum: 1; maximum: 100
query.after — Optional ID of the last webhook endpoint from the previous page.
query.after string Optional anyOf[1]
query.after null Optional anyOf[2]

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Create Webhook Endpoint — openai.createwebhookendpoint

Creates a webhook endpoint for the authenticated project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
body — Optional $ref: "#/definitions/PublicCreateEndpointBody"

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Retrieve Webhook Endpoint — openai.retrievewebhookendpoint

Retrieves a webhook endpoint for the authenticated project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_endpoint_id string Required The ID of the webhook endpoint to retrieve.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_endpoint_id": "whe_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Update Webhook Endpoint — openai.updatewebhookendpoint

Updates a webhook endpoint for the authenticated project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_endpoint_id string Required The ID of the webhook endpoint to update.
body — Optional $ref: "#/definitions/PublicUpdateEndpointBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_endpoint_id": "whe_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Delete Webhook Endpoint — openai.deletewebhookendpoint

Deletes a webhook endpoint for the authenticated project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_endpoint_id string Required The ID of the webhook endpoint to delete.

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_endpoint_id": "whe_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Rotate Webhook Endpoint Signing Secret — openai.rotatewebhookendpointsigningsecret

Rotates the signing secret for a webhook endpoint in the authenticated project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_endpoint_id string Required The ID of the webhook endpoint whose signing secret will be rotated.
body — Optional $ref: "#/definitions/PublicRotateSecretBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_endpoint_id": "whe_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Test Webhook Endpoint — openai.testwebhookendpoint

Sends a sample event to a webhook endpoint for the authenticated project.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
path object Required additionalProperties: false
path.webhook_endpoint_id string Required The ID of the webhook endpoint to test.
body — Optional $ref: "#/definitions/PublicTestEndpointBody"

Full JSON Schema

Full JSON Schema

Example input

{
  "path": {
    "webhook_endpoint_id": "whe_123"
  }
}

At most 1 provider requests per invocation; timeout: 120 seconds.

List Webhook Event Types — openai.listwebhookeventtypes

Returns webhook event types visible to the authenticated project.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 120 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close