Upload a blueprint file

POST /v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files

Upload a blueprint file

cURL

curl --request POST \
  --url https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=<string>'

import requests

url = "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files', 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.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	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.post("https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/blueprints/{blueprint_id}/files")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

201

{
  "blueprint_id": "<string>",
  "created_at": 123,
  "env_var_name": "<string>",
  "file_id": "<string>",
  "name": "<string>",
  "size_bytes": 123,
  "updated_at": 123
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

Permissions

Requires a service user with the ManageRepoBlueprints permission at the organization level.

Behavior

Uploads a file to the blueprint. Files are referenced in the blueprint YAML and made available during snapshot builds.

Authorizations

Authorization · string · header · required

Service User credential (prefix: cog_)

Path Parameters

blueprint_id · string · required

org_id · string · required

Organization ID (prefix: org-)

Example:

"org-abc123def456"

Query Parameters

name · string · required

Body

multipart/form-data

file · string · required

Response

201

application/json

Successful Response

Public BlueprintFile resource shape.

blueprint_id · string · required

created_at · integer · required

env_var_name · string · required

file_id · string · required

name · string · required

size_bytes · integer · required

updated_at · integer · required