---
title: "Search Ietf Rfcs"
method: POST
path: "/rfcs/search"
tags: ["rfcs"]
---

# Search Ietf Rfcs

`POST /rfcs/search`

## Request

- Base URL: `https://api.3gppscout.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.3gppscout.com/rfcs/search`
- Auth: none declared

Search the IETF RFCs that 3GPP specs depend on (SIP, SDP, Diameter, SCTP, QUIC, HTTP/2, OAuth, RTP, DetNet, IGP Flex-Algo and more), by meaning and by exact term.

Use when a question is about a protocol the IETF defines and 3GPP references, or when a 3GPP clause says
"as defined in RFC xxxx". The corpus is every RFC a current 3GPP spec cites (obsoleted ones included,
since specs cite them by number) plus the current RFCs of the transport and signalling working groups.
It holds no Internet-Drafts. RFC numbers in the query (for example "RFC 3261") bring in that RFC's passages.
For 3GPP's own text use search_text; this tool never returns 3GPP clauses.

Each result is one passage with its RFC number, title, section number and title, verbatim text, a link to
the section on rfc-editor.org (url), status, obsoleted_by and updated_by, the attribution line to show with
any quote, and cited_by: the 3GPP clauses that name this RFC (read one with get_sections). Call
get_rfc_section for a whole section or an RFC's outline.

Quoting rules: at most 100 words per excerpt and 300 words from one RFC per answer, verbatim, each with its
attribution line.

Errors: 400 `invalid_parameter`, 502 `search_unavailable`.

## Request body

- RfcSearchRequest
  - `query` string, required: What the RFC text should say, in plain words or exact terms, e.g. 'SCTP path failure detection', 'Flex-Algo prefix advertisement', 'RFC 3261 3xx response handling'.
  - `rfcs` integer[], nullable: Only these RFC numbers, e.g. [3261, 3264].
  - `include_obsoleted` boolean: Include RFCs that a later RFC obsoletes. 3GPP specs often cite those by number.
  - `cited_only` boolean: Only RFCs that a current 3GPP spec cites.
  - `top_k` integer: Passages to return.
  - `max_per_rfc` integer: At most this many passages from one RFC. Use 1 for a list of distinct RFCs.
  - `include_text` boolean: Include each passage's text.

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/3gppscout/apis/3gpp-scout-api.md) · [All operations](https://skmtc.dev/3gppscout/apis/3gpp-scout-api/llms.txt) · [OpenAPI document](https://skmtc.dev/3gppscout/apis/3gpp-scout-api/revisions/60bd6896e5b9?raw)