Send Message | Credal | Documentation

1 import uuid 2 3 from credal import CredalApi 4 from credal.copilots import InputVariable 5 6 client = CredalApi( 7 api_key="YOUR_API_KEY", 8 ) 9 client.copilots.send_message( 10 agent_id=uuid.UUID( 11 "82e4b12a-6990-45d4-8ebd-85c00e030c24", 12 ), 13 message="Is Credal SOC 2 compliant?", 14 user_email="ravin@credal.ai", 15 input_variables=[ 16 InputVariable( 17 name="input1", 18 ids=[ 19 uuid.UUID( 20 "82e4b12a-6990-45d4-8ebd-85c00e030c24", 21 ) 22 ], 23 ), 24 InputVariable( 25 name="input2", 26 ids=[ 27 uuid.UUID( 28 "82e4b12a-6990-45d4-8ebd-85c00e030c25", 29 ), 30 uuid.UUID( 31 "82e4b12a-6990-45d4-8ebd-85c00e030c26", 32 ), 33 ], 34 ), 35 ], 36 )

1 { 2 "sendChatResult": { 3 "type": "ai_response_result", 4 "conversationId": "fc938005-92db-411a-88eb-32ca50d5f744", 5 "inserted_audit_log": { 6 "id": "5842804e-ffbe-4f8d-873e-f007fff93440" 7 }, 8 "messageId": "dd721cd8-4bf2-4b94-9869-258df3dab9dc", 9 "policy_triggers": [], 10 "referencedSources": [ 11 { 12 "id": "1", 13 "externalResourceId": { 14 "externalResourceId": "123456", 15 "resourceType": "GOOGLE_DRIVE_ITEM" 16 }, 17 "name": "Example Document", 18 "url": "https://drive.google.com/file/d/123456/view" 19 } 20 ], 21 "response": { 22 "message": "Based on the context provided, Credal is SOC 2 compliant...", 23 "dataChunk": "...SOC 2 is a technical audit that requires companies to establish and follow strict information security policies and procedures. Credal's SOC 2 report is available upon request..." 24 }, 25 "sourcesInDataContext": [ 26 { 27 "id": "1", 28 "externalResourceId": { 29 "externalResourceId": "123456", 30 "resourceType": "GOOGLE_DRIVE_ITEM" 31 }, 32 "name": "Example Document", 33 "url": "https://drive.google.com/file/d/123456/view" 34 }, 35 { 36 "id": "2", 37 "externalResourceId": { 38 "externalResourceId": "123457", 39 "resourceType": "GOOGLE_DRIVE_ITEM" 40 }, 41 "name": "Example Document 2", 42 "url": "https://drive.google.com/file/d/123457/view" 43 } 44 ], 45 "warnings": [], 46 "webSearchResults": [ 47 { 48 "title": "SOC 2 Compliance", 49 "url": "https://www.credal.ai/soc2", 50 "contents": "Credal is SOC 2 compliant. Learn more about SOC 2 compliance at Credal." 51 } 52 ] 53 } 54 }

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

agentIdUUIDRequired

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

messagestringRequired

The message you want to send to your copilot.

userEmailstringRequired

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

conversationIdUUIDOptional

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.

inputVariableslist of objectsOptionalBeta

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

Response

This endpoint returns an object.

sendChatResultobject