Spike Labs Developer Portal

Spike Labs API

Endpointhttps://api.spikelabs.com

GET

https://api.spikelabs.com

/chat/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

chat-service

timestamp

string · date-time · required

GET/chat/health

curl --request GET \
  --url https://api.spikelabs.com/chat/health

shell

Example Responses

{
  "status": "healthy",
  "service": "chat-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/tenant/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

tenant-service

timestamp

string · date-time · required

GET/tenant/health

curl --request GET \
  --url https://api.spikelabs.com/tenant/health

shell

Example Responses

{
  "status": "healthy",
  "service": "tenant-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

POST

https://api.spikelabs.com

/tenant/api/tokens/mint

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.

Request Body

user_id

string · minLength: 1 · required

name

string

email

string · email

scopes

string[]

exp_seconds

integer · min: 0 · max: 86400

Responses

Token minted successfully

token

string · required

expires_at

string · date-time · required

POST/tenant/api/tokens/mint

curl --request POST \
  --url https://api.spikelabs.com/tenant/api/tokens/mint \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "user_123",
  "name": "John Doe",
  "email": "[email protected]",
  "scopes": [
    "read",
    "write"
  ],
  "exp_seconds": 3600
}
'

shell

Example Request Body

{
  "user_id": "user_123",
  "name": "John Doe",
  "email": "[email protected]",
  "scopes": [
    "read",
    "write"
  ],
  "exp_seconds": 3600
}

json

Example Responses

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2024-01-01T01:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/content/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

content-service

timestamp

string · date-time · required

GET/content/health

curl --request GET \
  --url https://api.spikelabs.com/content/health

shell

Example Responses

{
  "status": "healthy",
  "service": "content-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/media/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

media-service

timestamp

string · date-time · required

GET/media/health

curl --request GET \
  --url https://api.spikelabs.com/media/health

shell

Example Responses

{
  "status": "healthy",
  "service": "media-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

Generate presigned URL for large file upload

POST

https://api.spikelabs.com

/media/api/files/presigned

Returns a presigned S3 URL for direct browser-to-S3 upload. Use for files > 5MB. After upload completes, call POST /files/{id}/confirm.

Generate presigned URL for large file upload › Request Body

mimeType

string · minLength: 1 · maxLength: 255 · required

filename

string · minLength: 1 · maxLength: 255

size

integer · min: 0

Generate presigned URL for large file upload › Responses

Presigned URL generated successfully

id

string · uuid · required

uploadUrl

string · uri · required

cdnUrl

string · uri · required

expiresAt

string · date-time · required

POST/media/api/files/presigned

curl --request POST \
  --url https://api.spikelabs.com/media/api/files/presigned \
  --header 'Content-Type: application/json' \
  --data '
{
  "filename": "large-video.mp4",
  "mimeType": "video/mp4",
  "size": 104857600
}
'

shell

Example Request Body

{
  "filename": "large-video.mp4",
  "mimeType": "video/mp4",
  "size": 104857600
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "uploadUrl": "https://s3.amazonaws.com/...",
  "cdnUrl": "https://cdn.aifiles.io/tenant/file/video.mp4",
  "expiresAt": "2024-01-01T01:00:00.000Z"
}

json

application/json

List files for tenant

GET

https://api.spikelabs.com

/media/api/files

List all files for the authenticated tenant with pagination.

List files for tenant › query Parameters

limit

integer · min: 1 · max: 100

Default: 20

offset

integer · min: 0

Default: 0

status

string · enum

Enum values:

pending

completed

failed

List files for tenant › Responses

200

Files listed successfully

object[] · required

total

number · required

limit

number · required

offset

number · required

GET/media/api/files

curl --request GET \
  --url https://api.spikelabs.com/media/api/files

shell

Example Responses

{
  "files": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "tenantId": "550e8400-e29b-41d4-a716-446655440001",
      "filename": "document.pdf",
      "mimeType": "application/pdf",
      "size": 1048576,
      "cdnUrl": "https://cdn.aifiles.io/tenant/file/doc.pdf",
      "thumbnailUrl": "https://cdn.aifiles.io/tenant/file/thumb.webp",
      "uploadStatus": "completed",
      "uploadedAt": "2024-01-01T00:00:00.000Z",
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

json

application/json

Upload file directly

POST

https://api.spikelabs.com

/media/api/files

Upload small files (< 5MB) directly through the API using multipart form data.

Upload file directly › Request Body

file

string · binary

Upload file directly › Responses

File uploaded successfully

id

string · uuid · required

cdnUrl

string · uri · required

size

number · required

POST/media/api/files

curl --request POST \
  --url https://api.spikelabs.com/media/api/files \
  --header 'Content-Type: multipart/form-data' \
  --form file=file

shell

Example Request Body

{
  "file": "file"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "cdnUrl": "https://cdn.aifiles.io/tenant/file/image.jpg",
  "size": 1048576
}

json

application/json

Confirm presigned upload completed

POST

https://api.spikelabs.com

/media/api/files/{id}/confirm

Called after presigned URL upload completes to update file metadata and mark as completed.

Confirm presigned upload completed › path Parameters

id

string · uuid · required

Confirm presigned upload completed › Request Body

size

integer · min: 0 · required

contentHash

string

Confirm presigned upload completed › Responses

Upload confirmed successfully

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

POST/media/api/files/{id}/confirm

curl --request POST \
  --url https://api.spikelabs.com/media/api/files/:id/confirm \
  --header 'Content-Type: application/json' \
  --data '
{
  "size": 104857600,
  "contentHash": "sha256:abc123..."
}
'

shell

Example Request Body

{
  "size": 104857600,
  "contentHash": "sha256:abc123..."
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "550e8400-e29b-41d4-a716-446655440001",
  "filename": "document.pdf",
  "mimeType": "application/pdf",
  "size": 1048576,
  "cdnUrl": "https://cdn.aifiles.io/tenant/file/doc.pdf",
  "thumbnailUrl": "https://cdn.aifiles.io/tenant/file/thumb.webp",
  "uploadStatus": "completed",
  "uploadedAt": "2024-01-01T00:00:00.000Z",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

json

application/json

Get file metadata

GET

https://api.spikelabs.com

/media/api/files/{id}

Retrieve metadata for a specific file by ID.

Get file metadata › path Parameters

id

string · uuid · required

Get file metadata › Responses

File metadata retrieved successfully

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

GET/media/api/files/{id}

curl --request GET \
  --url https://api.spikelabs.com/media/api/files/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "550e8400-e29b-41d4-a716-446655440001",
  "filename": "document.pdf",
  "mimeType": "application/pdf",
  "size": 1048576,
  "cdnUrl": "https://cdn.aifiles.io/tenant/file/doc.pdf",
  "thumbnailUrl": "https://cdn.aifiles.io/tenant/file/thumb.webp",
  "uploadStatus": "completed",
  "uploadedAt": "2024-01-01T00:00:00.000Z",
  "createdAt": "2024-01-01T00:00:00.000Z"
}

json

application/json

Delete a file

DELETE

https://api.spikelabs.com

/media/api/files/{id}

Delete a file from storage and database.

Delete a file › path Parameters

id

string · uuid · required

Delete a file › Responses

File deleted successfully

No data returned

DELETE/media/api/files/{id}

curl --request DELETE \
  --url https://api.spikelabs.com/media/api/files/:id

shell

Example Responses

No example specified for this content type

GET

https://api.spikelabs.com

/platform/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

platform-service

timestamp

string · date-time · required

GET/platform/health

curl --request GET \
  --url https://api.spikelabs.com/platform/health

shell

Example Responses

{
  "status": "healthy",
  "service": "platform-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/activity/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

activity-service

timestamp

string · date-time · required

GET/activity/health

curl --request GET \
  --url https://api.spikelabs.com/activity/health

shell

Example Responses

{
  "status": "healthy",
  "service": "activity-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/journey/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

journey-service

timestamp

string · date-time · required

GET/journey/health

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

shell

Example Responses

{
  "status": "healthy",
  "service": "journey-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/gamification/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

gamification-service

timestamp

string · date-time · required

GET/gamification/health

curl --request GET \
  --url https://api.spikelabs.com/gamification/health

shell

Example Responses

{
  "status": "healthy",
  "service": "gamification-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/form/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

form-service

timestamp

string · date-time · required

GET/form/health

curl --request GET \
  --url https://api.spikelabs.com/form/health

shell

Example Responses

{
  "status": "healthy",
  "service": "form-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

GET

https://api.spikelabs.com

/avatar/health

Responses

200

Health check response

status

string · enum · required

Enum values:

healthy

unhealthy

service

string · enum · required

Enum values:

avatar-service

timestamp

string · date-time · required

GET/avatar/health

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

shell

Example Responses

{
  "status": "healthy",
  "service": "avatar-service",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

json

application/json

Public Forms