Request field
POST/v1/field-requests
Ask for a field; a request the catalog already answers returns the matched field and builds nothing, and any other is queued for people to build, with a status you can track. Needs the write_requests scope.
- scope
- write_requests
- auth
- Bearer key
- operationId
- RequestField
- MCP tool
- request_field
Request body
application/json · FieldRequestCreate · no other fields
| Field | Type | Required | Limits | Holds |
|---|---|---|---|---|
| request | string | yes | 1 to 1000 characters | The field you need, in words. |
Response
200 · FieldRequestResponse. The request, matched or queued.
| Field | Type |
|---|---|
| field_request | object |
Problems
RFC 9457 application/problem+json. An abstention is not one of these: it is a 200.
| HTTP | Code | When |
|---|---|---|
| 400 | INVALID_REQUEST | Malformed JSON, unknown fields, bad filter, limit exceeded |
| 401 | UNAUTHENTICATED | Missing, malformed, or revoked key |
| 403 | FORBIDDEN_SCOPE | The key lacks the required scope |
| 413 | PAYLOAD_TOO_LARGE | Body or upload over the limit |
| 429 | RATE_LIMITED | Rate limit or per-tenant model cap |
| 500 | INTERNAL, POLICY_ASSERT_FAILED, RESPONSE_UNREPLAYABLE | Server fault. The last two also alert |
| 503 | STORE_UNAVAILABLE, LLM_UNAVAILABLE, LOG_UNAVAILABLE | A dependency is down or a budget tripped |
| 504 | TIMEOUT | A deadline was exceeded |
Sample
Request
POST /v1/field-requests
Content-Type: application/json
{
"request": "Whether the Paso Canoas border crossing is open"
}Sample response · GET /v1/samples/field_requests
{
"field_request": {
"id": "freq_06GR5VVKPHW071265X3SWEEW88",
"request": "Whether the Paso Canoas border crossing is open",
"status": "queued",
"matched_field": null,
"similarity": 0.08695652335882187,
"note": "",
"created_at": "2026-10-28T14:34:53.236618Z",
"updated_at": "2026-10-28T14:34:53.236618Z"
}
}