/jobs/{id}

Request all information about a specific job.

Get Job Status

GET http://waveline.ai/api/v1/jobs/{id}

Request all information about a specific job.

Path Parameters

Name	Type	Description
id*	String	The id of the job to retrieve.

Headers

Name	Type	Description
Authorization*	String	Bearer <YOUR_API_KEY>

200: OK Response that contains all necessary information about your job.

{
    "id": string,
    "createdAt": string,
    "status": string, // CREATED, RUNNING, FAILED, COMPLETED
    "type": string, // the type of job (e.g. "guess-shape")
    "pages": number, // the number of billed pages
    "fileName": string,
    "result": {...} | null, // The result of your job.
    "urls": {
        "get": string // Query this URL to get the status/result of your job
    }
}

404: Not Found No job with the provided id could be found.

{
    "error": string
}

401: Unauthorized Provided API key is not valid.

{
    "error": string
}

500: Internal Server Error Internal Server error. Please report this to us at [email protected]

{
    "error": string
}

400: Bad Request id is missing.

{
    "error": string
}

Example Usage

After creating a job (either through the extract-document or guess-shape endpoint), you can check its status with a GET request. If the job is finished, the result will be in the result field of the returned JSON.

curl "https://waveline.ai/api/v1/jobs/a5ecc735-c48e-43ea-a739-d42bfb19edb3" \
     -H "Authorization: Bearer YOUR_API_KEY"