Retrieve hosted tool permissions for a project | OpenAI API (unofficial showcase)

1 parameter

project_idstringrequired

The ID of the project.

5 status codes

200Returns the project's permission state for file search, web search, image generation, MCP, and code interpreter, including whether each tool is enabled.

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.

400Returned when the project ID is invalid.

errorobjectrequired

403Returned when the caller does not have permission to perform this operation.

errorobjectrequired

Details about the permission error.

404Returned when the project was not found.

errorobjectrequired

429Returned when the management request rate is exceeded.

errorobjectrequired

Error handling

A 400 is returned when the project ID is invalid. A 403 is returned when the caller lacks permission, a 404 when the project is not found, and a 429 when the management request rate is exceeded. The project_id path parameter must identify the project whose permissions you want to retrieve.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

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
  }
}