Inbox

Draft, summarise, answer or translate a supplied draft without sending; translation requires text and targetLanguage and spends workspace credits

Use an explicitly scoped user-bound account bearer credential or an application session. Scope grants are intersected with live membership, role, tenant isolation, agent access and plan limits; a credential does not grant an owner role. Invitation acceptance requires the verified recipient email.

post/workspaces/{workspaceId}/inbox/{conversationId}/copilot

Request

  • Base URL: https://app.communicate.so/api/v1
  • URL: https://app.communicate.so/api/v1/workspaces/{workspaceId}/inbox/{conversationId}/copilot
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Secure-better-auth.session_token
    • API key in cookie better-auth.session_token

Path parameters

workspaceIdstring required
conversationIdstring required

Request body

mode'draft' | 'summarise' | 'answer' | 'translate' required
questionstring
requestIdstring uuid required
textstring
targetLanguage'English' | 'Spanish' | 'French' | 'German' | 'Portuguese' | 'Italian' | 'Dutch' | 'Russian' | 'Chinese' | 'Japanese' | 'Korean' | 'Hindi' | 'Arabic'

Response

Draft, summarise, answer or translate a supplied draft without sending; translation requires text and targetLanguage and spends workspace credits

textstring required

Changes

No recorded changes to this operation across all 1 revision of this API.