@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface Api_key_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/openai/keys/{api_key_uu-id}

    interface Api_key_uuItemRequestBuilder {
        get agents(): AgentsRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiDeleteOpenAIAPIKeyOutput>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiGetOpenAIAPIKeyOutput>;
        put(
            body: ApiUpdateOpenAIAPIKeyInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateOpenAIAPIKeyOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateOpenAIAPIKeyInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Api_key_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    agents

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete an OpenAI API key, send a DELETE request to /v2/gen-ai/openai/keys/{api_key_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiDeleteOpenAIAPIKeyOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To retrieve details of an OpenAI API key, send a GET request to /v2/gen-ai/openai/keys/{api_key_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiGetOpenAIAPIKeyOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To update an OpenAI API key, send a PUT request to /v2/gen-ai/openai/keys/{api_key_uuid}.

      Parameters

      • body: ApiUpdateOpenAIAPIKeyInputPublic

        UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI API key for a specific agent.

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiUpdateOpenAIAPIKeyOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To delete an OpenAI API key, send a DELETE request to /v2/gen-ai/openai/keys/{api_key_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To retrieve details of an OpenAI API key, send a GET request to /v2/gen-ai/openai/keys/{api_key_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update an OpenAI API key, send a PUT request to /v2/gen-ai/openai/keys/{api_key_uuid}.

      Parameters

      • body: ApiUpdateOpenAIAPIKeyInputPublic

        UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI API key for a specific agent.

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods