Indicators

Typing indicators

Write permission: own user only

Update

PATCH

/api/v1/indicators/:id

Update the last active time of an indicator.

Parameters

Field	Type	Required	Description
`id`	`string`	Yes
`lastActiveAt`	`number`	No

Example

Terminal

curl -X PATCH "https://start.chat/api/v1/indicators/{id}" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "abc123"
  }'

import { setup, mutate } from '@start-chat/sdk'

await setup({ apiKey: 'sk_live_xxx' })

const result = await mutate.indicator.update({
  id: 'abc123',
})

Response

{
  "ok": true,
  "data": {
    "id": "abc123",
    "type": "value",
    "userId": "usr_abc123",
    "lastActiveAt": 1709251200000
  }
}

Delete

DELETE

/api/v1/indicators/:id

Remove a typing indicator.

Parameters

Field	Type	Required	Description
`id`	`string`	Yes

Example

Terminal

curl -X DELETE "https://start.chat/api/v1/indicators/{id}" \
  -H "Authorization: Bearer sk_live_xxx"

import { setup, mutate } from '@start-chat/sdk'

await setup({ apiKey: 'sk_live_xxx' })

const result = await mutate.indicator.delete({
  id: 'abc123',
})

Response

{
  "ok": true,
  "data": {
    "id": "abc123",
    "type": "value",
    "userId": "usr_abc123",
    "lastActiveAt": 1709251200000
  }
}

Insert

POST

/api/v1/indicators

Create a typing indicator for real-time presence.

Parameters

Field	Type	Required
`type`	`string`	Yes
`serverId`	`string`	No
`channelId`	`string`	No
`threadId`	`string`	No
`lastActiveAt`	`number`	No

Example

Terminal

curl -X POST "https://start.chat/api/v1/indicators" \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "value"
  }'

import { setup, mutate } from '@start-chat/sdk'

await setup({ apiKey: 'sk_live_xxx' })

const result = await mutate.indicator.insert({
  type: 'value',
})

Response

{
  "ok": true,
  "data": {
    "id": "abc123",
    "type": "value",
    "userId": "usr_abc123",
    "lastActiveAt": 1709251200000
  }
}

Channels

Invites