Spike Labs API

Schemas

Chat_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

chat-service

timestamp

string · date-time · required

Tenant_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

tenant-service

timestamp

string · date-time · required

Tenant_AblyTokenRequest

object

Optional capability restrictions. Defaults to user channel subscribe.

scope

string · enum

Token scope. 'user' (default) grants access to user-specific channel. 'admin' grants access to tenant-wide admin channel.

Enum values:

user

admin

Tenant_AblyTokenResponse

object · required

channel_name

string · required

The channel name the token grants access to

Tenant_AblyErrorResponse

error

string · required

Tenant_MintTokenRequest

user_id

string · minLength: 1 · required

name

string

email

string · email

scopes

string[]

exp_seconds

integer · min: 0 · max: 86400

Tenant_MintTokenResponse

token

string · required

expires_at

string · date-time · required

Tenant_ErrorResponse

error

string · required

Content_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

content-service

timestamp

string · date-time · required

Content_ScratchpadResponse

id

number · required

content

string · required

version

number · required

type

string · enum · required

Enum values:

companion

roleplay

updated_at

string · date-time · required

Content_UserMemoryError

error

string · required

Content_UserUpdateScratchpadRequest

content

string · required

Media_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

media-service

timestamp

string · date-time · required

Media_PresignedUploadRequest

mimeType

string · minLength: 1 · maxLength: 255 · required

filename

string · minLength: 1 · maxLength: 255

size

integer · min: 0

Media_PresignedUploadResponse

id

string · uuid · required

uploadUrl

string · uri · required

cdnUrl

string · uri · required

expiresAt

string · date-time · required

Media_DirectUploadResponse

id

string · uuid · required

cdnUrl

string · uri · required

size

number · required

Media_ErrorResponse

error

string · required

Media_FileListResponse

object[] · required

total

number · required

limit

number · required

offset

number · required

Media_ConfirmUploadRequest

size

integer · min: 0 · required

contentHash

string

Media_FileMetadata

id

string · uuid · required

tenantId

string · uuid · required

filename

string · required

mimeType

string · required

size

number · required

cdnUrl

string · uri · required

thumbnailUrl

string · uri · required

Thumbnail URL for fast gallery loading (WebP, 320px)

uploadStatus

string · enum · required

Enum values:

pending

completed

failed

uploadedAt

string · date-time · required

createdAt

string · date-time · required

Media_SkinListResponse

object[] · required

object · required

Media_SkinDetail

id

string · uuid · required

name

string · required

gender

string · enum · required

Enum values:

male

female

other

style

string · enum · required

Enum values:

anime

realistic

cover_photo_url

string · required

Media_UserCollectionListResponse

object[] · required

object · required

Media_AddToCollectionRequest

mediaId

string · uuid · required

ID of the media to add to collection

relationType

string · enum

How the user is related to this media

Enum values:

created

saved

shared

Default: saved

object

Media_UserMediaItem

id

string · uuid · required

mediaId

string · uuid · required

mediaType

string · required

image | video | other

cdnUrl

string · uri · required

relationType

string · enum · required

How the user is related to this media

Enum values:

created

saved

shared

isFavorite

boolean · required

object · required

createdAt

string · date-time · required

Media_CollectionErrorResponse

object · required

Media_UpdateCollectionItemRequest

isFavorite

boolean

object

Media_GenerateImageSkinCategoryRequest

skin_id

string · uuid · required

category

string · enum · required

Pre-defined category for prompt generation

Enum values:

sports_action

cozy_at_home

beach_day

night_out

workout_gym

professional_headshot

dramatic_portrait

seed

integer

user_id

string

User ID who triggered the generation (for user_media record)

activity_instance_id

string · uuid

Activity instance (chat session) ID for message delivery callback and instance-specific context (persona, recent messages)

activity_id

string · uuid

Activity ID for fetching activity-level context (image gen fields, scenario, personality). Used by studio admin or alongside activity_instance_id.

generation_mode

string · enum

