How does the Assistant API use the metadata field?

I would like to store useful information about the user in the metadata field in the Thread object so that the Assistant can use it when replying. However, the Assistant seems to ignore the data I’m storing in metadata when replying unless I specifically inject it into the Instruction or user content.

What is the proper use of the metadata field in the Assistant, Thread, Message and Run objects?

1 Like

The metadata field is purely an API affordance for you to store any data you want. A common example is to store IDs from your database, so you can have a connection between your user object / thread object and the one stored in the OpenAI API. It is not used for any API functionality and is not displayed to the model.

3 Likes

Fab, thank you Atty! Really appreciate you taking time to respond. That’s a great use case for the field and I’ll utilize that.