Update Agent Metadata | Deepgram's Docs

PUT/v1/projects/{project_id}/agents/{agent_id}Update Agent Metadata

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.

Parameters

project_idstringpathrequired

The unique identifier of the project

agent_idstringpathrequired

The unique identifier of the agent configuration

Request body

Updated metadata for the agent configuration

application/json

objectUpdateAgentMetadataV1Request

UpdateAgentMetadataV1Request

Request body for updating agent configuration metadata

metadataobjectrequired

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

Example request

{
  "metadata": {
    "additionalProp1": "string"
  }
}

Responses

objectAgentConfigurationV1

AgentConfigurationV1

A reusable agent configuration

agent_idstringrequired

The unique identifier of the agent configuration

configobjectrequired

The agent configuration object

created_atstring · date-time

Timestamp when the configuration was created

metadataobject

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

updated_atstring · date-time

Timestamp when the configuration was last updated

Example response

{
  "agent_id": "string",
  "config": {},
  "created_at": "2026-06-09T00:00:00Z",
  "metadata": {
    "additionalProp1": "string"
  },
  "updated_at": "2026-06-09T00:00:00Z"
}

valueErrorResponse

ErrorResponse

oneOf · 3 options

Option 1stringErrorResponseTextError

ErrorResponseTextError

Option 2objectErrorResponseLegacyError

ErrorResponseLegacyError

err_codestring

The error code

err_msgstring

The error message

request_idstring

The request ID

Option 3objectErrorResponseModernError

ErrorResponseModernError

categorystring

The category of the error

detailsstring

A description of the error

messagestring

A message about the error

request_idstring

The unique identifier of the request

Example response

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

agent_idrequiredpath parameter

curl -X PUT 'https://agent.deepgram.com/v1/projects/string/agents/string' \
  -H 'Content-Type: application/json' \
  -d '{"metadata":{"additionalProp1":"string"}}'

const response = await fetch('https://agent.deepgram.com/v1/projects/string/agents/string', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"metadata":{"additionalProp1":"string"}}),
});
const data = await response.json();

const response = await fetch('https://agent.deepgram.com/v1/projects/string/agents/string', { method: 'PUT', headers: { 'Content-Type': 'application/json' }, body: "{\"metadata\":{\"additionalProp1\":\"string\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PUT",
    "https://agent.deepgram.com/v1/projects/string/agents/string",
    headers={"Content-Type": "application/json"},
    data='{"metadata":{"additionalProp1":"string"}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"metadata":{"additionalProp1":"string"}}`)
	req, err := http.NewRequestWithContext(ctx, "PUT", "https://agent.deepgram.com/v1/projects/string/agents/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://agent.deepgram.com/v1/projects/string/agents/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"metadata\":{\"additionalProp1\":\"string\"}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://agent.deepgram.com/v1/projects/string/agents/string"))
    .method("PUT", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"metadata\":{\"additionalProp1\":\"string\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://agent.deepgram.com/v1/projects/string/agents/string")
request = Net::HTTPGenericRequest.new("PUT", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"metadata\":{\"additionalProp1\":\"string\"}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://agent.deepgram.com/v1/projects/string/agents/string");
request.Content = new StringContent("{\"metadata\":{\"additionalProp1\":\"string\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "agent_id": "string",
  "config": {},
  "created_at": "2026-06-09T00:00:00Z",
  "metadata": {
    "additionalProp1": "string"
  },
  "updated_at": "2026-06-09T00:00:00Z"
}

{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}