Skip to content
Peritus
API reference · Requests and reports

Get field request

GET/v1/field-requests/{field_request_id}

One of your requests and its status. Needs the write_requests scope.

scope
write_requests
auth
Bearer key
operationId
GetFieldRequest

Parameters

Parameters
FieldInTypeRequiredLimits
field_request_idpathFieldRequestIDyes

Response

200 · FieldRequestResponse. The request and its status.

Response fields
FieldType
field_requestobject

Problems

RFC 9457 application/problem+json. An abstention is not one of these: it is a 200.

Problems
HTTPCodeWhen
400INVALID_REQUESTMalformed JSON, unknown fields, bad filter, limit exceeded
401UNAUTHENTICATEDMissing, malformed, or revoked key
403FORBIDDEN_SCOPEThe key lacks the required scope
404NOT_FOUNDUnknown response, job, document, or reserved route
429RATE_LIMITEDRate limit or per-tenant model cap
500INTERNAL, POLICY_ASSERT_FAILED, RESPONSE_UNREPLAYABLEServer fault. The last two also alert
503STORE_UNAVAILABLE, LLM_UNAVAILABLE, LOG_UNAVAILABLEA dependency is down or a budget tripped
504TIMEOUTA deadline was exceeded