Skip to main content
GET
/
v1
/
jobs
/
{job_id}
cURL
curl --request GET \
  --url https://api.peelapi.com/v1/jobs/{job_id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "portrait_edit",
    "status": "queued",
    "created_at": "2023-11-07T05:31:56Z",
    "input": {},
    "output": "<unknown>",
    "errors": "<unknown>",
    "links": {
      "self": "/v1/jobs/job_123",
      "stream": "/v1/jobs/job_123/stream"
    }
  },
  "errors": "<unknown>"
}
Returns the job metadata, input payload, current output (if any), and navigational links.

​
Path parameters

  • job_id: UUID returned by any write endpoint

​
Example

curl -H "Authorization: Bearer $PEEL_API_KEY" \
  https://api.peelapi.com/v1/jobs/job_123

{
    "data": {
        "type": "portrait",
        "status": "processing",
        "created_at": "2025-10-27T09:05:26.074Z",
        "input": {},
        "output": null,
        "errors": null,
        "links": {
            "self": "/v1/jobs/4ea6bae9-2efe-4d12-bc8e-23bb6c1e3366",
            "stream": "/v1/jobs/4ea6bae9-2efe-4d12-bc8e-23bb6c1e3366/stream"
        }
    },
    "errors": null
}

​
Error codes

  • JOB_ID_REQUIRED: missing job ID
  • JOB_NOT_FOUND: the job does not exist or was not made by your api key
When encountering unexpected issues, the API returns 500 with INTERNAL_ERROR and includes the message in the error payload.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
job_id
string
required

Response

Job response

​
data
object
required
​
errors
unknown