How do I use metadata to link runs to my own records?

metadata is an optional JSON object, up to 2 KB, that Cosmos doesn't read and the API returns as-is on the run.

{
  "input": "Fix the failing date test in utils/",
  "metadata": { "ticket": "OPS-112", "requested_by": "user_42" }
}

Good uses#

• Ticket, issue or pull-request ids.
• Your own user or customer id, so you can show each person their runs.
• The environment or service that started the run.

Things to avoid#

• Secrets or personal data you don't need: metadata comes back in every read of the run.
• Large blobs: over 2 KB answers 413 too_large.

Learn more#

• Your first real run
• Create a run