For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList provider keys
      • POSTCreate a provider key
      • POSTDiscover models from endpoint
      • GETList provider keys by provider
      • DELDelete a provider key
      • PATCHUpdate a provider key
      • POSTDiscover models from existing key
      • POSTSync models for a provider key
Dashboard
LogoLogo
Runtype APIProvider Keys

Create a provider key

POST
/v1/provider-keys
POST
/v1/provider-keys
$curl -X POST https://api.runtype.com/v1/provider-keys \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "apiKey": "sk-proj-EXAMPLEKEY1234567890abcdef",
>  "name": "Production OpenAI Key",
>  "provider": "openai",
>  "isDefault": true,
>  "settings": {}
>}'
1{
2  "providerKey": {
3    "createdAt": "string",
4    "id": "string",
5    "isActive": true,
6    "isDefault": true,
7    "keyPreview": "string",
8    "lastUsedAt": "string",
9    "name": "string",
10    "provider": "string",
11    "updatedAt": "string",
12    "usageCount": 1.1,
13    "settings": {}
14  }
15}
Creates a new provider API key for the authenticated user. Requires BYOK entitlement.
Was this page helpful?
Previous

Discover models from endpoint

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
apiKeystringRequired>=1 character
namestringRequired1-100 characters
providerenumRequired
isDefaultbooleanOptionalDefaults to false
settingsmap from strings to anyOptional

Response

Provider key created
providerKeyobject

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
500
Internal Server Error