When set, uses LLM to generate the prompt from chat context instead of requiring positive_prompt

Enum values:

portrait

face

user

scene

last_message

raw_last

background

free

nsfw_level

string · enum

Content explicitness level for LLM prompt generation

Enum values:

sfw

nsfw

Default: sfw

Media_GenerateResponse

job_id

string · uuid · required

generation_id

string · uuid · required

Media_GenerateVideoSkinCategoryRequest

skin_id

string · uuid · required

category

string · enum · required

Pre-defined category for prompt generation

Enum values:

sports_action

cozy_at_home

beach_day

night_out

workout_gym

professional_headshot

dramatic_portrait

first_frame_source

string · enum

Whether to generate first frame or use skin reference image

Enum values:

generate

reference

Default: generate

reference_image_type

string · enum

Which skin reference image to use

Enum values:

headshot_portrait

full_body_clothed_portrait

full_body_swimsuit_portrait

full_body_underwear_portrait

full_body_naked_portrait

full_body_clothed_from_behind_portrait

seed

integer

user_id

string

User ID who triggered the generation (for user_media record)

activity_instance_id

string · uuid

Activity instance (chat session) ID for message delivery callback and instance-specific context (persona, recent messages)

activity_id

string · uuid

Activity ID for fetching activity-level context (image gen fields, scenario, personality). Used by studio admin or alongside activity_instance_id.

generation_mode

string · enum

When set, uses LLM to generate the prompt from chat context instead of requiring positive_prompt

Enum values:

portrait

face

user

scene

last_message

raw_last

background

free

nsfw_level

string · enum

Content explicitness level for LLM prompt generation

Enum values:

sfw

nsfw

Default: sfw

Platform_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

platform-service

timestamp

string · date-time · required

Activity_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

activity-service

timestamp

string · date-time · required

Activity_ActivityListResponse

object[] · required

object · required

Activity_ActivityDetail

id

string · uuid · required

title

string · required

description

string · required

short_description

string · required

scenario

string · required

example_dialogue

string · required

listing_image_url

string · uri · required

secondary_image_urls

string[] · required

category

string · required

subcategory

string · required

featured

boolean · required

is_companion

boolean · required

anime_cover_image_url

string · uri · required

realistic_cover_image_url

string · uri · required

nsfw_anime_cover_image_url

string · uri · required

nsfw_realistic_cover_image_url

string · uri · required

anime_cover_video_url

string · uri · required

realistic_cover_video_url

string · uri · required

nsfw_anime_cover_video_url

string · uri · required

nsfw_realistic_cover_video_url

string · uri · required

anime_cover_image_urls

string[] · required

realistic_cover_image_urls

string[] · required

anime_cover_video_urls

string[] · required

realistic_cover_video_urls

string[] · required

default_cover_image_prompt

string · required

anime_cover_image_prompt

string · required

realistic_cover_image_prompt

string · required

nsfw_anime_cover_image_urls

string[] · required

nsfw_realistic_cover_image_urls

string[] · required

nsfw_anime_cover_video_urls

string[] · required

nsfw_realistic_cover_video_urls

string[] · required

nsfw_default_cover_image_prompt

string · required

nsfw_anime_cover_image_prompt

string · required

nsfw_realistic_cover_image_prompt

string · required

personality

string · required

first_message

string · required

system_prompt

string · required

post_history_instructions

string · required

alternate_greetings

string[] · required

creator_notes

string · required

creator

string · required

character_version

string · required

tags

string[] · required

object · required

image_gen_character_short_text

string · required

image_gen_character_clothed_text

string · required

image_gen_character_naked_text

string · required

default_outfit_text

string · required

default_footwear_text

string · required

llm_image_prompt_generation_help_text

string · required

video_character_prompt

string · required

nsfw_video_character_prompt

string · required

anime_skin_id

string · uuid · required

realistic_skin_id

string · uuid · required

Activity_ErrorResponse

object · required

Activity_InstanceListResponse

object[] · required

object · required

Activity_CreateInstanceRequest

activity_id

