latest--APIAgent

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/eidolon-resource/_shared/latest--APIAgent.json
Parent schema eidolon-resource
Type: object

An Agent that can call rest endpoints documented via OpenAPI (Swagger).

Properties

implementation const: "APIAgent" required
Constant: "APIAgent"
title string required

Title of the API

root_call_url string required

Root URL of the API to call

open_api_location string required

Location of the OpenAPI schema

operations_to_expose Operation[] required

Operations to expose

extra_header_params object

Extra header parameters to add to every call. This can be a jinja template where the variables in the template are ENV variables (matching case)

Default:
{}
extra_query_params object

Extra query parameters to add to every call. This can be a jinja template where the variables in the template are ENV variables (matching case)

Default:
{}
max_response_size integer

Maximum size of response content to allow. If the response is larger than this, an error will be raised. Default is 50k

Default: 51200

Definitions

Operation object
name string required

Name of the operation

path string required

Path of the operation. Must match exactly including path parameters

method string required

HTTP method of the operation. get and post are supported

description string | null

Description of the operation

Default: null
result_filters string[] | null

Filters to apply to the result of the operation per json ref spec

Default: null