Skip to main content
POST
/
v1
/
messaging
/
conversations
Create new conversation
curl --request POST \
  --url https://api.tybritelabs.com/v1/messaging/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_name": "Jane Wanjiku",
  "customer_email": "jane@example.com",
  "subject": "Question about my order",
  "message": "Hi, I placed an order yesterday — when will it ship?",
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_phone": "+254701234567",
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "priority": "normal"
}
'
{
  "thread": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subject": "<string>",
    "status": "<string>",
    "priority": "<string>"
  },
  "message": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tybritelabs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Authorization: Bearer tybrite_sk_live_YOUR_KEY

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Read-only access (GET requests only, plus POST semantic search)
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • All write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Headers

​
x-auth-token
string

Customer session access_token. Required when body.customer_id is supplied so the gateway can prove the caller owns that customer record.

Body

application/json
​
customer_name
string
required
Example:

"Jane Wanjiku"

​
customer_email
string<email>
required
Example:

"jane@example.com"

​
subject
string
required
Example:

"Question about my order"

​
message
string
required
Example:

"Hi, I placed an order yesterday — when will it ship?"

​
customer_id
string<uuid>

Optional — links thread to an existing customer record

​
customer_phone
string
Example:

"+254701234567"

​
order_id
string<uuid>
​
product_id
string<uuid>
​
priority
enum<string>
default:normal
Available options:
urgent,
high,
normal,
low
​
thread_type
enum<string>
Available options:
general,
order_inquiry,
product_inquiry,
support,
complaint,
delivery,
return,
refund,
technical

Response

Conversation created

​
thread
object
​
message
object