Skip to main content
POST
/
api
/
v1
/
agent-session-activities
Create Agent Session Activity
curl --request POST \
  --url https://api.opensink.com/api/v1/agent-session-activities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "session_started",
  "source": "system",
  "related_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "payload": {},
  "links": [
    {
      "text": "<string>",
      "href": "<string>"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "session_started",
  "source": "system",
  "related_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>",
  "payload": {},
  "links": [
    {
      "text": "<string>",
      "href": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Body

application/json
​
session_id
string<uuid>
required

Parent session ID

​
agent_id
string<uuid>
required

Parent agent ID

​
type
enum<string>
required

Activity type

Available options:
session_started,
session_ended,
message,
input_request_created,
input_request_resolved,
sink_item_created,
state_updated
​
source
enum<string>
required

Activity source

Available options:
system,
agent,
user
​
related_entity_id
string<uuid> | null

Related entity ID (e.g., input request ID, sink item ID)

​
message
string | null

Human-readable message

​
payload
object

Additional activity data

​
links
object[]

Associated links

Response

An activity log entry for an agent session

An activity log entry for an agent session

​
id
string<uuid>

Unique identifier

​
session_id
string<uuid>

Parent session ID

​
agent_id
string<uuid>

Parent agent ID

​
workspace_id
string<uuid>

Workspace ID

​
type
enum<string>

Activity type

Available options:
session_started,
session_ended,
message,
input_request_created,
input_request_resolved,
sink_item_created,
state_updated
​
source
enum<string>

Activity source

Available options:
system,
agent,
user
​
related_entity_id
string<uuid> | null

Related entity ID (e.g., input request ID, sink item ID)

​
message
string | null

Human-readable message

​
payload
object

Additional activity data

​
links
object[]

Associated links

​
created_at
string<date-time>

Creation timestamp

​
updated_at
string<date-time>

Last update timestamp