Retrieve project hosted tool permissions | Sample - OpenAI API

1 parameter

project_idstringrequired

The unique identifier of the project whose hosted tool permissions to retrieve.

1 status code

200Returns the project's hosted tool permissions, including an `enabled` boolean for file search, web search, image generation, MCP, and code interpreter.

file_searchobjectrequired

Permission state for a single hosted tool on a project.

web_searchobjectrequired

Permission state for a single hosted tool on a project.

image_generationobjectrequired

Permission state for a single hosted tool on a project.

mcpobjectrequired

Permission state for a single hosted tool on a project.

code_interpreterobjectrequired

Permission state for a single hosted tool on a project.

Error handling

project_id must identify the project whose hosted tool permissions you want to retrieve. The response includes an enabled boolean for each hosted tool permission.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.hostedToolPermissions.list({ projectId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "file_search": {
    "enabled": true
  },
  "web_search": {
    "enabled": true
  },
  "image_generation": {
    "enabled": true
  },
  "mcp": {
    "enabled": true
  },
  "code_interpreter": {
    "enabled": true
  }
}