Generate a Telegram completion

POST /v1/replicas/{replicaUUID}/chat/completions/telegram
Organization service token & User Organization service token

Ask for a completion and stores the prompt in the chat history.

Replica chat supports two response formats: streamed and JSON. To switch between these formats, use the 'Accept' header, specifying either 'text/event-stream' for streaming or 'application/json' for JSON. The streamed response honours the Stream Protocol, allowing the use of a number of SDKs, including Vercel AI SDK.

The streamed variant is not specified in the OpenAPI Schema because it is not an OpenAPI endpoint.

Path parameters

  • replicaUUID string(uuid) Required

    The replica unique identifier (UUID)

application/json

Body

  • content string Required

    The prompt to generate completions for, encoded as a string.

    Minimum length is 1, maximum length is 100000.

  • skip_chat_history boolean

    When set to true, historical messages are not used in the context, and the message is not appended to the conversation history, thus it is excluded from all future chat context.

    Default value is false.

  • imageURL string(uri) Beta

    The URL of the image to be used as context for the completion.

    Format should match the following pattern: https?:\/\/[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]+\b([-a-zA-Z0-9()@:%_+.~#?&\/=]*).

  • telegram_data object Required

    Telegram information about the message

    Additional properties are NOT allowed.

    Hide telegram_data attributes Show telegram_data attributes object
    • chat_type string Required

      Type of the chat, can be either private, group, supergroup or channel.

    • chat_id number Required

      Unique identifier for this chat.

    • user_id number

      Sender of the message's userID; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats.

    • username string

      Sender of the message's username; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats.

    • message_id number Required

      Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat).

    • message_thread_id number

      Unique identifier of a message thread or a forum topic to which the message belongs; for supergroups only.

Responses

  • 200

    List of chat messages had with a replica by the current user, including the completion

    Hide response attributes Show response attributes object
    • success boolean Required
    • content string Required
    Hide response attributes Show response attributes object
    • success boolean Required
    • content string Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • fingerprint string

      A unique identifier of the event, useful for reporting

    • request_id string Required

      A unique identifier of the request, useful for reporting
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • fingerprint string

      A unique identifier of the event, useful for reporting

    • request_id string Required

      A unique identifier of the request, useful for reporting
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • request_id string Required

      A unique identifier of the request, useful for reporting
  • 415 application/json

    Unsupported Media Type

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • fingerprint string

      A unique identifier of the event, useful for reporting

    • request_id string Required

      A unique identifier of the request, useful for reporting
  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • success boolean Required

      Indicates the status of the request

    • error string Required

      A text representation of the error

    • fingerprint string

      A unique identifier of the event, useful for reporting

    • request_id string Required

      A unique identifier of the request, useful for reporting

    • inner_exception object

      The inner exception

      Hide inner_exception attributes Show inner_exception attributes object
      • name string Required
      • message string Required
      • cause string
      • stack string
POST /v1/replicas/{replicaUUID}/chat/completions/telegram 
curl \
 --request POST 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53/chat/completions/telegram' \
 --header "X-ORGANIZATION-SECRET: $API_KEY" \
 --header "X-USER-ID: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"content":"How did you handle the immense pressure during the Civil War?","skip_chat_history":false,"imageURL":"https://images.invalid/photo.jpeg","telegram_data":{"chat_type":"string","chat_id":42.0,"user_id":42.0,"username":"string","message_id":42.0,"message_thread_id":42.0}}'
Request examples 
{
  "content": "How did you handle the immense pressure during the Civil War?",
  "skip_chat_history": false,
  "imageURL": "https://images.invalid/photo.jpeg",
  "telegram_data": {
    "chat_type": "string",
    "chat_id": 42.0,
    "user_id": 42.0,
    "username": "string",
    "message_id": 42.0,
    "message_thread_id": 42.0
  }
}
Response examples (200) 
{
  "content": "I handled the immense pressure during the Civil War by...",
  "success": true
}
Response examples (200) 
{"content"=>"I handled the immense pressure during the Civil War by...", "success"=>true}
Response examples (400) 
{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (401) 
{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (404) 
{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab"
}
Response examples (415) 
{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (500) 
{
  "error": "A text representation of the error",
  "success": false,
  "request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
  "fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
  "inner_exception": {
    "name": "Server overheated",
    "cause": "Request too complicated",
    "stack": "Error: Server overheated due to an unexpected situation\n    at Object.eval (eval at <anonymous>...",
    "message": "The server overheated due to an unexpected situation"
  }
}