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
      • POSTValidate Slack bot token (deprecated)
      • POSTValidate Telegram bot token (deprecated)
      • POSTValidate channel credentials
      • POSTSend echo message
Dashboard
LogoLogo
Runtype APIMessaging Validations

Send echo message

POST
/v1/messaging/validations/:channelType/echo
POST
/v1/messaging/validations/:channelType/echo
$curl -X POST https://api.runtype.com/v1/messaging/validations/channelType/echo \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "recipient": "+14155552671"
>}'
1{
2  "valid": true,
3  "error": "",
4  "metadata": {}
5}
Send a test "Hello from Runtype" message via the configured channel adapter.
Was this page helpful?
Previous

List model configurations

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

channelTypestringRequired

Request

This endpoint expects an object.
recipientstringRequired>=1 character
credentialsmap from strings to anyOptional

Response

Echo result
validboolean
errorstring
metadatamap from strings to any

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
501
Not Implemented Error