Get surface details | Runtype Documentation

{
  "createdAt": "string",
  "endpoint": "string",
  "id": "string",
  "items": [
    {
      "agentId": "string",
      "agentType": "string",
      "cachedSkills": [
        null
      ],
      "capabilityId": "string",
      "capabilityName": "string",
      "createdAt": "string",
      "displayOrder": 1,
      "enabled": true,
      "endpointSlug": "string",
      "exposedDescription": "string",
      "exposedName": "string",
      "flowId": "string",
      "id": "string",
      "isEntryPoint": true
    }
  ],
  "keys": [
    {
      "canReveal": true,
      "createdAt": "string",
      "environment": "string",
      "expiresAt": "string",
      "id": "string",
      "isActive": true,
      "isDevelopment": true,
      "keyHint": "string",
      "keyPrefix": "string",
      "lastUsedAt": "string",
      "name": "string",
      "rateLimitPerDay": 1,
      "rateLimitPerMinute": 1,
      "scopeTargetIds": [
        "string"
      ],
      "scopes": [
        "string"
      ],
      "usageCount": 1
    }
  ],
  "name": "string",
  "productId": "string",
  "scopeTargets": [
    {
      "id": "string",
      "name": "string",
      "capabilityId": "string",
      "surfaceItemId": "string"
    }
  ],
  "status": "string",
  "type": "string",
  "updatedAt": "string",
  "webhookHealth": {
    "lastDeliveryAt": "string",
    "recentFailures": [
      {
        "at": "string",
        "reason": "string",
        "statusCode": 1.1
      }
    ]
  }
}

Get an authorized surface by its globally unique ID, including items and keys.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

surfaceIdstringRequired

Response

Surface details

createdAtstring

endpointstring or null

Canonical public URL of this surface (MCP, API, A2A, AG-UI, webhook, chat). Null for surface types reached through their own channels (Slack, email, schedule, …). Clients should use this instead of constructing the URL themselves.

idstring

itemslist of objects

keyslist of objects

namestring

productIdstring

scopeTargetslist of objects

statusstring

typestring

updatedAtstring

webhookHealthobject

behavioranyOptional

inboundanyOptional

outboundanyOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.runtype.com/v1/surfaces/surfaceId \
>	-H "Authorization: <apiKey>"