string · uuid · required

assigned_voice_id

string · uuid

Activity_InstanceDetail

id

string · uuid · required

snapshot_title

string · required

snapshot_description

string · required

snapshot_short_description

string · required

snapshot_scenario

string · required

snapshot_example_dialogue

string · required

snapshot_listing_image_url

string · uri · required

snapshot_secondary_image_urls

string[] · required

snapshot_category

string · required

snapshot_subcategory

string · required

snapshot_personality

string · required

snapshot_first_message

string · required

snapshot_system_prompt

string · required

snapshot_post_history_instructions

string · required

snapshot_alternate_greetings

string[] · required

snapshot_lorebook_ids

string[] · required

assigned_voice_id

string · uuid · required

status

string · enum · required

Enum values:

active

archived

last_accessed_at

string · date-time · required

created_at

string · date-time · required

Activity_UpdateInstanceRequest

assigned_voice_id

string · uuid

status

string · enum

Enum values:

active

archived

Activity_MessageListResponse

object[] · required

object · required

Activity_CreateMessageRequest

role

string · enum · required

Enum values:

user

assistant

system

medium

string · enum · required

Enum values:

app

imessage

content

string · minLength: 1 · required

object[]

Activity_Message

id

string · uuid · required

role

string · enum · required

Enum values:

user

assistant

system

medium

string · enum · required

Enum values:

app

imessage

content

string · required

object[] · required

created_at

string · date-time · required

Activity_UpdateMessageRequest

content

string · minLength: 1

Activity_ChatRequest

content

string · minLength: 1 · maxLength: 10000 · required

The message content to send

medium

string · enum

The medium through which the message was sent

Enum values:

app

imessage

Default: app

skin_id

string

Skin ID for play mode XP scoping. When provided, XP is awarded scoped to this skin.

Activity_PersonaListResponse

object[] · required

Activity_CreatePersonaRequest

name

string · minLength: 1 · maxLength: 255 · required

gender

string · enum

Gender for pronoun substitution in templates

Enum values:

male

female

neutral

non_binary

other

description

string · maxLength: 1000

style_preference

string · enum

User's preferred image style for character displays

Enum values:

realistic

anime

is_default

boolean

Activity_Persona

id

string · uuid · required

name

string · required

gender

string · enum · required

Gender for pronoun substitution in templates

Enum values:

male

female

neutral

non_binary

other

description

string · required

style_preference

string · enum · required

User's preferred image style for character displays

Enum values:

realistic

anime

is_default

boolean · required

created_at

string · date-time · required

updated_at

string · date-time · required

Activity_UpdatePersonaRequest

name

string · minLength: 1 · maxLength: 255

gender

string · enum

Gender for pronoun substitution in templates

Enum values:

male

female

neutral

non_binary

other

description

string · maxLength: 1000

style_preference

string · enum

User's preferred image style for character displays

Enum values:

realistic

anime

Journey_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

journey-service

timestamp

string · date-time · required

Journey_BrowseJourneysResponse

object[] · required

object · required

Journey_PublicJourneyDetailResponse

object · required

Journey_ErrorResponse

object · required

Journey_StartJourneyRequest

object[]

object

onboarding_insight

string

Journey_StartJourneyResponse

object · required

Journey_UserJourneyInstancesResponse

object[] · required

object · required

Journey_UserJourneyInstanceResponse

object · required

Journey_CompleteOnboarding

object[]

form_submission_id

string

Journey_TodayEventsResponse

object[] · required

Journey_UserEventInstancesResponse

object[] · required

object · required

Journey_UserEventInstanceResponse

object · required

Journey_StartEventRequest

event_id

string · uuid · required

Journey_CompleteEvent

object[]

form_submission_id

string

object

Journey_ClassificationSnapshotRequest

object[] · required

Journey_ClassificationSnapshotResponse

object · required

Gamification_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

gamification-service

timestamp

string · date-time · required

Gamification_UserBadgesResponse

object[] · required

Gamification_UserAchievementsResponse

object[] · required

