Multimodal Input Conversational

POST

api

content

curl --request POST \
  --url https://api.worqhat.com/api/ai/content/v4 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "question": "hiii there",
  "model": "aicon-v4-nano-160824",
  "randomness": 0.5,
  "stream_data": false,
  "training_data": "You are alex and you are one of the best Tour Guides. answer everything while starting with your name",
  "response_type": "text",
  "conversation_id": "conv_1724236791746",
  "preserve_history": true,
  "conversation_history": [
    "What is the capital of India?: New Delhi",
    "What is the capital of USA?: Washington DC"
  ]
}'

{
  "Text Output": {
    "value": {
      "content": "Hi there!  My name is Alex, and I'm happy to help you with anything you need for your tour.  What can I do for you today?",
      "processingTime": 3105.397454,
      "processingId": "8aa97481-20f9-48f4-a12d-d02eb6c1d62a",
      "processing_count": 84,
      "conversation_id": "conv_1724236791746",
      "model": "aicon-v4-nano-160824"
    }
  },
  "JSON Structured Output": {
    "value": {
      "content": "{\"response\": \"Hi there!  My name is Alex, and I'm delighted to assist you with your travel needs. What can I help you with today\"}",
      "processingTime": 2946.176112,
      "processingId": "5944ab45-8bd7-4151-853d-da6cf315d617",
      "processing_count": 90,
      "conversation_id": "conv_1724237541817",
      "model": "aicon-v4-nano-160824"
    }
  },
  "Streaming Data": {
    "value": {
      "data": [
        {
          "content": "Hi",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278523,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": " there! My name is Alex, and I'm excited to be your tour",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278630,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": " guide today. What can I help you with? \n",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278708,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": "",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278712,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": "",
          "model": "aicon-v4-nano-160824",
          "finishReason": "stop",
          "timestamp": 1724240278716,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193",
          "wordCount": 77
        }
      ]
    }
  }
}

Generate from Multimodal Inputs

WorqHat AiCon V4 API allows you to generate text using multimodal inputs. You can choose from several models, each with its own strengths:

aicon-v4-nano-160824 (finetuned included): Ideal for quick and efficient text generation, especially when resources are limited.
aicon-v4-large-160824 (finetuned included): Our smartest and highest accuracy model, suitable for a wide range of text generation tasks, complex thought and reasoning along with mathematical solutions.
aicon-v4-alpha-160824: A better version of the aion-v4-nano-160824 model which is trained on live data, providing up-to-date insights and knowledge. It’s ideal for tasks that require real-time information, such as news analysis, market research, or staying informed on current events

Choose Your Response Style:

You have the option to either stream the response (stream_data = true) or wait for the entire result to be generated (stream_data = false).

Benefit: Faster interactions. You receive partial results as they are generated, allowing you to start working with the text immediately.

Example:

var files = document.querySelector('input[type="file"]').files;
var myHeaders = new Headers();
myHeaders.append('Authorization', 'Bearer sk-02e44************');

var formdata = new FormData();
formdata.append('question', 'what are the images about');
formdata.append(
  'training_data',
  'You are alex and you are one of the best Tour Guides. answer everything while starting with your name'
);

for (const file of files) {
  formdata.append('files', file);
}

formdata.append('model', 'aicon-v4-nano-160824');
formdata.append('stream_data', 'true');

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow',
};

fetch('https://api.worqhat.com/api/ai/content/v4', requestOptions)
  .then(response => response.text())
  .then(result => {
      console.log(result);
      alert('Response received: ' + result);
  })
  .catch(error => {
      console.log('error', error);
      alert('Error: ' + error);
  });

Benefit: Faster interactions. You receive partial results as they are generated, allowing you to start working with the text immediately.

Example:

var files = document.querySelector('input[type="file"]').files;
var myHeaders = new Headers();
myHeaders.append('Authorization', 'Bearer sk-02e44************');

var formdata = new FormData();
formdata.append('question', 'what are the images about');
formdata.append(
  'training_data',
  'You are alex and you are one of the best Tour Guides. answer everything while starting with your name'
);

for (const file of files) {
  formdata.append('files', file);
}

formdata.append('model', 'aicon-v4-nano-160824');
formdata.append('stream_data', 'true');

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: formdata,
  redirect: 'follow',
};

fetch('https://api.worqhat.com/api/ai/content/v4', requestOptions)
  .then(response => response.text())
  .then(result => {
      console.log(result);
      alert('Response received: ' + result);
  })
  .catch(error => {
      console.log('error', error);
      alert('Error: ' + error);
  });

Benefit: You receive the complete generated text in one go. Suitable for situations where you want to handle output generated

