Spike Labs API

public

Endpointhttps://api.spikelabs.com

Get Ably token for real-time subscriptions

POST

https://api.spikelabs.com

/tenant/api/ably/token

Creates an Ably TokenRequest that clients can exchange for a real-time connection token. The token grants subscribe access to the user's channel (user:{tenantId}:{userId}).

Get Ably token for real-time subscriptions › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Ably token for real-time subscriptions › Request Body optional

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

Get Ably token for real-time subscriptions › Responses

Ably TokenRequest created successfully

object · required

channel_name

string · required

The channel name the token grants access to

POST/tenant/api/ably/token

curl --request POST \
  --url https://api.spikelabs.com/tenant/api/ably/token \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "capability": {
    "user:*:*": [
      "subscribe"
    ]
  },
  "scope": "user"
}
'

shell

Example Request Body

{
  "capability": {
    "user:*:*": [
      "subscribe"
    ]
  },
  "scope": "user"
}

json

Example Responses

{
  "token_request": {
    "keyName": "keyName",
    "ttl": 0,
    "timestamp": 0,
    "capability": "capability",
    "clientId": "clientId",
    "nonce": "nonce",
    "mac": "mac"
  },
  "channel_name": "user:my-tenant:user_123"
}

json

application/json

Browse journeys

GET

https://api.spikelabs.com

/journey/api/user/journeys

Returns a paginated list of published, public journeys.

Browse journeys › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string

Cursor for pagination (base64 encoded created_at + id)

category

string · enum

Enum values:

wellness

fitness

professional

personal_growth

addiction_recovery

search

string

Browse journeys › Responses

200

List of journeys

object[] · required

object · required

GET/journey/api/user/journeys

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/journeys

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "slug": "slug",
      "description": {},
      "short_description": {},
      "category": "wellness",
      "icon": {},
      "cover_image_url": {},
      "timing_config": {
        "start_mode": "immediate",
        "start_weekday": "monday",
        "start_date": "start_date",
        "pre_start_content_enabled": true,
        "duration_mode": "fixed_days",
        "duration_days": 0,
        "end_date": "end_date"
      },
      "listing_metadata": {},
      "event_count": 0
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": null
  }
}

json

application/json

Get journey details

GET

https://api.spikelabs.com

/journey/api/user/journeys/{id}

Returns a single published journey by ID or slug.

Get journey details › path Parameters

id

string · uuid · required

Get journey details › Responses

Journey details

object · required

GET/journey/api/user/journeys/{id}

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/journeys/:id

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "slug": "slug",
    "description": {},
    "short_description": {},
    "category": "wellness",
    "icon": {},
    "cover_image_url": {},
    "timing_config": {
      "start_mode": "immediate",
      "start_weekday": "monday",
      "start_date": "start_date",
      "pre_start_content_enabled": true,
      "duration_mode": "fixed_days",
      "duration_days": 0,
      "end_date": "end_date"
    },
    "listing_metadata": {},
    "event_count": 0,
    "events_summary": {
      "check_in": 0,
      "reflection": 0,
      "challenge": 0,
      "insight": 0
    }
  }
}

json

application/json

Start a journey

POST

https://api.spikelabs.com

/journey/api/user/journeys/{id}/start

Enroll the current user in a journey. Optionally accepts pre-computed classification result and form responses to skip onboarding.

Start a journey › path Parameters

id

string · uuid · required

Start a journey › Request Body optional

object[]

object

onboarding_insight

string

Start a journey › Responses

Journey started

object · required

POST/journey/api/user/journeys/{id}/start

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/journeys/:id/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "responses": [
    {
      "field_id": "field_id",
      "response_value": {}
    }
  ],
  "classification_result": {
    "profile_key": "profile_key",
    "confidence": 0,
    "raw_output": "raw_output",
    "classified_at": "classified_at"
  },
  "onboarding_insight": "onboarding_insight"
}
'

shell

Example Request Body

