Get a message

GET

/v2/health-navigator/messages/{messageId}

curl --request GET \
  --url https://client-api.abi.ai/v2/health-navigator/messages/01K9F5PWBM2AFT1RG7TMN3YG1R \
  --header 'Authorization: Bearer <token>'

• Abi Client API

Authorizations

• bearerAuth

Parameters

Path Parameters

messageId

required

string

Health Navigator message identifier.

Example

01K9F5PWBM2AFT1RG7TMN3YG1R

Responses

200

Health Navigator message returned.

Media typeapplication/json

object

messageId

ULID message identifier.

string

conversationId

Conversation identifier.

string

role

Sender role.

string

Allowed values: user assistant

content

Message content composed of ordered parts.

object

type

string

parts

Ordered text, actionable, resource, image, location, audio, video, or file parts.

Array

One of:

object

A text message part.

object

type

string

Allowed value: text

text

Text to display.

string

object

An actionable part. The wire format uses type: action.

object

type

string

Allowed value: action

action

An Actionable suggested by Health Navigator or supplied by the user.

object

type

Actionable category.

string

Allowed values: abi_service client_service action

name

Configured actionable identifier.

string

source

Role that supplied the actionable.

string

Allowed values: user assistant

domain

Configured actionable domain.

string

Allowed values: medical general_support user

referenceUrl

Optional URL for additional context or redirection.

string format: uri

label

Optional call-to-action label for client rendering.

string

payload

Optional data for the client workflow.

object

key

additional properties

any

postEffects

Optional effects to apply after the actionable is handled.

Array<object>

object

type

string

args

object

key

additional properties

any

object

A supporting information resource.

object

type

string

Allowed value: resource

resource

Supporting information associated with a message.

object

title

Resource title.

string

url

URL where the resource can be accessed.

string format: uri

description

Optional resource description or preview.

string

object

An image part.

object

type

string

Allowed value: image

url

string format: uri

caption

string

mimeType

string

object

A location part.

object

type

string

Allowed value: location

location

object

name

string

placeId

string

address

string

latitude

number

longitude

number

object

An audio part.

object

type

string

Allowed value: audio

url

string format: uri

duration

number

mimeType

string

object

A video part.

object

type

string

Allowed value: video

url

string format: uri

duration

number

mimeType

string

object

A downloadable file part.

object

type

string

Allowed value: file

url

string format: uri

name

string

mimeType

string

sizeBytes

integer

parentMessageId

Parent message identifier for a threaded reply.

string

createdAt

string format: date-time

updatedAt

string format: date-time

protocolVersion

string

Example

{
  "messageId": "01K9F5PWBM2AFT1RG7TMN3YG1R",
  "conversationId": "01HK8GGQ123456789ABCDEFGHI",
  "role": "assistant",
  "content": {
    "type": "message",
    "parts": [
      {
        "type": "text",
        "text": "I am sorry you are feeling unwell. Here are some next steps to consider."
      },
      {
        "type": "action",
        "action": {
          "type": "client_service",
          "name": "book_consultation",
          "source": "assistant",
          "domain": "medical",
          "label": "Book a consultation"
        }
      }
    ]
  },
  "createdAt": "2025-08-28T10:13:04.000Z",
  "protocolVersion": "1.0.0"
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}