Ping

MCP Tool

whoamiWho Am I

Rate Limit

Default

Checks the API key or OAuth access token and returns its workspace and scopes.

Example

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://files.youvico.com/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif"
    },
    "scopes": ["projects:read", "files:read"]
  }
}

Request

No parameters.

Response

Returns 200 OK.

dataobject

Ping result

data.pongboolean

Always true

Example: true

data.workspaceobject

Workspace bound to the API key or OAuth connection

data.workspace.idstring

Workspace ID

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

data.workspace.namestring

Workspace name

Example: Acme Inc.

data.workspace.avatarUrlstring?

Workspace avatar URL

Example: https://files.youvico.com/workspaces/a1b2c3d4-e5f6-7890-abcd-ef1234567890/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif

data.scopesstring[]

Scopes of the API key or OAuth connection

Possible values: projects:readprojects:writefolders:readfolders:writefiles:readfiles:writefiles:downloadai:generatecomments:readcomments:writecomments:downloadworkspace-members:readproject-members:readproject-members:writeaccess-links:readaccess-links:writeaccess-links:read.keyskills:readskills:write