{
  "responses": [
    {
      "field_id": "field_id",
      "response_value": {}
    }
  ],
  "classification_result": {
    "profile_key": "profile_key",
    "confidence": 0,
    "raw_output": "raw_output",
    "classified_at": "classified_at"
  },
  "onboarding_insight": "onboarding_insight"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "journey_id": "00000000-0000-0000-0000-000000000000",
    "journey_name": "journey_name",
    "journey_slug": "journey_slug",
    "status": "onboarding",
    "current_day": {},
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "progress_summary": {},
    "onboarding_form_id": {},
    "profile_name": {},
    "profile_description": {},
    "profile_cover_image": {},
    "onboarding_insight": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

List my journeys

GET

https://api.spikelabs.com

/journey/api/user/me/journeys

Returns the current user's journey instances.

List my journeys › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string

Cursor for pagination (base64 encoded created_at + id)

status

string · enum

Enum values:

onboarding

characterization_complete

active

completed

abandoned

List my journeys › Responses

200

List of journey instances

object[] · required

object · required

GET/journey/api/user/me/journeys

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/me/journeys

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "journey_id": "00000000-0000-0000-0000-000000000000",
      "journey_name": "journey_name",
      "journey_slug": "journey_slug",
      "status": "onboarding",
      "current_day": {},
      "started_at": "2024-08-25T15:00:00Z",
      "completed_at": "2024-08-25T15:00:00Z",
      "progress_summary": {},
      "onboarding_form_id": {},
      "profile_name": {},
      "profile_description": {},
      "profile_cover_image": {},
      "onboarding_insight": {},
      "created_at": "2024-08-25T15:00:00Z",
      "updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": null
  }
}

json

application/json

Get my journey instance

GET

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}

Returns a single journey instance by ID.

Get my journey instance › path Parameters

instanceId

string · uuid · required

Get my journey instance › Responses

Journey instance details

object · required

GET/journey/api/user/me/journeys/{instanceId}

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "journey_id": "00000000-0000-0000-0000-000000000000",
    "journey_name": "journey_name",
    "journey_slug": "journey_slug",
    "status": "onboarding",
    "current_day": {},
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "progress_summary": {},
    "onboarding_form_id": {},
    "profile_name": {},
    "profile_description": {},
    "profile_cover_image": {},
    "onboarding_insight": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Complete onboarding

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/complete-onboarding

Transitions a journey from onboarding to characterization_complete. Submits form responses, runs classification and insight generation.

Complete onboarding › path Parameters

instanceId

string · uuid · required

Complete onboarding › Request Body optional

object[]

form_submission_id

string

Complete onboarding › Responses

Onboarding completed

object · required

POST/journey/api/user/me/journeys/{instanceId}/complete-onboarding

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/complete-onboarding \
  --header 'Content-Type: application/json' \
  --data '
{
  "responses": [
    {
      "field_id": "field_id",
      "response_value": {}
    }
  ],
  "form_submission_id": "form_submission_id"
}
'

shell

Example Request Body

{
  "responses": [
    {
      "field_id": "field_id",
      "response_value": {}
    }
  ],
  "form_submission_id": "form_submission_id"
}

json

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "journey_id": "00000000-0000-0000-0000-000000000000",
    "journey_name": "journey_name",
    "journey_slug": "journey_slug",
    "status": "onboarding",
    "current_day": {},
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "progress_summary": {},
    "onboarding_form_id": {},
    "profile_name": {},
    "profile_description": {},
    "profile_cover_image": {},
    "onboarding_insight": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Activate journey

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/activate

Transitions a journey from characterization_complete to active. Scaffolds day-1 events and sets start date.

Activate journey › path Parameters

instanceId

string · uuid · required

Activate journey › Responses

Journey activated

object · required

