Custom Metadata

You can attach custom metadata to bots through the metadata field in your Create Bot requests.

Any attached metadata will be present on the corresponding bot when fetched through the API, which can be useful for maintaining relationships with internal data models, or tagging resources with specific pieces of information.

Example: Tag a Bot's Recording with an internal user ID:

curl --request POST \
     --url https://us-east-1.recall.ai/api/v1/bot/ \
     --header 'Authorization: $RECALLAI_API_KEY' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "meeting_url": "...",
  "metadata": {
    "user_id": "12345"
  }
}
'

The metadata will be available through the bot's metadata field (for instance, when calling Retrieve Bot.

⚠️

Field Limitations

Each value in a custom metadata key-value pair has a maximum length of 500 characters.