--- title: "OpenAI" description: "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 an" --- > Documentation Index > Fetch the complete documentation index at: https://help.tooluse.net/llms.txt > Use this file to discover all available pages before exploring further. # OpenAI

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. Multipart uploads, event streams and unsupported schemas are explicit exclusions. Use a project key with only the permissions needed and set explicit token, result and spending limits. Billable calls can remain unconfirmed after a lost response; no automatic retry occurs.

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

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

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

Run List voice consents with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve voice consent with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update voice consent with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete voice consent with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create voice with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Delete voice with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create batch with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List batches with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve batch with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Cancel batch with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List Chat Completions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create chat completion with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Get chat completion with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update chat completion with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete chat completion with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get chat messages with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create completion with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List containers with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create container with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve container with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete a container with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List container files with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve container file with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete a container file with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create items with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve an item with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete an item with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create embeddings with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List evals with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Get an eval with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update an eval with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete an eval with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get eval runs with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create eval run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get an eval run with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete eval run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Cancel eval run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get eval run output items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Get an output item of an eval run with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List files with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete file with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve file with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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 Run grader with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Validate grader with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List checkpoint permissions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create checkpoint permissions with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete checkpoint permission with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create fine-tuning job with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve fine-tuning job with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Cancel fine-tuning with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List fine-tuning checkpoints with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List fine-tuning events with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Pause fine-tuning with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Resume fine-tuning with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create image edit with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create image with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create session with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Accept call with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Fork session with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Hang up session with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Transfer call with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Reject call with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List models with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve model with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete a fine-tuned model with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create moderation with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List all organization and project API keys. with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create admin API key with OpenAI. This command can change provider data. Review the target and input before invoking 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 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

Run Retrieve admin API key with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete admin API key with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List audit logs with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List organization certificates with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Upload certificate with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Activate certificates for organization with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Deactivate certificates for organization with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Get certificate with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify certificate with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete certificate with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Costs with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve organization data retention with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update organization data retention with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List groups with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create group with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve group with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List group organization role assignments with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Assign organization role to group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve group organization role with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Unassign organization role from group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List group users with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Add group user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve group user with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Remove group user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List invites with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create invite with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve invite with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete invite with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List projects with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create project with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve project with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify project with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project API keys with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve project API key with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete project API key with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Update project API key with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Archive project with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project certificates with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Activate certificates for project with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Deactivate certificates for project with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project data retention with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update project data retention with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project groups with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Add project group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project group with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Remove project group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project hosted tool permissions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify project hosted tool permissions with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project model permissions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify project model permissions with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete project model permissions with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project rate limits with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify project rate limit with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project service accounts with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create project service account with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project service account with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update project service account with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete project service account with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project spend alerts with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create project spend alert with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project spend alert with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update project spend alert with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete project spend alert with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project users with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create project user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project user with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify project user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete project user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List organization roles with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create organization role with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve organization role with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update organization role with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete organization role with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List organization spend alerts with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create organization spend alert with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve organization spend alert with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update organization spend alert with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete organization spend alert with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Audio speeches with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Audio transcriptions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Code interpreter sessions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Completions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Embeddings with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run File search calls with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Images with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Moderations with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Vector stores with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Web search calls with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List users with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve user with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List user organization role assignments with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Assign organization role to user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve user organization role with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Unassign organization role from user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project group role assignments with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Assign project role to group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project group role with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Unassign project role from group with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project roles with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create project role with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project role with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update project role with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete project role with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List project user role assignments with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Assign project role to user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve project user role with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Unassign project role from user with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Accept call with OpenAI. This command can change provider data. Review the target and input before invoking 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

Run Hang up call with OpenAI. This command can change provider data. Review the target and input before invoking 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. 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

Run Refer call with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Reject call with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Create client secret with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create session with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create transcription session with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create translation client secret with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create a model response with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Get a model response with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete a model response with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Cancel a response with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List input items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create thread with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Create thread and run with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve thread with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify thread with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete thread with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List messages with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create message with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve message with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify message with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete message with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List runs with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve run with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Cancel a run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List run steps with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve run step with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Submit tool outputs to run with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create upload with OpenAI. This command can change provider data. Review the target and input before invoking 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

Run Cancel upload with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Complete upload with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List vector stores with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create vector store with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Retrieve vector store with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Modify vector store with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete vector store with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create vector store file batch with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve vector store file batch with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Cancel vector store file batch with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List vector store files in a batch with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List vector store files with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create vector store file with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve vector store file with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete vector store file with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Update vector store file attributes with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve vector store file content with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Search vector store with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create a conversation with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve a conversation with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete a conversation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Update a conversation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get safety case with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Get project safety alert with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List the external key configs registered on the user's organization with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve an external key registration with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete an external key config for the user's organization with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Validate an external key config for the user's organization with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Decisions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List external storage configurations with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create an external storage configuration with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Get an external storage configuration with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete an external storage configuration with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Validate an external storage configuration with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get organization spend limit with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update organization spend limit with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Delete organization spend limit with OpenAI. This command can change provider data. Review the target and input before invoking 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.

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

Run Get project spend limit with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete project spend limit with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Update project spend limit with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create an API key for a service account with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get input token counts with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Compact conversation with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run List Skills with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete Skill with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get Skill with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update Skill Default Version with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get Skill Content with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List Skill Versions with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Get Skill Version with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete Skill Version with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Get Skill Version Content with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Cancel a ChatKit session with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create a ChatKit session with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run List ChatKit thread items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve a ChatKit thread with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete a ChatKit thread with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List ChatKit threads with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create a decision with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run Create an automation with OpenAI. This command can change provider data. Review the target and input before invoking 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/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

Run List automations with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Get an automation with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update an automation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete an automation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Pause an automation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Resume an automation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Invoke an automation with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List automation invocations with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Get an automation invocation with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List agent environments with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create an agent environment with OpenAI. This command can change provider data. Review the target and input before invoking 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
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

Run Retrieve an agent environment with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List agent environment files with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Write an agent environment file with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List session subagents with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve a session subagent with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List subagent items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List subagent turns with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve a subagent turn with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List subagent turn items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List agents with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create an agent with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve an agent with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update an agent with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete an agent with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List agent environment templates with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create an agent environment template with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve an agent environment template with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update an agent environment template with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete an agent environment template with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create an agent session with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve an agent session with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update an agent session with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete an agent session with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List agent session artifacts with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve an agent session artifact with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Delete an agent session artifact with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create agent session input events with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List agent session items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List agent session traces with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List agent session turns with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Retrieve an agent session turn with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run List agent session turn items with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create a vault with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve a vault with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update a vault with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete a vault with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Create a vault credential with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Retrieve a vault credential with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update a vault credential with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete a vault credential with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List Webhook Endpoints with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Create Webhook Endpoint with OpenAI. This command can change provider data. Review the target and input before invoking 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 — 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

Run Retrieve Webhook Endpoint with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Run Update Webhook Endpoint with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Delete Webhook Endpoint with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Rotate Webhook Endpoint Signing Secret with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run Test Webhook Endpoint with OpenAI. This command can change provider data. Review the target and input before invoking 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.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

Run List Webhook Event Types with OpenAI. This is a read command; it does not grant access beyond the connected account's permissions.

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

Source: https://help.tooluse.net/integrations/openai/index.mdx