API referenceCustomers
Health check
Smoke-test endpoint. Returns the project and livemode pair behind the Bearer key, useful for verifying that auth works without touching any resource.
Authorization
AuthorizationRequiredBearer <token>Send your API key in the Authorization header on every request:
Authorization: Bearer sk_live_.... Keys are created in the admin UI under
Settings → API Keys and are project-scoped.
In: header
Response Body
OK
TypeScript Definitions
Use the response body type in TypeScript.
objectRequiredstringValue in:
"ping"project_idRequiredintegerproject_namestringlivemodeRequiredbooleanrequest_idRequiredstringMissing or invalid API key.
TypeScript Definitions
Use the response body type in TypeScript.
errorRequiredobjectcurl -X GET "https://app.meetdolores.ai/v1/ping" \
-H "Authorization: Bearer <token>"fetch("https://app.meetdolores.ai/v1/ping", {
headers: {
"Authorization": "Bearer <token>"
}
})package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://app.meetdolores.ai/v1/ping"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}import requests
url = "https://app.meetdolores.ai/v1/ping"
response = requests.request("GET", url, headers = {
"Authorization": "Bearer <token>"
})
print(response.text)require 'net/http'
require 'json'
require 'uri'
uri = URI('https://app.meetdolores.ai/v1/ping')
req = Net::HTTP::Get.new(uri, {
'Authorization' => "Bearer #{ENV['DOLORES_API_KEY']}",
})
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.body<?php
$ch = curl_init('https://app.meetdolores.ai/v1/ping');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('DOLORES_API_KEY'),
],
]);
echo curl_exec($ch);{
"object": "ping",
"project_id": 42,
"project_name": "Acme Production",
"livemode": false,
"request_id": "req_01HXY7P3K9ABCDEFGHJKMNPQRS"
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "API key is invalid or has been revoked.",
"request_id": "req_01HXY7P3K9ABCDEFGHJKMNPQRS"
}
}