Activate Agent Profile

curl --request POST \
  --url https://api.example.com/api/agent-profiles/{profile_id}/activate \
  --header 'X-Access-Token: <api-key>'

import requests

url = "https://api.example.com/api/agent-profiles/{profile_id}/activate"

headers = {"X-Access-Token": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://api.example.com/api/agent-profiles/{profile_id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/agent-profiles/{profile_id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/agent-profiles/{profile_id}/activate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Access-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agent-profiles/{profile_id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "message": "<string>",
  "agent_settings_applied": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Agent Profiles

Activate Agent Profile

Activate a profile for the calling member — pointer only.

Writes the per-member OrgMember.active_agent_profile_id and nothing else (no agent_settings materialization, and the profiles collection itself is untouched — the transaction helper skips the write-back when nothing mutated; #15044 §3). Member-facing, so it requires only VIEW_ORG_SETTINGS (each member picks their own active profile); profile CRUD requires EDIT_ORG_SETTINGS. 404 if no stored profile has that id.

POST

api

agent-profiles

{profile_id}

activate

Activate Agent Profile

curl --request POST \
  --url https://api.example.com/api/agent-profiles/{profile_id}/activate \
  --header 'X-Access-Token: <api-key>'

import requests

url = "https://api.example.com/api/agent-profiles/{profile_id}/activate"

headers = {"X-Access-Token": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-Access-Token': '<api-key>'}};

fetch('https://api.example.com/api/agent-profiles/{profile_id}/activate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/agent-profiles/{profile_id}/activate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Access-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/agent-profiles/{profile_id}/activate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Access-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agent-profiles/{profile_id}/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "message": "<string>",
  "agent_settings_applied": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-Access-Token

string

header

required

Path Parameters

profile_id

string

required

Required string length: 1 - 128

Query Parameters

org_id

string<uuid> | null

Response

Successful Response

string

required

message

string

required

agent_settings_applied

boolean

default:false

OpenHands Cloud

Settings

Integrations

Cloud API

Organizations

Activate Agent Profile

Authorizations

Path Parameters

Query Parameters

Response