agents / Exports / OpenAPIToolConfig

Interface: OpenAPIToolConfig

OpenAPI specification configuration

Table of contents

Properties

• spec
• operationId
• baseURL
• auth

Properties

spec

• spec: Object

OpenAPI 3.0 specification

Type declaration

Name	Type
openapi	string
info	{ title: string ; version: string ; description?: string }
info.title	string
info.version	string
info.description?	string
servers?	{ url: string ; description?: string }[]
paths	Record<string, Record<string, string | number | boolean | Record<string, string | number | boolean>>>
components?	Record<string, Record<string, string | number | boolean>>

Defined in

packages/agents/src/interfaces/tool.ts:125

---

operationId

• operationId: string

Operation ID from the OpenAPI spec

Defined in

packages/agents/src/interfaces/tool.ts:140

---

baseURL

• baseURL: string

Base URL for API calls

Defined in

packages/agents/src/interfaces/tool.ts:142

---

auth

• Optional auth: Object

Authentication configuration

Type declaration

Name	Type
type	"bearer" | "apiKey" | "basic"
token?	string
apiKey?	string
header?	string
username?	string
password?	string

Defined in

packages/agents/src/interfaces/tool.ts:144