Create API key

POST

account

api-keys

Create API key

curl --request POST \
  --url https://api.darwin.so/api/v2/account/api-keys \
  --header 'Content-Type: application/json' \
  --cookie __Secure-better-auth.session_token= \
  --data '
{
  "applicationId": "<string>",
  "name": "Production server"
}
'

import requests

url = "https://api.darwin.so/api/v2/account/api-keys"

payload = {
    "applicationId": "<string>",
    "name": "Production server"
}
headers = {
    "cookie": "__Secure-better-auth.session_token=",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    cookie: '__Secure-better-auth.session_token=',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({applicationId: '<string>', name: 'Production server'})
};

fetch('https://api.darwin.so/api/v2/account/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.darwin.so/api/v2/account/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'applicationId' => '<string>',
    'name' => 'Production server'
  ]),
  CURLOPT_COOKIE => "__Secure-better-auth.session_token=",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.darwin.so/api/v2/account/api-keys"

	payload := strings.NewReader("{\n  \"applicationId\": \"<string>\",\n  \"name\": \"Production server\"\n}")

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

	req.Header.Add("cookie", "__Secure-better-auth.session_token=")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.darwin.so/api/v2/account/api-keys")
  .header("cookie", "__Secure-better-auth.session_token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicationId\": \"<string>\",\n  \"name\": \"Production server\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v2/account/api-keys")

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

request = Net::HTTP::Post.new(url)
request["cookie"] = '__Secure-better-auth.session_token='
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicationId\": \"<string>\",\n  \"name\": \"Production server\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "requestCount": 1,
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "apiKey": "<string>",
  "kind": "application",
  "applicationId": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

The response shows the plaintext key once. It identifies your application and can Search public capabilities. To Act for a person, use their scoped OAuth grant. Existing user-bound keys remain valid until revoked.

Use Me → Developer to register an application and create its Search key without opening a settings modal. You can also register an application through the API with the same verified account session, then call this endpoint while that session is active.

Authorizations

__Secure-better-auth.session_token

string

required

The HTTP-only Darwin account session cookie set after sign-in. Local development uses better-auth.session_token without the __Secure- prefix.

Body

application/json

applicationId

string

required

An active application owned by the signed-in account.

Required string length: 1 - 200

name

string

required

A recognizable name for the environment or integration that will use this key.

Required string length: 1 - 120

Example:

"Production server"

scopes

enum<string>[]

Optional. New application keys are limited to directory:read; use OAuth for user-scoped Act.

Required array length: 1 element

Available options:

directory:read

Example:

["directory:read"]

expiresAt

string<date-time> | null

Optional future ISO 8601 expiration. Omit or set null for no scheduled expiration.

Example:

"2027-09-21T00:00:00.000Z"

Response

The API key was created. Store apiKey securely because Darwin will not return it again.

string

required

Stable non-secret identifier for the API key.

name

string

required

Human-readable key name supplied at creation.

prefix

string

required

Non-secret prefix you can use to identify the key in logs and settings.

scopes

string[]

required

Permissions granted to the key. Every API operation still enforces its required scope.

requestCount

integer

required

Lifetime number of requests authenticated with this key.

Required range: x >= 0

lastUsedAt

string<date-time> | null

required

When Darwin most recently authenticated a request with this key, or null if unused.

expiresAt

string<date-time> | null

required

When the key expires, or null when it has no scheduled expiration.

revokedAt

string<date-time> | null

required

When the key was revoked, or null while it has not been revoked.

createdAt

string<date-time>

required

When the key was created.

apiKey

string

required

read-only

Plaintext API key. Darwin returns this value only in the create response.

kind

enum<string>

New keys identify an application; legacy keys retain their previous user-bound behavior until revoked.

Available options:

application,

legacy_user

applicationId

string | null

The application identified by a new key, or null for a legacy user key.

Last modified on September 29, 2026

Create API key

curl --request POST \
  --url https://api.darwin.so/api/v2/account/api-keys \
  --header 'Content-Type: application/json' \
  --cookie __Secure-better-auth.session_token= \
  --data '
{
  "applicationId": "<string>",
  "name": "Production server"
}
'

import requests

url = "https://api.darwin.so/api/v2/account/api-keys"

payload = {
    "applicationId": "<string>",
    "name": "Production server"
}
headers = {
    "cookie": "__Secure-better-auth.session_token=",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    cookie: '__Secure-better-auth.session_token=',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({applicationId: '<string>', name: 'Production server'})
};

fetch('https://api.darwin.so/api/v2/account/api-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.darwin.so/api/v2/account/api-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'applicationId' => '<string>',
    'name' => 'Production server'
  ]),
  CURLOPT_COOKIE => "__Secure-better-auth.session_token=",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.darwin.so/api/v2/account/api-keys"

	payload := strings.NewReader("{\n  \"applicationId\": \"<string>\",\n  \"name\": \"Production server\"\n}")

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

	req.Header.Add("cookie", "__Secure-better-auth.session_token=")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.darwin.so/api/v2/account/api-keys")
  .header("cookie", "__Secure-better-auth.session_token=")
  .header("Content-Type", "application/json")
  .body("{\n  \"applicationId\": \"<string>\",\n  \"name\": \"Production server\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v2/account/api-keys")

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

request = Net::HTTP::Post.new(url)
request["cookie"] = '__Secure-better-auth.session_token='
request["Content-Type"] = 'application/json'
request.body = "{\n  \"applicationId\": \"<string>\",\n  \"name\": \"Production server\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "requestCount": 1,
  "lastUsedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "revokedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "apiKey": "<string>",
  "kind": "application",
  "applicationId": "<string>"
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "fields": [
    {}
  ],
  "code": "<string>",
  "retryAfterSeconds": 1,
  "authenticationRequest": {
    "authenticationRequestId": "<string>",
    "actingAiId": "<string>",
    "targetAiId": "<string>",
    "purpose": "discovery",
    "expiresAt": "2023-11-07T05:31:56Z"
  },
  "targetAgent": "<string>",
  "agent": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "capabilities": [
    {
      "capability": "<string>",
      "title": "<string>",
      "inputSchema": {},
      "effect": "external_effect",
      "pricing": "unknown",
      "requiresConfirmation": true
    }
  ]
}