Skip to main content
POST
Start an agent signup and get a trial key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
email
string<email>
required
agentName
string
required
Required string length: 1 - 60
agentVendor
string | null
Maximum string length: 40
purpose
string | null
Maximum string length: 280

Response

Successful Response

keyPrefix
string
required
keyId
string
required
scopes
string[]
required
registrationId
string
required
apiKey
string
required

Works now, on the trial. Shown once: store it. Verifying keeps the same key.

docsUrl
string
required
openapiUrl
string
required
mcpUrl
string
required
trial
TrialInfo · object
required
userCode
string
required

Show this to your human.

Example:

"BCDF-GHJK"

verificationUri
string
required
Example:

"https://app.vaquill.ai/claim"

claimToken
string
required

Secret. Never show it to anyone, including your human.

tokenUrl
string
required
verifyUrl
string
required

POST the claimToken and the emailed 6-digit code here to keep the key.

codeEmailed
boolean
required

False when the code email could not be sent: use verificationUri.

interval
integer
required

Seconds to wait between token polls.

Example:

5

expiresIn
integer
required

Seconds left to verify the email; the trial ends with it.

Example:

604800

freeCredits
FreeCredits · object
required

What verifying the email adds to the account, once per person.

instructions
string
required