Meta API

Service and token context.

Service info

GET/v1/

Returns basic information about the API. Requires only a valid API key.

Request

cURL

curl "https://api.asks.app/v1/" \
  -H "Authorization: Bearer $ASKS_API_KEY"

Response 200

JSON

{
  "object": "api",
  "name": "string",
  "version": "string",
  "documentation_url": "string"
}

Get workspace & token context

GET/v1/me

Returns the workspace, environment and scopes of the current token, plus plan (API / agent-chat entitlements), agent (name, enabled, whether the API channel is on) and readiness (the get-started checklist; null when it can't be computed). A token that acts for a workspace member (an MCP connection) also gets user. Requires only a valid token.

Request

cURL

curl "https://api.asks.app/v1/me" \
  -H "Authorization: Bearer $ASKS_API_KEY"

Response 200

JSON

{
  "object": "workspace_context",
  "workspace": {
    "object": "workspace",
    "id": "string",
    "name": "string",
    "slug": "string"
  },
  "environment": "live",
  "scopes": [
    "string"
  ],
  "user": {
    "id": "string",
    "name": {},
    "email": "string",
    "role": "owner"
  },
  "plan": {
    "id": "string",
    "active": true,
    "api_access": true,
    "agent_chat": true
  },
  "agent": {
    "name": "string",
    "enabled": true,
    "api_channel_enabled": true
  },
  "readiness": {
    "completed": true,
    "steps": {
      "widget_setup": true,
      "knowledge_base_content": true,
      "ai_agent_setup": true,
      "invite_teammates": true,
      "connect_channels": true
    }
  }
}

← Previous

Webhook endpoints