Input schema (JSON)
{
"type": "object",
"title": "search_instancesArguments",
"required": [
"query"
],
"properties": {
"sort": {
"enum": [
"newest",
"most_instances"
],
"type": "string",
"title": "Sort",
"default": "newest",
"description": "newest (default): event date, newest first; on the same day, video sessions before official transcripts. most_instances: most instances first; check order_exact in the response."
},
"query": {
"type": "string",
"title": "Query",
"description": "Words to find. Put an exact phrase in double quotes: \"no tax on tips\". Unquoted words must occur within 8 words of each other."
},
"cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"default": null,
"description": "next_cursor from the previous page of the same search (same query and filters)."
},
"detail": {
"enum": [
"compact",
"full"
],
"type": "string",
"title": "Detail",
"default": "compact",
"description": "compact (default): small pages, passages only. full: the larger pages of the REST API (default 10 videos x 5), with every instance listed one by one as well as in passages."
},
"source": {
"anyOf": [
{
"enum": [
"house_floor_clerk",
"senate_floor_and_committees",
"govinfo_dcpd",
"govinfo_crec",
"us_gov_youtube"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Source",
"default": null,
"description": "Only one source: house_floor_clerk (U.S. House floor), senate_floor_and_committees (U.S. Senate floor and committee hearings), govinfo_dcpd (White House transcripts, no video timing), govinfo_crec (Congressional Record, House and Senate speeches as printed, no video timing) or us_gov_youtube (official U.S. government YouTube channels; see source_caveats). A source can hold nothing yet: govtube_get_coverage lists what each one holds."
},
"date_to": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Date To",
"default": null,
"description": "Latest event date, YYYY-MM-DD."
},
"speaker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Speaker",
"default": null,
"examples": [
"C001053"
],
"description": "Bioguide ID of a member of Congress, e.g. 'C001053' (Rep. Tom Cole). Matches speakers a person has confirmed. Names matched only from the on-screen caption are left out (the result counts them in unreviewed_excluded) unless include_unreviewed is true. Omit to search everyone."
},
"date_from": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Date From",
"default": null,
"description": "Earliest event date, YYYY-MM-DD."
},
"max_videos": {
"anyOf": [
{
"type": "integer",
"maximum": 25,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Max Videos",
"default": null,
"description": "Videos per page, 1 to 25. Default 5, or 10 with detail=\"full\"."
},
"playable_only": {
"type": "boolean",
"title": "Playable Only",
"default": false,
"description": "true: only results with playable video; transcript-only results (no video) are left out and counted in counts.transcript_only."
},
"include_unreviewed": {
"type": "boolean",
"title": "Include Unreviewed",
"default": false,
"description": "With speaker: also return moments where that person was named from the on-screen caption and nobody has reviewed the name yet. They are labelled 'matched from on-screen name, not reviewed'; say so when you quote them."
},
"max_instances_per_video": {
"anyOf": [
{
"type": "integer",
"maximum": 20,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Max Instances Per Video",
"default": null,
"description": "Passages per video, 1 to 20 (with detail=\"full\", also instances). Default 3, or 5 with detail=\"full\"."
}
}
}