Skip to content
ParseHawkParseHawk Developer Docs

Get a job

GET
/v1/jobs/{job_id}
Code sample: curl
API="${PARSEHAWK_API_URL:-http://127.0.0.1:8000}"
curl --fail --silent --show-error "$API/v1/jobs/job_..." | jq .

Retrieve the current state, result, or failure details for one extraction job.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
job_id
required
Job Id

Immutable job identifier.

string

Immutable job identifier.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
JobResponse

Current state and eventual result of one extraction job.

object
id
required
Id

Immutable job identifier.

string
extractor_id
required
Extractor Id

Immutable extractor identifier used by the job.

string
file_id
required
Any of:
string
source_text
required
Any of:
string
provider_name_used
required
Any of:
ProviderName

The fixed set of model providers ParseHawk ships.

Providers are preconfigured and configurable, not user-creatable, so the name doubles as the stable identifier extractors reference and as the discriminator the engine factory switches on.

string
Allowed values: openai microsoft_foundry openai_compatible_api
model_used
required
Any of:
string
status
required
JobStatus

Current job lifecycle state.

string
Allowed values: queued running completed failed canceling deleting canceled
result
required
Any of:
JobResultResponse

Validated structured output produced by an extraction job.

object
data
required
Data

Result validated against the extractor schema.

object
key
additional properties
any
error
required
Any of:
JobErrorResponse

Terminal extraction error stored with a failed job.

object
message
required
Message

Human-readable failure message.

string
code
required
Code

Stable machine-readable failure code.

string
created_at
required
Created At

UTC creation time.

string format: date-time
started_at
required
Any of:
string format: date-time
completed_at
required
Any of:
string format: date-time
Example
{
  "id": "job_01JZ6QK8M7",
  "provider_name_used": "openai",
  "status": "queued"
}

404

Section titled “404”

The requested ParseHawk resource does not exist.

Media typeapplication/json
ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object
detail
required
Any of:
string
Examplegenerated
{
  "detail": [
    {}
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

500

Section titled “500”

Unexpected server error.

Media typeapplication/json
ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object
detail
required
Any of:
string
Examplegenerated
{
  "detail": [
    {}
  ]
}