Skip to main content

ID format

Most public IDs are a prefix that names the kind of record, an underscore, and 24 lowercase hexadecimal characters, such as exp_4c19a7e2b05d3f8a61c2e9d0. An ID never changes, even when you rename the record. Pass IDs exactly as Obss returns them; these docs shorten them for readability, as in exp_8f2c41d0.

Record IDs

  • Run scope flags take exp_, sch_, tsk_, tskver_, trt_, skl_, mcp_, cli_, sdk_, sklver_, mcpver_, cliver_, sdkver_, fld_, env_, agm_, and frc_.
  • Tags go on tsk_, fld_, env_, skl_, mcp_, cli_, sdk_, trt_, and exp_.

Operation IDs

Obss returns these for one operation, for you to send back. Their length varies. A public experiment link has a pub_ ID with 32 hexadecimal characters, shown by obss experiments publications list and on Share results.

Keys

Some records have a key instead of an ID. Agent keys use lowercase letters, digits, and hyphens, never an underscore, so they never look like public IDs. Send a cursor (nextCursor) back exactly as you received it. An attempt ID (--attempt-id) is a string you choose; reuse it only to retry the same change (CLI conventions).

Paging limits

A --limit (or the plugin’s limit) above the maximum is capped, not refused. Responses are capped at 20 KiB, so a page can hold fewer items. Continue with nextCursor while hasMore is true. Comparisons page with the same --kind and --label (kind and label in the plugin), and a cursor is refused once the comparisons change.

Content and wait limits

Product limits

Next steps