Example:

  var files = document.querySelector('input[type="file"]').files;
  var myHeaders = new Headers();
  myHeaders.append('Authorization', 'Bearer sk-02e44************');

  var formdata = new FormData();
  formdata.append('question', 'what are the images about');
  formdata.append(
    'training_data',
    'You are alex and you are one of the best Tour Guides. answer everything while starting with your name'
  );

  for (const file of files) {
    formdata.append('files', file);
  }

  formdata.append('model', 'aicon-v4-nano-160824');
  formdata.append('stream_data', 'false');

  var requestOptions = {
    method: 'POST',
    headers: myHeaders,
    body: formdata,
    redirect: 'follow',
  };

  fetch('https://api.worqhat.com/api/ai/content/v4', requestOptions)
    .then(response => response.text())
    .then(result => {
        console.log(result);
        alert('Response received: ' + result);
    })
    .catch(error => {
        console.log('error', error);
        alert('Error: ' + error);
    });
});

Key Points:

Replace YOUR_API_KEY with your actual WorqHat AiCon V4 API key.
Adjust the model parameter to select the desired model.
Modify the prompt to provide your text input.

Try out other Capabilities of the WorqHat API

Build Multiturn Conversations or Chat Applications by having the model maintain history by default Text Only Conversational
Fetch real world information and data using the Alpha Models Alpha Models(Text Only)

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

question

string

required

The message or question you want to pass to the model.

model

enum<string>

required

ID of the model to use. See the model endpoint compatibility table for details on which models work and are currently supported.

Available options:

aicon-v4-nano-160824,

aicon-v4-large-160824,

aicon-v4-alpha-160824

randomness

number

default:0.5

What model prediction randomness to use, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

stream_data

boolean

default:false

If set, partial message deltas will be sent as data-only server-sent events, with the stream terminated by a data [DONE] message.

training_data

string

default:You are alex and you are one of the best Tour Guides. answer everything while starting with your name.

You can pass any sort of training data or system messages that you want the model to follow when answering your questions.

response_type

string

default:text

Specifies the format that the model must output.

conversation_id

string

default:conv_1724236791746

Used as per requirement.

preserve_history

boolean

default:true

Set to true to maintain conversation history.

conversation_history

object[]

Response

200

application/json

Text generated successfully

content

string

The response output of the processing.

processing_time

number

The amount of time in miliseconds it took to complete the request.

processing_id

string

A unique identifier for the server process. This helps us track support requests and complaints.

processing_count

integer

Usage statistics for the request. This is what is used for the billing.

conversation_id

string

A unique identifier for the Message. You can use this conversation id later when building multiturn chat applications. This conversation id is what keeps a track of your past conversation. You can use this to keep continuing your requests one after the other without the hassle of maintaining the conversation history on your own.

model

string

The model used for the process.

Was this page helpful?

Alpha Model (Text Only)

curl --request POST \
  --url https://api.worqhat.com/api/ai/content/v4 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "question": "hiii there",
  "model": "aicon-v4-nano-160824",
  "randomness": 0.5,
  "stream_data": false,
  "training_data": "You are alex and you are one of the best Tour Guides. answer everything while starting with your name",
  "response_type": "text",
  "conversation_id": "conv_1724236791746",
  "preserve_history": true,
  "conversation_history": [
    "What is the capital of India?: New Delhi",
    "What is the capital of USA?: Washington DC"
  ]
}'

{
  "Text Output": {
    "value": {
      "content": "Hi there!  My name is Alex, and I'm happy to help you with anything you need for your tour.  What can I do for you today?",
      "processingTime": 3105.397454,
      "processingId": "8aa97481-20f9-48f4-a12d-d02eb6c1d62a",
      "processing_count": 84,
      "conversation_id": "conv_1724236791746",
      "model": "aicon-v4-nano-160824"
    }
  },
  "JSON Structured Output": {
    "value": {
      "content": "{\"response\": \"Hi there!  My name is Alex, and I'm delighted to assist you with your travel needs. What can I help you with today\"}",
      "processingTime": 2946.176112,
      "processingId": "5944ab45-8bd7-4151-853d-da6cf315d617",
      "processing_count": 90,
      "conversation_id": "conv_1724237541817",
      "model": "aicon-v4-nano-160824"
    }
  },
  "Streaming Data": {
    "value": {
      "data": [
        {
          "content": "Hi",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278523,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": " there! My name is Alex, and I'm excited to be your tour",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278630,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": " guide today. What can I help you with? \n",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278708,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": "",
          "model": "aicon-v4-nano-160824",
          "timestamp": 1724240278712,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193"
        },
        {
          "content": "",
          "model": "aicon-v4-nano-160824",
          "finishReason": "stop",
          "timestamp": 1724240278716,
          "processing_id": "bc4cc3b9-d000-4866-83ad-ad71abf10c8f",
          "conversation_id": "conv_1724240276193",
          "wordCount": 77
        }
      ]
    }
  }
}

Introduction

AI Models

Workflows

Authorization check

Server Status

Policies

Authorizations

Body

Response