Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference
API Reference
Admin
Organization
Usage

File search calls

admin.organization.usage.file_search_calls(UsageFileSearchCallsParams**kwargs) -> UsageFileSearchCallsResponse
GET/organization/usage/file_search_calls

Get file search calls usage details for the organization.

ParametersExpand Collapse
start_time: int

Start time (Unix seconds) of the query time range, inclusive.

api_key_ids: Optional[Sequence[str]]

Return only usage for these API keys.

bucket_width: Optional[Literal["1m", "1h", "1d"]]

Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

end_time: Optional[int]

End time (Unix seconds) of the query time range, exclusive.

group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", "vector_store_id"]]]

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.

limit: Optional[int]

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
page: Optional[str]

A cursor for use in pagination. Corresponding to the next_page field from the previous response.

project_ids: Optional[Sequence[str]]

Return only usage for these projects.

user_ids: Optional[Sequence[str]]

Return only usage for these users.

vector_store_ids: Optional[Sequence[str]]

Return only usage for these vector stores.

ReturnsExpand Collapse
class UsageFileSearchCallsResponse: …
data: List[Data]
has_more: bool
next_page: Optional[str]
object: Literal["page"]

File search calls

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.file_search_calls(
    start_time=0,
)
print(response.data)
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.file_searches.result",
                    "num_requests": 2,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "vector_store_id": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}
Returns Examples
{
    "object": "page",
    "data": [
        {
            "object": "bucket",
            "start_time": 1730419200,
            "end_time": 1730505600,
            "results": [
                {
                    "object": "organization.usage.file_searches.result",
                    "num_requests": 2,
                    "project_id": null,
                    "user_id": null,
                    "api_key_id": null,
                    "vector_store_id": null
                }
            ]
        }
    ],
    "has_more": false,
    "next_page": null
}