Get a session

Get a session

cURL

curl --request GET \
  --url https://agentgateway.atlan.engineering/agent/v1/sessions/{session_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "artifact_status": "<string>",
  "commit_ts": "<string>",
  "content_hash_hex": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "extension": "<string>",
  "id": "<string>",
  "is_latest": true,
  "kind": "<string>",
  "name": "<string>",
  "source_type": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>",
  "version_ordinal": 123,
  "workspace_id": "<string>",
  "session_status": "running",
  "subject_id": "<string>",
  "subject_kind": "harness",
  "display_name": "<string>",
  "identity": {
    "client_id": "<string>",
    "credential_kind": "<string>",
    "api_key": "<string>",
    "expires_at": "<string>"
  },
  "oidc_client_id": "<string>",
  "owner_id": "<string>",
  "project_id": "<string>",
  "repo_id": "<string>",
  "source_created_at": "<string>",
  "source_created_by": "<string>",
  "source_digest": "<string>",
  "source_id": "<string>",
  "source_last_modified_at": "<string>",
  "source_last_modified_by": "<string>",
  "source_metadata": "<unknown>",
  "source_synced_at": "<string>",
  "source_uri": "<string>",
  "source_version": "<string>",
  "version_label": "<string>",
  "agent_provider_id": "<string>",
  "agent_provider_type": "local",
  "environment_id": "<string>",
  "error": "<string>",
  "external_session_id": "<string>",
  "is_subject_system": true,
  "message_count": 123,
  "model_id": "<string>",
  "stop_reason": "<string>",
  "title": "<string>",
  "usage": {
    "cache_creation_input_tokens": 123,
    "cache_read_input_tokens": 123,
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123
  },
  "visitor_email": "<string>",
  "visitor_external_id": "<string>",
  "visitor_link_status": "unlinked",
  "visitor_name": "<string>",
  "visitor_type": "human",
  "visitor_user_id": "<string>",
  "permissions": {},
  "relationships": {
    "count": 1,
    "incoming": [
      {
        "direction": "<string>",
        "provenance": "<string>",
        "rel_type": "<string>",
        "relationship_status": "<string>",
        "attributes": {},
        "confidence": 123,
        "from": {
          "id": "<string>",
          "kind": "<string>"
        },
        "label": "<string>",
        "role": "<string>",
        "to": {
          "id": "<string>",
          "kind": "<string>"
        },
        "weight": 123
      }
    ],
    "outgoing": [
      {
        "direction": "<string>",
        "provenance": "<string>",
        "rel_type": "<string>",
        "relationship_status": "<string>",
        "attributes": {},
        "confidence": 123,
        "from": {
          "id": "<string>",
          "kind": "<string>"
        },
        "label": "<string>",
        "role": "<string>",
        "to": {
          "id": "<string>",
          "kind": "<string>"
        },
        "weight": 123
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

session_id · string · required

Response

200

application/json

HTTP 200 response.

artifact_status · string · required

commit_ts · string · required

content_hash_hex · string · required

created_at · string · required

created_by · string · required

extension · string · required

id · string · required

is_latest · boolean · required

kind · string · required

name · string · required

source_type · string · required

updated_at · string · required

updated_by · string · required

version_ordinal · integer<int64> · required

workspace_id · string · required

session_status · enum<string> · required

Available options: running, completed, failed

subject_id · string · required

subject_kind · enum<string> · required

Available options: harness, agent

display_name · string

identity · null | object

Show child attributes

oidc_client_id · string | null

owner_id · string | null

project_id · string | null

repo_id · string | null

source_created_at · string | null

source_created_by · string | null

source_digest · string | null

source_id · string | null

source_last_modified_at · string | null

source_last_modified_by · string | null

source_metadata · any

source_synced_at · string | null

source_uri · string | null

source_version · string | null

version_label · string | null

agent_provider_id · string | null

agent_provider_type · null | enum<string>

Available options: local, custom

environment_id · string | null

error · string | null

external_session_id · string | null

is_subject_system · boolean

message_count · integer<int64>

model_id · string

stop_reason · string | null

title · string | null

usage · object

Show child attributes

visitor_email · string | null

visitor_external_id · string | null

visitor_link_status · enum<string>

Available options: unlinked, linked, no_match

visitor_name · string | null

visitor_type · null | enum<string>

Available options: human, agent

visitor_user_id · string | null

permissions · null | object

Show child attributes

relationships · null | object

Show child attributes