POST/journey/api/user/me/journeys/{instanceId}/activate

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/activate

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "journey_id": "00000000-0000-0000-0000-000000000000",
    "journey_name": "journey_name",
    "journey_slug": "journey_slug",
    "status": "onboarding",
    "current_day": {},
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "progress_summary": {},
    "onboarding_form_id": {},
    "profile_name": {},
    "profile_description": {},
    "profile_cover_image": {},
    "onboarding_insight": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Redo characterization

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/redo-characterization

Transitions a journey from characterization_complete back to onboarding. Clears classification and insight.

Redo characterization › path Parameters

instanceId

string · uuid · required

Redo characterization › Responses

Characterization reset

object · required

POST/journey/api/user/me/journeys/{instanceId}/redo-characterization

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/redo-characterization

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "journey_id": "00000000-0000-0000-0000-000000000000",
    "journey_name": "journey_name",
    "journey_slug": "journey_slug",
    "status": "onboarding",
    "current_day": {},
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "progress_summary": {},
    "onboarding_form_id": {},
    "profile_name": {},
    "profile_description": {},
    "profile_cover_image": {},
    "onboarding_insight": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Abandon a journey

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/abandon

Abandons an active or onboarding journey.

Abandon a journey › path Parameters

instanceId

string · uuid · required

Abandon a journey › Responses

Journey abandoned

object · required

POST/journey/api/user/me/journeys/{instanceId}/abandon

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/abandon

shell

Example Responses

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "journey_id": "00000000-0000-0000-0000-000000000000",
    "journey_name": "journey_name",
    "journey_slug": "journey_slug",
    "status": "onboarding",
    "current_day": {},
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "progress_summary": {},
    "onboarding_form_id": {},
    "profile_name": {},
    "profile_description": {},
    "profile_cover_image": {},
    "onboarding_insight": {},
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Get today's events across all active journeys

GET

https://api.spikelabs.com

/journey/api/user/me/today-events

Returns the next actionable events for today across all of the user's active journeys. Events are grouped by journey and ordered: scheduled events first (by position), then unscheduled events (by position). Only non-completed events are returned.

Get today's events across all active journeys › Responses

200

Today's events grouped by journey

object[] · required

GET/journey/api/user/me/today-events

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/me/today-events

shell

Example Responses

{
  "data": [
    {
      "journey_instance": {
        "id": "00000000-0000-0000-0000-000000000000",
        "journey_id": "00000000-0000-0000-0000-000000000000",
        "journey_name": "journey_name",
        "journey_slug": "journey_slug",
        "category": "category",
        "cover_image_url": {},
        "current_day": 0,
        "status": "status",
        "progress_summary": {},
        "duration_days": {}
      },
      "events": [
        {
          "event_id": "00000000-0000-0000-0000-000000000000",
          "event_name": "event_name",
          "event_type": "check_in",
          "position": 0,
          "form_id": {},
          "schedule_type": "specific_day",
          "schedule_config": {
            "day": 0
          },
          "event_config": {
            "default_recurrence": "daily",
            "phase": "phase"
          },
          "synthesis_config": {},
          "instance_id": "00000000-0000-0000-0000-000000000000",
          "status": "pending",
          "scheduled_for": "2024-08-25T15:00:00Z",
          "started_at": "2024-08-25T15:00:00Z",
          "completed_at": "2024-08-25T15:00:00Z",
          "synthesis_output": {},
          "renderer_spec": {},
          "synthesis_metadata": {},
          "xp_earned": {},
          "sort_order": {},
          "read_at": "2024-08-25T15:00:00Z",
          "created_at": "2024-08-25T15:00:00Z"
        }
      ]
    }
  ]
}

json

application/json

List my events for a journey

GET

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events

Returns the event instances for a journey instance.

List my events for a journey › path Parameters

instanceId

string · uuid · required

List my events for a journey › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

cursor

string

Cursor for pagination (base64 encoded created_at + id)

status

string · enum

Enum values:

pending

in_progress

completed

skipped

List my events for a journey › Responses

List of event instances

object[] · required

object · required

