SpikeCore AI
SpikeCoreAI
Sign InSign UpStart Free Trial
Back to Integrations

REST API Documentation

Integrate SpikeCore AI into your tools and workflows

Base URL

https://spikecore.ai

All API endpoints are versioned under /api/v1/. Requests and responses use JSON unless otherwise noted (file uploads use multipart/form-data).

Authentication

Authenticate by obtaining an access token via the login endpoint, then include it as a Bearer token in subsequent requests.

1. Get an access token

curl -X POST https://spikecore.ai/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "you@company.com", "password": "your-password"}'

2. Use the token

curl https://spikecore.ai/api/v1/projects \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Token expiry: Access tokens expire after 30 minutes. Use the refresh endpoint to obtain a new one without re-authenticating. Each API call consumes credits based on the action performed.

Rate Limits

Free

60 requests/min

Pro / Business

300 requests/min

Enterprise

1,000 requests/min

Exceeding the limit returns 429 Too Many Requests with a Retry-After header.

Endpoints

POST/api/v1/auth/login
POST/api/v1/auth/refresh
GET/api/v1/auth/meAUTH
GET/api/v1/projectsAUTH
POST/api/v1/projectsAUTH
GET/api/v1/projects/{id}AUTH
PATCH/api/v1/projects/{id}AUTH
DELETE/api/v1/projects/{id}AUTH
POST/api/v1/projects/{id}/uploadAUTH
GET/api/v1/projects/{id}/questionsAUTH
POST/api/v1/projects/{id}/extractAUTH
POST/api/v1/ai/generateAUTH
POST/api/v1/ai/generate-batchAUTH
PATCH/api/v1/questions/{id}AUTH
GET/api/v1/knowledgeAUTH
POST/api/v1/knowledgeAUTH
POST/api/v1/knowledge/uploadAUTH
DELETE/api/v1/knowledge/{id}AUTH
POST/api/v1/compliance/validateAUTH
POST/api/v1/ai/red-teamAUTH
POST/api/v1/ai/gap-analysisAUTH
GET/api/v1/opportunitiesAUTH
GET/api/v1/opportunities/{id}AUTH
POST/api/v1/opportunities/{id}/go-no-goAUTH
GET/api/v1/credits/balanceAUTH
GET/api/v1/credits/usageAUTH

Error Responses

All errors return a JSON body with a detail field.

CodeMeaning
400Bad Request — invalid parameters or body
401Unauthorized — missing or expired token
403Forbidden — insufficient permissions or credits
404Not Found — resource does not exist
409Conflict — duplicate resource
422Validation Error — request body failed schema validation
429Rate Limited — too many requests
500Internal Server Error — contact support

Need help integrating? Reach out at support@spikecore.ai or visit the Contact page.