Gamification_UserXpResponse

object · required

Gamification_GamificationLevelsResponse

object[] · required

Gamification_UserRewardListResponse

object[] · required

Form_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

form-service

timestamp

string · date-time · required

Form_PublicForm

id

string · uuid · required

title

string · required

description

string | null · required

key

string · required

version

integer · required

object | null · required

object[] · required

object[]

style

object | null

Form_ErrorResponse

object · required

Form_SubmitFormRequest

object[] · required

object

Form_SubmitFormSuccess

success

boolean · enum · required

Enum values:

object · required

Form_SubmitFormValidationError

success

boolean · enum · required

Enum values:

error

string · enum · required

Enum values:

VALIDATION_FAILED

object[] · required

Form_DraftFormSuccess

submissionId

string · uuid · required

status

string · enum · required

Enum values:

draft

Form_GetSubmissionResponse

submissionId

string · uuid · required

status

string · enum · required

Enum values:

draft

submitted

reviewed

submittedAt

string | null · date-time · required

object[] · required

object | null · required

Avatar_HealthResponse

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

avatar-service

timestamp

string · date-time · required

Avatar_CreateSession

avatarId

string · uuid · required

mode

string · enum

Enum values:

video_and_audio

audio_only

pregenerated_video

Default: video_and_audio

object

deviceId

string · maxLength: 64

isAuthenticated

boolean

Avatar_CreateSessionResponse

sessionId

string · uuid · required

roomName

string · required

token

string · required

livekitUrl

string · uri · required

Avatar_ErrorResponse

object · required

Avatar_SessionResponse

id

string · uuid · required

tenantId

string · required

userId

string · required

avatarId

string · uuid · required

livekitRoomName

string · required

livekitRoomSid

string · required

mode

string · enum · required

Enum values:

video_and_audio

audio_only

pregenerated_video

status

string · enum · required

Enum values:

pending

active

ended

failed

startedAt

string · date-time · required

endedAt

string · date-time · required

createdAt

string · date-time · required

updatedAt

string · date-time · required

metadata

Avatar_SessionTokenResponse

token

string · required

livekitUrl

string · uri · required

Media_SkinListItem

id

string · uuid · required

name

string · required

gender

string · enum · required

Enum values:

male

female

other

style

string · enum · required

Enum values:

anime

realistic

cover_photo_url

string · required

Media_UserMediaMetadata

prompt

string

style

string

aspectRatio

string

tags

string[]

Activity_ActivityListItem

id

string · uuid · required

title

string · required

short_description

string · required

listing_image_url

string · uri · required

category

string · required

subcategory

string · required

featured

boolean · required

is_companion

boolean · required

created_at

string · date-time · required

anime_cover_image_url

string · uri · required

realistic_cover_image_url

string · uri · required

nsfw_anime_cover_image_url

string · uri · required

nsfw_realistic_cover_image_url

string · uri · required

Activity_InstanceListItem

id

string · uuid · required

activity_id

string · uuid · required

snapshot_title

string · required

snapshot_short_description

string · required

snapshot_listing_image_url

string · uri · required

snapshot_category

string · required

status

string · enum · required

Enum values:

active

archived

last_accessed_at

string · date-time · required

Journey_PublicJourney

id

string · uuid · required

name

string · required

slug

string · required

description

string | null · required

short_description

string | null · required

category

string · enum · required

Enum values:

wellness

fitness

professional

personal_growth

addiction_recovery

icon

string | null · required

cover_image_url

string | null · required

object · required

listing_metadata

object | null · required

event_count

integer · required

Journey_PublicJourneyDetail

id

string · uuid · required

name

string · required

slug

string · required

description

string | null · required

short_description

string | null · required

category

string · enum · required

Enum values:

wellness

fitness

professional

personal_growth

addiction_recovery

icon

string | null · required

cover_image_url

string | null · required

object · required

listing_metadata

object | null · required

event_count

integer · required

object · required

Journey_UserJourneyInstance

id

string · uuid · required

journey_id

