Skip to content
OpenBot

sessions.sessionConfessions

GET
/v1/sessions/{sessionId}/confessions
curl --request GET \
  --url https://example.com/v1/sessions/example/confessions \
  --header 'Authorization: Bearer <token>'

Lists what the Bot said with confide in this Session, and the answers that it got. The Bot uses it to talk about how its work goes. See the client guide before you show it to people.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
sessionId
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
id
required
string
session
required
string
turn
required
string
text
required
string
reply
required
string
at
required
number

Example generated

[
  {
    "id": "example",
    "session": "example",
    "turn": "example",
    "text": "example",
    "reply": "example",
    "at": 1
  }
]

400

Section titled “400”

SessionInvalidRecord | SessionModelInvalid | OrganizationRequired

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

Example 

{
  "_tag": "SessionInvalidRecord"
}

401

Section titled “401”

AuthenticationRequired

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

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve bots.read bots.write bots.delegate bots.share triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish computers.read computers.write computers.use computer_providers.read computer_providers.write computer_providers.use 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 usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

SessionNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: SessionNotFound
session
required
string

Example 

{
  "_tag": "SessionNotFound"
}

409

Section titled “409”

SessionBusy | SessionConflict

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

Example 

{
  "_tag": "SessionBusy"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

SessionStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "SessionStorageUnavailable"
}