For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList conversations
      • POSTCreate conversation
      • GETGet conversation
      • PUTUpdate conversation
      • DELDelete conversation
      • GETList messages
      • POSTCreate message
Dashboard
LogoLogo
Runtype APIMessaging Conversations

Create conversation

POST
/v1/messaging/conversations
POST
/v1/messaging/conversations
$curl -X POST https://api.runtype.com/v1/messaging/conversations \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "surfaceId": "surf_123abc456def"
>}'
1{
2  "createdAt": "2024-06-01T10:15:30Z",
3  "externalParticipantId": "user_789xyz",
4  "externalThreadId": "thread_456def",
5  "id": "conv_001122334455",
6  "lastMessageAt": "2024-06-01T10:45:00Z",
7  "messageCount": 5,
8  "participantEmail": "jane.doe@example.com",
9  "participantName": "Jane Doe",
10  "status": "open",
11  "subject": "Inquiry about product features",
12  "surfaceId": "surf_123abc456def",
13  "timezone": "America/New_York",
14  "updatedAt": "2024-06-01T10:50:00Z",
15  "context": {},
16  "participantMetadata": {},
17  "surface": {
18    "id": "surf_123abc456def",
19    "name": "Customer Support Chat",
20    "type": "chat"
21  }
22}
Create a new messaging conversation linked to a surface.
Was this page helpful?
Previous

Get conversation

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
surfaceIdstringRequired
contextobjectOptional
externalParticipantIdstringOptional<=500 characters
externalThreadIdstringOptional<=500 characters
participantEmailstringOptionalformat: "email"<=255 characters
participantMetadatamap from strings to anyOptional
participantNamestringOptional<=255 characters
statusenumOptional
Allowed values:
subjectstringOptional<=500 characters
timezonestring or nullOptional<=64 characters

Response

Created conversation
createdAtstring
externalParticipantIdstring or null
externalThreadIdstring or null
idstring
lastMessageAtstring or null
messageCountdouble
participantEmailstring or null
participantNamestring or null
statusstring
subjectstring or null
surfaceIdstring
timezonestring or null
updatedAtstring
contextmap from strings to any
participantMetadatamap from strings to any
surfaceobject

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error