string · uuid · required

journey_name

string · required

journey_slug

string · required

status

string · enum · required

Enum values:

onboarding

characterization_complete

active

completed

abandoned

current_day

integer | null · required

started_at

string | null · date-time · required

completed_at

string | null · date-time · required

progress_summary

object | null · required

onboarding_form_id

string | null · required

profile_name

string | null · required

profile_description

string | null · required

profile_cover_image

string | null · required

onboarding_insight

string | null · required

created_at

string · date-time · required

updated_at

string · date-time · required

Journey_UserEventInstance

event_id

string · uuid · required

event_name

string · required

event_type

string · enum · required

Enum values:

check_in

reflection

challenge

insight

position

integer · required

form_id

string | null · required

schedule_type

string · enum · required

Enum values:

specific_day

specific_date

daily

weekly

unscheduled

required

synthesis_config

object | null · required

instance_id

string | null · uuid · required

status

string | null · enum · required

Enum values:

pending

in_progress

completed

skipped

scheduled_for

string | null · date-time · required

started_at

string | null · date-time · required

completed_at

string | null · date-time · required

synthesis_output

string | null · required

object | null · required

synthesis_metadata

object | null · required

xp_earned

integer | null · required

sort_order

integer | null · required

read_at

string | null · date-time · required

created_at

string | null · date-time · required

Gamification_UserBadge

id

string · uuid · required

badge_id

string · uuid · required

badge_name

string · required

badge_description

string · required

badge_icon

string · required

badge_rarity

string · enum · required

Enum values:

common

rare

epic

legendary

earned_at

string · date-time · required

source_resource_type

string · required

source_resource_id

string · required

Gamification_UserAchievement

id

string · uuid · required

achievement_id

string · uuid · required

achievement_name

string · required

achievement_description

string · required

achievement_icon

string · required

status

string · enum · required

Enum values:

in_progress

completed

object · required

completed_at

string · date-time · required

xp_awarded

integer · required

Gamification_XpLedgerEntry

id

string · uuid · required

amount

integer · required

reason

string · enum · required

Enum values:

event_completion

achievement_earned

admin_adjustment

source_id

string · required

resource_type

string · required

resource_id

string · required

created_at

string · date-time · required

Gamification_GamificationLevel

level

integer · required

min_xp

integer · required

max_xp

integer · required

Gamification_UserReward

id

string · uuid · required

name

string · required

description

string · required

type

string · enum · required

Enum values:

video

audio

image

pose

avatar-clip

thumbnail_url

string · required

unlock_level

integer · required

position

integer · required

featured

boolean · required

unlocked

boolean · required

media_url

string · required

Form_PublicFormGroup

id

string · uuid · required

position

integer · required

title

string | null · required

subtitle

string | null · required

object[] · required

Form_PublicIntermediate

id

string · uuid · required

beforeGroupId

string | null · uuid · required

afterGroupId

string | null · uuid · required

position

integer · required

title

string | null · required

backgroundImage

string | null · required

buttonText

string | null · required

object | null · required

object[] · required

Form_PublicFormStyle

Form_FieldResponseValue

No data returned

Form_SubmissionMetadata

deviceType

string · enum

Enum values:

mobile

tablet

desktop

userAgent

string

timeSpentSeconds

number

startedAt

string

No data returned

Form_ValidationError

fieldId

string · required

message

string · required

Form_SubmissionResponse

fieldId

string · uuid · required

object · required

Form_PublicFormField

id

string · uuid · required

position

integer · required

fieldType

string · enum · required

Enum values:

text_input

voice_input

single_select

multi_select

scale

boolean

counter

checklist

label

string | null · required

labelVariants

array | null · required

object | null · required

isRequired

boolean · required

key

string | null · required

Form_PublicIntermediateBlock

id

string · uuid · required

intermediateId

string · uuid · required

parentBlockId

string | null · uuid · required

position

integer · required

blockType

string · enum · required

Enum values:

text

image

card

row

column

stack

object · required

object[]

Default: []