appViews.get

GET

/v1/app-views/{viewId}

curl --request GET \
  --url https://example.com/v1/app-views/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• token
• session

Parameters

Path Parameters

viewId

required

string

Responses

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

object

null

null

Example

{
  "source": {
    "kind": "tool"
  }
}

400

ExperienceInputInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

AppRestricted | PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppRestricted

restriction

required

object

cardUrl

required

string

reason

required

string

>= 1 characters

appealUrl

required

string

object

object

_tag

required

string

Allowed values: PermissionDenied

permission

required

string

Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read

resource

required

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "AppRestricted"
}

404

ExperienceNotFound

Media typeapplication/json

object

_tag

required

string

Allowed values: ExperienceNotFound

id

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

AppViewUnavailable | SessionConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: AppViewUnavailable

reason

required

string

Allowed values: Declaration Resource ConnectionChanged Closed Unsupported Protocol

message

required

string

object

object

_tag

required

string

Allowed values: SessionConflict

message

required

string

Example

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

503

ExperienceStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

object

object

_tag

required

string

Allowed values: AuthorizationUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

Example

{
  "_tag": "ExperienceStorageUnavailable"
}