Skip to main content

​
Endpoint

POST /get/url
Submit a Git repository URL for deployment. The service will clone the repository, upload files to storage, and queue the build process.

​
Request

​
Headers

​
Content-Type
string
required
Must be application/json

​
Body Parameters

​
url
string
required
The Git repository URL to clone and deploy. Supports HTTPS Git URLs.Example: https://github.com/username/repository.git

​
Response

​
Success Response

​
success
boolean
Always true when the deployment is successfully initiated
​
id
string
A unique deployment identifier. Use this ID to reference your deployment.Example: abc123def456

​
Error Response

​
error
string
Error message describing what went wrong

​
Status Codes

  • 200 - Deployment successfully queued
  • 500 - Failed to clone repository (invalid URL, network issues, or private repository)

​
Examples

curl -X POST http://localhost:3000/get/url \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://github.com/username/my-website.git"
  }'

​
Response Examples

​
Successful Deployment

{
  "success": true,
  "id": "abc123def456"
}

​
Error Response

{
  "error": "Failed to clone repository"
}

​
What Happens After Upload

  1. The repository is cloned to the server
  2. All files are uploaded to S3 storage with the deployment ID
  3. The deployment ID is added to a build queue
  4. A build worker processes the deployment asynchronously
The endpoint returns immediately after queueing the deployment. The actual build process happens asynchronously. See Deployment Status for tracking your deployment.

​
Common Errors

ErrorCauseSolution
Failed to clone repositoryInvalid Git URLVerify the repository URL is correct and accessible
Failed to clone repositoryPrivate repositoryEnsure the repository is public or configure authentication
Failed to clone repositoryNetwork timeoutCheck network connectivity and try again
400 Bad RequestMissing url fieldInclude url in the request body

Build docs developers (and LLMs) love

Get started for freeTalk to us