Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NovelAI /ai/module/ API

The /ai/module/ API from NovelAI — 3 operation(s) for /ai/module/.

NovelAI /ai/module/ API is one of 6 APIs that NovelAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include /ai/module/. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://api.novelai.net.

4 operations 3 paths 3 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Server
https://api.novelai.net
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NovelAI /ai/module/ API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

/ai/module/ 4
GET
/ai/module/all
description: "Access Token is incorrect.", type: ApiError, }) status: HttpStatus.PAYMENTREQUIRED, description: "An active subscription required to access this endpoint.", type: ApiError, }) descripti…
AIModuleController_allModules → 200401500
GET
/ai/module/{id}
AIModuleController_getModule 1 param → 200401404500
DELETE
/ai/module/{id}
AIModuleController_deleteModule 1 param → 200401404409500
POST
/ai/module/buy-training-steps
AIModuleController_buyTrainingSteps body → 200400401409500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are AiModuleDto (10 properties), ApiError (2 properties), BuyTrainingStepsRequest (1 property). Each schema is shown below with its type and property counts.

ApiError
object
2 properties 2 required
BuyTrainingStepsRequest
object
1 property 1 required
AiModuleDto
object
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novelai-ai-module-api-openapi.yml Raw ↑

Other APIs NovelAI publishes across the network.

NovelAI API
NovelAI /ai/ API
NovelAI / API
NovelAI /user/ API
NovelAI /user/subscription/ API