Create API key

Mints a key and returns it in full, once. raw is never retrievable again, so store it when you receive it. A key authenticated with an API key cannot grant scopes it does not itself hold.

POST/api-key

AuthAPI keyorOAuth tokenHow to send it

Request body#

scopesstring[]: default ["generate"]≥ 1 items
namestring: ≥ 1 characters≤ 256 characters

Response#

201API key created

dataobjectrequired

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.

Request

curl -X POST https://api.mynth.io/api-key \
  -H "Authorization: Bearer $MYNTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

{
  "data": {
    "apiKey": {
      "id": "string",
      "keyPreview": "string",
      "scopes": [
        "generate"
      ],
      "spendingLimitPeriod": "day",
      "userId": "string",
      "name": "string",
      "spendingLimit": "string"
    },
    "raw": "string"
  }
}