Commet
  • Pricing
Log InTry out
Create API key POSTDelete API key DELETEList API keys GET
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Create API key

Create a new API key. The full key is only returned once in the response.

Update add-on PUT

Update an add-on's name, description, or pricing.

Delete API key DELETE

Permanently revoke and delete an API key.

POST
/api-keys

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string
Length1 <= length
expiresInDays?integer
0 < value
Range

Response Body

application/json

application/json

curl -X POST "https://commet.co/api/v1/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

application/json

application/json

Display name for the key

Days until expiration (default 365)

Create a new API key. The full key is only returned once in the response.

{
  "success": true,
  "data": {
    "object": "api_key",
    "livemode": true,
    "id": "string",
    "name": "string",
    "apiKey": "string",
    "prefix": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "createdAt"


{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
:
"2019-08-24T14:15:22Z"
}
}