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

    Interface KeysRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/openai/keys

    interface KeysRequestBuilder {
        byApi_key_uuId(api_key_uuId: string): Api_key_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                KeysRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiListOpenAIAPIKeysOutput>;
        post(
            body: ApiCreateOpenAIAPIKeyInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiCreateOpenAIAPIKeyOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                KeysRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiCreateOpenAIAPIKeyInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): KeysRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byApi_key_uuId get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all OpenAI API keys, send a GET request to /v2/gen-ai/openai/keys.

      Parameters

      Returns Promise<undefined | ApiListOpenAIAPIKeysOutput>

      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

    post

    • post(
          body: ApiCreateOpenAIAPIKeyInputPublic,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ApiCreateOpenAIAPIKeyOutput>

      To create an OpenAI API key, send a POST request to /v2/gen-ai/openai/keys.

      Parameters

      • body: ApiCreateOpenAIAPIKeyInputPublic

        CreateOpenAIAPIKeyInputPublic is used to create a new 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 | ApiCreateOpenAIAPIKeyOutput>

      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 create an OpenAI API key, send a POST request to /v2/gen-ai/openai/keys.

      Parameters

      • body: ApiCreateOpenAIAPIKeyInputPublic

        CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key for a specific agent.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns KeysRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods