@nevermined-io/payments
    Preparing search index...

    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 {
        agentDefinitionUrl?: string;
        authType?: "none" | "basic" | "oauth" | "bearer";
        endpoints?: Endpoint[];
        openEndpoints?: string[];
        password?: string;
        token?: string;
        username?: string;
    }
    Index

    Properties

    agentDefinitionUrl? authType? endpoints? openEndpoints? password? token? username?

    Properties

    agentDefinitionUrl?: string

    Optional URL to a discoverable agent definition (OpenAPI spec, MCP Manifest, or A2A agent card). Stored as metadata for documentation / discovery — not consumed at runtime by the Nevermined platform.

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

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

    endpoints?: Endpoint[]

    Optional allowlist of upstream endpoints that require a valid Payment Plan subscription. When provided, the Nevermined platform enforces this list as Additional Security (defense-in-depth) on top of any per-route gating the Payments library middleware applies in your agent. When omitted, no route-level allowlist is enforced — your library middleware remains the sole gate.

    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.

    password?: string

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

    token?: string

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

    username?: string

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

    Settings

    Member Visibility

    On This Page

    Properties