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

    Interface AgentsRequestBuilder

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

    interface AgentsRequestBuilder {
        byAgent_uuId(agent_uuId: string): Agent_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                AgentsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiListAgentsOutputPublic>;
        post(
            body: ApiCreateAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiCreateAgentOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                AgentsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiCreateAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): AgentsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byAgent_uuId get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

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

      Parameters

      Returns Promise<undefined | ApiListAgentsOutputPublic>

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

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

      Parameters

      • body: ApiCreateAgentInputPublic

        Parameters for Agent Creation

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiCreateAgentOutput>

      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 new agent, send a POST request to /v2/gen-ai/agents. The response body contains a JSON object with the newly created agent object.

      Parameters

      • body: ApiCreateAgentInputPublic

        Parameters for Agent Creation

      • 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