GET/journey/api/user/me/journeys/{instanceId}/events

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events

shell

Example Responses

{
  "data": [
    {
      "event_id": "00000000-0000-0000-0000-000000000000",
      "event_name": "event_name",
      "event_type": "check_in",
      "position": 0,
      "form_id": {},
      "schedule_type": "specific_day",
      "schedule_config": {
        "day": 0
      },
      "event_config": {
        "default_recurrence": "daily",
        "phase": "phase"
      },
      "synthesis_config": {},
      "instance_id": "00000000-0000-0000-0000-000000000000",
      "status": "pending",
      "scheduled_for": "2024-08-25T15:00:00Z",
      "started_at": "2024-08-25T15:00:00Z",
      "completed_at": "2024-08-25T15:00:00Z",
      "synthesis_output": {},
      "renderer_spec": {},
      "synthesis_metadata": {},
      "xp_earned": {},
      "sort_order": {},
      "read_at": "2024-08-25T15:00:00Z",
      "created_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "has_more": true,
    "next_cursor": null
  }
}

json

application/json

Get my event instance

GET

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}

Returns a single event instance.

Get my event instance › path Parameters

instanceId

string · uuid · required

eventInstanceId

string · uuid · required

Get my event instance › Responses

Event instance details

object · required

GET/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}

curl --request GET \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events/:eventInstanceId

shell

Example Responses

