Skip to content
Pile
Esc
↑↓navigate↵open⌘Jpreview

Get agent session

GET/workspaces/{organizationId}/agent/sessions/{sessionId}
Authorization
AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters
organizationIdstringrequired
sessionIdstringrequired
Query parameters
summarystring
Responses
200

Agent session with activities. Pass ?summary=1 for lane-row scalars only.

Any of:
object
idstringrequired
organizationIdstringrequired
issueIdstringrequired
agentIdstringrequired
providerstringrequired
actorIdstringrequired
actorTypestringrequired
Allowed:useragent
statusstringrequired
Allowed:createdrunningstalewaitingcompletedfailedcanceled
resultstring | nullrequired
urlstring | nullrequired
providerSessionIdstring | nullrequired
prUrlstring | nullrequired
prStatestring | nullrequired
branchstring | nullrequired
purposestring | null
secondaryReposstring | null
maxDurationMinutesinteger | null
effortstring | null
Allowed:lowmediumhighmaxnull
labelstring | null
resultSchemaobject | null
structuredResultany | null
resultSchemaErrorsstring[] | null
createdAtstringrequired
updatedAtstringrequired
lastProgressAtstring | null
lastStateHashstring | null
awaitingActivityIdstring | null
awaitingEscalatedAtstring | null
pausednumber
stepKeystring | null
planobject[] | null
Show properties
Array of object
contentstringrequired
min length 1 · max length 500
statusstringrequired
Allowed:pendinginProgresscompletedcanceled
guidanceobject[] | null
Show properties
Array of object
idstringrequired
namestringrequired
scopestringrequired
Allowed:workspaceteamstatusstep
scopeKeystring | nullrequired
versionintegerrequired
derivedStatusstring | null
Allowed:stalledneeds_inputnull
awaitingFirstAckboolean
firstActivityAtstring | null
queuedAfterstring | null
receiptobject | null
Show properties
idstringrequired
organizationIdstringrequired
sessionIdstringrequired
issueIdstringrequired
agentIdstringrequired
stepKeystring | nullrequired
dealIdstring | nullrequired
statusstringrequired
modelstring | nullrequired
effortstring | nullrequired
inputTokensinteger | nullrequired
outputTokensinteger | nullrequired
totalTokensinteger | nullrequired
toolCallsinteger | nullrequired
costMicrosinteger | nullrequired
externalSpendMicrosinteger | nullrequired
totalCostMicrosinteger | nullrequired
costSourcestring | nullrequired
Allowed:reportedrate_mapnull
capExceededintegerrequired
stopReasonstring | nullrequired
startedAtstring | nullrequired
endedAtstring | nullrequired
durationMsinteger | nullrequired
createdAtstringrequired
updatedAtstringrequired
activitiesobject[]
Show properties
Array of object
idstringrequired
sessionIdstringrequired
actorIdstring | nullrequired
typestringrequired
Allowed:thoughtresponseerrorelicitationpromptactionstatusartifact
messagestringrequired
payloadany | null
parentIdstring | nullrequired
startedAtstring | nullrequired
endedAtstring | nullrequired
durationMsnumber | nullrequired
createdAtstringrequired
object
idstringrequired
issueIdstringrequired
agentIdstringrequired
providerstringrequired
statusstringrequired
Allowed:createdrunningstalewaitingcompletedfailedcanceled
prUrlstring | nullrequired
prStatestring | nullrequired
createdAtstringrequired
updatedAtstringrequired
lastProgressAtstring | null
derivedStatusstring | null
Allowed:stalledneeds_inputnull
labelstring | null
awaitingActivityIdstring | null
firstActivityAtstring | null
queuedAfterstring | null
startedAtstring | nullrequired
endedAtstring | nullrequired
404

Session not found

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://pile.nyc/workspaces/string/agent/sessions/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "string",
  "organizationId": "string",
  "issueId": "string",
  "agentId": "string",
  "provider": "string",
  "actorId": "string",
  "actorType": "user",
  "status": "created",
  "result": "string",
  "url": "string",
  "providerSessionId": "string",
  "prUrl": "string",
  "prState": "string",
  "branch": "string",
  "purpose": "string",
  "secondaryRepos": "string",
  "maxDurationMinutes": 0,
  "effort": "low",
  "label": "string",
  "resultSchema": {
    "property1": null,
    "property2": null
  },
  "structuredResult": null,
  "resultSchemaErrors": [
    "string"
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "lastProgressAt": "string",
  "lastStateHash": "string",
  "awaitingActivityId": "string",
  "awaitingEscalatedAt": "string",
  "paused": 0,
  "stepKey": "string",
  "plan": [
    {
      "content": "string",
      "status": "pending"
    }
  ],
  "guidance": [
    {
      "id": "string",
      "name": "string",
      "scope": "workspace",
      "scopeKey": "string",
      "version": 0
    }
  ],
  "derivedStatus": "stalled",
  "awaitingFirstAck": true,
  "firstActivityAt": "string",
  "queuedAfter": "string",
  "receipt": {
    "id": "string",
    "organizationId": "string",
    "sessionId": "string",
    "issueId": "string",
    "agentId": "string",
    "stepKey": "string",
    "dealId": "string",
    "status": "string",
    "model": "string",
    "effort": "string",
    "inputTokens": 0,
    "outputTokens": 0,
    "totalTokens": 0,
    "toolCalls": 0,
    "costMicros": 0,
    "externalSpendMicros": 0,
    "totalCostMicros": 0,
    "costSource": "reported",
    "capExceeded": 0,
    "stopReason": "string",
    "startedAt": "string",
    "endedAt": "string",
    "durationMs": 0,
    "createdAt": "string",
    "updatedAt": "string"
  },
  "activities": [
    {
      "id": "string",
      "sessionId": "string",
      "actorId": "string",
      "type": "thought",
      "message": "string",
      "payload": null,
      "parentId": "string",
      "startedAt": "string",
      "endedAt": "string",
      "durationMs": 0,
      "createdAt": "string"
    }
  ]
}

Was this page helpful?