API keys

Create an API key

Creates a new API key. The secret key is returned only once in this response, so store it securely.

post/v1/keys

Request

Base URL
https://api.metal.ai
Auth
API key in header x-metal-client-id and API key in header x-metal-api-key
TypeScript
https://skmtc.dev/metal/apis/metal-api/docs/v1/keys/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

A descriptive name for the key.

Example request

{
  "name": "Data sync (production)"
}

Response

The created API key, including the one-time secret.

Example response

{
  "data": {
    "name": "Production sync",
    "key": "pk_your_api_key_here",
    "keyLastFour": "here",
    "clientId": "ci_your_client_id_here"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.