Interface AgentAPIAttributes

It describes the API exposed by an AI Agent. This information is necessary to query the AI Agent and to know which endpoints are available.

interface AgentAPIAttributes {
    authType?: "none" | "basic" | "oauth" | "bearer";
    endpoints: Endpoint[];
    openApiUrl?: string;
    openEndpoints?: string[];
    password?: string;
    token?: string;
    username?: string;
}

Properties

authType? endpoints openApiUrl? openEndpoints? password? token? username?

Properties

Optional authType

authType?: "none" | "basic" | "oauth" | "bearer"

The upstream agent/service authentication type ('none', 'basic', 'bearer' or 'oauth').

endpoints

endpoints: Endpoint[]

The list endpoints of the upstream service. All these endpoints are protected and only accessible to subscribers of the Payment Plan.

Optional openApiUrl

openApiUrl?: string

The URL to the OpenAPI description of the Upstream API. The access to the OpenAPI definition don't require subscription to the Payment Plan.

Optional openEndpoints

openEndpoints?: string[]

The list of endpoints of the upstream service that publicly available. The access to these endpoints don't require subscription to the Payment Plan. They are useful to expose documentation, etc.

Optional password

password?: string

The upstream agent/service password for authentication. Only if authType is 'basic'.

Optional token

token?: string

The upstream agent/service bearer token for authentication. Only if authType is 'bearer' or 'oauth'.

Optional username

username?: string

The upstream agent/service username for authentication. Only if authType is 'basic'.

Settings

Member Visibility

Theme

On This Page

authTypeendpointsopenApiUrlopenEndpointspasswordtokenusername