{
  "data": {
    "event_id": "00000000-0000-0000-0000-000000000000",
    "event_name": "event_name",
    "event_type": "check_in",
    "position": 0,
    "form_id": {},
    "schedule_type": "specific_day",
    "schedule_config": {
      "day": 0
    },
    "event_config": {
      "default_recurrence": "daily",
      "phase": "phase"
    },
    "synthesis_config": {},
    "instance_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "scheduled_for": "2024-08-25T15:00:00Z",
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "synthesis_output": {},
    "renderer_spec": {},
    "synthesis_metadata": {},
    "xp_earned": {},
    "sort_order": {},
    "read_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Start an event

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/start

Transitions an event from pending to in_progress.

Start an event › path Parameters

instanceId

string · uuid · required

eventInstanceId

string · uuid · required

Start an event › Responses

Event started

object · required

POST/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/start

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events/:eventInstanceId/start

shell

Example Responses

{
  "data": {
    "event_id": "00000000-0000-0000-0000-000000000000",
    "event_name": "event_name",
    "event_type": "check_in",
    "position": 0,
    "form_id": {},
    "schedule_type": "specific_day",
    "schedule_config": {
      "day": 0
    },
    "event_config": {
      "default_recurrence": "daily",
      "phase": "phase"
    },
    "synthesis_config": {},
    "instance_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "scheduled_for": "2024-08-25T15:00:00Z",
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "synthesis_output": {},
    "renderer_spec": {},
    "synthesis_metadata": {},
    "xp_earned": {},
    "sort_order": {},
    "read_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Start an event by journey event ID

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events/start

Creates or returns an event instance for the given journey event ID. If an instance already exists, returns it. Otherwise creates one with status in_progress.

Start an event by journey event ID › path Parameters

instanceId

string · uuid · required

Start an event by journey event ID › Request Body

event_id

string · uuid · required

Start an event by journey event ID › Responses

Event instance created or returned

object · required

POST/journey/api/user/me/journeys/{instanceId}/events/start

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "event_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": {
    "event_id": "00000000-0000-0000-0000-000000000000",
    "event_name": "event_name",
    "event_type": "check_in",
    "position": 0,
    "form_id": {},
    "schedule_type": "specific_day",
    "schedule_config": {
      "day": 0
    },
    "event_config": {
      "default_recurrence": "daily",
      "phase": "phase"
    },
    "synthesis_config": {},
    "instance_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "scheduled_for": "2024-08-25T15:00:00Z",
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "synthesis_output": {},
    "renderer_spec": {},
    "synthesis_metadata": {},
    "xp_earned": {},
    "sort_order": {},
    "read_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Complete an event

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/complete

Marks an event as completed.

Complete an event › path Parameters

instanceId

string · uuid · required

eventInstanceId

string · uuid · required

Complete an event › Request Body

object[]

form_submission_id

string

object

Complete an event › Responses

Event completed

object · required

POST/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/complete

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events/:eventInstanceId/complete \
  --header 'Content-Type: application/json' \
  --data '
{
  "responses": [
    {
      "field_id": "field_id",
      "response_value": {}
    }
  ],
  "form_submission_id": "form_submission_id",
  "event_data": {}
}
'

shell

Example Request Body

{
  "responses": [
    {
      "field_id": "field_id",
      "response_value": {}
    }
  ],
  "form_submission_id": "form_submission_id",
  "event_data": {}
}

json

Example Responses

{
  "data": {
    "event_id": "00000000-0000-0000-0000-000000000000",
    "event_name": "event_name",
    "event_type": "check_in",
    "position": 0,
    "form_id": {},
    "schedule_type": "specific_day",
    "schedule_config": {
      "day": 0
    },
    "event_config": {
      "default_recurrence": "daily",
      "phase": "phase"
    },
    "synthesis_config": {},
    "instance_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "scheduled_for": "2024-08-25T15:00:00Z",
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "synthesis_output": {},
    "renderer_spec": {},
    "synthesis_metadata": {},
    "xp_earned": {},
    "sort_order": {},
    "read_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Skip an event

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/skip

Skips an event.

Skip an event › path Parameters

instanceId

string · uuid · required

eventInstanceId

string · uuid · required

Skip an event › Responses

Event skipped

object · required

POST/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/skip

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events/:eventInstanceId/skip

shell

Example Responses

{
  "data": {
    "event_id": "00000000-0000-0000-0000-000000000000",
    "event_name": "event_name",
    "event_type": "check_in",
    "position": 0,
    "form_id": {},
    "schedule_type": "specific_day",
    "schedule_config": {
      "day": 0
    },
    "event_config": {
      "default_recurrence": "daily",
      "phase": "phase"
    },
    "synthesis_config": {},
    "instance_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "scheduled_for": "2024-08-25T15:00:00Z",
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "synthesis_output": {},
    "renderer_spec": {},
    "synthesis_metadata": {},
    "xp_earned": {},
    "sort_order": {},
    "read_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Mark an event as read

POST

https://api.spikelabs.com

/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/read

Sets the read_at timestamp on an event instance.

Mark an event as read › path Parameters

instanceId

string · uuid · required

eventInstanceId

string · uuid · required

Mark an event as read › Responses

Event marked as read

object · required

POST/journey/api/user/me/journeys/{instanceId}/events/{eventInstanceId}/read

curl --request POST \
  --url https://api.spikelabs.com/journey/api/user/me/journeys/:instanceId/events/:eventInstanceId/read

shell

Example Responses

{
  "data": {
    "event_id": "00000000-0000-0000-0000-000000000000",
    "event_name": "event_name",
    "event_type": "check_in",
    "position": 0,
    "form_id": {},
    "schedule_type": "specific_day",
    "schedule_config": {
      "day": 0
    },
    "event_config": {
      "default_recurrence": "daily",
      "phase": "phase"
    },
    "synthesis_config": {},
    "instance_id": "00000000-0000-0000-0000-000000000000",
    "status": "pending",
    "scheduled_for": "2024-08-25T15:00:00Z",
    "started_at": "2024-08-25T15:00:00Z",
    "completed_at": "2024-08-25T15:00:00Z",
    "synthesis_output": {},
    "renderer_spec": {},
    "synthesis_metadata": {},
    "xp_earned": {},
    "sort_order": {},
    "read_at": "2024-08-25T15:00:00Z",
    "created_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Preview classification

POST

https://api.spikelabs.com

/journey/api/public/journeys/{id}/classification-snapshot

Returns a classification result and onboarding insight for the given form responses without creating a user instance.

Preview classification › path Parameters

id

string · uuid · required

Preview classification › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Preview classification › Request Body

object[] · required

Preview classification › Responses

Classification snapshot

object · required

POST/journey/api/public/journeys/{id}/classification-snapshot

curl --request POST \
  --url https://api.spikelabs.com/journey/api/public/journeys/:id/classification-snapshot \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "responses": [
    {
      "label": "label",
      "value": {}
    }
  ]
}
'

shell

Example Request Body

{
  "responses": [
    {
      "label": "label",
      "value": {}
    }
  ]
}

json

Example Responses

{
  "data": {
    "classification_result": {},
    "onboarding_insight": {}
  }
}

json

application/json

Get my badges

GET

https://api.spikelabs.com

/gamification/api/user/me/badges

Returns all badges earned by the current user.

Get my badges › Responses

200

User badges

object[] · required

GET/gamification/api/user/me/badges

curl --request GET \
  --url https://api.spikelabs.com/gamification/api/user/me/badges

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "badge_id": "00000000-0000-0000-0000-000000000000",
      "badge_name": "badge_name",
      "badge_description": "badge_description",
      "badge_icon": "badge_icon",
      "badge_rarity": "common",
      "earned_at": "2024-08-25T15:00:00Z",
      "source_resource_type": "source_resource_type",
      "source_resource_id": "source_resource_id"
    }
  ]
}

json

application/json

Get my achievements

GET

https://api.spikelabs.com

/gamification/api/user/me/achievements

Returns all achievement progress for the current user.

Get my achievements › Responses

200

User achievements

object[] · required

GET/gamification/api/user/me/achievements

curl --request GET \
  --url https://api.spikelabs.com/gamification/api/user/me/achievements

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "achievement_id": "00000000-0000-0000-0000-000000000000",
      "achievement_name": "achievement_name",
      "achievement_description": "achievement_description",
      "achievement_icon": "achievement_icon",
      "status": "in_progress",
      "progress": {
        "count": 0,
        "completed": true
      },
      "completed_at": "2024-08-25T15:00:00Z",
      "xp_awarded": 0
    }
  ]
}

json

application/json

Get my XP

GET

https://api.spikelabs.com

/gamification/api/user/me/xp

Returns XP balance, level, and recent history for the current user. Optionally filter by resource.

Get my XP › query Parameters

resource_type

string

Filter XP by resource type

resource_id

string · uuid

Filter XP by resource ID

Get my XP › Responses

200

User XP

object · required

GET/gamification/api/user/me/xp

curl --request GET \
  --url https://api.spikelabs.com/gamification/api/user/me/xp

shell

Example Responses

{
  "data": {
    "balance": 0,
    "level": 0,
    "recent_history": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "amount": 0,
        "reason": "event_completion",
        "source_id": "source_id",
        "resource_type": "resource_type",
        "resource_id": "resource_id",
        "created_at": "2024-08-25T15:00:00Z"
      }
    ]
  }
}

json

application/json

Get level thresholds

GET

https://api.spikelabs.com

/gamification/api/user/me/levels

Returns all level definitions with XP thresholds.

Get level thresholds › Responses

200

Level thresholds

object[] · required

GET/gamification/api/user/me/levels

curl --request GET \
  --url https://api.spikelabs.com/gamification/api/user/me/levels

shell

Example Responses

{
  "data": [
    {
      "level": 0,
      "min_xp": 0,
      "max_xp": 0
    }
  ]
}

json

application/json

Get my rewards

GET

https://api.spikelabs.com

/gamification/api/user/me/rewards

Returns all rewards with unlock status based on the current user's XP level.

Get my rewards › query Parameters

resource_type

string

Filter by resource type

resource_id

string · uuid

Filter by resource ID

Get my rewards › Responses

200

User rewards with unlock status

object[] · required

GET/gamification/api/user/me/rewards

curl --request GET \
  --url https://api.spikelabs.com/gamification/api/user/me/rewards

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "type": "video",
      "thumbnail_url": "thumbnail_url",
      "unlock_level": 0,
      "position": 0,
      "featured": true,
      "unlocked": true,
      "media_url": "media_url"
    }
  ]
}

