API दस्तावेज़ीकरण

Start Assistant

post/api/v1/chat/start

Starts a new chat session. Signed-in users receive authenticated research tools; anonymous callers must pass bot verification and receive a session token for follow-up requests.

Chat

अनुरोध निकाय

{
  "locale": "Example",
  "pageUrl": "Example",
  "referrer": "Example",
  "turnstileToken": "Example",
  "clientSurface": "Example"
}

जवाब

200Session id, session token, and display name for the assistant.application/json

{
  "sessionId": "84663654-d102-4d64-98c6-5f8bbce52858",
  "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…",
  "agentName": "Obermind"
}

400Bot verification failed for anonymous callers.application/json

{
  "type": "Deposit",
  "title": "Example",
  "status": 1,
  "detail": "The request could not be completed. Check the values and try again.",
  "instance": "Example"
}

429Too many sessions from the same client.application/json

{
  "type": "Deposit",
  "title": "Example",
  "status": 1,
  "detail": "The request could not be completed. Check the values and try again.",
  "instance": "Example"
}

503Chat is disabled on this environment.

भाषा

प्रमाणीकरण

साख

Authorization: Bearer

डेवलपर्स के अंतर्गत लॉग इन किए गए ऐप में एक व्यक्तिगत एक्सेस टोकन बनाएं, फिर उसे यहां पेस्ट करें। अपने स्वयं के स्क्रिप्ट के लिए इस पथ को प्राथमिकता दें।

सुझावों का अनुरोध करें

अनुरोध निकाय

आवश्यक

अनुरोध

curl --request POST \
  --url https://platform.obermind.com/api/v1/chat/start \
  --header 'content-type: application/json' \
  --data '{
  "locale": "Example",
  "pageUrl": "Example",
  "referrer": "Example",
  "turnstileToken": "Example",
  "clientSurface": "Example"
}'

प्रतिक्रिया

अनुरोध शुरू करने और यहां प्रतिक्रिया देखने के लिए "इसे आज़माएं!" पर क्लिक करें।

अपने प्लेटफ़ॉर्म को लॉन्च करें।

शुरू करें।आज़माएँ।