Salambo
Browse documentation
Runs

Add and remove a run's tags

Adds the tags in add and removes the tags in remove, then returns the run's full tag list, sorted. Both are set operations: adding a tag the run already has, or removing one it does not have, changes nothing, so a repeated request is safe without an idempotency key, and two callers editing one run do not erase each other's tags. A tag in both lists is ambiguous and returns 400. Requires run:write.

A run has at most 20 tags. The limit applies to the result, so a request may add tags as it removes others. A result over 20 tags returns 400 naming add and changes nothing. A tag is 1 to 64 characters, stored exactly as sent: it is case-sensitive, nothing is trimmed, and a tag that is empty, only whitespace or contains a control character returns 400. A tag is any other text, so choose the convention you like.

Changing tags never changes the run's turns, their inputs and outputs, the deployment version they ran on, or the work in progress. It does not keep an idle run retained longer.

POST/runs/{runId}/tags

Authorization

AuthorizationBearer <token>

Path parameters

runIdstringrequired
pattern
"^run_[A-Za-z0-9]+$"

Bodyrequired

application/json
object

The tags to add and the tags to remove. Supply at least one of them, and no tag in both.

minProperties
1

Additional properties are not allowed.

addarray

Up to 20 tags. A repeated tag is one tag, and the order does not matter.

maxItems
20
Show nested schema
Array items
string

A free-form label of 1 to 64 characters, stored exactly as sent. It is case-sensitive and nothing is trimmed. It may not be only whitespace or contain a control character.

minLength
1
maxLength
64
pattern
"^(?![ \\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000]+$)[^\\u0000-\\u001f\\u007f-\\u009f]+$"
removearray

Up to 20 tags. A repeated tag is one tag, and the order does not matter.

maxItems
20
Show nested schema
Array items
string

A free-form label of 1 to 64 characters, stored exactly as sent. It is case-sensitive and nothing is trimmed. It may not be only whitespace or contain a control character.

minLength
1
maxLength
64
pattern
"^(?![ \\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000]+$)[^\\u0000-\\u001f\\u007f-\\u009f]+$"

Response

application/json

The run's tags after the change.

object

Additional properties are allowed.

objectstringrequired
const
"run_tags"
run_idstringrequired
pattern
"^run_[A-Za-z0-9]+$"
tagsarrayrequired

The run's tags, sorted, without repeats. A run has at most 20.

maxItems
20
uniqueItems
true
Show nested schema
Array items
string

A free-form label of 1 to 64 characters, stored exactly as sent. It is case-sensitive and nothing is trimmed. It may not be only whitespace or contain a control character.

minLength
1
maxLength
64
pattern
"^(?![ \\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000]+$)[^\\u0000-\\u001f\\u007f-\\u009f]+$"