json

application/json

Create avatar session

POST

https://api.spikelabs.com

/avatar/api/sessions

Creates a new avatar session: validates avatar, creates a LiveKit room, and returns a participant token.

Create avatar session › Request Body

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

Create avatar session › Responses

Session created

sessionId

string · uuid · required

roomName

string · required

token

string · required

livekitUrl

string · uri · required

POST/avatar/api/sessions

curl --request POST \
  --url https://api.spikelabs.com/avatar/api/sessions \
  --header 'Content-Type: application/json' \
  --data '
{
  "avatarId": "660e8400-e29b-41d4-a716-446655440000",
  "mode": "video_and_audio",
  "metadata": null,
  "deviceId": "d3f1a2b4-5678-4c9d-abcd-ef0123456789",
  "isAuthenticated": false
}
'

shell

Example Request Body

{
  "avatarId": "660e8400-e29b-41d4-a716-446655440000",
  "mode": "video_and_audio",
  "metadata": null,
  "deviceId": "d3f1a2b4-5678-4c9d-abcd-ef0123456789",
  "isAuthenticated": false
}

json

Example Responses

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "roomName": "avatar-550e8400-e29b-41d4-a716-446655440000",
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "livekitUrl": "wss://spike-55ae0q2w.livekit.cloud"
}

