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

Create agent session register

POST/workspaces/{organizationId}/agent/sessions/register
Path parameters
organizationIdstringrequired
Request body
application/json
issueIdstringrequired
providerstringrequired
min length 1
providerSessionIdstring
statusstring
Allowed:createdrunningwaitingcompletedfailedcanceled
urlstring
branchstring
prUrlstring
Responses
200

Session already registered (providerSessionId dedupe)

sessionobjectrequired
Show properties
idstringrequired
organizationIdstringrequired
issueIdstringrequired
agentIdstringrequired
providerstringrequired
actorIdstringrequired
actorTypestringrequired
Allowed:useragent
statusstringrequired
Allowed:createdrunningwaitingcompletedfailedcanceled
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
derivedStatusstring | null
Allowed:stalledneeds_inputnull
activitiesobject[]
Show properties
Array of object
idstringrequired
sessionIdstringrequired
actorIdstring | nullrequired
typestringrequired
Allowed:thoughtresponseerrorelicitationactionstatusartifact
messagestringrequired
payloadany | null
parentIdstring | nullrequired
startedAtstring | nullrequired
endedAtstring | nullrequired
durationMsnumber | nullrequired
createdAtstringrequired
laneTokenstring | nullrequired
logUrlstring | nullrequired
reportUrlstring | nullrequired
mcpUrlstring | nullrequired
201

Session registered

sessionobjectrequired
Show properties
idstringrequired
organizationIdstringrequired
issueIdstringrequired
agentIdstringrequired
providerstringrequired
actorIdstringrequired
actorTypestringrequired
Allowed:useragent
statusstringrequired
Allowed:createdrunningwaitingcompletedfailedcanceled
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
derivedStatusstring | null
Allowed:stalledneeds_inputnull
activitiesobject[]
Show properties
Array of object
idstringrequired
sessionIdstringrequired
actorIdstring | nullrequired
typestringrequired
Allowed:thoughtresponseerrorelicitationactionstatusartifact
messagestringrequired
payloadany | null
parentIdstring | nullrequired
startedAtstring | nullrequired
endedAtstring | nullrequired
durationMsnumber | nullrequired
createdAtstringrequired
laneTokenstring | nullrequired
logUrlstring | nullrequired
reportUrlstring | nullrequired
mcpUrlstring | nullrequired
404

Issue not found

Try it
Server
Parameters
Bodyapplication/json
Request
curl -X POST '/workspaces/string/agent/sessions/register' \
  -H 'Content-Type: application/json' \
  -d '{
  "issueId": "string",
  "provider": "string",
  "providerSessionId": "string",
  "status": "created",
  "url": "string",
  "branch": "string",
  "prUrl": "string"
}'
Response
{
  "session": {
    "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",
    "derivedStatus": "stalled",
    "activities": [
      {
        "id": "string",
        "sessionId": "string",
        "actorId": "string",
        "type": "thought",
        "message": "string",
        "payload": null,
        "parentId": "string",
        "startedAt": "string",
        "endedAt": "string",
        "durationMs": 0,
        "createdAt": "string"
      }
    ]
  },
  "laneToken": "string",
  "logUrl": "string",
  "reportUrl": "string",
  "mcpUrl": "string"
}