Stream Message

POST/v0/copilots/streamMessageStream Message

Deprecated. Use the [v1 Agents API](/api-reference/v-1/api-reference/agents) instead: send a message with POST /v1/agents/sendMessage, then poll for the response with GET /v1/agents/fetchAgentResponse.

Previously, this endpoint streamed a response back as Server-Sent Events.

Request body

application/json

object

conversationIdstring · uuid

Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.

copilotIdstring · uuidrequired

Credal-generated Agent ID to specify which agent to route the request to.

emailstringrequired

The user profile you want to use when sending the message.

inputVariablesarray of object

Optional input variables to be used in the message. Map the name of the variable to a list of urls.

Show child attributes

Show array items

idsarray of string · uuidrequired

Show child attributes

namestringrequired

messagestringrequired

The message you want to send to your agent.

Example request

{
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "copilotId": "00000000-0000-0000-0000-000000000000",
  "email": "string",
  "inputVariables": [
    {
      "ids": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "name": "string"
    }
  ],
  "message": "string"
}

Responses

valuecopilots_StreamingChunk

StreamingChunk

oneOf · 6 options

Option 1object

conversationIdstringrequired

dataFiltersobject

Show child attributes

filteredDataSourcesPerCollectionarray of objectrequired

Show child attributes

Show array items

collectionIdstring · uuidrequired

filteredDataIdsarray of string · uuidrequired

Show child attributes

filtersarray of valuerequired

Show child attributes

Show array items

oneOf · 4 options

Option 1object

fieldstringrequired

fieldTypestringrequired

Discriminator value: string

one of "string"

operatorstringrequired

one of "<", ">", "<=", ">=", "!=", "==", "contains"

valuestringrequired

Option 2object

fieldstringrequired

fieldTypestringrequired

Discriminator value: number

one of "number"

operatorstringrequired

one of "<", ">", "<=", ">=", "!=", "==", "contains"

valueintegerrequired

Option 3object

fieldstringrequired

fieldTypestringrequired

Discriminator value: boolean

one of "boolean"

operatorstringrequired

one of "=="

valuebooleanrequired

Option 4object

fieldstringrequired

fieldTypestringrequired

Discriminator value: datetime

one of "datetime"

operatorstringrequired

one of "<", ">", "<=", ">=", "!=", "==", "contains"

valuestring · daterequired

semanticSearchTermsarray of stringrequired

Show child attributes

webSearchTermarray of stringrequired

Show child attributes

eventstringrequired

Discriminator value: initial

one of "initial"

warningsarray of stringrequired

Show child attributes

webSearchResultsarray of objectrequired

Show child attributes

Show array items

contentsstringrequired

titlestringrequired

urlstringrequired

Option 2object

chunkstringrequired

eventstringrequired

Discriminator value: data_chunk

one of "data_chunk"

Option 3object

eventstringrequired

Discriminator value: end_of_message

one of "end_of_message"

Option 4object

eventstringrequired

Discriminator value: final_chunk

one of "final_chunk"

sourcesarray of objectrequired

Show child attributes

Show array items

externalResourceIdobjectrequired

Show child attributes

externalResourceIdstringrequired

resourceTypestringrequired

one of "GOOGLE_DRIVE_ITEM", "MICROSOFT_DRIVE_ITEM", "ZENDESK_TICKET", "ZENDESK_ARTICLE", "ZENDESK_GROUP", "ZENDESK_ARTICLE_SECTION", "ZENDESK_ARTICLE_CATEGORY", "CONFLUENCE_PAGE", "CONFLUENCE_SPACE", "JIRA_TICKET", "JIRA_PROJECT", "SALESFORCE_TASK", "BOX_FILE", "BOX_FOLDER", "NOTION_PAGE", "NOTION_DATABASE", "SLACK_CHANNEL", "MONGO_COLLECTION_SYNC", "UNKNOWN"

idstringrequired

namestringrequired

urlstring

Option 5object

blocksarray of stringrequired

Show child attributes

conversationIdstring · uuidrequired

eventstringrequired

Discriminator value: blocked

one of "blocked"

warningsarray of stringrequired

Show child attributes

Option 6object

errorobjectrequired

Show child attributes

messagestringrequired

eventstringrequired

Discriminator value: error_chunk

one of "error_chunk"

Example response

{
  "blocks": [
    "string"
  ],
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "event": "blocked",
  "warnings": [
    "string"
  ]
}

Examples

curl -X POST 'https://api.credal.ai/api/v0/copilots/streamMessage' \
  -H 'Content-Type: application/json' \
  -d '{"conversationId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000","email":"string","inputVariables":[{"ids":["00000000-0000-0000-0000-000000000000"],"name":"string"}],"message":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/copilots/streamMessage', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"conversationId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000","email":"string","inputVariables":[{"ids":["00000000-0000-0000-0000-000000000000"],"name":"string"}],"message":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/copilots/streamMessage', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\",\"email\":\"string\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/copilots/streamMessage",
    headers={"Content-Type": "application/json"},
    data='{"conversationId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000","email":"string","inputVariables":[{"ids":["00000000-0000-0000-0000-000000000000"],"name":"string"}],"message":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"conversationId":"00000000-0000-0000-0000-000000000000","copilotId":"00000000-0000-0000-0000-000000000000","email":"string","inputVariables":[{"ids":["00000000-0000-0000-0000-000000000000"],"name":"string"}],"message":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/copilots/streamMessage", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.credal.ai/api/v0/copilots/streamMessage");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\",\"email\":\"string\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.credal.ai/api/v0/copilots/streamMessage"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\",\"email\":\"string\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/copilots/streamMessage")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\",\"email\":\"string\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.credal.ai/api/v0/copilots/streamMessage");
request.Content = new StringContent("{\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"copilotId\":\"00000000-0000-0000-0000-000000000000\",\"email\":\"string\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "blocks": [
    "string"
  ],
  "conversationId": "00000000-0000-0000-0000-000000000000",
  "event": "blocked",
  "warnings": [
    "string"
  ]
}

Search documentation

copilots

documentCatalog

documentCollections

search

users

Request body

Responses

copilots

documentCatalog

documentCollections

search

users