Beta

Ping

GEThttps://api.youvico.com/api/ping
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": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "name": "Acme Inc.",
      "avatarUrl": "https://files.youvico.com/workspaces/6ba7b810-9dad-11d1-80b4-00c04fd430c8/A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6.avif"
    },
    "scopes": ["projects:read", "files:read"]
  }
}
Request
curl -X GET 'https://api.youvico.com/api/ping' \
-H 'Authorization: Bearer YOUR_API_KEY'
Response200 OK
{
  "data": {
    "pong": true,
    "workspace": {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "name": "Acme Inc.",
      "avatarUrl": "https://files.youvico.com/workspaces/6ba7b810-9dad-11d1-80b4-00c04fd430c8/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.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