Method retrieve

src/openai/resources/files.py:154–189

Returns information about a specific file. Args: extra_headers: Send extra headers extra_query: Add additional query parameters to the request extra_body: Add additional JSON properties to the request timeout: Override the client-level def

(
        self,
        file_id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    )

        )

    def retrieve(
        self,
        file_id: str,
        *,
        class="cm"># Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        class="cm"># The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> FileObject:
        class="st">"""
        Returns information about a specific file.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        class="st">"""
        if not file_id:
            raise ValueError(fclass="st">"Expected a non-empty value for `file_id` but received {file_id!r}")
        return self._get(
            path_template(class="st">"/files/{file_id}", file_id=file_id),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                security={class="st">"bearer_auth": True},
            ),
            cast_to=FileObject,
        )

    def list(
        self,