Skip to content
Fedwright developers

This is the staging environment's documentation. It is a draft and may change at any time.

Ask about notices

POST
/ask
curl --request POST \
  --url https://api-staging.fedwright.com/v1/ask \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "filters": { "phases": [ "open" ], "setAsidePrograms": [ "sdvosb" ] }, "question": "Which open SDVOSB set-asides for aircraft parts close this month?" }'

Answers one question from the notices Fedwright holds, citing the notices each part of the answer comes from. Each ask stands alone: nothing from an earlier ask is used. As in searchNotices, only open opportunity notices that aren’t archived are searched by default; filters and includeHistory narrow or widen that, and noticeIds or threadId limit the ask to those notices.

When Accept names text/event-stream, the answer streams as server-sent events while it is written. Any other Accept, */* or none included, gets it once, as one JSON AskAnswer with the same content. A stream sends:

  1. retrieval, first: the notices the answer may draw on, and what semantic search did. It comes before any text is written.
  2. For each claim (a sentence of the answer, in order), a text event with its text, then a citation event for each passage that supports it. Text arrives a whole claim at a time.
  3. done, last: the answer’s ID, its status, and its token usage.

Each event’s data is one line of JSON, as AskEvent describes by event name. A comment line (: keep-alive) is sent every 15 seconds while nothing else is. Once the stream has started its status can’t change, so a later failure is an error event (Problem Details) followed by done with status: error.

Refusals come before the stream starts, as ordinary Problem Details: the organization’s AI spending budget (429 ai-budget-exceeded), its premium units for the day (429 premium-quota-exceeded; an ask uses ten), the rate limits (429 rate-limited), the AI provider (503 ai-unavailable), and search readiness for the ask’s scope (503 search-unavailable).

The answer and cited text are plain text, never Markdown or HTML: render them as text. An ask may take up to 90 seconds in all, not the 10 seconds other operations have. It creates nothing, so it takes no Idempotency-Key.

Authorizations

Section titled “Authorizations”
  • oauth2
    ai:use opportunities:read

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

One question, and where to look for its answer. Name at most one of noticeIds and threadId. Unknown properties are rejected.

object
filters

Every filter is optional. Values within one filter are alternatives (OR); different filters must all hold (AND). Free-text array items cannot contain backslashes or control characters.

object
acceptingResponses

When true, include only forecast, presolicitation, and solicitation notices whose current response deadline is after the search time or missing. False or absent applies no filter. Unlike the open phase, this includes Sources Sought and Special Notices in forecast and notices in presolicitation. A date-only deadline ends at midnight after its date in US Eastern time.

boolean
awardAmountMax

Include only notices whose award amount is at most this amount, as a decimal string.

string
/^[0-9]+(\.[0-9]+)?$/
awardAmountMin

Include only notices whose award amount is at least this amount, as a decimal string.

string
/^[0-9]+(\.[0-9]+)?$/
conditions

Enrichment conditions.

Array<string>
<= 100 items
deadlineFrom

Include only notices whose response deadline is at or after this time.

string format: date-time
deadlineTo

Include only notices whose response deadline is at or before this time.

string format: date-time
departments

Department keys.

Array<string>
<= 100 items
firstSeenFrom

Include only notices Fedwright first saw at or after this time. Using this filter leaves out historical notices.

string format: date-time
labels

Enrichment labels.

Array<string>
<= 100 items
naics

NAICS codes at any level, including range sectors such as 31-33. Older-edition codes match their current equivalents.

Array<string>
<= 100 items
noticeTypes

Include only notices of these types.

Array<string>
<= 100 items
Allowed values: Sources Sought Special Notice Presolicitation Consolidate/(Substantially) Bundle Solicitation Combined Synopsis/Solicitation Sale of Surplus Property Modification/Amendment/Cancel Award Notice Justification Justification and Approval (J&A)
phases

Phase is the notice’s stage: Sources Sought and Special Notices are forecast; open and closed apply only to solicitations and use the deadline at the time of the search. Use acceptingResponses to find notices that can still receive a response. archived requires includeHistory: true.

Array<string>
<= 100 items
Allowed values: forecast presolicitation open closed awarded archived
placeCountries

Include only notices whose place of performance is in one of these countries.

Array<string>
<= 100 items
placeStates

Include only notices whose place of performance is in one of these states or territories, by USPS code.

Array<string>
<= 100 items
postedFrom

Include only notices SAM.gov posted at or after this time.

string format: date-time
postedTo

Include only notices SAM.gov posted at or before this time.

string format: date-time
psc

PSC codes at any level, for example 61, 6145, R, R4, or R499.

Array<string>
<= 100 items
setAsideCodes

Include only notices with one of these SAM.gov set-aside codes.

Array<string>
<= 100 items
setAsidePrograms

Include only notices whose set-aside belongs to one of these programs.

Array<string>
<= 100 items
Allowed values: 8a edwosb hubzone indian_enterprise local_area sdvosb small_business vosb wosb
soleSource

When true, include only sole-source notices. When false, include only notices that are not sole-source.

boolean
subTiers

Include only notices from these sub-tier agencies, by the name SAM.gov gives.

Array<string>
<= 100 items
threadId

Opaque thread identifier; use the ID the API returns.

string
/^(N:[0-9a-f]{32}|[A-Z0-9]+:[A-Z0-9]+)$/
includeHistory

Also search award notices, justifications, and archived notices, as searchNotices does.

boolean
noticeIds

Answer from these notices only, such as when asking from a notice’s page.

Array<string>
>= 1 items <= 10 items unique items
question
required

The question, in plain language.

string
>= 1 characters <= 1000 characters
threadId

Answer from this thread’s notices only.

string
/^(N:[0-9a-f]{32}|[A-Z0-9]+:[A-Z0-9]+)$/

Responses

Section titled “Responses”

200

Section titled “200”

The answer: server-sent events when the request accepts text/event-stream, otherwise one JSON body. Either way it is sent with Cache-Control: no-store.

A whole answer, the JSON form of an ask: the stream’s content in one body. text is plain text, the claims in order; each citation’s claim counts the answer’s claims from 0. grounded is false when the answer has text but no valid citation.

object
answerId
required

A UUIDv7.

string format: uuid
citations
required

The notice passages that support the answer’s claims, in answer order.

Array<object>

A notice passage that supports one claim of the answer. citedText is the passage as the notice has it, word for word, in plain text. Only citations Fedwright found in the notice’s text are sent.

object
citedText
required

The supporting passage, word for word as the notice has it, in plain text.

string
claim
required

The claim the passage supports, counted from 0 in answer order.

integer
link
required

The notice’s page.

string format: uri
noticeId
required

SAM.gov NoticeId.

string
/^[0-9a-f]{32}$/
threadId
required

Opaque thread identifier; use the ID the API returns.

string
/^(N:[0-9a-f]{32}|[A-Z0-9]+:[A-Z0-9]+)$/
title
required

The notice’s title.

string
coverage
required

Which notices the ask’s scope includes. full when it includes only fully covered notices: notices whose whole text is indexed in passages for search by meaning. limited when it also includes notices that aren’t, such as archived notices, historical notices, and very long descriptions: their passages are found only when they share the question’s words, and may be missed when they say it another way. Coverage doesn’t say what ran for this ask: when the question can’t be searched by meaning, coverage stays full and semantic says why.

string
Allowed values: full limited
grounded
required

False when the answer has text but no valid citation.

boolean
notices
required

The notices the answer may draw on, in the order they were found.

Array<object>

A notice the answer may draw on.

object
coverage
required

Which notices the ask’s scope includes. full when it includes only fully covered notices: notices whose whole text is indexed in passages for search by meaning. limited when it also includes notices that aren’t, such as archived notices, historical notices, and very long descriptions: their passages are found only when they share the question’s words, and may be missed when they say it another way. Coverage doesn’t say what ran for this ask: when the question can’t be searched by meaning, coverage stays full and semantic says why.

string
Allowed values: full limited
link
required

The notice’s page.

string format: uri
noticeId
required

SAM.gov NoticeId.

string
/^[0-9a-f]{32}$/
threadId
required

Opaque thread identifier; use the ID the API returns.

string
/^(N:[0-9a-f]{32}|[A-Z0-9]+:[A-Z0-9]+)$/
title
required

The notice’s title.

string
semantic
required

What semantic search did for a request. Semantic ranking is best effort: when it can’t run, results come from ranking by words alone, and reason says why. It covers only the notices indexed for it. When applied, model is an opaque version of the ranking, ratio is above 0, and reason is null; otherwise model is null, ratio is 0, and reason says why.

object
applied
required

Whether the results were ranked by meaning as well as by words (a hybrid query).

boolean
model
required

When applied, an opaque version of the semantic ranking used for these results; otherwise null. Compare it, don’t parse it. It changes when the ranking changes.

null | string
ratio
required

The semantic ratio that ran, 0 when not applied.

number
<= 1
reason
required

Null when applied. Otherwise why not:

  • capped: the caller’s or Fedwright’s limit for semantic queries is used up for now.
  • disabled: semantic search is off in this environment.
  • embeddingTimeout: the query couldn’t be prepared in time.
  • embeddingUnavailable: the AI provider that prepares queries is unavailable.
  • emptyQuery: there is no text to rank by meaning.
  • modelMismatch: semantic ranking was unavailable for this query, so it ran by words.
  • notRequested: the ratio is 0.
  • premiumQuota: the organization’s premium units for the day can’t cover a semantic search, or its plan has none, so the query ran by words. It is not an error.
  • semanticSearchUnavailable: the hybrid query failed, so the query ran again by words.
null | string
Allowed values: capped disabled embeddingTimeout embeddingUnavailable emptyQuery modelMismatch notRequested premiumQuota semanticSearchUnavailable
status
required

How the answer ended:

  • complete: the answer is whole.
  • error: it failed; the stream’s error event says why.
  • noEvidence: no notice in the ask’s scope matched, or the model found no answer in the notices that did, so no answer was written. coverage says what that covers.
  • refused: the model declined to answer, so any text already sent is not an answer.
  • truncated: the answer reached its length limit, so it is incomplete.
string
Allowed values: complete error noEvidence refused truncated
text
required

The answer, as plain text. Empty for noEvidence.

string
usage
required

The tokens the answer used, as the AI provider reported them.

object
cacheReadTokens
required

The input tokens the AI provider served from its cache.

integer
inputTokens
required

The input tokens the AI provider reported for the request.

integer
outputTokens
required

The tokens the AI provider generated for the answer.

integer

Examples

Exampledefault

An ask answer

{
  "answerId": "019aa3f2-6d10-7b20-9c4f-7e2d3cad5b12",
  "citations": [
    {
      "citedText": "15--STEP ASSY",
      "claim": 0,
      "link": "https://sam.gov/opp/e6a41be9630d4261b6f3131923fdc4ce/view",
      "noticeId": "e6a41be9630d4261b6f3131923fdc4ce",
      "threadId": "DEPTOFDEFENSE:N0038326QFC09",
      "title": "15--STEP ASSY"
    }
  ],
  "coverage": "full",
  "grounded": true,
  "notices": [
    {
      "coverage": "full",
      "link": "https://sam.gov/opp/e6a41be9630d4261b6f3131923fdc4ce/view",
      "noticeId": "e6a41be9630d4261b6f3131923fdc4ce",
      "threadId": "DEPTOFDEFENSE:N0038326QFC09",
      "title": "15--STEP ASSY"
    }
  ],
  "semantic": {
    "applied": true,
    "model": "model-version-1",
    "ratio": 0.5,
    "reason": null
  },
  "status": "complete",
  "text": "The Navy is buying a step assembly (PSC 1560), with offers due November 2, 2026.",
  "usage": {
    "cacheReadTokens": 0,
    "inputTokens": 5210,
    "outputTokens": 184
  }
}

400

Section titled “400”

The request is malformed, or its schema refuses it: an unknown property, a value of the wrong type or outside its bounds, a limit above 200, or a sort outside the operation’s allow-list (Problem type bad-request). errors names each field by its path, such as nested.note, or $ for the body itself. The request is refused before anything is read or written. A cursor that was altered, has expired, or was issued for other filters, another sort, organization, or user returns Problem type invalid-cursor.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
  "detail": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "instance": "example",
  "limit": "example",
  "resetsAt": "2026-04-15T12:00:00Z",
  "status": 1,
  "title": "example",
  "traceId": "example",
  "type": "https://example.com"
}

401

Section titled “401”

The access token is missing, expired, or invalid.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
  "detail": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "instance": "example",
  "limit": "example",
  "resetsAt": "2026-04-15T12:00:00Z",
  "status": 1,
  "title": "example",
  "traceId": "example",
  "type": "https://example.com"
}

403

Section titled “403”

The Problem type says which check refused the caller, when that is about the caller’s own token, client, or role: insufficient-scope when the token’s scopes (or an MCP grant’s) lack the operation’s scope, with WWW-Authenticate: Bearer error="insufficient_scope", scope="..." (RFC 6750) naming the missing scopes; client-not-allowed when the operation doesn’t admit the caller’s kind of client, such as a machine client calling a user-only operation; and insufficient-role when a confirmed member’s roles don’t allow the action. Any other refusal is the generic forbidden, which says nothing more. Another organization’s resource is 404 (not-found) instead, so no reason confirms that it exists. An owner or administrator who sent no proof of a second factor gets mfa-required. An operation that needs an active subscription, when the organization has none, returns subscription-inactive, or organization-suspended when Fedwright suspended the organization. A suspended organization also refuses invitations, new joins through an invitation, and role changes with organization-suspended. Creating or joining an organization without a verified email returns email-unverified, and accepting an invitation sent to another address returns invitation-email-mismatch. A request from Fedwright’s web or mobile app whose session acts for no organization yet returns organization-required, except on getMe, createOrganization, and acceptInvitation. Shared data needs the acting organization’s own subscription; another organization’s doesn’t count.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
  "detail": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "instance": "example",
  "limit": "example",
  "resetsAt": "2026-04-15T12:00:00Z",
  "status": 1,
  "title": "example",
  "traceId": "example",
  "type": "https://example.com"
}

422

Section titled “422”

The request is well formed and its schema accepts it, but it breaks a rule beyond the schema, such as an unknown NAICS code (Problem type validation-failed, with errors by field path). An Idempotency-Key already used for another request returns idempotency-key-reused.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
  "detail": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "instance": "example",
  "limit": "example",
  "resetsAt": "2026-04-15T12:00:00Z",
  "status": 1,
  "title": "example",
  "traceId": "example",
  "type": "https://example.com"
}

429

Section titled “429”

A rate limit is used up. Direct API access counts against the organization’s burst, daily, and monthly quotas, which all its machine clients share; there is no client quota. A 429 comes in two shapes with two header families, so read the response by what it carries.

A machine client’s calls can get a 429 with an empty body. It has three headers: X-RateLimit-Limit, the exhausted rule’s limit and window, such as 3000, 3000;w=2592000; X-RateLimit-Remaining, what is left in that window (0 on a 429); and X-RateLimit-Reset, the seconds until that window resets. It has no Retry-After, no RateLimit headers, no Problem, and does not name the quota. Read the quota from the window w:

w (seconds) Quota
60 Burst.
86400 Daily.
2592000 Monthly (the calendar month is reported as 30 days; X-RateLimit-Reset is exact).

Wait X-RateLimit-Reset seconds before you retry. Refused requests still count: a client that keeps calling after a 429 keeps adding to the counter, so it does not regain budget inside the window. A tier change takes effect within 10 minutes (checkout, the billing portal, and grants alike), once the client gets a new access token.

Every other 429 has a Problem and Retry-After. The Problem type is rate-limited for a used-up quota, or, for an ask, ai-budget-exceeded or premium-quota-exceeded (below). On rate-limited, Retry-After is the seconds until the used-up limit’s window resets, the latest if several are. The Problem also carries limit, the quota that is used up (the one that resets last, if several are), resetsAt, when it starts again, and traceId. RateLimit-Policy and RateLimit describe only the caller’s own limits, here and on every other response a limit applies to. A request refused with rate-limited uses no quota. One refused after that check, for its scope, role, subscription, or kind of client, still counts, so once a quota is used up such a request gets 429 instead of its 403. A request that fails authentication is not counted. An ask that the organization’s AI spending budget can’t cover returns ai-budget-exceeded instead, with Retry-After at the end of the budget’s window: that budget counts what asks cost, not how many there are. An ask that the organization’s premium units for the day can’t cover returns premium-quota-exceeded, with limit (org-premium-day), resetsAt (the next midnight UTC), and Retry-After. That is the plan’s allowance: a plan with no premium units never covers an ask, and a higher plan may. A refused ask uses no units.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Examples

An ask the premium units can't cover

{
  "limit": "org-premium-day",
  "resetsAt": "2026-11-08T00:00:00Z",
  "status": 429,
  "title": "Too Many Requests",
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
  "type": "https://fedwright.com/problems/premium-quota-exceeded"
}

Headers

Section titled “Headers”
RateLimit
string

For each limit in RateLimit-Policy, the requests r its window still allows and the seconds t until the window resets, such as "org-burst";r=7;t=40, "org-day";r=62;t=41000.

RateLimit-Policy
string

The caller’s rate limits, in the IETF HTTPAPI RateLimit header fields: each limit’s name, its quota q, and its window w in seconds, such as "org-burst";q=20;w=60, "org-day";q=100;w=86400.

Retry-After
integer

Seconds to wait before retrying.

X-RateLimit-Limit
string

On a 429 with an empty body (and on the successful responses that carry these headers), the exhausted rule’s limit and window w in seconds, such as 3000, 3000;w=2592000. The window names the quota: 60 is burst, 86400 is daily, and 2592000 is monthly.

X-RateLimit-Remaining
integer

What is left in that rule’s window (0 on a 429).

X-RateLimit-Reset
integer

Seconds until that rule’s window resets.

503

Section titled “503”

The ask can’t run now, and nothing was charged. The AI provider is unavailable, or Fedwright’s own AI capacity is used up for now (Problem type ai-unavailable); or the search indexes the ask’s scope needs aren’t ready (search-unavailable). Retry after the indicated number of seconds.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
  "detail": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "instance": "example",
  "limit": "example",
  "resetsAt": "2026-04-15T12:00:00Z",
  "status": 1,
  "title": "example",
  "traceId": "example",
  "type": "https://example.com"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.

default

Section titled “default”

Any other error. A request body over 64 KiB returns 413 (payload-too-large), and a request that takes longer than 10 seconds (90 for askOpportunities) returns 503 (request-timeout). An invitation when the API can’t send mail returns 503 (mail-unavailable), and creates nothing. An unexpected failure returns 500 (internal-error) with only type, title, status, and traceId.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
  "detail": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "instance": "example",
  "limit": "example",
  "resetsAt": "2026-04-15T12:00:00Z",
  "status": 1,
  "title": "example",
  "traceId": "example",
  "type": "https://example.com"
}