cURL
curl --fail-with-body --request POST \
--url "$XPILOT_API_BASE_URL/v1/video-agents/conversations/%3Cconversation_id%3E/stop" \
--header "Authorization: Bearer $XPILOT_API_KEY"const response = await fetch(process.env.XPILOT_API_BASE_URL + "/v1/video-agents/conversations/%3Cconversation_id%3E/stop", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.XPILOT_API_KEY}`,
},
});
const result = await response.json();
if (!response.ok) throw new Error(JSON.stringify(result));
console.log(result);import os, json, requests
response = requests.request(
"POST",
os.environ["XPILOT_API_BASE_URL"] + "/v1/video-agents/conversations/%3Cconversation_id%3E/stop",
headers={
"Authorization": "Bearer " + os.environ["XPILOT_API_KEY"],
},
timeout=70,
)
print(response.status_code, response.text)
response.raise_for_status(){
"data": {
"conversation_id": "<conversation_id>",
"message_id": "<message_id>",
"status": "stopping",
"cost_credits": 12
}
}{
"error": {
"code": "invalid_parameter",
"message": "Check parameter types, required fields and idempotency key."
},
"request_id": "<request_id>"
}{
"error": {
"code": "invalid_token",
"message": "Use an active scoped API Key. MCP OAuth tokens cannot call REST."
},
"request_id": "<request_id>"
}{
"error": {
"code": "insufficient_scope",
"message": "Check the credential scope and resource ownership."
},
"request_id": "<request_id>"
}{
"error": {
"code": "not_found",
"message": "Use an existing owned conversation, message, brand kit or render ID."
},
"request_id": "<request_id>"
}{
"error": {
"code": "idempotency_conflict",
"message": "The same idempotency key must use the exact same input. A conversation may already be busy."
},
"request_id": "<request_id>"
}{
"error": {
"code": "rate_limited",
"message": "Credential/workspace rate or concurrency limit reached. Respect Retry-After before retrying.",
"retry_after": 60
},
"request_id": "<request_id>"
}Video Agent
Stop conversation
Stops the running message (409 not_running when nothing runs). Poll list messages until stopped; cost already incurred may still be charged.
POST
/
v1
/
video-agents
/
conversations
/
{conversation_id}
/
stop
cURL
curl --fail-with-body --request POST \
--url "$XPILOT_API_BASE_URL/v1/video-agents/conversations/%3Cconversation_id%3E/stop" \
--header "Authorization: Bearer $XPILOT_API_KEY"const response = await fetch(process.env.XPILOT_API_BASE_URL + "/v1/video-agents/conversations/%3Cconversation_id%3E/stop", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.XPILOT_API_KEY}`,
},
});
const result = await response.json();
if (!response.ok) throw new Error(JSON.stringify(result));
console.log(result);import os, json, requests
response = requests.request(
"POST",
os.environ["XPILOT_API_BASE_URL"] + "/v1/video-agents/conversations/%3Cconversation_id%3E/stop",
headers={
"Authorization": "Bearer " + os.environ["XPILOT_API_KEY"],
},
timeout=70,
)
print(response.status_code, response.text)
response.raise_for_status(){
"data": {
"conversation_id": "<conversation_id>",
"message_id": "<message_id>",
"status": "stopping",
"cost_credits": 12
}
}{
"error": {
"code": "invalid_parameter",
"message": "Check parameter types, required fields and idempotency key."
},
"request_id": "<request_id>"
}{
"error": {
"code": "invalid_token",
"message": "Use an active scoped API Key. MCP OAuth tokens cannot call REST."
},
"request_id": "<request_id>"
}{
"error": {
"code": "insufficient_scope",
"message": "Check the credential scope and resource ownership."
},
"request_id": "<request_id>"
}{
"error": {
"code": "not_found",
"message": "Use an existing owned conversation, message, brand kit or render ID."
},
"request_id": "<request_id>"
}{
"error": {
"code": "idempotency_conflict",
"message": "The same idempotency key must use the exact same input. A conversation may already be busy."
},
"request_id": "<request_id>"
}{
"error": {
"code": "rate_limited",
"message": "Credential/workspace rate or concurrency limit reached. Respect Retry-After before retrying.",
"retry_after": 60
},
"request_id": "<request_id>"
}Documentation by X-Pilot
This request changes or stops a task. Review the target identifier before sending it.
video_agents:write.
Manage API keys · Authentication and recovery

