Skip to content
OpenBot

codeRuns.list

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
sessionId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
Array<object>
object
id
required
string
session
required
string
turn
required
string
callId
required
string
status
required
string
Allowed values: Running Waiting Completed Failed Cancelled
code
required
string
reason
required
string
calls
required
Array<object>
object
index
required
integer
<= 9007199254740991
binding
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
operationId
required
string
outcome
required
Any of:
object
_tag
required
string
Allowed values: Waiting
result
required
Any of:
Any of:
object
_tag
required
string
Allowed values: Completed
value
required
logs
required
Array<string>
createdAt
required
number
updatedAt
required
number

Example 

[
  {
    "status": "Running",
    "calls": [
      {
        "source": {
          "kind": "tool"
        },
        "outcome": {
          "_tag": "Waiting"
        }
      }
    ],
    "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”

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 agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write 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 usage.read budgets.read budgets.write
resource
required
string

Example 

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

404

Section titled “404”

ExperienceNotFound

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

Example 

{
  "_tag": "ExperienceNotFound"
}

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 | AuthorizationUnavailable | AuthenticationUnavailable

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

Example 

{
  "_tag": "ExperienceStorageUnavailable"
}