appViews.get

GET

/v1/app-views/{viewId}

const url = 'https://example.com/v1/app-views/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

token
session

Parameters

Path Parameters

viewId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

required

string

>= 1 characters <= 128 characters

operationId

required

string

>= 1 characters <= 128 characters

readOnly

required

boolean

chat

required

string

turn

required

string

item

required

string

source

required

object

connectionId

required

string

>= 1 characters <= 128 characters

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
null

object

Example

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

400

ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired

application/json

Any of:

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

Example

{
  "_tag": "ExperienceInputInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | AppRestricted | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionForbidden

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExperienceNotFound | ExecutionNotFound | ChatNotFound

application/json

Any of:

object

_tag

required

string

Allowed values: ExperienceNotFound

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | AppViewUnavailable | ChatConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object

_tag

required

string

Allowed values: ExecutionConflict

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

Example

{
  "_tag": "ExperienceStorageUnavailable"
}