Update YouTube video
PATCH /v1/youtube/videos/:id scope write
Edits the title, description and tags of a video (with dryRun: true it only shows the before and after, without saving).
Headers
Authorization: Bearer praeko_… and X-Praeko-Contract: en. Always send both.Parameters
| Name | In | Description |
|---|---|---|
id |
path | YouTube video id. |
Idempotency-Key |
header | Idempotency key (1 to 255 visible characters, for example a UUID). Repeating the SAME request with the same key within 24 h returns the stored response (with Idempotent-Replayed: true) without running it again; a different request with the same key returns 422 idempotency_key_reuse; a request still in progress returns 409 idempotency_in_progress. 5xx errors are not stored. The key is scoped per workspace and per route. See Retry a request safely. |
Request body
JSON. Required fields must be sent; the others can be left out. At least one of title, description and tags. Start with dryRun: true.
| Field | Type | Description |
|---|---|---|
title (optional) |
string | New title (1 to 100 characters, without < or >). Up to 100 characters. |
description (optional) |
string | New description (up to 5000 characters; "" clears it). Up to 5000 characters. |
tags (optional) |
string[] | New tags (up to 500 characters in total). |
dryRun (optional) |
boolean | true only returns the before and after, without writing to YouTube. Default: false. |
{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}Example
curl -X PATCH "https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ" \
-H "Authorization: Bearer $PRAEKO_KEY" \
-H "X-Praeko-Contract: en" \
-H "Content-Type: application/json" \
-d '{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}'const res = await fetch("https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ", {
method: "PATCH",
headers: {
"Authorization": `Bearer ${process.env.PRAEKO_KEY}`,
"X-Praeko-Contract": "en",
"Content-Type": "application/json",
},
body: JSON.stringify({
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}),
});
console.log(res.status, await res.json());import { Praeko } from "@praeko/sdk";
const praeko = new Praeko({ url: "https://praeko.app", key: process.env.PRAEKO_KEY });
const resultado = await praeko.youtube.editVideo("dQw4w9WgXcQ", {
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
});
console.log(resultado);import os
import requests
resp = requests.patch(
"https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ",
headers={
"Authorization": f"Bearer {os.environ['PRAEKO_KEY']}",
"X-Praeko-Contract": "en",
},
json={
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing",
],
"dryRun": True,
},
)
print(resp.status_code, resp.json())<?php
$corpo = <<<'JSON'
{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}
JSON;
$ch = curl_init('https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("PRAEKO_KEY"),
'X-Praeko-Contract: en',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => $corpo,
]);
$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $resposta, PHP_EOL;
curl_close($ch);package main
import (
"fmt"
"io"
"net/http"
"os"
"strings"
)
func main() {
body := strings.NewReader(`{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}`)
req, err := http.NewRequest("PATCH", "https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("PRAEKO_KEY"))
req.Header.Set("X-Praeko-Contract", "en")
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
out, _ := io.ReadAll(resp.Body)
fmt.Println(resp.Status, string(out))
}require "net/http"
require "uri"
uri = URI("https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer #{ENV['PRAEKO_KEY']}"
request["X-Praeko-Contract"] = "en"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, response.bodyusing System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PRAEKO_KEY"));
request.Headers.Add("X-Praeko-Contract", "en");
request.Content = new StringContent("""
{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}
""", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String body = """
{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ"))
.header("Authorization", "Bearer " + System.getenv("PRAEKO_KEY"))
.header("X-Praeko-Contract", "en")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(body))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}http PATCH "https://praeko.app/v1/youtube/videos/dQw4w9WgXcQ" \
"Authorization: Bearer $PRAEKO_KEY" \
"X-Praeko-Contract: en" \
"Content-Type: application/json" \
--raw='{
"title": "The test that only failed on Mondays",
"tags": [
"programming",
"testing"
],
"dryRun": true
}'Official SDK for NodeInstall it with
npm install @praeko/sdk (see SDK and CLI).No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
No official SDKExample with the language's standard library (or HTTP client). Only the JavaScript SDK exists.
Response
| Success status | When |
|---|---|
200 |
Success. |
{
"id": "dQw4w9WgXcQ",
"before": {
"title": "The failing test",
"description": "",
"tags": []
},
"after": {
"title": "The test that only failed on Mondays",
"description": "",
"tags": [
"programming",
"testing"
]
},
"changed": true,
"written": false
}Errors
| Status | code | When |
|---|---|---|
| 400 | empty_body |
The request body is empty. |
| 400 | invalid_json |
The request body is not a JSON object. |
| 413 | body_too_large |
The request body is larger than 1 MB. |
| 422 | invalid_field |
Title, description or tags over the limit. |
| 409 | youtube_not_connected |
YouTube is not connected. |
| 502 | youtube_error |
YouTube rejected the request. |
| 422 | idempotency_key_reuse |
The Idempotency-Key was already used with a different request (different method, path, query or body). |
| 409 | idempotency_in_progress |
A request with the same Idempotency-Key is still in progress (retry in a moment). |
| 409 | idempotency_response_too_large |
The original response was larger than 256 KB and was not stored; fetch the resource with GET instead. |
Errors on any route
| Status | code | When |
|---|---|---|
| 401 | unauthorized |
The Authorization: Bearer … header is missing. |
| 401 | invalid_api_key |
The key does not exist. |
| 401 | revoked_api_key |
The key has been revoked. |
| 401 | expired_api_key |
The key has expired. |
| 403 | forbidden |
The key's scope is not enough for this route (see the scope badge). |
| 429 | rate_limited |
The per-minute request limit was exceeded. |
The body of every error is { "error": { "code", "message", "details"? } }. See all error codes.
Try it
Try it
Sign in to try itThe live test uses your key and your account. It stays off when you are not signed in.
Question or mistake on this page? contato@praeko.appView .md