Get an archived pitch document
Returns a time-limited signed URL for a snapshot artifact: a write-up (format=pdf|mhtml|md) or a linked attachment (artifact=attachment). Do not pass format and artifact together. By default the response is JSON { url, format, artifact, snapshot, filename, expires_in_seconds } (format or artifact is null depending on which was signed). Pass redirect=1 to receive a 302 to the signed URL instead. disposition controls Content-Disposition on the signed URL: attachment (default) downloads the file, inline opens it in the browser. Yellowbrick Premium is required. Author-paywalled pitches also need the same access as GET /api/v1/pitches/.
curl --request GET \
--url https://www.joinyellowbrick.com/api/v1/pitches/{id}/document \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.joinyellowbrick.com/api/v1/pitches/{id}/document"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.joinyellowbrick.com/api/v1/pitches/{id}/document', 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://www.joinyellowbrick.com/api/v1/pitches/{id}/document",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://www.joinyellowbrick.com/api/v1/pitches/{id}/document"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.joinyellowbrick.com/api/v1/pitches/{id}/document")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.joinyellowbrick.com/api/v1/pitches/{id}/document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"url": "<string>",
"format": "pdf",
"artifact": "attachment",
"snapshot": "<string>",
"filename": "<string>",
"expires_in_seconds": 123
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}Authorizations
Key from Profile. Send Authorization: Bearer yb_....
Path Parameters
Pitch id from the list (pitch_id).
1Query Parameters
Optional. Vercel Protection Bypass for Automation — use when calling the Staging server.
Preferred write-up format. Defaults to the best available (pdf, then mhtml, then md). Mutually exclusive with artifact.
pdf, mhtml, md Snapshot sidecar artifact (not a write-up format). Use attachment for document.attachment.pdf when the archive has one. Mutually exclusive with format.
attachment Archive snapshot id. Defaults to the latest snapshot.
When 1, true, or yes, respond with a 302 to the signed URL instead of JSON.
0, 1, true, false, yes, no Content-Disposition on the signed URL. attachment (default) downloads the file. inline opens it in the browser when the format supports inline display.
attachment, inline Response
Signed document URL
Time-limited signed CloudFront URL.
Write-up format when signing a write-up. Null for artifacts.
pdf, mhtml, md Artifact kind when signing a sidecar. Null for write-ups.
attachment Snapshot id that was signed.
Suggested download filename (also set via Content-Disposition on the signed URL).
Signed URL lifetime in seconds.
x <= 9007199254740991curl --request GET \
--url https://www.joinyellowbrick.com/api/v1/pitches/{id}/document \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.joinyellowbrick.com/api/v1/pitches/{id}/document"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.joinyellowbrick.com/api/v1/pitches/{id}/document', 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://www.joinyellowbrick.com/api/v1/pitches/{id}/document",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://www.joinyellowbrick.com/api/v1/pitches/{id}/document"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.joinyellowbrick.com/api/v1/pitches/{id}/document")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.joinyellowbrick.com/api/v1/pitches/{id}/document")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"url": "<string>",
"format": "pdf",
"artifact": "attachment",
"snapshot": "<string>",
"filename": "<string>",
"expires_in_seconds": 123
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 0,
"detail": "<string>"
}