POST /v1/nomis/:id/chat

The POST /v1/nomis/:id/chat endpoint allows you to send a message in the main chat for this Nomi and get a reply.

HTTP Method

POST

URL

https://api.nomi.ai/v1/nomis/:id/chat

URL Parameters

{
  id: UUID;
}

Request Body Format

{
  messageText: string;
}

Response Body Format

{
  sentMessage: {
    uuid: UUID;
    text: string;
    sent: ISODateString;
  };
  replyMessage: {
    uuid: UUID;
    text: string;
    sent: ISODateString;
  };
}

Error Response Types

Type	Description
NomiNotFound	The specified Nomi was not found. It may not exist or may not be associated with this account.
InvalidRouteParams	The id parameter is not a valid UUID.
InvalidContentType	The Content-Type header is not application/json.
NoReply	The Nomi did not reply to the message. This is rare but will occur if there is a server issue or if the Nomi does not respond within 30 seconds.
NomiStillResponding	The Nomi is already replying a user message (either made through the UI or a different API call) and so cannot reply to this message.
NomiNotReady	Immediately after the creation of a Nomi, there is a short period of several seconds before it is possible to send messages.
OngoingVoiceCallDetected	The Nomi is currently in a voice call and cannot respond to messages.
MessageLengthLimitExceeded	The provided messageText is too long. Maximum message length is 400 for free accounts and 800 for users with a subscription.
LimitExceeded	Cannot send the message because the user has exhausted their daily message quota.
InvalidBody	Issue will be detailed in the errors.issues key, but there is an issue with the request body. This can happen if the messageText key is missing, the wrong type, or an empty string.