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

# Create surface API key

POST https://api.runtype.com/v1/products/{id}/surfaces/{surfaceId}/keys
Content-Type: application/json

Create a new API key for a surface. The plaintext key is only returned on creation.

Reference: https://docs.runtype.com/api-reference/runtype-api/products/create-surface-api-key

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Path parameters

- `id` (string, required)
- `surfaceId` (string, required)

### Body (application/json)

This endpoint expects an object.

- `environment` (enum, optional, default: test)
  - Allowed values: `test`, `production`
- `expiresAt` (datetime, optional)
- `name` (string, optional)
- `rateLimitPerDay` (integer, optional)
- `rateLimitPerMinute` (integer, optional)
- `scopes` (list of string, optional) — Capability restrictions. Prefer IDs from get_surface.scopeTargets; linked surface-item/capability IDs and unique names shown in that catalog are accepted and resolved to immutable authorization targets. Use `*` for unrestricted access.

## Response

### 201

Surface key created

- `createdAt` (string, required)
- `environment` (string, required)
- `expiresAt` (string, required, nullable)
- `id` (string, required)
- `isActive` (boolean, required)
- `key` (string, required)
- `keyHint` (string, required, nullable)
- `keyPrefix` (string, required)
- `name` (string, required, nullable)
- `rateLimitPerDay` (integer, required, nullable)
- `rateLimitPerMinute` (integer, required, nullable)
- `scopeTargetIds` (list of string, required)
- `scopes` (list of string, required)
- `surfaceId` (string, required)

## Errors

### 400 Bad Request Error

Validation error or chat surface

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Product or surface not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

## Examples

**Request**

```json
{
  "name": "Production Key",
  "rateLimitPerDay": 5000,
  "rateLimitPerMinute": 60,
  "scopes": [
    "surfitem_01jexampleanswer",
    "surfitem_01jexampleticket"
  ]
}
```

**Response**

```json
{
  "createdAt": "string",
  "environment": "string",
  "expiresAt": "string",
  "id": "string",
  "isActive": true,
  "key": "string",
  "keyHint": "string",
  "keyPrefix": "string",
  "name": "string",
  "rateLimitPerDay": 1,
  "rateLimitPerMinute": 1,
  "scopeTargetIds": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "surfaceId": "string"
}
```

**SDK Code**

```python Create Surface API Key
import requests

url = "https://api.runtype.com/v1/products/id/surfaces/surfaceId/keys"

payload = {
    "name": "Production Key",
    "rateLimitPerDay": 5000,
    "rateLimitPerMinute": 60,
    "scopes": ["surfitem_01jexampleanswer", "surfitem_01jexampleticket"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Create Surface API Key
const url = 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/keys';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Production Key","rateLimitPerDay":5000,"rateLimitPerMinute":60,"scopes":["surfitem_01jexampleanswer","surfitem_01jexampleticket"]}'
};

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

```go Create Surface API Key
package main

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

func main() {

	url := "https://api.runtype.com/v1/products/id/surfaces/surfaceId/keys"

	payload := strings.NewReader("{\n  \"name\": \"Production Key\",\n  \"rateLimitPerDay\": 5000,\n  \"rateLimitPerMinute\": 60,\n  \"scopes\": [\n    \"surfitem_01jexampleanswer\",\n    \"surfitem_01jexampleticket\"\n  ]\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 Create Surface API Key
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/products/id/surfaces/surfaceId/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 Key\",\n  \"rateLimitPerDay\": 5000,\n  \"rateLimitPerMinute\": 60,\n  \"scopes\": [\n    \"surfitem_01jexampleanswer\",\n    \"surfitem_01jexampleticket\"\n  ]\n}"

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

```java Create Surface API Key
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/products/id/surfaces/surfaceId/keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Production Key\",\n  \"rateLimitPerDay\": 5000,\n  \"rateLimitPerMinute\": 60,\n  \"scopes\": [\n    \"surfitem_01jexampleanswer\",\n    \"surfitem_01jexampleticket\"\n  ]\n}")
  .asString();
```

```php Create Surface API Key
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/products/id/surfaces/surfaceId/keys', [
  'body' => '{
  "name": "Production Key",
  "rateLimitPerDay": 5000,
  "rateLimitPerMinute": 60,
  "scopes": [
    "surfitem_01jexampleanswer",
    "surfitem_01jexampleticket"
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Create Surface API Key
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/products/id/surfaces/surfaceId/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 Key\",\n  \"rateLimitPerDay\": 5000,\n  \"rateLimitPerMinute\": 60,\n  \"scopes\": [\n    \"surfitem_01jexampleanswer\",\n    \"surfitem_01jexampleticket\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Create Surface API Key
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Production Key",
  "rateLimitPerDay": 5000,
  "rateLimitPerMinute": 60,
  "scopes": ["surfitem_01jexampleanswer", "surfitem_01jexampleticket"]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/products/id/surfaces/surfaceId/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()
```