Skip to content
AIDE AI Partner API

Your credits' validity ends in 7 days

POST

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
AIDE-Signature
required
string

Verify it before you trust the body (client docs, “Verify the signature”).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
string
object
required
string
Allowed value: event
type
required
string
Allowed value: credits.expiring
livemode
required
boolean
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z))$/
data
required
object
object
required
object
object
required
string
Allowed value: account
id
required
string
name
required
string
livemode
required
boolean
pricing
required
object
paper_credits_per_page
required
integer
grading_credits_per_page
required
integer
low_balance_threshold
required
integer
credits_valid_until
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:Z))$/
technical_contact_email
required
Any of:
string
rate_limit_per_minute
required
integer

Responses

Section titled “Responses”

2XX

Section titled “2XX”

Received. Anything else, or no answer within 10 seconds, is retried.