Set up the onboarding repository
curl --request POST \
--url https://api.runaether.dev/profile/onboarding/repo \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"installation_id": 2,
"repo_url": "<string>",
"env_content": "<string>"
}
'import requests
url = "https://api.runaether.dev/profile/onboarding/repo"
payload = {
"installation_id": 2,
"repo_url": "<string>",
"env_content": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({installation_id: 2, repo_url: '<string>', env_content: '<string>'})
};
fetch('https://api.runaether.dev/profile/onboarding/repo', 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.runaether.dev/profile/onboarding/repo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'installation_id' => 2,
'repo_url' => '<string>',
'env_content' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.runaether.dev/profile/onboarding/repo"
payload := strings.NewReader("{\n \"installation_id\": 2,\n \"repo_url\": \"<string>\",\n \"env_content\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.runaether.dev/profile/onboarding/repo")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"installation_id\": 2,\n \"repo_url\": \"<string>\",\n \"env_content\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.runaether.dev/profile/onboarding/repo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"installation_id\": 2,\n \"repo_url\": \"<string>\",\n \"env_content\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"already_linked": true,
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}Profile
Set up the onboarding repository
Creates the caller's onboarding project for a GitHub repository in their personal organization: the project, its repository link, its env vars and its skill indexing commit in one transaction.
Use this tool when you need to:
- Create the first project during onboarding from the repository the caller picked
- Save the repository's .env content as the project's env vars in the same step
- Repair the onboarding project's link after GitHub was disconnected or the repository renamed, by calling it again for the same repository
Examples:
- POST /profile/onboarding/repo {"repo_url": "acme/widgets", "installation_id": 12345678}
- POST /profile/onboarding/repo {"repo_url": "https://github.com/acme/widgets", "installation_id": 12345678, "env_content": "API_URL=https://api.acme.dev"}
Hints:
- repo_url is required, owner/repo or a GitHub URL: an empty one is refused by the schema with 422, and a non-empty one that does not parse as a repository with 400. installation_id is required: the caller's GitHub App installation that reaches the repository, from listGithubRepos or getGithubRepo. env_content is optional .env text up to 49152 characters, parsed before GitHub is called; malformed content or an invalid key is 400.
- The caller needs push access to the repository, and it must have a commit, be at most 2 GB and have a default branch with no surrounding whitespace, which would name another branch trimmed (400 otherwise, naming the branch). A new project is named after the repository.
- Idempotent: a repeat for the same repository returns the project already linked to it with already_linked true, re-saving the link (repairing one a GitHub disconnect cleared, or following a rename) and upserting the env vars.
- Use launchOnboardingTask next with the returned project_id; use importGithubRepo instead to link a repository to a project outside onboarding.
- The caller, acting in their personal organization: a credential acting in another organization is refused with 403. Refused with 401 when the installation is not the caller's, 404 when the repository is out of the caller's reach, 409 github_reconnect_required, 502 when GitHub fails to answer and 503 when this deployment's GitHub integration is disabled.
POST
/
profile
/
onboarding
/
repo
Set up the onboarding repository
curl --request POST \
--url https://api.runaether.dev/profile/onboarding/repo \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"installation_id": 2,
"repo_url": "<string>",
"env_content": "<string>"
}
'import requests
url = "https://api.runaether.dev/profile/onboarding/repo"
payload = {
"installation_id": 2,
"repo_url": "<string>",
"env_content": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({installation_id: 2, repo_url: '<string>', env_content: '<string>'})
};
fetch('https://api.runaether.dev/profile/onboarding/repo', 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.runaether.dev/profile/onboarding/repo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'installation_id' => 2,
'repo_url' => '<string>',
'env_content' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.runaether.dev/profile/onboarding/repo"
payload := strings.NewReader("{\n \"installation_id\": 2,\n \"repo_url\": \"<string>\",\n \"env_content\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
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.runaether.dev/profile/onboarding/repo")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"installation_id\": 2,\n \"repo_url\": \"<string>\",\n \"env_content\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.runaether.dev/profile/onboarding/repo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"installation_id\": 2,\n \"repo_url\": \"<string>\",\n \"env_content\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"already_linked": true,
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}Authorizations
Body
application/json