Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface CreateAsyncConsultResponse

    POST /v1/async-consults response.

    With consent: 'collected' the consult is already queued or active (assignment is attempted synchronously). With consent: 'embed' it is invited and sessionToken is present — render <natzar-async session-token="…"> to let the patient consent and chat.

    interface CreateAsyncConsultResponse {
        consult: AsyncConsultResource;
        sessionToken?: string;
        graphqlUrl?: string;
        publicApiKey?: string;
    }
    Index
    consult sessionToken? graphqlUrl? publicApiKey?
    consult: AsyncConsultResource

    The consult after creation (status reflects the consent mode).

    sessionToken?: string

    Embed session token for the patient widget. Present when consent: 'embed'; mint later/again via POST /v1/async-consults/{id}/embed-session.

    graphqlUrl?: string

    Present alongside sessionToken, for the same reason it is on the /embed-session mints: hand this whole response to the browser half of @natzar/client and it is self-configuring. See CreateEmbedSessionResponse.graphqlUrl.

    publicApiKey?: string

    Public transport key for the patient surface. Rotates; never bake it in.

    Settings
    Member Visibility

    On This Page
    Properties