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

    Interface WorkspacesRequestBuilder

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

    interface WorkspacesRequestBuilder {
        byWorkspace_uuid(
            workspace_uuid: string,
        ): WithWorkspace_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiListWorkspacesOutput>;
        post(
            body: ApiCreateWorkspaceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiCreateWorkspaceOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiCreateWorkspaceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WorkspacesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byWorkspace_uuid get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all workspaces, send a GET request to /v2/gen-ai/workspaces.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiListWorkspacesOutput>

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

      To create a new workspace, send a POST request to /v2/gen-ai/workspaces. The response body contains a JSON object with the newly created workspace object.

      Parameters

      • body: ApiCreateWorkspaceInputPublic

        Parameters for Workspace Creation

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiCreateWorkspaceOutput>

      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 list all workspaces, send a GET request to /v2/gen-ai/workspaces.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To create a new workspace, send a POST request to /v2/gen-ai/workspaces. The response body contains a JSON object with the newly created workspace object.

      Parameters

      • body: ApiCreateWorkspaceInputPublic

        Parameters for Workspace Creation

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods