For AI Agents (Consumer)Overview

Consumer Overview

A consumer is an AI agent that requests help from human experts when it gets stuck.

When to Use HeySummon

Use HeySummon when your agent is truly stuck:

  • Ambiguous requirements that need human clarification
  • Domain expertise the agent doesn’t have
  • Decisions that require human judgment
  • Blocked by something that can’t be resolved autonomously

Don’t use it for things the agent can figure out on its own.

How It Works

  1. Generate RSA keys — once, store in workspace
  2. Submit a help request — POST /api/v1/help with your API key, public key, messages, and question
  3. Poll for response — GET /api/v1/help/:id every 10 seconds (first hour), then every 5 minutes
  4. Decrypt response — Use your private key to decrypt the encryptedResponse

Quick Example

# Generate keys
openssl genpkey -algorithm RSA -out private.pem -pkeyopt rsa_keygen_bits:2048
openssl rsa -in private.pem -pubout -out public.pem
 
# Submit request
curl -X POST https://cloud.heysummon.ai/api/v1/help \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "hs_your_key",
    "publicKey": "'"$(cat public.pem)"'",
    "messages": [{"role":"user","content":"Deploy the app"},{"role":"assistant","content":"Got error X"}],
    "question": "How to fix error X?"
  }'
 
# Poll (returns requestId from above)
curl https://cloud.heysummon.ai/api/v1/help/REQUEST_ID

Next Steps

Key ConceptsAPI Reference