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

    Interface FunctionsRequestBuilder

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

    interface FunctionsRequestBuilder {
        byFunction_uuid(
            function_uuid: string,
        ): WithFunction_uuItemRequestBuilder;
        post(
            body: ApiLinkAgentFunctionInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiLinkAgentFunctionOutput>;
        toPostRequestInformation(
            body: ApiLinkAgentFunctionInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): FunctionsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byFunction_uuid post toPostRequestInformation withUrl

    Methods

    post

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

      To create a function route for an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/functions.

      Parameters

      • body: ApiLinkAgentFunctionInputPublic

        Information for a agent function link

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiLinkAgentFunctionOutput>

      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 a function route for an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/functions.

      Parameters

      • body: ApiLinkAgentFunctionInputPublic

        Information for a agent function link

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns FunctionsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods