Retrieve Session

curl --request GET \
  --url https://app.agentcloud.dev/{resourceSlug}/session/{sessionId}.json \
  --header 'Authorization: Bearer <token>'

{
  "csrf": "<string>",
  "session": {
    "orgId": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "startDate": {},
    "lastUpdatedDate": {},
    "tokensUsed": 123,
    "status": "started",
    "sharingConfig": {
      "permissions": {},
      "mode": "restricted"
    },
    "_id": "<string>",
    "appId": "<string>",
    "previewLabel": "<string>"
  }
}

GET

{resourceSlug}

session

{sessionId}

.json

Retrieve Session

curl --request GET \
  --url https://app.agentcloud.dev/{resourceSlug}/session/{sessionId}.json \
  --header 'Authorization: Bearer <token>'

{
  "csrf": "<string>",
  "session": {
    "orgId": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "startDate": {},
    "lastUpdatedDate": {},
    "tokensUsed": 123,
    "status": "started",
    "sharingConfig": {
      "permissions": {},
      "mode": "restricted"
    },
    "_id": "<string>",
    "appId": "<string>",
    "previewLabel": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resourceSlug

string

required

The resourceSlug is a url parameter of the teamId associated with the user. Anywhere the resourceSlug is used can be interpreted as a teamId Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

sessionId

string

required

The sessionId of the session to retrieve Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

Response

JSON object the session associated with the given sessionId, will return an empty array if the request is successful but there are no associated agents.

csrf

string

cross site token

session

object

Session Object returned for the given sessionId

Show child attributes

session.orgId

string

required

The id of the organisation that the session belongs to (usually the teamId of the corresponding app object).

session.teamId

string

required

The id object of the team the session belongs to (usually the teamId of the corresponding app object the session stems from).

session.name

string

required

The name of the session

session.startDate

object

required

Date object of when the session was started.

session.lastUpdatedDate

object

required

Date object of when the session was last updated.

session.tokensUsed

integer

required

The number of AI tokens used in this session.

session.status

enum<string>

required

The cuurent state of the session

Available options:

started,

running,

waiting,

warning,

error,

terminated

While the permissions object is intended to hold permissions presence in the permissions object as a key implies view/read access for now until we implement checks and update middleware chains for more complex permissions. Keys are intended to be user, team, or org IDs with a mapping to permissions.

Show child attributes

Permissions mapping where keys are user, team, or org IDs and values are permissions. Presence implies view/read access.

Show child attributes

The mode of sharing.

Available options:

restricted,

team,

public

session._id

string

Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

session.appId

string

The appId of the app that the session is running

session.previewLabel

string

Label to show when previewing the session

Retrieve Sessions

⌘I

Reference

Authorizations

Path Parameters

Response