Metadata

Tag each task with your own key-value pairs, such as the user or team it ran for, and read them back on its usage record.

Only API keys of Studio and Enterprise teams can tag tasks. On other plans, Meshy ignores the header and never returns 400 for it.

Tag a task

To tag a task, send the X-Meshy-Metadata header with the request that creates it:

X-Meshy-Metadata: user=alex@example.com,team=fab

The header value follows the W3C Baggage format, with at most 64 pairs and 8,192 bytes. A header that's malformed or over these limits returns 400, and Meshy doesn't create the task.

Creative Lab endpoints ignore the header and never return 400 for it.

Read the tags

Each record of the Usage API has the task's tags in its metadata field, for example {"user": "alex@example.com", "team": "fab"}. It's {} for a task without tags.