Webiny API Catalog

Others

webiny-api-catalog

Webiny API Catalog is an Agent Skill for general use published in the webiny/webiny-js repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

api — 21 abstractions.

View on GitHub ↗

QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

Open your project in Codex.
Copy and paste the prompt below.
Review files and risks before approving any action.

Prompt to paste

Inspect the Agent Skill at https://github.com/webiny/webiny-js/blob/HEAD/skills/user-skills/generated/api/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/webiny-api-catalog, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

api

How to Use

Find the abstraction you need below
You MUST read the source file to get the exact interface and types!
Import: import { Name } from "<importPath>";

Abstractions

Name: Ai Import: import { Ai } from "webiny/api" Source: @webiny/api-core/features/ai/index.ts Description: Interact with AI language models using registered providers.

Name: AiConnectionFactory Import: import { AiConnectionFactory } from "webiny/api" Source: @webiny/api-core/features/ai/index.ts Description: Factory that asynchronously produces an AiConnection.

Name: AiSdk Import: import { AiSdk } from "webiny/api" Source: @webiny/api-core/features/ai/index.ts Description: A single AI SDK instance (e.g. OpenAI, Anthropic) that resolves model instances.

Name: AiSdkFactory Import: import { AiSdkFactory } from "webiny/api" Source: @webiny/api-core/features/ai/index.ts Description: Factory that asynchronously initialises an AI SDK. Register one per provider namespace.

Name: BaseError Import: import { BaseError } from "webiny/api" Source: @webiny/feature/api/index.ts

Name: BuildParam Import: import { BuildParam } from "webiny/api" Source: @webiny/api-core/features/buildParams/index.ts Description: A single build-time configuration parameter.

Name: BuildParams Import: import { BuildParams } from "webiny/api" Source: @webiny/api-core/features/buildParams/index.ts Description: Access build-time configuration parameters.

Name: Compression Import: import { Compression } from "webiny/api" Source: @webiny/utils/features/compression/abstractions/Compression.ts

Name: CompressionHandler Import: import { CompressionHandler } from "webiny/api" Source: @webiny/utils/features/compression/abstractions/CompressionHandler.ts

Name: createAbstraction Import: import { createAbstraction } from "webiny/api" Source: @webiny/feature/api/index.ts

Name: createFeature Import: import { createFeature } from "webiny/api" Source: @webiny/feature/api/index.ts

Name: DomainEvent Import: import { DomainEvent } from "webiny/api" Source: @webiny/api-core/features/eventPublisher/index.ts Description: Base class for all domain events.

Name: Encryption Import: import { Encryption } from "webiny/api" Source: @webiny/api-core/features/encryption/index.ts Description: Symmetric encryption and decryption using a configured secret key.

Name: EventPublisher Import: import { EventPublisher } from "webiny/api" Source: @webiny/api-core/features/eventPublisher/index.ts Description: Publish domain events to registered handlers.

Name: GlobalKeyValueStore Import: import { GlobalKeyValueStore } from "webiny/api" Source: @webiny/api-core/features/keyValueStore/index.ts Description: Global (non-tenant-scoped) key-value store.

Name: IAiConnection Kind: type Import: import type { IAiConnection } from "webiny/api" Source: @webiny/api-core/features/ai/index.ts

Name: IAiConnectionInline Kind: type Import: import type { IAiConnectionInline } from "webiny/api" Source: @webiny/api-core/features/ai/index.ts

Name: KeyValueStore Import: import { KeyValueStore } from "webiny/api" Source: @webiny/api-core/features/keyValueStore/index.ts Description: Tenant-scoped key-value store.

Name: Logger Import: import { Logger } from "webiny/api" Source: @webiny/api-core/features/logger/index.ts Description: Structured logging with multiple log levels.

Name: Result Import: import { Result } from "webiny/api" Source: @webiny/feature/api/index.ts Description: A container type that represents either a successful result (ok) or a failure (fail). Inspired by functional programming constructs like Either or Result in other languages.

Name: Route Import: import { Route } from "webiny/api" Source: @webiny/handler/abstractions/Route.ts