Get surface details | Runtype Documentation

{
  "createdAt": "2024-06-01T12:00:00Z",
  "environment": "production",
  "id": "surf_9f8b7c6d5e4a3b2c1d0e",
  "items": [
    {
      "agentId": "agent_12345abcde",
      "agentType": "chatbot",
      "cachedSkills": [
        "natural-language-processing",
        "sentiment-analysis"
      ],
      "capabilityId": "cap_98765zyxwv",
      "capabilityName": "Customer Support Chat",
      "createdAt": "2024-05-20T09:30:00Z",
      "displayOrder": 1,
      "enabled": true,
      "endpointSlug": "customer-support-chat",
      "exposedDescription": "Handles customer inquiries and support requests",
      "exposedName": "Support Chat",
      "flowId": "flow_abc123xyz",
      "id": "item_0011223344",
      "isEntryPoint": true
    }
  ],
  "keys": [
    {
      "canReveal": true,
      "createdAt": "2024-05-25T08:00:00Z",
      "environment": "production",
      "expiresAt": "2025-05-25T08:00:00Z",
      "id": "key_5566778899",
      "isActive": true,
      "isDevelopment": false,
      "keyHint": "Used for customer support integration",
      "keyPrefix": "runtype-prod-",
      "lastUsedAt": "2024-06-01T11:45:00Z",
      "name": "Customer Support API Key",
      "rateLimitPerDay": 10000,
      "rateLimitPerMinute": 500,
      "scopes": [
        "read:messages",
        "write:responses"
      ],
      "usageCount": 4523
    }
  ],
  "name": "Customer Support Surface",
  "productId": "prod_1234567890abcdef",
  "status": "active",
  "type": "chat-interface",
  "updatedAt": "2024-06-01T12:00:00Z"
}

Get a surface by ID including its items and keys.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

surfaceIdstringRequired

Response

Surface details

createdAtstring

environmentstring

idstring

itemslist of objects

keyslist of objects

namestring

productIdstring

statusstring

typestring

updatedAtstring

behaviorany

inboundany

outboundany

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/products/id/surfaces/surfaceId \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json"