Skip to content
agentex-sdk
API Reference
Spans

Partial Update Span

PATCH/spans/{span_id}

Update a span with the provided output data and mark it as complete

Path ParametersExpand Collapse
span_id: string
Body ParametersJSONExpand Collapse
data: optional map[unknown] or array of map[unknown]

Any additional metadata or context for the span

One of the following:
map[unknown]
array of map[unknown]
end_time: optional string

The time the span ended

formatdate-time
input: optional map[unknown] or array of map[unknown]

Input parameters or data for the operation

One of the following:
map[unknown]
array of map[unknown]
name: optional string

Name that describes what operation this span represents

output: optional map[unknown] or array of map[unknown]

Output data resulting from the operation

One of the following:
map[unknown]
array of map[unknown]
parent_id: optional string

ID of the parent span if this is a child span in a trace

start_time: optional string

The time the span started

formatdate-time
task_id: optional string

ID of the task this span belongs to

trace_id: optional string

Unique identifier for the trace this span belongs to

ReturnsExpand Collapse
Span object { id, name, start_time, 7 more }
id: string
name: string

Name that describes what operation this span represents

start_time: string

The time the span started

formatdate-time
trace_id: string

Unique identifier for the trace this span belongs to

data: optional map[unknown] or array of map[unknown]

Any additional metadata or context for the span

One of the following:
map[unknown]
array of map[unknown]
end_time: optional string

The time the span ended

formatdate-time
input: optional map[unknown] or array of map[unknown]

Input parameters or data for the operation

One of the following:
map[unknown]
array of map[unknown]
output: optional map[unknown] or array of map[unknown]

Output data resulting from the operation

One of the following:
map[unknown]
array of map[unknown]
parent_id: optional string

ID of the parent span if this is a child span in a trace

task_id: optional string

ID of the task this span belongs to

Partial Update Span

curl http://localhost:5003/spans/$SPAN_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $AGENTEX_SDK_API_KEY" \
    -d '{}'
{
  "id": "id",
  "name": "name",
  "start_time": "2019-12-27T18:11:19.117Z",
  "trace_id": "trace_id",
  "data": {
    "foo": "bar"
  },
  "end_time": "2019-12-27T18:11:19.117Z",
  "input": {
    "foo": "bar"
  },
  "output": {
    "foo": "bar"
  },
  "parent_id": "parent_id",
  "task_id": "task_id"
}
Returns Examples
{
  "id": "id",
  "name": "name",
  "start_time": "2019-12-27T18:11:19.117Z",
  "trace_id": "trace_id",
  "data": {
    "foo": "bar"
  },
  "end_time": "2019-12-27T18:11:19.117Z",
  "input": {
    "foo": "bar"
  },
  "output": {
    "foo": "bar"
  },
  "parent_id": "parent_id",
  "task_id": "task_id"
}