For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList products
      • POSTCreate product
      • POSTAssemble product from FPO
      • GETGet product details
      • PUTUpdate product
      • DELDelete product
      • POSTAdd capability to product
      • PUTUpdate capability
      • DELRemove capability
      • GETPreview cleanup resources
      • GETGet product configuration summary
      • GETList surfaces
      • POSTCreate surface
      • GETGet surface details
      • PUTUpdate surface
      • DELDelete surface
      • POSTAdd item to surface
      • PUTUpdate surface item
      • DELRemove surface item
      • POSTCreate surface API key
      • DELDelete surface API key
      • GETReveal development surface key
      • GETList schedules for surface
      • POSTCreate schedule for surface
      • GETGet schedule details
      • PUTUpdate schedule
      • DELDelete schedule
      • POSTPause schedule
      • POSTResume schedule
      • POSTRun schedule immediately
Dashboard
LogoLogo
Runtype APIProducts

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  "environment": "production",
4  "id": "surf_9f8b7c6d5e4a3b2c1d0e",
5  "items": [
6    {
7      "agentId": "agent_12345abcde",
8      "agentType": "chatbot",
9      "cachedSkills": [
10        "natural-language-processing",
11        "sentiment-analysis"
12      ],
13      "capabilityId": "cap_98765zyxwv",
14      "capabilityName": "Customer Support Chat",
15      "createdAt": "2024-05-20T09:30:00Z",
16      "displayOrder": 1,
17      "enabled": true,
18      "endpointSlug": "customer-support-chat",
19      "exposedDescription": "Handles customer inquiries and support requests",
20      "exposedName": "Support Chat",
21      "flowId": "flow_abc123xyz",
22      "id": "item_0011223344",
23      "isEntryPoint": true
24    }
25  ],
26  "keys": [
27    {
28      "canReveal": true,
29      "createdAt": "2024-05-25T08:00:00Z",
30      "environment": "production",
31      "expiresAt": "2025-05-25T08:00:00Z",
32      "id": "key_5566778899",
33      "isActive": true,
34      "isDevelopment": false,
35      "keyHint": "Used for customer support integration",
36      "keyPrefix": "runtype-prod-",
37      "lastUsedAt": "2024-06-01T11:45:00Z",
38      "name": "Customer Support API Key",
39      "rateLimitPerDay": 10000,
40      "rateLimitPerMinute": 500,
41      "scopes": [
42        "read:messages",
43        "write:responses"
44      ],
45      "usageCount": 4523
46    }
47  ],
48  "name": "Customer Support Surface",
49  "productId": "prod_1234567890abcdef",
50  "status": "active",
51  "type": "chat-interface",
52  "updatedAt": "2024-06-01T12:00:00Z"
53}
Get a surface by ID including its items and keys.
Was this page helpful?
Previous

Update surface

Next
Built with

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