Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/googleworkspace/cli/llms.txt

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

​
Overview

The Google Chat API allows you to create Chat apps, send messages, manage spaces, and interact with Google Chat programmatically. API Name: chat
Version: v1
Official Documentation: Chat API Reference

​
Common Resources

​
Spaces

Manage Chat spaces (rooms and direct messages).
​
name
string
required
The space resource name (e.g., spaces/AAAAxxxxx)
​
displayName
string
The human-readable name of the space
​
spaceType
string
The type: SPACE, GROUP_CHAT, or DIRECT_MESSAGE

​
Messages

Send and manage messages in spaces.
​
parent
string
required
The space where to send the message (e.g., spaces/AAAAxxxxx)
​
text
string
The message text content
​
thread
object
Thread information for replies

​
Common Methods

​
List Spaces

gws chat spaces list --params '{
  "pageSize": 100
}'
​
spaces
array
Array of space objects
​
name
string
The space resource name
​
displayName
string
The space display name
​
spaceType
string
The space type

​
Get Space

gws chat spaces get --params '{
  "name": "spaces/AAAAxxxxx"
}'

​
Create Space

gws chat spaces create --json '{
  "displayName": "Project Alpha",
  "spaceType": "SPACE"
}'

​
Send Message

gws chat spaces messages create \
  --params '{"parent": "spaces/AAAAxxxxx"}' \
  --json '{
    "text": "Deploy completed successfully! ✅"
  }'

​
Get Message

gws chat spaces messages get --params '{
  "name": "spaces/AAAAxxxxx/messages/123456"
}'

​
Update Message

gws chat spaces messages patch \
  --params '{
    "name": "spaces/AAAAxxxxx/messages/123456",
    "updateMask": "text"
  }' \
  --json '{
    "text": "Updated message content"
  }'

​
Delete Message

gws chat spaces messages delete --params '{
  "name": "spaces/AAAAxxxxx/messages/123456"
}'

​
Message Examples

gws chat spaces messages create \
  --params '{"parent": "spaces/AAAAxxxxx"}' \
  --json '{
    "text": "Hello, team!"
  }'

​
Response Format

List spaces response: 
{
  "spaces": [
    {
      "name": "spaces/AAAAxxxxx",
      "displayName": "Project Alpha",
      "spaceType": "SPACE",
      "createTime": "2026-01-15T10:00:00Z"
    }
  ],
  "nextPageToken": "xyz789..."
}
Message response: 
{
  "name": "spaces/AAAAxxxxx/messages/123456",
  "sender": {
    "name": "users/12345",
    "displayName": "Alice Smith",
    "type": "HUMAN"
  },
  "createTime": "2026-03-05T14:30:00Z",
  "text": "Deploy completed successfully!",
  "thread": {
    "name": "spaces/AAAAxxxxx/threads/654321"
  }
}
  • +send - Send a message to a space

​
Key Resources

  • spaces - Create and manage Chat spaces
  • spaces.messages - Send and manage messages
  • spaces.members - Manage space memberships
  • customEmojis - Manage custom emojis
  • media - Upload and download media

​
Space Management

​
List Members

gws chat spaces members list --params '{
  "parent": "spaces/AAAAxxxxx"
}'

​
Add Member

gws chat spaces members create \
  --params '{"parent": "spaces/AAAAxxxxx"}' \
  --json '{
    "member": {
      "name": "users/12345",
      "type": "HUMAN"
    }
  }'

​
Find Direct Message

gws chat spaces findDirectMessage --params '{
  "name": "users/12345"
}'

​
Learn More

​
Schema Inspection

Before calling any method, inspect its schema: 
gws schema chat.spaces.list
gws schema chat.spaces.messages.create