Update Agent Metadata | Deepgram's Docs

Updates the metadata associated with an agent configuration. The config itself is immutable—to change the configuration, delete the existing agent and create a new one.

Authentication

AuthorizationToken

Use Authorization: Token <API_KEY> Example: Authorization: Token 12345abcdef

Path parameters

project_idstringRequired

agent_idstringRequired

Request

Updated metadata for the agent configuration

metadatamap from strings to stringsRequired

A map of string key-value pairs to associate with this agent configuration

Response

Agent configuration updated

agent_idstring

The unique identifier of the agent configuration

configobject

The agent configuration object

metadatamap from strings to strings

A map of arbitrary key-value pairs for labeling or organizing the agent configuration

created_atstringformat: "date-time"

Timestamp when the configuration was created

updated_atstringformat: "date-time"

Timestamp when the configuration was last updated

Errors

400

Bad Request Error

1	import requests
2
3	url = "https://api.deepgram.com/v1/projects/project_id/agents/agent_id"
4
5	payload = {}
6	headers = {
7	"Authorization": "Token <apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.put(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"agent_id": "agent_1234567890abcdef",
3	"config": {},
4	"metadata": {},
5	"created_at": "2024-01-15T09:30:00Z",
6	"updated_at": "2024-01-15T09:30:00Z"
7	}