Yapper API
Api reference
GET
/me

Returns the team, the acting user with their name and team role, the credential kind/name, and granted scopes for the current API key or MCP OAuth connection. Use this before moving assets between multiple configured Yapper connections.

Authorization

bearerAuth models:read
AuthorizationBearer <token>

In: header

Scope: models:read

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/me"
{  "team": {    "id": "string",    "name": "string"  },  "actor": {    "userId": "string",    "name": "string",    "role": "owner"  },  "credential": {    "id": "string",    "name": "string",    "kind": "api_key",    "scopes": [      "string"    ]  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}

Get a canvas run GET

Returns a canvas run's status and, per card in run order, its state, why it failed, the process ids it started, and the outputs (or text, for LLM cards) this run made. While status is running, wait suggestedPollAfterSeconds between polls. Uses the processes:read scope.

Get team credits GET

Returns the team-level credit balance shared by the API and app.