appViews.interaction

GET

/v1/app-operations/{operationId}/interaction

curl --request GET \
  --url 'https://example.com/v1/app-operations/example/interaction?chatId=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

• token
• session

Parameters

Path Parameters

operationId

required

string

>= 1 characters <= 128 characters

Query Parameters

chatId

required

string

Responses

200

Success

Media typeapplication/json

object

revision

required

integer

<= 9007199254740991

context

required

Any of:

object

object

null

null

Example ^generated

{
  "revision": 1,
  "context": {}
}

400

ExperienceInputInvalid | ChatModelInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceInputInvalid

message

required

string

object

object

_tag

required

string

Allowed values: ChatModelInvalid

reason

required

string

Allowed values: provider-not-found model-not-found unsupported-option missing

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

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

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionForbidden

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: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExperienceNotFound | ExecutionNotFound | ChatNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ChatNotFound

chat

required

string

Example

{
  "_tag": "ExperienceNotFound"
}

409

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

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

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: ChatConflict

message

required

string

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExperienceStorageUnavailable | ExecutionUnavailable | ChatStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExperienceStorageUnavailable

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ChatStorageUnavailable

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExperienceStorageUnavailable"
}