Skip to main content
POST /api/hosted-links/ Required headers:
  • Authorization: Bearer <YOUR_AKAPULU_API_KEY>
  • Content-Type: application/json
The body is exactly these four fields:
  • label — string, at most 255 characters after trim (may be empty)
  • avatar_id — UUID of an avatar you own or a public catalog avatar
  • system_prompt — non-empty string after trim
  • show_ai_label — boolean JSON (true / false, not a string)
Status is 200. Share url. Anyone with that URL can open the page and start a call. The page never sees your API key. An unknown or private avatar you do not own is 404 AVATAR_NOT_FOUND. Extra body fields are 400 VALIDATION. On failure the body includes error and error_code. See Error responses.