Skip to content
OpenBot

codeRuns.list

GET
/v1/chats/{chatId}/code-runs
curl --request GET \
  --url https://example.com/v1/chats/example/code-runs \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
calls
required
Array<object>
object
index
required
integer
<= 9007199254740991
binding
required
string
app
required
Any of:
object
id
required
string
>= 1 characters <= 128 characters
executionId
required
string
>= 1 characters <= 128 characters
chat
required
string
turn
required
string
callId
required
string
toolName
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
arguments
required
object
readOnly
required
boolean
round
required
integer
<= 9007199254740991
status
required
string
Allowed values: queued running waiting cancelling completed failed cancelled interrupted outcome_unknown
result
required
Any of:
object
_tag
required
string
Allowed values: Completed
result
required
failure
required
Any of:
object
errorId
required
string
>= 1 characters <= 128 characters
category
required
string
Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted
createdAt
required
number
updatedAt
required
number
rejection
required
Any of:
object
name
required
string
message
required
string
id
required
string
>= 1 characters <= 128 characters
executionId
required
string
>= 1 characters <= 128 characters
chat
required
string
turn
required
string
callId
required
string
code
required
string
>= 1 characters <= 100000 characters
reason
required
string
status
required
string
Allowed values: queued running waiting cancelling completed failed cancelled interrupted outcome_unknown
failure
required
Any of:
object
errorId
required
string
>= 1 characters <= 128 characters
category
required
string
Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted
result
required
Any of:
object
_tag
required
string
Allowed values: Completed
value
required
logs
required
Array<string>
createdAt
required
number
updatedAt
required
number

Example 

[
  {
    "calls": [
      {
        "app": {
          "source": {
            "kind": "tool"
          },
          "status": "queued",
          "result": {
            "_tag": "Completed"
          },
          "failure": {
            "category": "invalid"
          }
        }
      }
    ],
    "status": "queued",
    "failure": {
      "category": "invalid"
    },
    "result": {
      "_tag": "Completed"
    }
  }
]

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”

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

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

Example 

{
  "_tag": "ExecutionForbidden"
}

404

Section titled “404”

ExperienceNotFound | ExecutionNotFound

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

Example 

{
  "_tag": "ExperienceNotFound"
}

409

Section titled “409”

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

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: ExecutionConflict
id
required
string
>= 1 characters <= 128 characters

Example 

{
  "_tag": "ExecutionConflict"
}

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”

ExperienceStorageUnavailable | ExecutionUnavailable | AuthenticationUnavailable | RequestFailed

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

Example 

{
  "_tag": "ExperienceStorageUnavailable"
}