Send Message

POST/v0/copilots/sendMessageSend 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.

Request body

application/json

object

agentIdstring · uuidrequired

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

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.

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.

userEmailstringrequired

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

Example request

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

Responses

objectcopilots_SendAgentMessageResponse

SendAgentMessageResponse

sendChatResultvaluerequired

Show child attributes

oneOf · 2 options

Option 1object

Returned when there is a reply fetched from the agent.

conversationIdstring · uuidrequired

inserted_audit_logobjectrequired

Show child attributes

idstring · uuidrequired

messageIdstring · uuidrequired

referencedSourcesarray 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

responseobjectrequired

Show child attributes

dataChunkstringrequired

messagestringrequired

structuredOutputvalue

Any type

sourcesInDataContextarray of objectrequired

Show child attributes

Items: copilots_ReferencedSource ↑

typestringrequired

Discriminator value: ai_response_result

one of "ai_response_result"

warningsarray of stringrequired

Show child attributes

webSearchResultsarray of objectrequired

Show child attributes

Show array items

contentsstringrequired

titlestringrequired

urlstringrequired

Option 2object

Returned when Credal detects possible infosec violations and blocks the message.

blocksarray of stringrequired

Show child attributes

conversationIdstring · uuidrequired

inserted_audit_logobjectrequiredcopilots_InsertedAuditLog ↑

typestringrequired

Discriminator value: blocked_result

one of "blocked_result"

warningsarray of stringrequired

Show child attributes

Example response

{
  "sendChatResult": {
    "blocks": [
      "string"
    ],
    "conversationId": "00000000-0000-0000-0000-000000000000",
    "inserted_audit_log": {
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "type": "blocked_result",
    "warnings": [
      "string"
    ]
  }
}

Examples

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

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

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

import requests

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

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"agentId":"00000000-0000-0000-0000-000000000000","conversationId":"00000000-0000-0000-0000-000000000000","inputVariables":[{"ids":["00000000-0000-0000-0000-000000000000"],"name":"string"}],"message":"string","userEmail":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/copilots/sendMessage", 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/sendMessage");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\",\"userEmail\":\"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/sendMessage"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\",\"userEmail\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/copilots/sendMessage")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\",\"userEmail\":\"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/sendMessage");
request.Content = new StringContent("{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"conversationId\":\"00000000-0000-0000-0000-000000000000\",\"inputVariables\":[{\"ids\":[\"00000000-0000-0000-0000-000000000000\"],\"name\":\"string\"}],\"message\":\"string\",\"userEmail\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "sendChatResult": {
    "blocks": [
      "string"
    ],
    "conversationId": "00000000-0000-0000-0000-000000000000",
    "inserted_audit_log": {
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "type": "blocked_result",
    "warnings": [
      "string"
    ]
  }
}

Search documentation

copilots

documentCatalog

documentCollections

search

users

Request body

Responses

copilots

documentCatalog

documentCollections

search

users