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

    Interface WithChild_agent_uuItemRequestBuilder

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

    interface WithChild_agent_uuItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUnlinkAgentOutput>;
        post(
            body: ApiLinkAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiLinkAgentOutput>;
        put(
            body: ApiUpdateLinkedAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateLinkedAgentOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiLinkAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateLinkedAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithChild_agent_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete post put toDeleteRequestInformation toPostRequestInformation toPutRequestInformation withUrl

    Methods

    • To delete an agent route from a parent agent, send a DELETE request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUnlinkAgentOutput>

      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: ApiLinkAgentInputPublic,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ApiLinkAgentOutput>

      To add an agent route to an agent, send a POST request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

      Parameters

      • body: ApiLinkAgentInputPublic

        Information for linking an agent

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiLinkAgentOutput>

      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 route for an agent, send a PUT request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

      Parameters

      • body: ApiUpdateLinkedAgentInputPublic

        Information about updating the linkage of an agent

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUpdateLinkedAgentOutput>

      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 agent route from a parent agent, send a DELETE request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To add an agent route to an agent, send a POST request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

      Parameters

      • body: ApiLinkAgentInputPublic

        Information for linking an agent

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update an agent route for an agent, send a PUT request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

      Parameters

      • body: ApiUpdateLinkedAgentInputPublic

        Information about updating the linkage of an agent

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods