> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.kuudo.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.kuudo.com/_mcp/server.

# Create API key

POST https://app.kuudo.com/api/developers/api-keys
Content-Type: application/json

Issues an API key for an active M2M client in the caller's organization and returns HTTP 201. The apiToken is shown only once; store it securely. The key carries its M2M client's scopes, and its sk_live_ or sk_test_ prefix follows the client's environment. A bearer caller may issue a key only for its own authenticated M2M client (403 PERMISSION_DENIED for another client, even when its scopes fit). The bearer must also hold every scope of that client (403 PERMISSION_DENIED with details.exceedingScopes otherwise). An unknown or other-organization client returns 404, and an inactive client 400. The organization's API key plan limit applies (403).

Requires every scope: `api-keys:write`.

Reference: https://docs.kuudo.com/api-reference/developer-credentials/create-api-key

## Authentication

- `Authorization` header (bearer token, required) — JWT returned by POST /api/auth/token-exchange. Amazon, authorization invitations, and developer credentials require API-key-derived tokens.

## Request

### Body (application/json)

This endpoint expects an ApiKeyCreate.

- `name` (string, required)
- `m2mClientId` (integer, required) — Numeric M2M client ID in the caller's organization.
- `description` (string, optional)
- `expiresInDays` (integer, optional) — Days until the key expires. Omit for a key that never expires.

## Response

### 201

Created. apiToken is returned only in this response.

- `apiKey` (ApiKeyCreated, required)

## Errors

### 400 Bad Request Error

Invalid request or unsupported resource state.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 401 Unauthorized Error

Missing or invalid credentials, or inactive machine principal.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 403 Forbidden Error

Insufficient scope, authorization policy, or entitlement.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 404 Not Found Error

Resource not found or not visible to this principal.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 500 Internal Server Error

Internal error.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

### 503 Service Unavailable Error

Dependency unavailable or application maintenance.

- `error` (ErrorError, required)
- `code` (string, optional)
- `details` (any, optional) — Endpoint-specific validation or failure details; shape varies.
- `requiredScopes` (list of string, optional)
- `errorCode` (string, optional)
- `message` (string, optional)
- `remediation` (string, optional)

## Types

### ApiKeyCreated

- `id` (integer, required)
- `name` (string, required)
- `description` (string, required, nullable)
- `apiKeyPrefix` (string, required)
- `apiToken` (string, required) — Long-lived sk_live_* or sk_test_* key, shown only once. Treat as a secret; exchange it at POST /api/auth/token-exchange.
- `m2mClient` (ApiKeyM2MClient, required)
- `expiresAt` (datetime, required, nullable)
- `createdAt` (datetime, required)
- `warning` (string, required)

### ErrorError

- string
- ErrorError1

### ApiKeyM2MClient

- `clientId` (string, required)
- `name` (string, required)
- `scopes` (list of string, required)
- `environment` (enum, required)
  - Allowed values: `production`, `development`
- `status` (string, required)

### ErrorError1

- `code` (string, required)
- `message` (string, required)

## Examples

**Request**

```json
{
  "name": "Production sync key",
  "m2mClientId": 42,
  "description": "Used by the nightly sync worker",
  "expiresInDays": 90
}
```

**Response**

```json
{
  "apiKey": {
    "id": 1,
    "name": "string",
    "description": "string",
    "apiKeyPrefix": "string",
    "apiToken": "string",
    "m2mClient": {
      "clientId": "string",
      "name": "string",
      "scopes": [
        "string"
      ],
      "environment": "production",
      "status": "string"
    },
    "expiresAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "warning": "string"
  }
}
```

**SDK Code**

```python Developer credentials_createApiKey_example
import requests

url = "https://app.kuudo.com/api/developers/api-keys"

payload = {
    "name": "Production sync key",
    "m2mClientId": 42,
    "description": "Used by the nightly sync worker",
    "expiresInDays": 90
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Developer credentials_createApiKey_example
const url = 'https://app.kuudo.com/api/developers/api-keys';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Production sync key","m2mClientId":42,"description":"Used by the nightly sync worker","expiresInDays":90}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Developer credentials_createApiKey_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.kuudo.com/api/developers/api-keys"

	payload := strings.NewReader("{\n  \"name\": \"Production sync key\",\n  \"m2mClientId\": 42,\n  \"description\": \"Used by the nightly sync worker\",\n  \"expiresInDays\": 90\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Developer credentials_createApiKey_example
require 'uri'
require 'net/http'

url = URI("https://app.kuudo.com/api/developers/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Production sync key\",\n  \"m2mClientId\": 42,\n  \"description\": \"Used by the nightly sync worker\",\n  \"expiresInDays\": 90\n}"

response = http.request(request)
puts response.read_body
```

```java Developer credentials_createApiKey_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.kuudo.com/api/developers/api-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Production sync key\",\n  \"m2mClientId\": 42,\n  \"description\": \"Used by the nightly sync worker\",\n  \"expiresInDays\": 90\n}")
  .asString();
```

```php Developer credentials_createApiKey_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.kuudo.com/api/developers/api-keys', [
  'body' => '{
  "name": "Production sync key",
  "m2mClientId": 42,
  "description": "Used by the nightly sync worker",
  "expiresInDays": 90
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Developer credentials_createApiKey_example
using RestSharp;

var client = new RestClient("https://app.kuudo.com/api/developers/api-keys");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Production sync key\",\n  \"m2mClientId\": 42,\n  \"description\": \"Used by the nightly sync worker\",\n  \"expiresInDays\": 90\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Developer credentials_createApiKey_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Production sync key",
  "m2mClientId": 42,
  "description": "Used by the nightly sync worker",
  "expiresInDays": 90
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.kuudo.com/api/developers/api-keys")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```