Ping Tier 3

GET/api/pingCopied!

API 키가 유효한지 확인하고, 해당 키에 바인딩된 워크스페이스를 반환합니다.

예시

SDK

const ping = await client.ping();

CLI

youvico auth ping

cURL

curl 'https://api.youvico.com/api/ping' \
  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "data": {
    "PONG": true,
    "workspace": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Acme Inc.",
      "avatarUrl": "https://cdn.youvico.com/workspaces/acme/avatar.avif"
    }
  }
}

요청

파라미터는 없습니다.

응답

200 OK를 반환합니다.

dataobject

Ping 결과

data.PONGboolean

API 키 인증 성공 여부

Example: true

data.workspaceobject

API 키에 바인딩된 워크스페이스

data.workspace.idstring

워크스페이스 ID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

data.workspace.namestring

워크스페이스 이름

Example: Acme Inc.

data.workspace.avatarUrlstring?

워크스페이스 아바타 URL

Example: https://cdn.youvico.com/workspaces/acme/avatar.avif