Studio

Read a Studio workspace

Without query returns persisted resources, file revisions, participants, test results, proposals and release state. view=summary returns bounded counts, candidate review metadata, saved testRuns IDs/revision/status metadata with testRunPage and runtime state. Summary accepts only take/skip paging: omit proposalId, pointer, offset, limit and contentDigest. Read saved results through the separate session TestRun route using the indexed studioTestRunId. view=proposal requires proposalId and exposes complete pinned candidate/TestRun evidence through bounded JSON-pointer pages with digest-checked continuation. linkedChats distinguishes automatically associated session-born conversations (SESSION_THREAD/MEMBERS) from explicitly consented shared history (SHARED_HISTORY/SHARED). Member history is never granted by a public Studio share.

GET

/

api

/

v1

/

studio

/

sessions

/

{sessionId}

Read a Studio workspace

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.revoengine.com/api/v1/studio/sessions/{sessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/studio/sessions/{sessionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Authorizations

Authorization

string

header

required

Bearer JWT token or API Key (sk-*).

Path Parameters

sessionId

string

required

Query Parameters

view

enum<string>

Bounded summary or exact pinned proposal evidence. Omit for the existing full workspace response.

Available options:

summary,

proposal

proposalId

string<uuid>

Required for proposal view; selects one candidate within this session.

pointer

string

RFC 6901 pointer into {proposal,testRuns}. Defaults to /proposal. Read /proposal/resources, /proposal/files, /proposal/dependencyManifest or /testRuns/ for pinned evidence.

Maximum string length: 1024

offset

integer

UTF-16 character offset into the selected JSON value. Continuation requires its returned contentDigest.

Required range: x >= 0

limit

integer

default:4096

Maximum JSON characters per selected evidence page; no manifest fields are discarded.

Required range: 1 <= x <= 8192

contentDigest

string

Read digest binding the selected pointer to the complete pinned document and review metadata; required when offset > 0. Drift returns STUDIO_READ_STALE.

Maximum string length: 100

take

integer

default:10

Summary page size for candidate and saved TestRun metadata; excludes full evidence.

Required range: 1 <= x <= 20

skip

integer

default:0

Summary offset for the separate candidate and saved TestRun metadata lists.

Required range: x >= 0

Response

200

Read a Studio workspace

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.revoengine.com/api/v1/studio/sessions/{sessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.revoengine.com/api/v1/studio/sessions/{sessionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)