Create Conversation

POST/v0/copilots/createConversationCreate Conversation

OPTIONAL. Create a new conversation with the Agent. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.

Request body

application/json

object

agentIdstring · uuidrequired

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

userEmailstringrequired

End-user for the conversation.

Example request

{
  "agentId": "00000000-0000-0000-0000-000000000000",
  "userEmail": "string"
}

Responses

objectcopilots_CreateConversationResponse

CreateConversationResponse

conversationIdstring · uuidrequired

Example response

{
  "conversationId": "00000000-0000-0000-0000-000000000000"
}

Examples

curl -X POST 'https://api.credal.ai/api/v0/copilots/createConversation' \
  -H 'Content-Type: application/json' \
  -d '{"agentId":"00000000-0000-0000-0000-000000000000","userEmail":"string"}'

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

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

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/copilots/createConversation",
    headers={"Content-Type": "application/json"},
    data='{"agentId":"00000000-0000-0000-0000-000000000000","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","userEmail":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/copilots/createConversation", 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/createConversation");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"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/createConversation"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"agentId\":\"00000000-0000-0000-0000-000000000000\",\"userEmail\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

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

{
  "conversationId": "00000000-0000-0000-0000-000000000000"
}

Search documentation

copilots

documentCatalog

documentCollections

search

users