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

The /user/ API from NovelAI — 28 operation(s) for /user/.

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

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

This API exposes 35 operations across 28 paths, and defines 33 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.

35 operations 28 paths 33 schemas 3 DELETE12 GET2 PATCH14 POST4 PUT

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 /user/ API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 35

Across 28 paths, the API surfaces 35 operations — 3 DELETE, 12 GET, 2 PATCH, 14 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

/user/ 35
POST
/user/register
UserController_createUser body → 201400409500
POST
/user/login
UserController_loginUser body → 201400401500
POST
/user/change-access-key
UserController_changeAccessKey body → 200400401409500
POST
/user/sso/google
UserController_ssoGoogle body → 201500
PATCH
/user/change-mailing-list-consent
UserController_changeMailingListConsent body → 200204400401409500
POST
/user/resend-email-verification
UserController_requestEmailVerification body → 201400401409500
POST
/user/verify-email
UserController_verifyEmail body → 200400401500
GET
/user/information
UserController_getAccountInformation → 200401500
GET
/user/osano-external-id
UserController_getOsanoExternalId → 200401500
PUT
/user/consent
UserController_upsertUserConsent body → 200400401500
POST
/user/deletion/request
UserController_requestAccountDeletion body → 202400409500
POST
/user/deletion/delete
UserController_deleteAccount body → 200401409500
POST
/user/recovery/request
UserController_requestAccountRecovery body → 202400500
POST
/user/recovery/recover
UserController_recoverAccount body → 201400401409500
POST
/user/delete
UserController_deleteAccountUnchecked → 200401409500
GET
/user/data
UserController_getUserData → 200401500
GET
/user/priority
UserController_getCurrentPriority → 200401500
GET
/user/giftkeys
UserController_getGiftKeys → 200401500
GET
/user/subscription
UserController_getSubscription → 200401500
GET
/user/keystore
UserController_getKeystore → 200401500
PUT
/user/keystore
UserController_updateKeystore body → 200400401500
GET
/user/objects/{type}
UserController_getObjects 4 params → 200401500
PUT
/user/objects/{type}
UserController_createObject 1 param body → 200400401404500
GET
/user/objects/{type}/{id}
UserController_getObject 2 params → 200401500
PATCH
/user/objects/{type}/{id}
UserController_editObject 2 params body → 200400401404409500
DELETE
/user/objects/{type}/{id}
UserController_deleteObject 2 params → 200401404500
GET
/user/clientsettings
UserController_getClientSettings → 200401500
PUT
/user/clientsettings
UserController_updateClientSettings body → 200400401500
DELETE
/user/objects/batch
UserController_batchDeleteObjects body → 200400401500
POST
/user/create-persistent-token
UserController_createPersistentToken body → 200201401500
POST
/user/submission
UserController_postUserSubmission body → 200400401500
GET
/user/submission/{event}
UserController_getUserSubmission 1 param → 200401500
GET
/user/vote-submission/{event}
UserController_getUserSubmissionVotes 1 param → 200401500
POST
/user/vote-submission/{event}
UserController_voteSubmission 1 param body → 200201401409500
DELETE
/user/vote-submission/{event}
UserController_retractSubmissionVote 1 param body → 200401409500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are AccountInformationResponse (11 properties), CreateUserRequest (8 properties), UserSubmissionInput (7 properties), SubscriptionResponse (7 properties). Each schema is shown below with its type and property counts.

SubscriptionAvailableTrainingSteps
object
2 properties 2 required
UpsertConsentRequest
object
6 properties 6 required
UserSubmissionVoteInput
object
1 property 1 required
ApiError
object
2 properties 2 required
BatchDeleteRequest
object
1 property 1 required
UserAccountDataResponse
object
5 properties 5 required
DeletionFinishRequest
object
1 property 1 required
SubscriptionTierPerks
object
5 properties 5 required
UserSubmissionInput
object
7 properties 7 required
LoginRequest
object
2 properties 1 required
EmailVerificationStartRequest
object
1 property 1 required
ChangeAccessKeyRequest
object
3 properties 2 required
PriorityResponse
object
3 properties 3 required
OsanoExternalIdResponse
object
1 property 1 required
RecoveryFinishRequest
object
3 properties 3 required
EmailVerificationRequest
object
2 properties 1 required
CreateUserRequest
object
8 properties 4 required
UpdateKeystoreRequest
object
2 properties 1 required
SuccessfulLoginResponse
object
1 property 1 required
RecoveryStartRequest
object
2 properties 1 required
UserDataInput
object
3 properties 2 required
ChangeMailingListRequest
object
3 properties 1 required
AccountInformationResponse
object
11 properties 11 required
UserData
object
6 properties 6 required
CreatePersistentTokenResponse
object
1 property 1 required
CreateUserResponse
object
1 property 1 required
GoogleSSORequest
object
1 property 1 required
CreatePersistentTokenInput
object
1 property
GiftKeysResponse
object
1 property 1 required
DeletionStartRequest
object
1 property 1 required
SubscriptionResponse
object
7 properties 7 required
ObjectsResponse
object
1 property 1 required
GetKeystoreResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

novelai-user-api-openapi.yml Raw ↑

Other APIs NovelAI publishes across the network.

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