Record an agent-opened run surface

curl -X POST https://api.islo.dev/factories/factory_id/line-runs/run_id/surfaces \
     -H "X-Islo-Api-Version: X-Islo-Api-Version" \
     -H "Authorization: Bearer <api_key>" \
     -H "Content-Type: application/json" \
     -d '{
  "label": "string",
  "sandbox": {
    "name": "string",
    "region": "string"
  },
  "stage_name": "string",
  "target": {
    "port": 1,
    "share_id": "string",
    "url": "string"
  }
}'

{
  "created_at": "2024-01-15T09:30:00Z",
  "event_type": "string",
  "id": "string",
  "payload": {
    "label": "string",
    "sandbox": {
      "name": "string",
      "region": "string"
    },
    "stage_name": "string",
    "target": {
      "kind": "web",
      "port": 1,
      "share_id": "string",
      "url": "string"
    }
  },
  "sequence": 1
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

factory_idstringRequired

run_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

labelstringRequired1-200 characters

sandboxobjectRequired

stage_namestringRequired1-200 characters

targetobjectRequired

Response

Successful Response

created_atdatetime

event_type"surface_opened"

idstringformat: "uuid"

payloadobject

sequenceinteger

Errors

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors