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

    Interface WithApi_key_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/agents/{agent_uu-id}/api_keys/{api_key_uuid}

    interface WithApi_key_uuItemRequestBuilder {
        get regenerate(): RegenerateRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiDeleteAgentAPIKeyOutput>;
        put(
            body: ApiUpdateAgentAPIKeyInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateAgentAPIKeyOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateAgentAPIKeyInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithApi_key_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    regenerate

    Methods

    delete put toDeleteRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiDeleteAgentAPIKeyOutput>

      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 agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

      Parameters

      • body: ApiUpdateAgentAPIKeyInputPublic

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUpdateAgentAPIKeyOutput>

      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 API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_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 agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

      Parameters

      • body: ApiUpdateAgentAPIKeyInputPublic

        The request body

      • 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