json

application/json

Get avatar session

GET

https://api.spikelabs.com

/avatar/api/sessions/{id}

Retrieves an avatar session by ID (tenant-scoped).

Get avatar session › path Parameters

id

string · uuid · required

Get avatar session › Responses

Session details

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

GET/avatar/api/sessions/{id}

curl --request GET \
  --url https://api.spikelabs.com/avatar/api/sessions/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "tenant_123",
  "userId": "user_456",
  "avatarId": "660e8400-e29b-41d4-a716-446655440000",
  "livekitRoomName": "avatar-550e8400-e29b-41d4-a716-446655440000",
  "livekitRoomSid": "RM_abc123",
  "mode": "video_and_audio",
  "status": "active",
  "startedAt": "2024-01-01T00:00:00.000Z",
  "endedAt": null,
  "metadata": null,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

json

application/json

End avatar session

DELETE

https://api.spikelabs.com

/avatar/api/sessions/{id}

Ends an active session and deletes the LiveKit room.

End avatar session › path Parameters

id

string · uuid · required

End avatar session › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

End avatar session › Responses

Session ended

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

DELETE/avatar/api/sessions/{id}

curl --request DELETE \
  --url https://api.spikelabs.com/avatar/api/sessions/:id \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "tenant_123",
  "userId": "user_456",
  "avatarId": "660e8400-e29b-41d4-a716-446655440000",
  "livekitRoomName": "avatar-550e8400-e29b-41d4-a716-446655440000",
  "livekitRoomSid": "RM_abc123",
  "mode": "video_and_audio",
  "status": "active",
  "startedAt": "2024-01-01T00:00:00.000Z",
  "endedAt": null,
  "metadata": null,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

json

application/json

Create session token

POST

https://api.spikelabs.com

/avatar/api/sessions/{id}/token

Generates a new LiveKit participant token for an existing session.

Create session token › path Parameters

id

string · uuid · required

Create session token › Responses

New participant token

token

string · required

livekitUrl

string · uri · required

POST/avatar/api/sessions/{id}/token

curl --request POST \
  --url https://api.spikelabs.com/avatar/api/sessions/:id/token

shell

Example Responses

{
  "token": "eyJhbGciOiJIUzI1NiIs...",
  "livekitUrl": "wss://spike-55ae0q2w.livekit.cloud"
}

json

application/json

user