COcounselhealth
/v1/user

Get a signed URL for a user to access the embedded iFrame or WebView app

The signed URL is valid for one-time use until the expiry time (default 7 days, but can be configured). If this API is called multiple times for the same user, the same URL is returned if it has not already been used. Idempotency-Key response replays are available for one day after the request completes. Replays are best-effort: keys may be lost before the one-day window elapses, in which case a retry is executed as a new request.

post/v1/user/{userId}/signedAppUrl/

Request

  • Base URL
    https://api.counselhealth.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

userIdstring required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Optional idempotency key. Repeat requests with the same key and body return the original result.

Request body

agent_contextobject

Example request

{
  "action": {
    "module": "get_care",
    "initial_messages": [
      {
        "body": "I am feeling sick today and need to speak to a doctor",
        "role": "patient"
      },
      {
        "body": "Let me route you to Counsel AI",
        "role": "model"
      }
    ],
    "metadata": {
      "external_session_id": "abc123",
      "plan": "pro",
      "linked_thread_title": "Lightheadedness when standing"
    }
  }
}

Response

Default Response

urlstring uri required
expirystring date-time required

datetime in ISO 8601 format

Example response

{
  "expiry": "2030-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.