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

    Interface Agent_uuItemRequestBuilder

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

    interface Agent_uuItemRequestBuilder {
        get api_keys(): Api_keysRequestBuilder;
        get child_agents(): Child_agentsRequestBuilder;
        get deployment_visibility(): Deployment_visibilityRequestBuilder;
        get functions(): FunctionsRequestBuilder;
        get knowledge_bases(): Knowledge_basesRequestBuilder;
        get usage(): UsageRequestBuilder;
        get versions(): VersionsRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiDeleteAgentOutput>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiGetAgentOutput>;
        put(
            body: ApiUpdateAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateAgentOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateAgentInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Agent_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    api_keys child_agents deployment_visibility functions knowledge_bases usage versions

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete an agent, send a DELETE request to /v2/gen-ai/agents/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiDeleteAgentOutput>

      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 retrieve details of an agent, GET request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiGetAgentOutput>

      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, send a PUT request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.

      Parameters

      • body: ApiUpdateAgentInputPublic

        Data to modify an existing Agent

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUpdateAgentOutput>

      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, send a DELETE request to /v2/gen-ai/agents/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To retrieve details of an agent, GET request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update an agent, send a PUT request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.

      Parameters

      • body: ApiUpdateAgentInputPublic

        Data to modify an existing Agent

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods