Docs/API reference

Setup

Check that an API key works. Built for AI assistants, which call it first to confirm their connection.

post /setup/ping Confirm your AI assistant is connected

Confirm your AI assistant is connected

post https://api.emailchaser.com/r/setup/ping
Works with a read-only key

Called by the customer's AI assistant as its first request, to confirm the API key works. Records which assistant connected and when on the key itself, and completes the "Set up with AI" onboarding task for the key's workspace. Idempotent: repeat pings simply refresh the recorded assistant and timestamp. The optional agent field is the assistant's name in any form; it is normalized to a short lowercase identifier (e.g. chatgpt, claude, grok, gemini, copilot) and echoed back.

Request bodyJSON · SetupPingRequest

  • agent string

    Agent is the assistant's self-reported name, in any form; the backend normalizes it to a short lowercase identifier.

Responses

Fields in the 200 response
  • agent string
  • ok boolean

Request

curl -X POST "https://api.emailchaser.com/r/setup/ping" \
  -H "Authorization: Bearer $EMAILCHASER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "agent": "string"
}'

Response

{
  "agent": "string",
  "ok": true
}

Generated from the Emailchaser API's own OpenAPI definition, so it always matches the running API.