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

    Interface AgentsRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/workspaces/{workspace_uuid}/agents

    interface AgentsRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<
                AgentsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiListAgentsByWorkspaceOutput>;
        put(
            body: ApiMoveAgentsToWorkspaceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiMoveAgentsToWorkspaceOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AgentsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiMoveAgentsToWorkspaceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AgentsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get put toGetRequestInformation toPutRequestInformation withUrl

    Methods

    • To list all agents by a Workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.

      Parameters

      Returns Promise<undefined | ApiListAgentsByWorkspaceOutput>

      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 move all listed agents a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.

      Parameters

      • body: ApiMoveAgentsToWorkspaceInputPublic

        Parameters for Moving agents to a Workspace

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiMoveAgentsToWorkspaceOutput>

      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 move all listed agents a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.

      Parameters

      • body: ApiMoveAgentsToWorkspaceInputPublic

        Parameters for Moving agents to a Workspace

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns AgentsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods