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/ API

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

NovelAI /ai/ 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/. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 10 operations across 9 paths, and defines 15 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.

10 operations 9 paths 15 schemas 2 GET8 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/ API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 2 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

/ai/ 10
POST
/ai/generate
Generate text. IMPORTANT NOTICE FOR EXISTING API TEXTGEN USERS.
AIController_aiGenerate body → 201400401402409500
POST
/ai/generate-prompt
AIController_aiGeneratePrompt body → 201401500
POST
/ai/generate-stream
AIController_aiGenerateStreamable body → 201400401402409500
POST
/ai/annotate-image
AIController_annotateImage body → 201400401402409500
POST
/ai/generate-image
AIController_aiGenerateImage body → 201400401402409500
POST
/ai/upscale
AIController_aiUpscaleImage body → 201400401402409500
POST
/ai/classify
AIController_classify → 201400401402409500
GET
/ai/generate-image/suggest-tags
AIController_generateImageTags 2 params → 200401500
GET
/ai/generate-voicedeprecated
Generate voice from text. The GET endpoint has been deprecated, please use the POST endpoint instead.
AIController_generateVoice 5 params → 200401500
POST
/ai/generate-voice
AIController_generateVoicePost body → 201401500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are AiGenerateParameters (49 properties), AiGenerateVoiceRequest (5 properties), AiGenerateImageRequest (5 properties), AiGenerateImageResponse (4 properties). Each schema is shown below with its type and property counts.

AiGeneratePromptRequest
object
4 properties 4 required
AiSequenceClassificationResponse
object
2 properties
AiGenerateImageResponse
object
4 properties
AiRequestImageGenerationTagsResponse
object
1 property 1 required
AiGenerateStreamableResponse
object
4 properties
AiGenerateParameters
object
49 properties 3 required
AiGenerateVoiceRequest
object
5 properties 5 required
AiGenerateResponse
object
2 properties
AiUpscaleImageRequest
object
4 properties 4 required
AiGenerateImageRequest
object
5 properties 3 required
AiGeneratePromptResponse
object
1 property 1 required
AiRequestImageGenerationTag
object
3 properties 3 required
AiAnnotateImageRequest
object
2 properties 2 required
ApiError
object
2 properties 2 required
AiGenerateRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novelai-ai-api-openapi.yml Raw ↑

Other APIs NovelAI publishes across the network.

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