Skip to main content

​
Send Your First Request

Get started with PeelAPI by sending your first request:
1

Create an Account

Sign up for a PeelAPI account at the Developer Platform. You’ll get access to your dashboard where you can manage API keys, credits, and usage.
2

Get Your API Key

Navigate to the API Keys section in your dashboard and create your first API key. Copy the key - it starts with sk_live_v1... and you’ll need it for authentication.
3

Buy Credits

Before making requests, you need to purchase credits. Visit the pricing page to choose a credit package, then complete your purchase in the dashboard.
4

Send a POST Request

Choose an endpoint and send a request with your API key:
curl -X POST https://api.peelapi.com/v1/portraits \
  -H "Authorization: Bearer sk_live_v1_your_key_here" \
The API will return a job ID:
{
    "data": {
        "job_id": "job_abc123xyz",
        "links": {
            "job": "/v1/jobs/job_abc123xyz",
            "stream": "/v1/jobs/job_abc123xyz/stream"
        }
    },
    "errors": null
}
Save this job_id - you’ll use it to check the status and retrieve your results.
5

Get Job Results

Use the job ID to check the status:
curl https://api.peelapi.com/v1/jobs/job_abc123xyz \
  -H "Authorization: Bearer sk_live_v1_your_key_here"
When the job completes, you’ll receive your results:
{
  "data": {
    "job_id": "job_abc123xyz",
    "status": "succeeded",
    "outputs": [
      {
        "url": "https://static.peelapi.com/outputs/image1.jpg"
      }
    ]
  },
  "errors": null
}