Get surface details

GET

/v1/products/:id/surfaces/:surfaceId

GET

/v1/products/:id/surfaces/:surfaceId

$ curl https://api.runtype.com/v1/products/id/surfaces/surfaceId \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "createdAt": "2024-06-01T12:00:00Z",
3   "endpoint": "https://api.runtype.com/v1/products/7f8e9d6c-1234-4b56-8a9b-0c1d2e3f4a5b/surfaces/3a2b1c4d-5678-4e90-b123-456789abcdef",
4   "environment": "production",
5   "id": "3a2b1c4d-5678-4e90-b123-456789abcdef",
6   "items": [
7     {
8       "agentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
9       "agentType": "chatbot",
10       "cachedSkills": [
11         "natural-language-processing",
12         "sentiment-analysis"
13       ],
14       "capabilityId": "cap-9876543210",
15       "capabilityName": "Customer Support Chat",
16       "createdAt": "2024-05-20T09:30:00Z",
17       "displayOrder": 1,
18       "enabled": true,
19       "endpointSlug": "customer-support-chat",
20       "exposedDescription": "Handles customer inquiries and support requests",
21       "exposedName": "Support Chat",
22       "flowId": "flow-1234abcd5678ef90",
23       "id": "item-1234abcd5678ef90",
24       "isEntryPoint": true
25     }
26   ],
27   "keys": [
28     {
29       "canReveal": true,
30       "createdAt": "2024-01-15T08:00:00Z",
31       "environment": "production",
32       "expiresAt": "2025-01-15T08:00:00Z",
33       "id": "key-abcdef1234567890",
34       "isActive": true,
35       "isDevelopment": false,
36       "keyHint": "Used for external API integrations",
37       "keyPrefix": "RTAPI",
38       "lastUsedAt": "2024-05-30T16:45:00Z",
39       "name": "External Integration Key",
40       "rateLimitPerDay": 10000,
41       "rateLimitPerMinute": 500,
42       "scopes": [
43         "read:products",
44         "write:surfaces"
45       ],
46       "usageCount": 2543
47     }
48   ],
49   "name": "Main Customer Support Surface",
50   "productId": "7f8e9d6c-1234-4b56-8a9b-0c1d2e3f4a5b",
51   "status": "active",
52   "type": "chat-interface",
53   "updatedAt": "2024-06-01T12:00:00Z"
54 }

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

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.

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