Skip to content
OpenBot

appViews.open

POST
/v1/app-operations/{operationId}/view
curl --request POST \
  --url https://example.com/v1/app-operations/example/view \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sessionId": "example", "itemId": "example", "version": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
operationId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
sessionId
required
string
itemId
required
string
version
string

Example generated

{
  "sessionId": "example",
  "itemId": "example",
  "version": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
id
required
string
operationId
required
string
readOnly
required
boolean
session
required
string
turn
required
string
item
required
string
source
required
object
connectionId
required
string
connectionName
required
string
cardUrl
required
string
appName
required
string
remoteIndex
required
integer
<= 9007199254740991
revision
required
integer
<= 9007199254740991
kind
required
string
Allowed values: tool resource template prompt
name
required
string
definition
interaction
required
object
revision
required
integer
<= 9007199254740991
context
required
Any of:
object
resource
required
object
uri
required
string
mimeType
required
string
Allowed values: text/html;profile=mcp-app
html
required
string
>= 1 characters
prefersBorder
Any of:
boolean
tools
required
Array<object>
object
arguments
required
object
result
object

Example 

{
  "source": {
    "kind": "tool"
  },
  "resource": {
    "mimeType": "text/html;profile=mcp-app"
  }
}

400

Section titled “400”

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExperienceInputInvalid
message
required
string

Example 

{
  "_tag": "ExperienceInputInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppRestricted
restriction
required
object
cardUrl
required
string
reason
required
string
>= 1 characters
appealUrl
required
string

Example 

{
  "_tag": "AppRestricted"
}

404

Section titled “404”

ExperienceNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: ExperienceNotFound
id
required
string

Example 

{
  "_tag": "ExperienceNotFound"
}

409

Section titled “409”

AppViewUnavailable | SessionConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: AppViewUnavailable
reason
required
string
Allowed values: Declaration Resource ConnectionChanged Closed Unsupported Protocol
message
required
string

Example 

{
  "_tag": "AppViewUnavailable",
  "reason": "Declaration"
}

503

Section titled “503”

ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExperienceStorageUnavailable

Example 

{
  "_tag": "ExperienceStorageUnavailable"
}