Skip to content
StudyPlug API

Request an API key

POST
/api/v1/keys/request

Submit a request for an API key. The StudyPlug team will review and respond via email.

Request Body required

Section titled “Request Body required ”
object
name
required

Your name

string
>= 1 characters <= 255 characters
email
required

Email to receive your API key

string format: email
projectDescription
required

Brief description of your project and how you plan to use the API

string
>= 10 characters <= 2000 characters

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Request submitted

object
data
object
message
string
Example
Your API key request has been submitted. We'll review it and get back to you via email.
meta
object
requestId
string format: uuid
generatedAt
string format: date-time
apiVersion
string
Allowed values: v1
cacheHit
boolean

400

Section titled “400 ”

Invalid JSON

RFC 7807 Problem Details

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
retryAfter

Seconds to wait before retrying (present on 429 responses)

integer

422

Section titled “422 ”

Validation error

RFC 7807 Problem Details

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
retryAfter

Seconds to wait before retrying (present on 429 responses)

integer

429

Section titled “429 ”

Rate limit exceeded

RFC 7807 Problem Details

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string
retryAfter

Seconds to wait before retrying (present on 429 responses)

integer
Example
{
  "type": "https://api.studyplug.org/errors/rate-limited",
  "title": "Rate Limit Exceeded",
  "status": 429,
  "detail": "You have exceeded 20 requests per minute. Please wait before retrying.",
  "instance": "/api/v1/skills",
  "retryAfter": 12
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until rate limit resets

X-RateLimit-Limit
integer

Max requests per window

X-RateLimit-Remaining
integer
Allowed values: 0

Always 0 when rate limited