{"openapi":"3.1.0","info":{"title":"AI Power Ups API","version":"0.1.0","description":"AI Power Ups REST API for applications that call explicit search capabilities with typed requests.\n\nFlow: GET /v1/catalog (what is enabled and available) → POST /v1/capabilities/{id}/execute (typed body per capability) → POST /v1/follow-up (next page, changed query, or a record action). Capability execution responses carry charged_credits and balance. Projects routes use their own status/commit_status envelope and durable request IDs; consult projects_status for access and quota.\n\nContract revision: 2026-09-24. Developer documentation: see the servers entry origin's website under /docs.","x-aipa-contract-date":"2026-09-24"},"servers":[{"url":"https://ai-powerups.smalltree.cloud"}],"tags":[{"name":"abilities","description":"Catalog, inspection, execution and follow-up."},{"name":"Web and news","description":"Execute operations: web.search, web.read, news.search."},{"name":"Research and reading","description":"Execute operations: academic.search, scripture.search, classics.search, books.search, patents.search, companies.financials, legal.search, legal.read."},{"name":"Dev","description":"Execute operations: github.search, npm.search, npm.package, npm.downloads, pypi.details, pypi.versions, pypi.downloads, pypi.search."},{"name":"Media and social","description":"Execute operations: music.search, youtube.search, social.search."},{"name":"Travel and places","description":"Execute operations: weather.forecast, navigation.route, navigation.matrix, hotels.search, flights.search, places.search, transit.routes."},{"name":"Commerce and markets","description":"Execute operations: shopping.search, markets.quote, jobs.search, realestate.search, trends.search."},{"name":"Food and fitness","description":"Execute operations: recipes.search, fitness.exercises."},{"name":"sharpen","description":"Second-opinion review of a draft answer."},{"name":"account","description":"Account balance and the Markdown guide."},{"name":"health","description":"Liveness and readiness."}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"apa_live_… API key"}},"schemas":{"ErrorEnvelope":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","retryable"],"properties":{"code":{"anyOf":[{"const":"invalid_request","type":"string"},{"const":"unauthorized","type":"string"},{"const":"credits_exhausted","type":"string"},{"const":"capability_disabled","type":"string"},{"const":"capability_unknown","type":"string"},{"const":"record_unknown","type":"string"},{"const":"session_expired","type":"string"},{"const":"rate_limited","type":"string"},{"const":"provider_error","type":"string"},{"const":"sharpen_no_reviewer","type":"string"},{"const":"capability_unavailable","type":"string"},{"const":"provider_timeout","type":"string"},{"const":"service_unavailable","type":"string"},{"const":"media_stale","type":"string"},{"const":"workout_unavailable","type":"string"},{"const":"provider_allowance","type":"string"},{"const":"not_found","type":"string"},{"const":"internal_error","type":"string"}]},"message":{"type":"string"},"hint":{"type":"string"},"retryable":{"type":"boolean"},"violations":{"type":"array","items":{"$ref":"#/components/schemas/Violation"}},"requestId":{"type":"string"}}}}},"Violation":{"type":"object","required":["path","message"],"properties":{"path":{"description":"JSON pointer to the offending field, or \"\" for the body.","type":"string"},"message":{"type":"string"}}},"Balance":{"type":"object","required":["used","cap","period_end"],"properties":{"used":{"minimum":0,"type":"integer"},"cap":{"minimum":0,"type":"integer"},"period_end":{"anyOf":[{"format":"date-time","type":"string"},{"type":"null"}]}}},"Link":{"type":"object","required":["label","url"],"properties":{"label":{"type":"string"},"url":{"type":"string"}}},"RecordSummary":{"additionalProperties":true,"type":"object","required":["record_id","title"],"properties":{"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}}},"NextStep":{"type":"object","required":["url","actions","example"],"properties":{"url":{"type":"string"},"actions":{"description":"Search actions this capability accepts: \"more\" and/or \"update\", or none.","type":"array","items":{"type":"string"}},"example":{"description":"A follow-up body that is valid right now, or null when this response admits no follow-up (single-result capability without record actions).","anyOf":[{"type":"object","additionalProperties":{}},{"type":"null"}]}}},"ExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RecordSummary"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}}},"FollowUpRequest":{"additionalProperties":false,"type":"object","required":["action"],"properties":{"search_id":{"pattern":"^srch_[0-9A-Za-z]{16}$","type":"string"},"record_id":{"pattern":"^rec_[0-9A-Za-z]{16}$","type":"string"},"action":{"minLength":1,"maxLength":40,"type":"string"},"params":{"type":"object","additionalProperties":{}}}},"RecordFollowUpResponse":{"type":"object","required":["record_id","action","detail","links","charged_credits","balance"],"properties":{"record_id":{"type":"string"},"action":{"type":"string"},"detail":{},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"cached":{"type":"boolean"},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}}},"CatalogCapability":{"type":"object","required":["id","title","summary","topic","enabled","available","typical_credits","inspect_url"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"summary":{"type":"string"},"topic":{"type":"string"},"enabled":{"description":"Enabled on the caller plan.","type":"boolean"},"available":{"description":"False when the vendor key is missing here.","type":"boolean"},"unavailable_reason":{"type":"string"},"typical_credits":{"minimum":0,"type":"integer"},"inspect_url":{"type":"string"}}},"CatalogResponse":{"type":"object","required":["capabilities","sharpen","instructions"],"properties":{"capabilities":{"type":"array","items":{"$ref":"#/components/schemas/CatalogCapability"}},"sharpen":{"type":"object","required":["tier","url","typical_credits","enabled"],"properties":{"tier":{"anyOf":[{"const":"sharpen","type":"string"},{"const":"plus","type":"string"},{"const":"ultra","type":"string"},{"const":"ultra2x","type":"string"}]},"stage":{"anyOf":[{"const":"stock","type":"string"},{"anyOf":[{"const":"stage1","type":"string"},{"const":"stage2","type":"string"},{"const":"stage3","type":"string"},{"const":"stage3+","type":"string"}]}]},"stages":{"type":"array","items":{"type":"object","required":["stage","tier"],"properties":{"stage":{"anyOf":[{"const":"stage1","type":"string"},{"const":"stage2","type":"string"},{"const":"stage3","type":"string"},{"const":"stage3+","type":"string"}]},"tier":{"anyOf":[{"const":"sharpen","type":"string"},{"const":"plus","type":"string"},{"const":"ultra","type":"string"},{"const":"ultra2x","type":"string"}]}}}},"url":{"type":"string"},"typical_credits":{"minimum":0,"type":"integer"},"enabled":{"type":"boolean"}}},"instructions":{"type":"string"}}},"FollowUpDescriptor":{"type":"object","required":["action","scope","description"],"properties":{"action":{"type":"string"},"scope":{"anyOf":[{"const":"search","type":"string"},{"const":"record","type":"string"}]},"description":{"type":"string"},"params_schema":{"type":"object","additionalProperties":{}}}},"CapabilityExample":{"type":"object","required":["title","body"],"properties":{"title":{"type":"string"},"body":{"type":"object","additionalProperties":{}}}},"CapabilityInspectResponse":{"type":"object","required":["id","title","description","available","execute","follow_ups","examples","cost"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"available":{"type":"boolean"},"unavailable_reason":{"type":"string"},"execute":{"type":"object","required":["method","url","body_schema"],"properties":{"method":{"const":"POST","type":"string"},"url":{"type":"string"},"body_schema":{"type":"object","additionalProperties":{}}}},"follow_ups":{"type":"array","items":{"$ref":"#/components/schemas/FollowUpDescriptor"}},"examples":{"type":"array","items":{"$ref":"#/components/schemas/CapabilityExample"}},"cost":{"type":"object","required":["typical_credits","basis"],"properties":{"typical_credits":{"minimum":0,"type":"integer"},"basis":{"type":"string"}}}}},"SharpenRequest":{"additionalProperties":false,"type":"object","required":["task","draft","caller_provider"],"properties":{"task":{"minLength":1,"description":"What the user asked for, verbatim or close.","type":"string"},"context":{"description":"Facts, constraints, data the reviewer needs to judge the draft.","type":"string"},"approach":{"description":"How the draft was produced: assumptions, method, trade-offs.","type":"string"},"draft":{"minLength":1,"description":"The answer to be reviewed.","type":"string"},"caller_provider":{"anyOf":[{"const":"openai","type":"string"},{"const":"anthropic","type":"string"},{"const":"google","type":"string"},{"const":"xai","type":"string"},{"const":"deepseek","type":"string"},{"const":"meta","type":"string"},{"const":"mistral","type":"string"},{"const":"other","type":"string"}]},"stage":{"description":"Stages: stage1 = Stage 1 (sharpen), stage2 = Stage 2 (plus), stage3 = Stage 3 (ultra), stage3+ = Stage 3+ (ultra2x, two independent reviewers). Stock means Sharpen is disabled. Omit stage to use the saved setting; for an explicit request such as \"take it to Stage 3+\", pass stage: \"stage3+\". A per-call stage never changes the saved setting and requires Sharpen to be enabled.","anyOf":[{"const":"stage1","type":"string"},{"const":"stage2","type":"string"},{"const":"stage3","type":"string"},{"const":"stage3+","type":"string"}]}}},"Reviewer":{"type":"object","required":["family","model"],"properties":{"family":{"type":"string"},"model":{"type":"string"}}},"SharpenReview":{"type":"object","required":["reviewer","review"],"properties":{"reviewer":{"$ref":"#/components/schemas/Reviewer"},"review":{"type":"string"}}},"SharpenResponse":{"type":"object","required":["tier","reviews","partial","instruction","charged_credits","balance"],"properties":{"tier":{"anyOf":[{"const":"sharpen","type":"string"},{"const":"plus","type":"string"},{"const":"ultra","type":"string"},{"const":"ultra2x","type":"string"}]},"stage":{"anyOf":[{"const":"stage1","type":"string"},{"const":"stage2","type":"string"},{"const":"stage3","type":"string"},{"const":"stage3+","type":"string"}]},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/SharpenReview"}},"partial":{"type":"boolean"},"routing_note":{"type":"string"},"instruction":{"type":"string"},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}}},"AccountResponse":{"type":"object","required":["plan","status","cadence","credits","sharpen_tier","enabled_capabilities"],"properties":{"plan":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"status":{"anyOf":[{"const":"free","type":"string"},{"const":"active","type":"string"},{"const":"past_due","type":"string"},{"const":"canceled","type":"string"}]},"cadence":{"anyOf":[{"anyOf":[{"const":"monthly","type":"string"},{"const":"annual","type":"string"}]},{"type":"null"}]},"credits":{"$ref":"#/components/schemas/Balance"},"sharpen_tier":{"anyOf":[{"const":"sharpen","type":"string"},{"const":"plus","type":"string"},{"const":"ultra","type":"string"},{"const":"ultra2x","type":"string"}]},"sharpen_stage":{"anyOf":[{"const":"stock","type":"string"},{"anyOf":[{"const":"stage1","type":"string"},{"const":"stage2","type":"string"},{"const":"stage3","type":"string"},{"const":"stage3+","type":"string"}]}]},"enabled_capabilities":{"type":"array","items":{"type":"string"}}}},"HealthResponse":{"type":"object","required":["status","checks","version"],"properties":{"status":{"anyOf":[{"const":"ok","type":"string"},{"const":"degraded","type":"string"}]},"checks":{"type":"object","additionalProperties":{"anyOf":[{"const":"ok","type":"string"},{"const":"failed","type":"string"}]}},"version":{"type":"string"}}},"WebSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"description":"Results per page (1-20).","type":"integer"},"country":{"minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2, e.g. \"gb\".","type":"string"},"language":{"minLength":2,"maxLength":5,"description":"Interface language, e.g. \"en\".","type":"string"},"time_range":{"anyOf":[{"const":"day","type":"string"},{"const":"week","type":"string"},{"const":"month","type":"string"},{"const":"year","type":"string"}]}}},"WebReadRequest":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"minLength":1,"format":"uri","type":"string"},"format":{"default":"markdown","anyOf":[{"const":"markdown","type":"string"},{"const":"text","type":"string"}]},"max_chars":{"minimum":500,"maximum":200000,"default":20000,"description":"Truncate the page content to this many characters.","type":"integer"}}},"AcademicSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"from_year":{"minimum":1000,"maximum":2100,"type":"integer"},"to_year":{"minimum":1000,"maximum":2100,"type":"integer"},"open_access_only":{"default":false,"type":"boolean"},"sort":{"default":"relevance","anyOf":[{"const":"relevance","type":"string"},{"const":"cited","type":"string"},{"const":"recent","type":"string"}]},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"ScriptureSearchRequest":{"additionalProperties":false,"type":"object","required":["text"],"properties":{"text":{"anyOf":[{"const":"bible","type":"string"},{"const":"quran","type":"string"}]},"query":{"minLength":1,"maxLength":300,"description":"Full-text search phrase.","type":"string"},"reference":{"minLength":1,"maxLength":60,"description":"Passage reference: \"John 3:16-18\" for the Bible, \"2:255\" or \"2\" for the Quran.","type":"string"},"translation":{"minLength":1,"maxLength":20,"description":"Bible: Bolls translation code (default KJV; e.g. YLT, WEB, NIV). Quran: quran.com translation id (default 131, The Clear Quran).","type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"ClassicsSearchRequest":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"author":{"minLength":1,"maxLength":200,"type":"string"},"language":{"minLength":2,"maxLength":2,"description":"ISO 639-1 code, e.g. \"en\".","type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"BooksSearchRequest":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"author":{"minLength":1,"maxLength":200,"type":"string"},"subject":{"minLength":1,"maxLength":200,"type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"MusicSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"kind":{"default":"track","anyOf":[{"const":"track","type":"string"},{"const":"artist","type":"string"},{"const":"album","type":"string"}]},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"YoutubeSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"num":{"minimum":1,"maximum":50,"default":10,"description":"Results per page (1-50).","type":"integer"},"published_after":{"format":"date-time","description":"RFC 3339, e.g. \"2025-01-01T00:00:00Z\".","type":"string"},"duration":{"anyOf":[{"const":"short","type":"string"},{"const":"medium","type":"string"},{"const":"long","type":"string"}]}}},"WeatherForecastRequest":{"additionalProperties":false,"type":"object","required":["location"],"properties":{"location":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"days":{"minimum":1,"maximum":16,"default":3,"type":"integer"},"units":{"default":"metric","anyOf":[{"const":"metric","type":"string"},{"const":"imperial","type":"string"}]},"include":{"maxItems":2,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"air_quality","type":"string"},{"const":"marine","type":"string"}]}}}},"NavigationRouteRequest":{"additionalProperties":false,"type":"object","required":["origin","destination"],"properties":{"origin":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"destination":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"waypoints":{"maxItems":10,"type":"array","items":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]}},"mode":{"anyOf":[{"const":"driving","type":"string"},{"const":"walking","type":"string"},{"const":"cycling","type":"string"}]},"alternatives":{"default":false,"type":"boolean"}}},"NavigationMatrixRequest":{"additionalProperties":false,"type":"object","required":["locations"],"properties":{"locations":{"minItems":2,"maxItems":25,"type":"array","items":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]}},"mode":{"anyOf":[{"const":"driving","type":"string"},{"const":"walking","type":"string"},{"const":"cycling","type":"string"}]}}},"HotelsSearchRequest":{"additionalProperties":false,"type":"object","required":["destination","check_in","check_out"],"properties":{"destination":{"minLength":1,"maxLength":200,"type":"string"},"check_in":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Check-in date (YYYY-MM-DD).","type":"string"},"check_out":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Check-out date (YYYY-MM-DD).","type":"string"},"adults":{"minimum":1,"maximum":10,"default":2,"type":"integer"},"children_ages":{"maxItems":5,"description":"Child ages for hotels only; at most six guests including adults. Not supported for explicit vacation-rental searches.","type":"array","items":{"minimum":1,"maximum":17,"type":"integer"}},"currency":{"minLength":3,"maxLength":3,"default":"USD","type":"string"},"max_price":{"minimum":0,"description":"Per night.","type":"number"},"min_rating":{"minimum":0,"maximum":5,"description":"Guest rating floor, 0-5.","type":"number"},"amenities":{"maxItems":10,"type":"array","items":{"minLength":1,"type":"string"}},"property_type":{"anyOf":[{"const":"hotel","type":"string"},{"const":"vacation_rental","type":"string"}]},"sort":{"anyOf":[{"const":"relevance","type":"string"},{"const":"lowest_price","type":"string"},{"const":"highest_rating","type":"string"},{"const":"most_reviewed","type":"string"}]}}},"FlightsSearchRequest":{"additionalProperties":false,"type":"object","required":["origin","destination","departure_date"],"properties":{"origin":{"minLength":3,"maxLength":3,"description":"IATA airport code.","type":"string"},"destination":{"minLength":3,"maxLength":3,"description":"IATA airport code.","type":"string"},"departure_date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Outbound date (YYYY-MM-DD).","type":"string"},"return_date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Return date; omit for one-way (YYYY-MM-DD).","type":"string"},"departure_token":{"minLength":1,"maxLength":16384,"description":"Outbound selection token supplied by flight details; use with its original round-trip query to list return flights.","type":"string"},"adults":{"minimum":1,"maximum":9,"default":1,"type":"integer"},"children":{"minimum":0,"maximum":8,"default":0,"description":"Child passengers; the provider accepts a count, not individual ages. At most 9 passengers in total.","type":"integer"},"infants_in_seat":{"minimum":0,"maximum":8,"default":0,"type":"integer"},"infants_on_lap":{"minimum":0,"maximum":8,"default":0,"type":"integer"},"cabin":{"anyOf":[{"const":"economy","type":"string"},{"const":"premium_economy","type":"string"},{"const":"business","type":"string"},{"const":"first","type":"string"}]},"max_stops":{"minimum":0,"maximum":2,"type":"integer"},"currency":{"minLength":3,"maxLength":3,"default":"USD","type":"string"}}},"GithubSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":300,"description":"GitHub search syntax.","type":"string"},"kind":{"default":"repositories","anyOf":[{"const":"repositories","type":"string"},{"const":"code","type":"string"},{"const":"issues","type":"string"}]},"sort":{"minLength":1,"maxLength":30,"description":"stars | forks | updated (repositories); created | updated | comments (issues).","type":"string"},"num":{"minimum":1,"maximum":30,"default":10,"description":"Results per page (1-30).","type":"integer"}}},"NpmSearchRequest":{"additionalProperties":false,"type":"object","required":["text"],"properties":{"text":{"minLength":1,"maxLength":1000,"description":"npm search text; supports keywords:validation, scope:babel and maintainer:username.","type":"string"},"size":{"minimum":1,"maximum":250,"default":10,"type":"integer"},"from":{"minimum":0,"default":0,"type":"integer"}}},"NpmPackageRequest":{"additionalProperties":false,"type":"object","required":["package"],"properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^(?:@[a-zA-Z0-9_~][a-zA-Z0-9._~-]*/)?[a-zA-Z0-9_~][a-zA-Z0-9._~-]*$","description":"Public npm package name, including scoped names such as @babel/core.","type":"string"},"version":{"minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._+~-]*$","description":"latest, a dist-tag, or an exact version such as 3.23.8. Omit for full metadata and version history.","type":"string"}}},"NpmDownloadsRequest":{"additionalProperties":false,"type":"object","required":["package"],"properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^(?:@[a-zA-Z0-9_~][a-zA-Z0-9._~-]*/)?[a-zA-Z0-9_~][a-zA-Z0-9._~-]*$","description":"Public npm package name, including scoped names such as @babel/core.","type":"string"},"period":{"pattern":"^(last-day|last-week|last-month|last-year|[0-9]{4}-[0-9]{2}-[0-9]{2}(:[0-9]{4}-[0-9]{2}-[0-9]{2})?)$","default":"last-month","description":"Named period, YYYY-MM-DD, or inclusive YYYY-MM-DD:YYYY-MM-DD range (upstream limit: 18 months). last-month is the last 30 available days, not the previous calendar month.","type":"string"},"kind":{"default":"point","description":"point returns a total; range returns daily counts.","anyOf":[{"const":"point","type":"string"},{"const":"range","type":"string"}]}}},"PypiDetailsRequest":{"additionalProperties":false,"type":"object","required":["package"],"properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$","description":"PyPI project name. Case and runs of hyphens, underscores and dots are normalized.","type":"string"},"version":{"minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9.!+_-]*$","description":"Exact published version, e.g. 2.32.3. Omit for the latest version.","type":"string"}}},"PypiVersionsRequest":{"additionalProperties":false,"type":"object","required":["package"],"properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$","description":"PyPI project name. Case and runs of hyphens, underscores and dots are normalized.","type":"string"}}},"PypiDownloadsRequest":{"additionalProperties":false,"type":"object","required":["package"],"properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$","description":"PyPI project name. Case and runs of hyphens, underscores and dots are normalized.","type":"string"},"kind":{"default":"recent","description":"recent: last day/week/month totals. overall: daily history (up to 180 days), excluding known mirrors. Source: PyPI Stats, not the PyPI metadata API.","anyOf":[{"const":"recent","type":"string"},{"const":"overall","type":"string"}]}}},"PypiSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":300,"description":"Discovery query such as Python PDF extraction. Searched through Serper with site:pypi.org/project/.","type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"SocialSearchRequest":{"additionalProperties":false,"type":"object","required":["platform","query"],"properties":{"platform":{"anyOf":[{"const":"x","type":"string"},{"const":"reddit","type":"string"}]},"query":{"minLength":1,"maxLength":300,"type":"string"},"kind":{"default":"posts","anyOf":[{"const":"posts","type":"string"},{"const":"profiles","type":"string"}]},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"ShoppingSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"country":{"pattern":"^[a-zA-Z]{2}$","description":"Search country code; prices use this market’s currency.","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"location":{"minLength":1,"maxLength":200,"type":"string"},"filter_id":{"description":"For follow-up update only: choose a filter id returned by this search; null clears the selection. Query/localization changes clear it. Cannot combine with sort or condition.","anyOf":[{"pattern":"^flt_[a-f0-9-]{36}$","type":"string"},{"type":"null"}]},"num":{"minimum":1,"maximum":25,"default":10,"type":"integer"},"price_min":{"minimum":0,"maximum":100000000,"description":"Minimum item price in the selected country’s currency, excluding delivery.","type":"number"},"price_max":{"minimum":0,"maximum":100000000,"description":"Maximum item price in the selected country’s currency, excluding delivery.","type":"number"},"condition":{"anyOf":[{"const":"new","type":"string"},{"const":"used","type":"string"}]},"sort":{"anyOf":[{"const":"price_low_to_high","type":"string"},{"const":"price_high_to_low","type":"string"},{"const":"rating_high_to_low","type":"string"}]}}},"MarketsQuoteRequest":{"additionalProperties":false,"type":"object","required":["symbol"],"properties":{"symbol":{"minLength":1,"maxLength":80,"pattern":"^[A-Za-z0-9.^:_-]+$","description":"Google Finance instrument, e.g. NVDA:NASDAQ, .DJI:INDEXDJX, VTSAX:MUTF, or BTC-USD.","type":"string"},"window":{"default":"1D","anyOf":[{"const":"1D","type":"string"},{"const":"5D","type":"string"},{"const":"1M","type":"string"},{"const":"6M","type":"string"},{"const":"YTD","type":"string"},{"const":"1Y","type":"string"},{"const":"5Y","type":"string"},{"const":"MAX","type":"string"}]},"language":{"minLength":2,"maxLength":12,"type":"string"}}},"JobsSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"country":{"pattern":"^[a-zA-Z]{2}$","description":"Search country code; prices use this market’s currency.","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"location":{"minLength":1,"maxLength":200,"type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"type":"integer"}}},"PatentsSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"type":"integer"},"countries":{"minItems":1,"maxItems":20,"uniqueItems":true,"type":"array","items":{"pattern":"^[A-Za-z]{2}$","type":"string"}},"status":{"anyOf":[{"const":"GRANT","type":"string"},{"const":"APPLICATION","type":"string"}]},"patent_type":{"anyOf":[{"const":"PATENT","type":"string"},{"const":"DESIGN","type":"string"}]},"inventor":{"minLength":1,"maxLength":250,"type":"string"},"assignee":{"minLength":1,"maxLength":250,"type":"string"},"before":{"pattern":"^(?:(?:priority|filing|publication):)?[0-9]{8}$","description":"YYYYMMDD, optionally prefixed by priority:, filing:, or publication:.","type":"string"},"after":{"pattern":"^(?:(?:priority|filing|publication):)?[0-9]{8}$","description":"YYYYMMDD, optionally prefixed by priority:, filing:, or publication:.","type":"string"},"sort":{"anyOf":[{"const":"relevance","type":"string"},{"const":"new","type":"string"},{"const":"old","type":"string"}]}}},"RealestateSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":300,"description":"US city, state, ZIP code, or neighborhood for Zillow.","type":"string"},"listing_status":{"default":"for_sale","anyOf":[{"const":"for_sale","type":"string"},{"const":"for_rent","type":"string"},{"const":"sold","type":"string"}]},"home_types":{"minItems":1,"maxItems":7,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"house","type":"string"},{"const":"condo","type":"string"},{"const":"townhouse","type":"string"},{"const":"multi_family","type":"string"},{"const":"apartment","type":"string"},{"const":"land","type":"string"},{"const":"manufactured","type":"string"}]}},"min_price":{"minimum":0,"description":"USD asking/sold price, or monthly rent when for_rent.","type":"number"},"max_price":{"minimum":0,"type":"number"},"min_beds":{"minimum":1,"maximum":5,"type":"integer"},"min_baths":{"minimum":1,"maximum":4,"type":"integer"},"sort":{"default":"relevance","anyOf":[{"const":"relevance","type":"string"},{"const":"newest","type":"string"},{"const":"price_asc","type":"string"},{"const":"price_desc","type":"string"},{"const":"beds","type":"string"},{"const":"baths","type":"string"},{"const":"sqft","type":"string"}]},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"NewsSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"country":{"pattern":"^[a-zA-Z]{2}$","type":"string"},"language":{"pattern":"^[a-zA-Z]{2,3}(-[a-zA-Z]{2})?$","type":"string"},"time_range":{"anyOf":[{"const":"day","type":"string"},{"const":"week","type":"string"},{"const":"month","type":"string"},{"const":"year","type":"string"}]},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"TrendsSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":500,"description":"Up to five comma-separated search terms for time series or geography; one term for related queries/topics.","type":"string"},"data_type":{"default":"TIMESERIES","anyOf":[{"const":"TIMESERIES","type":"string"},{"const":"GEO_MAP","type":"string"},{"const":"RELATED_QUERIES","type":"string"},{"const":"RELATED_TOPICS","type":"string"}]},"geo":{"maxLength":30,"pattern":"^[A-Z0-9-]*$","description":"Google Trends geography code; omit for worldwide.","type":"string"},"region":{"anyOf":[{"const":"COUNTRY","type":"string"},{"const":"REGION","type":"string"},{"const":"DMA","type":"string"},{"const":"CITY","type":"string"}]},"category":{"minimum":0,"type":"integer"},"property":{"default":"web","anyOf":[{"const":"web","type":"string"},{"const":"images","type":"string"},{"const":"news","type":"string"},{"const":"froogle","type":"string"},{"const":"youtube","type":"string"}]},"time_range":{"pattern":"^(now (1-H|4-H|1-d|7-d)|today (1-m|3-m|12-m|5-y)|all|[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{4}-[0-9]{2}-[0-9]{2})$","default":"today 12-m","type":"string"},"timezone_offset_minutes":{"minimum":-1439,"maximum":1439,"default":0,"description":"Provider timezone offset in minutes, used to bucket observations; default UTC.","type":"integer"}}},"RecipesSearchRequest":{"additionalProperties":false,"description":"Choose exactly one recipe name query, ingredient, category or cuisine (TheMealDB area). Filters cannot be combined.","oneOf":[{"required":["query"]},{"required":["ingredient"]},{"required":["category"]},{"required":["cuisine"]}],"type":"object","properties":{"query":{"minLength":1,"maxLength":120,"type":"string"},"ingredient":{"minLength":1,"maxLength":120,"type":"string"},"category":{"minLength":1,"maxLength":120,"type":"string"},"cuisine":{"minLength":1,"maxLength":120,"type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"FitnessExercisesRequest":{"additionalProperties":false,"description":"Search exercise demonstrations by words, equipment and muscle. Playable results include a private link to Resources → Workouts in the requesting account.","type":"object","properties":{"query":{"minLength":1,"maxLength":120,"type":"string"},"equipment":{"minLength":1,"maxLength":120,"type":"string"},"muscle":{"minLength":1,"maxLength":120,"type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"PlacesSearchRequest":{"additionalProperties":false,"type":"object","required":["query"],"properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"location":{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}},"radius_m":{"minimum":62,"maximum":50000,"description":"Strict distance from location; requires location and excludes results without coordinates.","type":"number"},"country":{"pattern":"^[A-Za-z]{2}$","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"min_rating":{"minimum":0,"maximum":5,"type":"number"},"open_now":{"description":"Require an explicit open or closed provider state at observation time; unknown states do not qualify.","type":"boolean"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"TransitRoutesRequest":{"additionalProperties":false,"type":"object","required":["origin","destination"],"properties":{"origin":{"anyOf":[{"minLength":1,"maxLength":300,"type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"destination":{"anyOf":[{"minLength":1,"maxLength":300,"type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"time":{"description":"Omit to depart now; source results may supply only local clock labels.","anyOf":[{"additionalProperties":false,"type":"object","required":["mode","at"],"properties":{"mode":{"anyOf":[{"const":"depart_at","type":"string"},{"const":"arrive_by","type":"string"}]},"at":{"maxLength":40,"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?(?:Z|[+-]\\d{2}:\\d{2})$","description":"RFC3339 timestamp with an explicit timezone offset.","type":"string"}}},{"additionalProperties":false,"type":"object","required":["mode"],"properties":{"mode":{"const":"last_available","type":"string"}}}]},"preference":{"default":"best","anyOf":[{"const":"best","type":"string"},{"const":"fewer_transfers","type":"string"},{"const":"less_walking","type":"string"},{"const":"wheelchair_accessible","type":"string"}]},"prefer":{"minItems":1,"maxItems":4,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"bus","type":"string"},{"const":"subway","type":"string"},{"const":"train","type":"string"},{"const":"tram_and_light_rail","type":"string"}]}},"country":{"pattern":"^[A-Za-z]{2}$","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"num":{"minimum":1,"maximum":10,"default":5,"description":"Alternatives per local page. This does not request more routes than the provider supplies.","type":"integer"}}},"CompaniesFinancialsRequest":{"additionalProperties":false,"type":"object","required":["company"],"properties":{"company":{"description":"SEC filer identity. Use CIK for an issuer without a listed ticker.","anyOf":[{"additionalProperties":false,"type":"object","required":["cik"],"properties":{"cik":{"pattern":"^[0-9]{1,10}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["ticker"],"properties":{"ticker":{"pattern":"^[A-Za-z0-9][A-Za-z0-9.-]{0,14}$","type":"string"}}}]},"view":{"default":"filings","anyOf":[{"const":"filings","type":"string"},{"const":"financials","type":"string"},{"const":"revenue_breakdown","type":"string"}]},"accession":{"pattern":"^\\d{10}-\\d{2}-\\d{6}$","description":"Required for a paginated fact view; public SEC accession number.","type":"string"},"forms":{"minItems":1,"maxItems":8,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"10-K","type":"string"},{"const":"10-Q","type":"string"},{"const":"20-F","type":"string"},{"const":"40-F","type":"string"},{"const":"10-K/A","type":"string"},{"const":"10-Q/A","type":"string"},{"const":"20-F/A","type":"string"},{"const":"40-F/A","type":"string"}]}},"filed_from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"filed_to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"num":{"minimum":1,"maximum":10,"default":5,"type":"integer"}}},"LegalSearchRequest":{"additionalProperties":false,"type":"object","required":["search"],"properties":{"search":{"anyOf":[{"additionalProperties":false,"type":"object","required":["jurisdiction","query"],"properties":{"jurisdiction":{"const":"us","type":"string"},"query":{"minLength":1,"maxLength":500,"type":"string"},"courts":{"default":"all","anyOf":[{"const":"all","type":"string"},{"const":"federal","type":"string"},{"const":"state","type":"string"}]},"from_year":{"minimum":1600,"maximum":2100,"type":"integer"},"to_year":{"minimum":1600,"maximum":2100,"type":"integer"}}},{"additionalProperties":false,"type":"object","required":["jurisdiction","query"],"properties":{"jurisdiction":{"const":"eu","type":"string"},"query":{"minLength":1,"maxLength":500,"type":"string"},"kind":{"anyOf":[{"const":"judgment","type":"string"},{"const":"legislation","type":"string"},{"const":"opinion","type":"string"}]},"language":{"default":"EN","anyOf":[{"const":"BG","type":"string"},{"const":"CS","type":"string"},{"const":"DA","type":"string"},{"const":"DE","type":"string"},{"const":"EL","type":"string"},{"const":"EN","type":"string"},{"const":"ES","type":"string"},{"const":"ET","type":"string"},{"const":"FI","type":"string"},{"const":"FR","type":"string"},{"const":"GA","type":"string"},{"const":"HR","type":"string"},{"const":"HU","type":"string"},{"const":"IT","type":"string"},{"const":"LT","type":"string"},{"const":"LV","type":"string"},{"const":"MT","type":"string"},{"const":"NL","type":"string"},{"const":"PL","type":"string"},{"const":"PT","type":"string"},{"const":"RO","type":"string"},{"const":"SK","type":"string"},{"const":"SL","type":"string"},{"const":"SV","type":"string"}]}}}]},"num":{"minimum":1,"maximum":10,"default":3,"type":"integer"}}},"LegalReadRequest":{"additionalProperties":false,"type":"object","required":["document"],"properties":{"document":{"anyOf":[{"additionalProperties":false,"type":"object","required":["source","celex"],"properties":{"source":{"const":"eurlex","type":"string"},"celex":{"pattern":"^[0-9][0-9A-Z()_/-]{5,50}$","description":"Exact CELEX document identifier, e.g.62012CJ0131. Use legal.search for discovery; no case-number guessing.","type":"string"},"language":{"default":"EN","anyOf":[{"const":"BG","type":"string"},{"const":"CS","type":"string"},{"const":"DA","type":"string"},{"const":"DE","type":"string"},{"const":"EL","type":"string"},{"const":"EN","type":"string"},{"const":"ES","type":"string"},{"const":"ET","type":"string"},{"const":"FI","type":"string"},{"const":"FR","type":"string"},{"const":"GA","type":"string"},{"const":"HR","type":"string"},{"const":"HU","type":"string"},{"const":"IT","type":"string"},{"const":"LT","type":"string"},{"const":"LV","type":"string"},{"const":"MT","type":"string"},{"const":"NL","type":"string"},{"const":"PL","type":"string"},{"const":"PT","type":"string"},{"const":"RO","type":"string"},{"const":"SK","type":"string"},{"const":"SL","type":"string"},{"const":"SV","type":"string"}]}}},{"additionalProperties":false,"type":"object","required":["source","item_id"],"properties":{"source":{"const":"us_reports","type":"string"},"item_id":{"pattern":"^usrep[0-9]{6}$","description":"Library of Congress U.S. Reports item, e.g.usrep532514. Text extracted from official PDF; printed pages and PDF indices remain distinct.","type":"string"}}},{"additionalProperties":false,"type":"object","required":["source","caselaw_id"],"properties":{"source":{"const":"scholar","type":"string"},"caselaw_id":{"pattern":"^[0-9]{1,25}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["source","work_id"],"properties":{"source":{"const":"historical","type":"string"},"work_id":{"const":"warren-brandeis-right-to-privacy-1890","type":"string"}}}]},"num":{"minimum":1,"maximum":10,"default":3,"type":"integer"}}},"WebSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"description":"Results per page (1-20).","type":"integer"},"country":{"minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2, e.g. \"gb\".","type":"string"},"language":{"minLength":2,"maxLength":5,"description":"Interface language, e.g. \"en\".","type":"string"},"time_range":{"anyOf":[{"const":"day","type":"string"},{"const":"week","type":"string"},{"const":"month","type":"string"},{"const":"year","type":"string"}]}}},"WebReadUpdateParams":{"additionalProperties":false,"type":"object","properties":{"url":{"minLength":1,"format":"uri","type":"string"},"format":{"default":"markdown","anyOf":[{"const":"markdown","type":"string"},{"const":"text","type":"string"}]},"max_chars":{"minimum":500,"maximum":200000,"default":20000,"description":"Truncate the page content to this many characters.","type":"integer"}}},"AcademicSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"from_year":{"minimum":1000,"maximum":2100,"type":"integer"},"to_year":{"minimum":1000,"maximum":2100,"type":"integer"},"open_access_only":{"default":false,"type":"boolean"},"sort":{"default":"relevance","anyOf":[{"const":"relevance","type":"string"},{"const":"cited","type":"string"},{"const":"recent","type":"string"}]},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"ScriptureSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"text":{"anyOf":[{"const":"bible","type":"string"},{"const":"quran","type":"string"}]},"query":{"minLength":1,"maxLength":300,"description":"Full-text search phrase.","type":"string"},"reference":{"minLength":1,"maxLength":60,"description":"Passage reference: \"John 3:16-18\" for the Bible, \"2:255\" or \"2\" for the Quran.","type":"string"},"translation":{"minLength":1,"maxLength":20,"description":"Bible: Bolls translation code (default KJV; e.g. YLT, WEB, NIV). Quran: quran.com translation id (default 131, The Clear Quran).","type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"ClassicsSearchUpdateParams":{"$ref":"#/components/schemas/ClassicsSearchRequest"},"BooksSearchUpdateParams":{"$ref":"#/components/schemas/BooksSearchRequest"},"MusicSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"kind":{"default":"track","anyOf":[{"const":"track","type":"string"},{"const":"artist","type":"string"},{"const":"album","type":"string"}]},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"YoutubeSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"num":{"minimum":1,"maximum":50,"default":10,"description":"Results per page (1-50).","type":"integer"},"published_after":{"format":"date-time","description":"RFC 3339, e.g. \"2025-01-01T00:00:00Z\".","type":"string"},"duration":{"anyOf":[{"const":"short","type":"string"},{"const":"medium","type":"string"},{"const":"long","type":"string"}]}}},"WeatherForecastUpdateParams":{"additionalProperties":false,"type":"object","properties":{"location":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"days":{"minimum":1,"maximum":16,"default":3,"type":"integer"},"units":{"default":"metric","anyOf":[{"const":"metric","type":"string"},{"const":"imperial","type":"string"}]},"include":{"maxItems":2,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"air_quality","type":"string"},{"const":"marine","type":"string"}]}}}},"NavigationRouteUpdateParams":{"additionalProperties":false,"type":"object","properties":{"origin":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"destination":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"waypoints":{"maxItems":10,"type":"array","items":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]}},"mode":{"anyOf":[{"const":"driving","type":"string"},{"const":"walking","type":"string"},{"const":"cycling","type":"string"}]},"alternatives":{"default":false,"type":"boolean"}}},"NavigationMatrixUpdateParams":{"additionalProperties":false,"type":"object","properties":{"locations":{"minItems":2,"maxItems":25,"type":"array","items":{"anyOf":[{"minLength":1,"description":"Place name or address, geocoded server-side.","type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]}},"mode":{"anyOf":[{"const":"driving","type":"string"},{"const":"walking","type":"string"},{"const":"cycling","type":"string"}]}}},"HotelsSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"destination":{"minLength":1,"maxLength":200,"type":"string"},"check_in":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Check-in date (YYYY-MM-DD).","type":"string"},"check_out":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Check-out date (YYYY-MM-DD).","type":"string"},"adults":{"minimum":1,"maximum":10,"default":2,"type":"integer"},"children_ages":{"maxItems":5,"description":"Child ages for hotels only; at most six guests including adults. Not supported for explicit vacation-rental searches.","type":"array","items":{"minimum":1,"maximum":17,"type":"integer"}},"currency":{"minLength":3,"maxLength":3,"default":"USD","type":"string"},"max_price":{"minimum":0,"description":"Per night.","type":"number"},"min_rating":{"minimum":0,"maximum":5,"description":"Guest rating floor, 0-5.","type":"number"},"amenities":{"maxItems":10,"type":"array","items":{"minLength":1,"type":"string"}},"property_type":{"anyOf":[{"const":"hotel","type":"string"},{"const":"vacation_rental","type":"string"}]},"sort":{"anyOf":[{"const":"relevance","type":"string"},{"const":"lowest_price","type":"string"},{"const":"highest_rating","type":"string"},{"const":"most_reviewed","type":"string"}]}}},"FlightsSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"origin":{"minLength":3,"maxLength":3,"description":"IATA airport code.","type":"string"},"destination":{"minLength":3,"maxLength":3,"description":"IATA airport code.","type":"string"},"departure_date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Outbound date (YYYY-MM-DD).","type":"string"},"return_date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","description":"Return date; omit for one-way (YYYY-MM-DD).","type":"string"},"departure_token":{"minLength":1,"maxLength":16384,"description":"Outbound selection token supplied by flight details; use with its original round-trip query to list return flights.","type":"string"},"adults":{"minimum":1,"maximum":9,"default":1,"type":"integer"},"children":{"minimum":0,"maximum":8,"default":0,"description":"Child passengers; the provider accepts a count, not individual ages. At most 9 passengers in total.","type":"integer"},"infants_in_seat":{"minimum":0,"maximum":8,"default":0,"type":"integer"},"infants_on_lap":{"minimum":0,"maximum":8,"default":0,"type":"integer"},"cabin":{"anyOf":[{"const":"economy","type":"string"},{"const":"premium_economy","type":"string"},{"const":"business","type":"string"},{"const":"first","type":"string"}]},"max_stops":{"minimum":0,"maximum":2,"type":"integer"},"currency":{"minLength":3,"maxLength":3,"default":"USD","type":"string"}}},"GithubSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"description":"GitHub search syntax.","type":"string"},"kind":{"default":"repositories","anyOf":[{"const":"repositories","type":"string"},{"const":"code","type":"string"},{"const":"issues","type":"string"}]},"sort":{"minLength":1,"maxLength":30,"description":"stars | forks | updated (repositories); created | updated | comments (issues).","type":"string"},"num":{"minimum":1,"maximum":30,"default":10,"description":"Results per page (1-30).","type":"integer"}}},"NpmSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"text":{"minLength":1,"maxLength":1000,"description":"npm search text; supports keywords:validation, scope:babel and maintainer:username.","type":"string"},"size":{"minimum":1,"maximum":250,"default":10,"type":"integer"},"from":{"minimum":0,"default":0,"type":"integer"}}},"NpmPackageUpdateParams":{"additionalProperties":false,"type":"object","properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^(?:@[a-zA-Z0-9_~][a-zA-Z0-9._~-]*/)?[a-zA-Z0-9_~][a-zA-Z0-9._~-]*$","description":"Public npm package name, including scoped names such as @babel/core.","type":"string"},"version":{"minLength":1,"maxLength":256,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9._+~-]*$","description":"latest, a dist-tag, or an exact version such as 3.23.8. Omit for full metadata and version history.","type":"string"}}},"NpmDownloadsUpdateParams":{"additionalProperties":false,"type":"object","properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^(?:@[a-zA-Z0-9_~][a-zA-Z0-9._~-]*/)?[a-zA-Z0-9_~][a-zA-Z0-9._~-]*$","description":"Public npm package name, including scoped names such as @babel/core.","type":"string"},"period":{"pattern":"^(last-day|last-week|last-month|last-year|[0-9]{4}-[0-9]{2}-[0-9]{2}(:[0-9]{4}-[0-9]{2}-[0-9]{2})?)$","default":"last-month","description":"Named period, YYYY-MM-DD, or inclusive YYYY-MM-DD:YYYY-MM-DD range (upstream limit: 18 months). last-month is the last 30 available days, not the previous calendar month.","type":"string"},"kind":{"default":"point","description":"point returns a total; range returns daily counts.","anyOf":[{"const":"point","type":"string"},{"const":"range","type":"string"}]}}},"PypiDetailsUpdateParams":{"additionalProperties":false,"type":"object","properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$","description":"PyPI project name. Case and runs of hyphens, underscores and dots are normalized.","type":"string"},"version":{"minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9.!+_-]*$","description":"Exact published version, e.g. 2.32.3. Omit for the latest version.","type":"string"}}},"PypiVersionsUpdateParams":{"additionalProperties":false,"type":"object","properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$","description":"PyPI project name. Case and runs of hyphens, underscores and dots are normalized.","type":"string"}}},"PypiDownloadsUpdateParams":{"additionalProperties":false,"type":"object","properties":{"package":{"minLength":1,"maxLength":214,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$","description":"PyPI project name. Case and runs of hyphens, underscores and dots are normalized.","type":"string"},"kind":{"default":"recent","description":"recent: last day/week/month totals. overall: daily history (up to 180 days), excluding known mirrors. Source: PyPI Stats, not the PyPI metadata API.","anyOf":[{"const":"recent","type":"string"},{"const":"overall","type":"string"}]}}},"PypiSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"description":"Discovery query such as Python PDF extraction. Searched through Serper with site:pypi.org/project/.","type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"SocialSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"platform":{"anyOf":[{"const":"x","type":"string"},{"const":"reddit","type":"string"}]},"query":{"minLength":1,"maxLength":300,"type":"string"},"kind":{"default":"posts","anyOf":[{"const":"posts","type":"string"},{"const":"profiles","type":"string"}]},"num":{"minimum":1,"maximum":25,"default":10,"description":"Results per page (1-25).","type":"integer"}}},"ShoppingSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"country":{"pattern":"^[a-zA-Z]{2}$","description":"Search country code; prices use this market’s currency.","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"location":{"minLength":1,"maxLength":200,"type":"string"},"filter_id":{"description":"For follow-up update only: choose a filter id returned by this search; null clears the selection. Query/localization changes clear it. Cannot combine with sort or condition.","anyOf":[{"pattern":"^flt_[a-f0-9-]{36}$","type":"string"},{"type":"null"}]},"num":{"minimum":1,"maximum":25,"default":10,"type":"integer"},"price_min":{"minimum":0,"maximum":100000000,"description":"Minimum item price in the selected country’s currency, excluding delivery.","type":"number"},"price_max":{"minimum":0,"maximum":100000000,"description":"Maximum item price in the selected country’s currency, excluding delivery.","type":"number"},"condition":{"anyOf":[{"const":"new","type":"string"},{"const":"used","type":"string"}]},"sort":{"anyOf":[{"const":"price_low_to_high","type":"string"},{"const":"price_high_to_low","type":"string"},{"const":"rating_high_to_low","type":"string"}]}}},"MarketsQuoteUpdateParams":{"additionalProperties":false,"type":"object","properties":{"symbol":{"minLength":1,"maxLength":80,"pattern":"^[A-Za-z0-9.^:_-]+$","description":"Google Finance instrument, e.g. NVDA:NASDAQ, .DJI:INDEXDJX, VTSAX:MUTF, or BTC-USD.","type":"string"},"window":{"default":"1D","anyOf":[{"const":"1D","type":"string"},{"const":"5D","type":"string"},{"const":"1M","type":"string"},{"const":"6M","type":"string"},{"const":"YTD","type":"string"},{"const":"1Y","type":"string"},{"const":"5Y","type":"string"},{"const":"MAX","type":"string"}]},"language":{"minLength":2,"maxLength":12,"type":"string"}}},"JobsSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"country":{"pattern":"^[a-zA-Z]{2}$","description":"Search country code; prices use this market’s currency.","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"location":{"minLength":1,"maxLength":200,"type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"type":"integer"}}},"PatentsSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"num":{"minimum":1,"maximum":25,"default":10,"type":"integer"},"countries":{"minItems":1,"maxItems":20,"uniqueItems":true,"type":"array","items":{"pattern":"^[A-Za-z]{2}$","type":"string"}},"status":{"anyOf":[{"const":"GRANT","type":"string"},{"const":"APPLICATION","type":"string"}]},"patent_type":{"anyOf":[{"const":"PATENT","type":"string"},{"const":"DESIGN","type":"string"}]},"inventor":{"minLength":1,"maxLength":250,"type":"string"},"assignee":{"minLength":1,"maxLength":250,"type":"string"},"before":{"pattern":"^(?:(?:priority|filing|publication):)?[0-9]{8}$","description":"YYYYMMDD, optionally prefixed by priority:, filing:, or publication:.","type":"string"},"after":{"pattern":"^(?:(?:priority|filing|publication):)?[0-9]{8}$","description":"YYYYMMDD, optionally prefixed by priority:, filing:, or publication:.","type":"string"},"sort":{"anyOf":[{"const":"relevance","type":"string"},{"const":"new","type":"string"},{"const":"old","type":"string"}]}}},"RealestateSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"description":"US city, state, ZIP code, or neighborhood for Zillow.","type":"string"},"listing_status":{"default":"for_sale","anyOf":[{"const":"for_sale","type":"string"},{"const":"for_rent","type":"string"},{"const":"sold","type":"string"}]},"home_types":{"minItems":1,"maxItems":7,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"house","type":"string"},{"const":"condo","type":"string"},{"const":"townhouse","type":"string"},{"const":"multi_family","type":"string"},{"const":"apartment","type":"string"},{"const":"land","type":"string"},{"const":"manufactured","type":"string"}]}},"min_price":{"minimum":0,"description":"USD asking/sold price, or monthly rent when for_rent.","type":"number"},"max_price":{"minimum":0,"type":"number"},"min_beds":{"minimum":1,"maximum":5,"type":"integer"},"min_baths":{"minimum":1,"maximum":4,"type":"integer"},"sort":{"default":"relevance","anyOf":[{"const":"relevance","type":"string"},{"const":"newest","type":"string"},{"const":"price_asc","type":"string"},{"const":"price_desc","type":"string"},{"const":"beds","type":"string"},{"const":"baths","type":"string"},{"const":"sqft","type":"string"}]},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"NewsSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"type":"string"},"country":{"pattern":"^[a-zA-Z]{2}$","type":"string"},"language":{"pattern":"^[a-zA-Z]{2,3}(-[a-zA-Z]{2})?$","type":"string"},"time_range":{"anyOf":[{"const":"day","type":"string"},{"const":"week","type":"string"},{"const":"month","type":"string"},{"const":"year","type":"string"}]},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"TrendsSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":500,"description":"Up to five comma-separated search terms for time series or geography; one term for related queries/topics.","type":"string"},"data_type":{"default":"TIMESERIES","anyOf":[{"const":"TIMESERIES","type":"string"},{"const":"GEO_MAP","type":"string"},{"const":"RELATED_QUERIES","type":"string"},{"const":"RELATED_TOPICS","type":"string"}]},"geo":{"maxLength":30,"pattern":"^[A-Z0-9-]*$","description":"Google Trends geography code; omit for worldwide.","type":"string"},"region":{"anyOf":[{"const":"COUNTRY","type":"string"},{"const":"REGION","type":"string"},{"const":"DMA","type":"string"},{"const":"CITY","type":"string"}]},"category":{"minimum":0,"type":"integer"},"property":{"default":"web","anyOf":[{"const":"web","type":"string"},{"const":"images","type":"string"},{"const":"news","type":"string"},{"const":"froogle","type":"string"},{"const":"youtube","type":"string"}]},"time_range":{"pattern":"^(now (1-H|4-H|1-d|7-d)|today (1-m|3-m|12-m|5-y)|all|[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{4}-[0-9]{2}-[0-9]{2})$","default":"today 12-m","type":"string"},"timezone_offset_minutes":{"minimum":-1439,"maximum":1439,"default":0,"description":"Provider timezone offset in minutes, used to bucket observations; default UTC.","type":"integer"}}},"RecipesSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":120,"type":"string"},"ingredient":{"minLength":1,"maxLength":120,"type":"string"},"category":{"minLength":1,"maxLength":120,"type":"string"},"cuisine":{"minLength":1,"maxLength":120,"type":"string"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"FitnessExercisesUpdateParams":{"$ref":"#/components/schemas/FitnessExercisesRequest"},"PlacesSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"query":{"minLength":1,"maxLength":300,"type":"string"},"location":{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}},"radius_m":{"minimum":62,"maximum":50000,"description":"Strict distance from location; requires location and excludes results without coordinates.","type":"number"},"country":{"pattern":"^[A-Za-z]{2}$","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"min_rating":{"minimum":0,"maximum":5,"type":"number"},"open_now":{"description":"Require an explicit open or closed provider state at observation time; unknown states do not qualify.","type":"boolean"},"num":{"minimum":1,"maximum":20,"default":10,"type":"integer"}}},"TransitRoutesUpdateParams":{"additionalProperties":false,"type":"object","properties":{"origin":{"anyOf":[{"minLength":1,"maxLength":300,"type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"destination":{"anyOf":[{"minLength":1,"maxLength":300,"type":"string"},{"additionalProperties":false,"type":"object","required":["lat","lon"],"properties":{"lat":{"minimum":-90,"maximum":90,"type":"number"},"lon":{"minimum":-180,"maximum":180,"type":"number"}}}]},"time":{"description":"Omit to depart now; source results may supply only local clock labels.","anyOf":[{"additionalProperties":false,"type":"object","required":["mode","at"],"properties":{"mode":{"anyOf":[{"const":"depart_at","type":"string"},{"const":"arrive_by","type":"string"}]},"at":{"maxLength":40,"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?(?:Z|[+-]\\d{2}:\\d{2})$","description":"RFC3339 timestamp with an explicit timezone offset.","type":"string"}}},{"additionalProperties":false,"type":"object","required":["mode"],"properties":{"mode":{"const":"last_available","type":"string"}}}]},"preference":{"default":"best","anyOf":[{"const":"best","type":"string"},{"const":"fewer_transfers","type":"string"},{"const":"less_walking","type":"string"},{"const":"wheelchair_accessible","type":"string"}]},"prefer":{"minItems":1,"maxItems":4,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"bus","type":"string"},{"const":"subway","type":"string"},{"const":"train","type":"string"},{"const":"tram_and_light_rail","type":"string"}]}},"country":{"pattern":"^[A-Za-z]{2}$","type":"string"},"language":{"minLength":2,"maxLength":12,"type":"string"},"num":{"minimum":1,"maximum":10,"default":5,"description":"Alternatives per local page. This does not request more routes than the provider supplies.","type":"integer"}}},"CompaniesFinancialsUpdateParams":{"additionalProperties":false,"type":"object","properties":{"company":{"description":"SEC filer identity. Use CIK for an issuer without a listed ticker.","anyOf":[{"additionalProperties":false,"type":"object","required":["cik"],"properties":{"cik":{"pattern":"^[0-9]{1,10}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["ticker"],"properties":{"ticker":{"pattern":"^[A-Za-z0-9][A-Za-z0-9.-]{0,14}$","type":"string"}}}]},"view":{"default":"filings","anyOf":[{"const":"filings","type":"string"},{"const":"financials","type":"string"},{"const":"revenue_breakdown","type":"string"}]},"accession":{"pattern":"^\\d{10}-\\d{2}-\\d{6}$","description":"Required for a paginated fact view; public SEC accession number.","type":"string"},"forms":{"minItems":1,"maxItems":8,"uniqueItems":true,"type":"array","items":{"anyOf":[{"const":"10-K","type":"string"},{"const":"10-Q","type":"string"},{"const":"20-F","type":"string"},{"const":"40-F","type":"string"},{"const":"10-K/A","type":"string"},{"const":"10-Q/A","type":"string"},{"const":"20-F/A","type":"string"},{"const":"40-F/A","type":"string"}]}},"filed_from":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"filed_to":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"num":{"minimum":1,"maximum":10,"default":5,"type":"integer"}}},"LegalSearchUpdateParams":{"additionalProperties":false,"type":"object","properties":{"search":{"anyOf":[{"additionalProperties":false,"type":"object","required":["jurisdiction","query"],"properties":{"jurisdiction":{"const":"us","type":"string"},"query":{"minLength":1,"maxLength":500,"type":"string"},"courts":{"default":"all","anyOf":[{"const":"all","type":"string"},{"const":"federal","type":"string"},{"const":"state","type":"string"}]},"from_year":{"minimum":1600,"maximum":2100,"type":"integer"},"to_year":{"minimum":1600,"maximum":2100,"type":"integer"}}},{"additionalProperties":false,"type":"object","required":["jurisdiction","query"],"properties":{"jurisdiction":{"const":"eu","type":"string"},"query":{"minLength":1,"maxLength":500,"type":"string"},"kind":{"anyOf":[{"const":"judgment","type":"string"},{"const":"legislation","type":"string"},{"const":"opinion","type":"string"}]},"language":{"default":"EN","anyOf":[{"const":"BG","type":"string"},{"const":"CS","type":"string"},{"const":"DA","type":"string"},{"const":"DE","type":"string"},{"const":"EL","type":"string"},{"const":"EN","type":"string"},{"const":"ES","type":"string"},{"const":"ET","type":"string"},{"const":"FI","type":"string"},{"const":"FR","type":"string"},{"const":"GA","type":"string"},{"const":"HR","type":"string"},{"const":"HU","type":"string"},{"const":"IT","type":"string"},{"const":"LT","type":"string"},{"const":"LV","type":"string"},{"const":"MT","type":"string"},{"const":"NL","type":"string"},{"const":"PL","type":"string"},{"const":"PT","type":"string"},{"const":"RO","type":"string"},{"const":"SK","type":"string"},{"const":"SL","type":"string"},{"const":"SV","type":"string"}]}}}]},"num":{"minimum":1,"maximum":10,"default":3,"type":"integer"}}},"LegalReadUpdateParams":{"additionalProperties":false,"type":"object","properties":{"document":{"anyOf":[{"additionalProperties":false,"type":"object","required":["source","celex"],"properties":{"source":{"const":"eurlex","type":"string"},"celex":{"pattern":"^[0-9][0-9A-Z()_/-]{5,50}$","description":"Exact CELEX document identifier, e.g.62012CJ0131. Use legal.search for discovery; no case-number guessing.","type":"string"},"language":{"default":"EN","anyOf":[{"const":"BG","type":"string"},{"const":"CS","type":"string"},{"const":"DA","type":"string"},{"const":"DE","type":"string"},{"const":"EL","type":"string"},{"const":"EN","type":"string"},{"const":"ES","type":"string"},{"const":"ET","type":"string"},{"const":"FI","type":"string"},{"const":"FR","type":"string"},{"const":"GA","type":"string"},{"const":"HR","type":"string"},{"const":"HU","type":"string"},{"const":"IT","type":"string"},{"const":"LT","type":"string"},{"const":"LV","type":"string"},{"const":"MT","type":"string"},{"const":"NL","type":"string"},{"const":"PL","type":"string"},{"const":"PT","type":"string"},{"const":"RO","type":"string"},{"const":"SK","type":"string"},{"const":"SL","type":"string"},{"const":"SV","type":"string"}]}}},{"additionalProperties":false,"type":"object","required":["source","item_id"],"properties":{"source":{"const":"us_reports","type":"string"},"item_id":{"pattern":"^usrep[0-9]{6}$","description":"Library of Congress U.S. Reports item, e.g.usrep532514. Text extracted from official PDF; printed pages and PDF indices remain distinct.","type":"string"}}},{"additionalProperties":false,"type":"object","required":["source","caselaw_id"],"properties":{"source":{"const":"scholar","type":"string"},"caselaw_id":{"pattern":"^[0-9]{1,25}$","type":"string"}}},{"additionalProperties":false,"type":"object","required":["source","work_id"],"properties":{"source":{"const":"historical","type":"string"},"work_id":{"const":"warren-brandeis-right-to-privacy-1890","type":"string"}}}]},"num":{"minimum":1,"maximum":10,"default":3,"type":"integer"}}},"WebSearchRecord":{"additionalProperties":true,"description":"Result record of web.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"kind":{"anyOf":[{"const":"organic","type":"string"},{"const":"answer_box","type":"string"},{"const":"knowledge_graph","type":"string"}],"description":"Always present."},"position":{"type":"integer","description":"Present when the source has a value. Organic rank on the provider page."},"date":{"type":"string","description":"Present when the source has a value."},"type":{"type":"string","description":"Present when the source has a value. Knowledge graph."},"attributes":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value. Knowledge graph, provider-shaped."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"WebSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WebSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of web.search; results[] carries its documented record keys."},"WebReadRecord":{"additionalProperties":true,"description":"Result record of web.read: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"content":{"type":"string","description":"Always present. Markdown or plain text, truncated to `max_chars`."},"chars":{"type":"integer","description":"Always present."},"truncated":{"type":"boolean","description":"Always present."},"format":{"anyOf":[{"const":"markdown","type":"string"},{"const":"text","type":"string"}],"description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"WebReadExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WebReadRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of web.read; results[] carries its documented record keys."},"AcademicSearchRecord":{"additionalProperties":true,"description":"Result record of academic.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"year":{"type":"integer","description":"Present when the source has a value."},"venue":{"type":"string","description":"Present when the source has a value."},"authors":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"cited_by":{"type":"integer","description":"Present when the source has a value."},"type":{"type":"string","description":"Present when the source has a value."},"open_access":{"type":"boolean","description":"Present when the source has a value."},"oa_url":{"type":"string","description":"Present when the source has a value."},"doi":{"type":"string","description":"Present when the source has a value."},"openalex_id":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"AcademicSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AcademicSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of academic.search; results[] carries its documented record keys."},"ScriptureSearchRecord":{"additionalProperties":true,"description":"Result record of scripture.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"text":{"type":"string","description":"Always present. The verse text in the requested translation."},"book":{"type":"string","description":"Always present."},"chapter":{"type":"integer","description":"Always present."},"verse":{"type":"integer","description":"Always present."},"translation":{"type":"string","description":"Always present."},"arabic":{"type":"string","description":"Present when the source has a value. Quran only."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"ScriptureSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ScriptureSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of scripture.search; results[] carries its documented record keys."},"ClassicsSearchRecord":{"additionalProperties":true,"description":"Result record of classics.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"source":{"anyOf":[{"const":"gutenberg","type":"string"},{"const":"wikisource","type":"string"}],"description":"Always present."},"authors":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"languages":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"subjects":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"downloads":{"type":"integer","description":"Present when the source has a value."},"words":{"type":"integer","description":"Present when the source has a value."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"ClassicsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ClassicsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of classics.search; results[] carries its documented record keys."},"BooksSearchRecord":{"additionalProperties":true,"description":"Result record of books.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"authors":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"first_published":{"type":"integer","description":"Present when the source has a value."},"editions":{"type":"integer","description":"Present when the source has a value."},"rating":{"type":"number","description":"Present when the source has a value."},"subjects":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"isbn":{"type":"string","description":"Present when the source has a value."},"cover_url":{"type":"string","description":"Present when the source has a value."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"BooksSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BooksSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of books.search; results[] carries its documented record keys."},"MusicSearchRecord":{"additionalProperties":true,"description":"Result record of music.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"kind":{"anyOf":[{"const":"track","type":"string"},{"const":"artist","type":"string"},{"const":"album","type":"string"}],"description":"Always present."},"artist":{"type":"string","description":"Present when the source has a value."},"album":{"type":"string","description":"Present when the source has a value."},"duration":{"type":"string","description":"Present when the source has a value. Formatted m:ss; tracks only."},"explicit":{"type":"boolean","description":"Present when the source has a value."},"preview_url":{"type":"string","description":"Present when the source has a value."},"fans":{"type":"integer","description":"Present when the source has a value. Artists only."},"albums":{"type":"integer","description":"Present when the source has a value. Artists only."},"picture":{"type":"string","description":"Present when the source has a value. Artists only."},"tracks":{"type":"integer","description":"Present when the source has a value. Albums only."},"type":{"type":"string","description":"Present when the source has a value. Albums only."},"cover":{"type":"string","description":"Present when the source has a value. Albums only."},"country":{"type":"string","description":"Present when the source has a value. MusicBrainz fallback."},"disambiguation":{"type":"string","description":"Present when the source has a value. MusicBrainz fallback."},"musicbrainz_id":{"type":"string","description":"Present when the source has a value. MusicBrainz fallback."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"MusicSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/MusicSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of music.search; results[] carries its documented record keys."},"YoutubeSearchRecord":{"additionalProperties":true,"description":"Result record of youtube.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"channel":{"type":"string","description":"Present when the source has a value."},"published_at":{"type":"string","description":"Present when the source has a value."},"thumbnail":{"type":"string","description":"Present when the source has a value."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"YoutubeSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/YoutubeSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of youtube.search; results[] carries its documented record keys."},"WeatherForecastRecord":{"additionalProperties":true,"description":"Result record of weather.forecast: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"attribution":{"type":"string","description":"Always present."},"source_url":{"type":"string","description":"Always present."},"license":{"type":"string","description":"Always present."},"license_url":{"type":"string","description":"Always present."},"location":{"additionalProperties":true,"type":"object","properties":{},"description":"Always present. `name`, `lat`, `lon`, `timezone`, `elevation_m`."},"units":{"additionalProperties":true,"type":"object","properties":{},"description":"Always present. `temperature`, `wind`, `precipitation` unit labels."},"current":{"additionalProperties":true,"type":"object","properties":{},"description":"Always present."},"daily":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Always present. One entry per requested day."},"air_quality":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value. Only with `include: [\"air_quality\"]`."},"marine":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Present when the source has a value. Only with `include: [\"marine\"]` near a coast."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"WeatherForecastExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WeatherForecastRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of weather.forecast; results[] carries its documented record keys."},"NavigationRouteRecord":{"additionalProperties":true,"description":"Result record of navigation.route: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"distance_km":{"type":"number","description":"Always present."},"duration_min":{"type":"number","description":"Always present."},"steps":{"type":"integer","description":"Always present."},"via":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"engine":{"type":"string","description":"Always present."},"attribution":{"type":"string","description":"Always present."},"license":{"type":"string","description":"Always present."},"license_url":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"NavigationRouteExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NavigationRouteRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of navigation.route; results[] carries its documented record keys."},"NavigationMatrixRecord":{"additionalProperties":true,"description":"Result record of navigation.matrix: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"locations":{"type":"array","items":{"type":"string"},"description":"Always present."},"durations_min":{"type":"array","items":{"type":"array","items":{"type":"number"}},"description":"Always present."},"distances_km":{"type":"array","items":{"type":"array","items":{"type":"number"}},"description":"Always present."},"engine":{"type":"string","description":"Always present."},"attribution":{"type":"string","description":"Always present."},"license":{"type":"string","description":"Always present."},"license_url":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"NavigationMatrixExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NavigationMatrixRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of navigation.matrix; results[] carries its documented record keys."},"HotelsSearchRecord":{"additionalProperties":true,"description":"Result record of hotels.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"price_per_night":{"type":"number","description":"Present when the source has a value."},"total_price":{"type":"number","description":"Present when the source has a value."},"currency":{"type":"string","description":"Present when the source has a value."},"rating":{"type":"number","description":"Present when the source has a value."},"reviews":{"type":"integer","description":"Present when the source has a value."},"hotel_class":{"type":"string","description":"Present when the source has a value."},"type":{"type":"string","description":"Present when the source has a value."},"amenities":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"location":{"type":"string","description":"Present when the source has a value."},"lat":{"type":"number","description":"Present when the source has a value."},"lon":{"type":"number","description":"Present when the source has a value."},"requested_occupancy":{"additionalProperties":true,"type":"object","properties":{},"description":"Always present."},"occupancy_status":{"type":"string","description":"Always present."},"occupancy_note":{"type":"string","description":"Present when the source has a value."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"HotelsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/HotelsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of hotels.search; results[] carries its documented record keys."},"FlightsSearchRecord":{"additionalProperties":true,"description":"Result record of flights.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"price":{"type":"number","description":"Present when the source has a value."},"currency":{"type":"string","description":"Always present."},"requested_passengers":{"additionalProperties":true,"type":"object","properties":{},"description":"Always present."},"total_duration":{"type":"string","description":"Present when the source has a value. Formatted, e.g. \"5h 30m\"."},"stops":{"type":"integer","description":"Present when the source has a value."},"layovers":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Present when the source has a value."},"departure":{"type":"string","description":"Present when the source has a value."},"arrival":{"type":"string","description":"Present when the source has a value."},"legs":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Always present."},"emissions_kg":{"type":"number","description":"Present when the source has a value."},"needs_return_selection":{"type":"boolean","description":"Present when the source has a value. Round trips: pick the outbound first."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"FlightsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/FlightsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of flights.search; results[] carries its documented record keys."},"GithubSearchRecord":{"additionalProperties":true,"description":"Result record of github.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"kind":{"anyOf":[{"const":"repository","type":"string"},{"const":"issue","type":"string"},{"const":"pull_request","type":"string"},{"const":"code","type":"string"}],"description":"Always present."},"stars":{"type":"integer","description":"Present when the source has a value. Repositories."},"forks":{"type":"integer","description":"Present when the source has a value. Repositories."},"open_issues":{"type":"integer","description":"Present when the source has a value. Repositories."},"language":{"type":"string","description":"Present when the source has a value. Repositories."},"topics":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value. Repositories."},"created_at":{"type":"string","description":"Present when the source has a value. Issues and pull requests."},"updated_at":{"type":"string","description":"Present when the source has a value."},"archived":{"type":"boolean","description":"Present when the source has a value. Repositories."},"license":{"type":"string","description":"Present when the source has a value. Repositories."},"repo":{"type":"string","description":"Present when the source has a value. Issues and code."},"number":{"type":"integer","description":"Present when the source has a value. Issues."},"state":{"type":"string","description":"Present when the source has a value. Issues."},"author":{"type":"string","description":"Present when the source has a value. Issues."},"comments":{"type":"integer","description":"Present when the source has a value. Issues."},"labels":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value. Issues."},"path":{"type":"string","description":"Present when the source has a value. Code."},"matches":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value. Code."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"GithubSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GithubSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of github.search; results[] carries its documented record keys."},"NpmSearchRecord":{"additionalProperties":true,"description":"Result record of npm.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"version":{"type":"string","description":"Present when the source has a value."},"keywords":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"maintainers":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Present when the source has a value."},"repository":{"type":"string","description":"Present when the source has a value."},"links":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"score":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"search_score":{"type":"number","description":"Present when the source has a value."},"published_at":{"type":"string","description":"Present when the source has a value."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"NpmSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NpmSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of npm.search; results[] carries its documented record keys."},"NpmPackageRecord":{"additionalProperties":true,"description":"Result record of npm.package: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"version":{"type":"string","description":"Present when the source has a value."},"license":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object","properties":{}}],"description":"Present when the source has a value."},"repository":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object","properties":{}}],"description":"Present when the source has a value."},"maintainers":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Present when the source has a value."},"dependencies":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"dist":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"dist_tags":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"version_count":{"type":"integer","description":"Present when the source has a value."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"NpmPackageExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NpmPackageRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of npm.package; results[] carries its documented record keys."},"NpmDownloadsRecord":{"additionalProperties":true,"description":"Result record of npm.downloads: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"kind":{"anyOf":[{"const":"point","type":"string"},{"const":"range","type":"string"}],"description":"Always present."},"start":{"type":"string","description":"Always present."},"end":{"type":"string","description":"Always present."},"downloads":{"anyOf":[{"type":"integer"},{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}}],"description":"Always present. Total, or daily { day, downloads } entries for range."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"NpmDownloadsExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NpmDownloadsRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of npm.downloads; results[] carries its documented record keys."},"PypiDetailsRecord":{"additionalProperties":true,"description":"Result record of pypi.details: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"version":{"type":"string","description":"Always present."},"requires_python":{"type":"string","description":"Present when the source has a value."},"requires_dist":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"license":{"type":"string","description":"Present when the source has a value."},"license_expression":{"type":"string","description":"Present when the source has a value."},"project_urls":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"vulnerabilities":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Present when the source has a value."},"file_count":{"type":"integer","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"PypiDetailsExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PypiDetailsRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of pypi.details; results[] carries its documented record keys."},"PypiVersionsRecord":{"additionalProperties":true,"description":"Result record of pypi.versions: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"versions":{"type":"array","items":{"type":"string"},"description":"Always present."},"version_count":{"type":"integer","description":"Always present."},"file_count":{"type":"integer","description":"Always present."},"source":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"PypiVersionsExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PypiVersionsRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of pypi.versions; results[] carries its documented record keys."},"PypiDownloadsRecord":{"additionalProperties":true,"description":"Result record of pypi.downloads: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"kind":{"anyOf":[{"const":"recent","type":"string"},{"const":"overall","type":"string"}],"description":"Always present."},"source":{"type":"string","description":"Always present."},"data":{"anyOf":[{"additionalProperties":true,"type":"object","properties":{}},{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}}],"description":"Always present."},"fetched_at":{"type":"string","description":"Always present."},"cache_hit":{"type":"boolean","description":"Always present."},"mirrors":{"type":"boolean","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"PypiDownloadsExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PypiDownloadsRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of pypi.downloads; results[] carries its documented record keys."},"PypiSearchRecord":{"additionalProperties":true,"description":"Result record of pypi.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"package":{"type":"string","description":"Always present."},"source":{"type":"string","description":"Always present."},"verified":{"type":"boolean","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"PypiSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PypiSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of pypi.search; results[] carries its documented record keys."},"SocialSearchRecord":{"additionalProperties":true,"description":"Result record of social.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"platform":{"anyOf":[{"const":"x","type":"string"},{"const":"reddit","type":"string"}],"description":"Always present."},"kind":{"anyOf":[{"const":"post","type":"string"},{"const":"profile","type":"string"}],"description":"Always present."},"author":{"type":"string","description":"Present when the source has a value."},"author_name":{"type":"string","description":"Present when the source has a value."},"created_at":{"type":"string","description":"Present when the source has a value."},"likes":{"type":"integer","description":"Present when the source has a value."},"reposts":{"type":"integer","description":"Present when the source has a value."},"replies":{"type":"integer","description":"Present when the source has a value."},"views":{"type":"integer","description":"Present when the source has a value."},"followers":{"type":"integer","description":"Present when the source has a value. Profiles."},"following":{"type":"integer","description":"Present when the source has a value. Profiles."},"posts":{"type":"integer","description":"Present when the source has a value. Profiles."},"verified":{"type":"boolean","description":"Present when the source has a value. Profiles."},"location":{"type":"string","description":"Present when the source has a value. Profiles."},"subreddit":{"type":"string","description":"Present when the source has a value. Reddit."},"score":{"type":"integer","description":"Present when the source has a value. Reddit."},"comments":{"type":"integer","description":"Present when the source has a value. Reddit."},"link_url":{"type":"string","description":"Present when the source has a value. Reddit."},"subscribers":{"type":"integer","description":"Present when the source has a value. Reddit."},"karma":{"type":"integer","description":"Present when the source has a value. Reddit."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"SocialSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SocialSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of social.search; results[] carries its documented record keys."},"ShoppingSearchRecord":{"additionalProperties":true,"description":"Result record of shopping.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"price":{"type":"number","description":"Present when the source has a value."},"price_display":{"type":"string","description":"Present when the source has a value."},"seller":{"type":"string","description":"Present when the source has a value."},"rating":{"type":"number","description":"Present when the source has a value."},"reviews":{"type":"integer","description":"Present when the source has a value."},"delivery":{"type":"string","description":"Present when the source has a value."},"condition":{"type":"string","description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"ShoppingSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ShoppingSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of shopping.search; results[] carries its documented record keys."},"MarketsQuoteRecord":{"additionalProperties":true,"description":"Result record of markets.quote: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"symbol":{"type":"string","description":"Always present."},"exchange":{"type":"string","description":"Present when the source has a value."},"price":{"type":"number","description":"Present when the source has a value."},"currency":{"type":"string","description":"Present when the source has a value."},"observed_at":{"type":"string","description":"Present when the source has a value."},"change":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"MarketsQuoteExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/MarketsQuoteRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of markets.quote; results[] carries its documented record keys."},"JobsSearchRecord":{"additionalProperties":true,"description":"Result record of jobs.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"company":{"type":"string","description":"Present when the source has a value."},"location":{"type":"string","description":"Present when the source has a value."},"posted_at":{"type":"string","description":"Present when the source has a value."},"schedule":{"type":"string","description":"Present when the source has a value."},"salary":{"type":"string","description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"JobsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/JobsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of jobs.search; results[] carries its documented record keys."},"PatentsSearchRecord":{"additionalProperties":true,"description":"Result record of patents.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"publication_number":{"type":"string","description":"Always present."},"priority_date":{"type":"string","description":"Present when the source has a value."},"filing_date":{"type":"string","description":"Present when the source has a value."},"publication_date":{"type":"string","description":"Present when the source has a value."},"inventor":{"type":"string","description":"Present when the source has a value."},"assignee":{"type":"string","description":"Present when the source has a value."},"language":{"type":"string","description":"Present when the source has a value."},"pdf":{"type":"string","description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"PatentsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PatentsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of patents.search; results[] carries its documented record keys."},"RealestateSearchRecord":{"additionalProperties":true,"description":"Result record of realestate.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"street":{"type":"string","description":"Present when the source has a value."},"city":{"type":"string","description":"Present when the source has a value."},"state":{"type":"string","description":"Present when the source has a value."},"zipcode":{"type":"string","description":"Present when the source has a value."},"country":{"type":"string","description":"Present when the source has a value."},"home_type":{"type":"string","description":"Present when the source has a value."},"home_status":{"type":"string","description":"Present when the source has a value."},"status_text":{"type":"string","description":"Present when the source has a value."},"beds":{"type":"number","description":"Present when the source has a value."},"baths":{"type":"number","description":"Present when the source has a value."},"sqft":{"type":"number","description":"Present when the source has a value."},"lot_sqft":{"type":"number","description":"Present when the source has a value."},"lot_area_unit":{"type":"string","description":"Present when the source has a value."},"days_on_zillow":{"type":"number","description":"Present when the source has a value."},"date_price_changed":{"type":"string","description":"Present when the source has a value."},"broker":{"type":"string","description":"Present when the source has a value."},"currency":{"type":"string","description":"Present when the source has a value."},"is_showcase":{"type":"boolean","description":"Present when the source has a value."},"price":{"type":"number","description":"Present when the source has a value. Numeric price extracted by the provider."},"price_label":{"type":"string","description":"Present when the source has a value. Provider display price."},"price_kind":{"anyOf":[{"const":"listing_price","type":"string"},{"const":"monthly_rent","type":"string"},{"const":"reported_sold_price","type":"string"},{"const":"unknown","type":"string"}],"description":"Always present."},"latitude":{"type":"number","description":"Present when the source has a value."},"longitude":{"type":"number","description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"fetched_at":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"RealestateSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RealestateSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of realestate.search; results[] carries its documented record keys."},"NewsSearchRecord":{"additionalProperties":true,"description":"Result record of news.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"publisher":{"type":"string","description":"Present when the source has a value."},"published_label":{"type":"string","description":"Present when the source has a value."},"image_url":{"type":"string","description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"fetched_at":{"type":"string","description":"Always present."},"content_scope":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"NewsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/NewsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of news.search; results[] carries its documented record keys."},"TrendsSearchRecord":{"additionalProperties":true,"description":"Result record of trends.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"data_type":{"type":"string","description":"Always present."},"time_range":{"type":"string","description":"Always present."},"source":{"type":"string","description":"Always present."},"fetched_at":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"TrendsSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TrendsSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of trends.search; results[] carries its documented record keys."},"RecipesSearchRecord":{"additionalProperties":true,"description":"Result record of recipes.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"category":{"type":"string","description":"Present when the source has a value."},"cuisine":{"type":"string","description":"Present when the source has a value."},"attribution":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"RecipesSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RecipesSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of recipes.search; results[] carries its documented record keys."},"FitnessExercisesRecord":{"additionalProperties":true,"description":"Result record of fitness.exercises: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"equipment":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"muscles":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"secondary_muscles":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"attribution":{"type":"string","description":"Always present."},"author":{"type":"string","description":"Present when the source has a value."},"licence":{"additionalProperties":true,"type":"object","properties":{},"description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"FitnessExercisesExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/FitnessExercisesRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of fitness.exercises; results[] carries its documented record keys."},"PlacesSearchRecord":{"additionalProperties":true,"description":"Result record of places.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"address":{"type":"string","description":"Present when the source has a value."},"phone":{"type":"string","description":"Present when the source has a value."},"type":{"type":"string","description":"Present when the source has a value."},"types":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"open_state":{"type":"string","description":"Present when the source has a value."},"hours":{"type":"string","description":"Present when the source has a value."},"website":{"type":"string","description":"Present when the source has a value."},"rating":{"type":"number","description":"Present when the source has a value."},"reviews":{"type":"integer","description":"Present when the source has a value."},"price_level_label":{"type":"string","description":"Present when the source has a value."},"coordinates":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"distance_m":{"type":"number","description":"Present when the source has a value. Only with `location`."},"open_now":{"type":"boolean","description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"fetched_at":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"PlacesSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PlacesSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of places.search; results[] carries its documented record keys."},"TransitRoutesRecord":{"additionalProperties":true,"description":"Result record of transit.routes: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"duration_seconds":{"type":"integer","description":"Present when the source has a value."},"distance_m":{"type":"integer","description":"Present when the source has a value."},"duration_label":{"type":"string","description":"Present when the source has a value."},"distance_label":{"type":"string","description":"Present when the source has a value."},"time_window":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value."},"requested_time":{"type":"string","description":"Present when the source has a value."},"requested_time_status":{"type":"string","description":"Always present."},"lines":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"source":{"type":"string","description":"Always present."},"fetched_at":{"type":"string","description":"Always present."},"realtime_status":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"TransitRoutesExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TransitRoutesRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of transit.routes; results[] carries its documented record keys."},"CompaniesFinancialsRecord":{"additionalProperties":true,"description":"Result record of companies.financials: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"cik":{"type":"string","description":"Always present."},"issuer":{"type":"string","description":"Present when the source has a value. Filings view."},"accession":{"type":"string","description":"Always present."},"form":{"type":"string","description":"Present when the source has a value. Filings view."},"filed_at":{"type":"string","description":"Present when the source has a value. Filings view."},"report_date":{"type":"string","description":"Present when the source has a value. Filings view."},"accepted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Present when the source has a value. Filings view."},"primary_document":{"type":"string","description":"Present when the source has a value. Filings view."},"primary_url":{"type":"string","description":"Present when the source has a value. Filings view."},"is_amendment":{"type":"boolean","description":"Present when the source has a value. Filings view."},"fact_id":{"type":"string","description":"Present when the source has a value. Fact views."},"value":{"anyOf":[{"type":"number"},{"type":"string"}],"description":"Present when the source has a value. Fact views."},"unit":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value. Fact views."},"period":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value. Fact views."},"dimensions":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}},"description":"Present when the source has a value. Fact views."},"source":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"CompaniesFinancialsExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CompaniesFinancialsRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of companies.financials; results[] carries its documented record keys."},"LegalSearchRecord":{"additionalProperties":true,"description":"Result record of legal.search: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"identifier":{"type":"string","description":"Always present."},"source":{"type":"string","description":"Always present."},"source_class":{"type":"string","description":"Always present."},"language":{"type":"string","description":"Present when the source has a value."},"ecli":{"type":"string","description":"Present when the source has a value. EU judgments."},"document_kind":{"type":"string","description":"Present when the source has a value."},"full_text":{"additionalProperties":true,"type":"object","properties":{},"description":"Present when the source has a value. `{ capability: \"legal.read\", params }`, a typed next request."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"LegalSearchExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LegalSearchRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of legal.search; results[] carries its documented record keys."},"LegalReadRecord":{"additionalProperties":true,"description":"Result record of legal.read: the stable base keys plus the documented tier (keys produced by the adapter, omitted when the source has no value).","type":"object","required":["record_id","title"],"properties":{"identifier":{"type":"string","description":"Always present."},"source_class":{"type":"string","description":"Always present."},"language":{"type":"string","description":"Present when the source has a value."},"section":{"type":"integer","description":"Always present."},"total_sections":{"type":"integer","description":"Always present."},"pdf_page":{"type":"integer","description":"Present when the source has a value. PDF sources."},"printed_page":{"type":"string","description":"Present when the source has a value. U.S. Reports."},"paragraph_anchors":{"type":"array","items":{"type":"string"},"description":"Present when the source has a value."},"extraction_method":{"type":"string","description":"Always present."},"record_id":{"type":"string"},"title":{"type":"string"},"url":{"type":"string"},"snippet":{"type":"string"},"workout_resource":{"type":"object","required":["id","url","title","video_available"],"properties":{"id":{"pattern":"^wkt_[0-9A-Za-z]{16}$","type":"string"},"url":{"type":"string"},"title":{"type":"string"},"video_available":{"const":true,"type":"boolean"}}}},"x-aipa-stability":"documented"},"LegalReadExecuteResponse":{"type":"object","required":["search_id","capability","results","result_count","has_more","next","record_actions","charged_credits","balance"],"properties":{"search_id":{"type":"string"},"capability":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/LegalReadRecord"}},"result_count":{"minimum":0,"type":"integer"},"has_more":{"type":"boolean"},"filters":{"type":"array","items":{"type":"object","required":["id","label","group"],"properties":{"id":{"type":"string"},"label":{"type":"string"},"group":{"type":"string"}}}},"next":{"$ref":"#/components/schemas/NextStep"},"record_actions":{"type":"array","items":{"type":"string"}},"notes":{"type":"array","items":{"type":"string"}},"charged_credits":{"minimum":0,"type":"integer"},"balance":{"$ref":"#/components/schemas/Balance"}},"description":"Execute envelope of legal.read; results[] carries its documented record keys."},"YoutubeSearchDetailsDetail":{"additionalProperties":true,"type":"object","properties":{"title":{"type":"string"},"channel":{"type":"string"},"published_at":{"type":"string"},"duration_seconds":{"type":"integer"},"views":{"type":"number"},"likes":{"type":"number"},"comments":{"type":"number"},"description":{"description":"At most 3,000 characters.","type":"string"},"tags":{"maxItems":10,"type":"array","items":{"type":"string"}},"definition":{"type":"string"}},"description":"Detail of the details record action of youtube.search: Video statistics and description from the YouTube Data API; every key omitted when absent.","x-aipa-stability":"documented"},"YoutubeSearchTranscriptDetail":{"additionalProperties":true,"type":"object","required":["language","available_languages","segments","timestamps"],"properties":{"language":{"type":"string"},"available_languages":{"type":"array","items":{"type":"string"}},"segments":{"minimum":0,"description":"Number of source segments.","type":"integer"},"text":{"description":"At most 60,000 characters.","type":"string"},"timestamps":{"maxItems":2000,"type":"array","items":{"additionalProperties":true,"type":"object","required":["start","text"],"properties":{"start":{"description":"Seconds.","type":"number"},"duration":{"description":"Seconds.","type":"number"},"text":{"type":"string"}}}},"timestamps_truncated":{"const":true,"type":"boolean"}},"description":"Detail of the transcript record action of youtube.search: Transcript text with timestamps; $0.004 per video.","x-aipa-stability":"documented"},"NavigationRouteDetailsDetail":{"additionalProperties":true,"type":"object","required":["distance_km","duration_min","steps"],"properties":{"distance_km":{"type":"number"},"duration_min":{"type":"number"},"steps":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["instruction","distance_m","duration_s"],"properties":{"instruction":{"type":"string"},"distance_m":{"type":"number"},"duration_s":{"type":"number"},"name":{"type":"string"}}}},"attribution":{"type":"string"},"license":{"type":"string"},"license_url":{"type":"string"}},"description":"Detail of the details record action of navigation.route: Turn-by-turn steps of the stored route; attribution trio only with OpenRouteService.","x-aipa-stability":"documented"},"FlightsSearchDetailsDetail":{"anyOf":[{"additionalProperties":true,"description":"Booking options (possibly empty with a note).","type":"object","required":["itinerary","requested_passengers","booking_options"],"properties":{"itinerary":{"additionalProperties":true,"type":"object","properties":{}},"requested_passengers":{"additionalProperties":true,"type":"object","properties":{}},"booking_options":{"type":"array","items":{"additionalProperties":true,"type":"object","required":["currency"],"properties":{"book_with":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"fare_type":{"type":"string"},"url":{"type":"string"},"booking_phone":{"type":"string"},"is_split_booking":{"type":"boolean"},"total_price":{"type":"number"},"baggage":{"type":"array","items":{"type":"string"}}}}},"note":{"type":"string"}}},{"additionalProperties":true,"description":"Outbound selected; execute return_search next.","type":"object","required":["itinerary","requested_passengers","note","return_search"],"properties":{"itinerary":{"additionalProperties":true,"type":"object","properties":{}},"requested_passengers":{"additionalProperties":true,"type":"object","properties":{}},"note":{"type":"string"},"return_search":{"additionalProperties":true,"type":"object","required":["capability","params"],"properties":{"capability":{"const":"flights.search","type":"string"},"params":{"additionalProperties":true,"type":"object","properties":{}}}}}}],"description":"Detail of the details record action of flights.search: Either booking options for the itinerary, or (round trips, outbound leg) a typed return_search request at no charge.","x-aipa-stability":"documented"},"CompaniesFinancialsDetailsDetail":{"anyOf":[{"additionalProperties":true,"description":"A filing (filings view).","type":"object","required":["cik","issuer","accession","form","filed_at","report_date","accepted_at","primary_document","source","url"],"properties":{"cik":{"type":"string"},"issuer":{"type":"string"},"accession":{"type":"string"},"form":{"type":"string"},"filed_at":{"type":"string"},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}]},"accepted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary_document":{"type":"string"},"source":{"type":"string"},"url":{"type":"string"},"primary_url":{"type":"string"},"is_amendment":{"type":"boolean"}}},{"additionalProperties":true,"description":"A reported fact (financials / revenue_breakdown views).","type":"object","required":["entity","period","dimensions","concept","label","fact_id","context_id","unit","value","decimals","precision","source_url","duplicate_fact_ids","conflicting_values","cik","accession","source","retrieved_at","content_sha256"],"properties":{"entity":{"type":"object","required":["scheme","identifier"],"properties":{"scheme":{"type":"string"},"identifier":{"type":"string"}}},"period":{"type":"object","required":["start","end","instant"],"properties":{"start":{"anyOf":[{"type":"string"},{"type":"null"}]},"end":{"anyOf":[{"type":"string"},{"type":"null"}]},"instant":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"dimensions":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"concept":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"fact_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"context_id":{"type":"string"},"unit":{"type":"object","required":["numerator","denominator"],"properties":{"numerator":{"type":"array","items":{"type":"string"}},"denominator":{"type":"array","items":{"type":"string"}}}},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"decimals":{"anyOf":[{"type":"string"},{"type":"null"}]},"precision":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_url":{"type":"string"},"duplicate_fact_ids":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}},"conflicting_values":{"type":"boolean"},"cik":{"type":"string"},"accession":{"type":"string"},"source":{"type":"string"},"retrieved_at":{"type":"string"},"content_sha256":{"type":"string"}}}],"description":"Detail of the details record action of companies.financials: Filings view: the stored filing record with SEC index and primary-document URLs. Fact views: the stored fact with its accession and retrieval provenance.","x-aipa-stability":"documented"},"CompaniesFinancialsFinancialsDetail":{"additionalProperties":true,"type":"object","required":["cik","accession","source","source_documents","content_sha256","retrieved_at","extraction_status","facts","fact_count","truncated","continuation","notes"],"properties":{"cik":{"type":"string"},"accession":{"type":"string"},"source":{"type":"string"},"source_documents":{"additionalProperties":true,"type":"object","required":["instance"],"properties":{"instance":{"type":"string"},"labels":{"type":"string"}}},"content_sha256":{"type":"string"},"retrieved_at":{"type":"string"},"extraction_status":{"const":"selected_reported_facts","type":"string"},"facts":{"description":"At most 100; see fact_count and truncated.","type":"array","items":{"additionalProperties":true,"type":"object","required":["entity","period","dimensions","concept","label","fact_id","context_id","unit","value","decimals","precision","source_url","duplicate_fact_ids","conflicting_values"],"properties":{"entity":{"type":"object","required":["scheme","identifier"],"properties":{"scheme":{"type":"string"},"identifier":{"type":"string"}}},"period":{"type":"object","required":["start","end","instant"],"properties":{"start":{"anyOf":[{"type":"string"},{"type":"null"}]},"end":{"anyOf":[{"type":"string"},{"type":"null"}]},"instant":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"dimensions":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"concept":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"fact_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"context_id":{"type":"string"},"unit":{"type":"object","required":["numerator","denominator"],"properties":{"numerator":{"type":"array","items":{"type":"string"}},"denominator":{"type":"array","items":{"type":"string"}}}},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"decimals":{"anyOf":[{"type":"string"},{"type":"null"}]},"precision":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_url":{"type":"string"},"duplicate_fact_ids":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}},"conflicting_values":{"type":"boolean"}}}},"fact_count":{"minimum":0,"type":"integer"},"truncated":{"type":"boolean"},"continuation":{"description":"A typed next request for the paginated fact view of this accession.","type":"object","required":["capability","body"],"properties":{"capability":{"const":"companies.financials","type":"string"},"body":{"additionalProperties":true,"type":"object","properties":{}}}},"notes":{"type":"array","items":{"type":"string"}}},"description":"Detail of the financials record action of companies.financials: Selected reported facts of the accession with units, periods and dimensions.","x-aipa-stability":"documented"},"CompaniesFinancialsRevenueBreakdownDetail":{"additionalProperties":true,"type":"object","required":["cik","accession","source","source_documents","content_sha256","retrieved_at","extraction_status","facts","fact_count","truncated","continuation","notes"],"properties":{"cik":{"type":"string"},"accession":{"type":"string"},"source":{"type":"string"},"source_documents":{"additionalProperties":true,"type":"object","required":["instance"],"properties":{"instance":{"type":"string"},"labels":{"type":"string"}}},"content_sha256":{"type":"string"},"retrieved_at":{"type":"string"},"extraction_status":{"const":"selected_reported_facts","type":"string"},"facts":{"description":"At most 100; see fact_count and truncated.","type":"array","items":{"additionalProperties":true,"type":"object","required":["entity","period","dimensions","concept","label","fact_id","context_id","unit","value","decimals","precision","source_url","duplicate_fact_ids","conflicting_values"],"properties":{"entity":{"type":"object","required":["scheme","identifier"],"properties":{"scheme":{"type":"string"},"identifier":{"type":"string"}}},"period":{"type":"object","required":["start","end","instant"],"properties":{"start":{"anyOf":[{"type":"string"},{"type":"null"}]},"end":{"anyOf":[{"type":"string"},{"type":"null"}]},"instant":{"anyOf":[{"type":"string"},{"type":"null"}]}}},"dimensions":{"type":"array","items":{"additionalProperties":true,"type":"object","properties":{}}},"concept":{"type":"string"},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"fact_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"context_id":{"type":"string"},"unit":{"type":"object","required":["numerator","denominator"],"properties":{"numerator":{"type":"array","items":{"type":"string"}},"denominator":{"type":"array","items":{"type":"string"}}}},"value":{"anyOf":[{"type":"string"},{"type":"null"}]},"decimals":{"anyOf":[{"type":"string"},{"type":"null"}]},"precision":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_url":{"type":"string"},"duplicate_fact_ids":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"null"}]}},"conflicting_values":{"type":"boolean"}}}},"fact_count":{"minimum":0,"type":"integer"},"truncated":{"type":"boolean"},"continuation":{"description":"A typed next request for the paginated fact view of this accession.","type":"object","required":["capability","body"],"properties":{"capability":{"const":"companies.financials","type":"string"},"body":{"additionalProperties":true,"type":"object","properties":{}}}},"notes":{"type":"array","items":{"type":"string"}}},"description":"Detail of the revenue_breakdown record action of companies.financials: Revenue facts by segment, geography and product; overlapping views, not addable.","x-aipa-stability":"documented"},"LegalReadDetailsDetail":{"additionalProperties":true,"description":"Detail of the details record action of legal.read: The complete stored text chunk with document metadata and provenance.","type":"object","required":["title","identifier","source","source_class","language","source_url","retrieved_at","source_sha256","extraction_method","legal_status","text","section","total_sections","complete_document_available_through_more"],"properties":{"title":{"type":"string"},"identifier":{"type":"string"},"source":{"type":"string"},"source_class":{"anyOf":[{"const":"official_publication","type":"string"},{"const":"institutional_transcription","type":"string"},{"const":"reproduction","type":"string"}]},"language":{"type":"string"},"source_url":{"type":"string"},"retrieved_at":{"type":"string"},"source_sha256":{"type":"string"},"extraction_method":{"type":"string"},"legal_status":{"const":"not_assessed","type":"string"},"text":{"type":"string"},"anchors":{"type":"array","items":{"type":"string"}},"pdf_page":{"type":"integer"},"printed_page":{"type":"string"},"section":{"minimum":1,"type":"integer"},"total_sections":{"minimum":1,"type":"integer"},"complete_document_available_through_more":{"const":true,"type":"boolean"}},"x-aipa-stability":"documented"}}},"paths":{"/health/live":{"get":{"operationId":"healthLive","tags":["health"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/health/ready":{"get":{"operationId":"healthReady","tags":["health"],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/v1/catalog":{"get":{"operationId":"getCatalog","tags":["abilities"],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogResponse"}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/capabilities/{id}":{"get":{"operationId":"inspectCapability","tags":["abilities"],"parameters":[{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"path","name":"id","required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapabilityInspectResponse"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/capabilities/{id}/execute":{"post":{"operationId":"executeCapability","tags":["abilities"],"requestBody":{"required":true,"description":"One of the capability request bodies.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/WebSearchRequest"},{"$ref":"#/components/schemas/WebReadRequest"},{"$ref":"#/components/schemas/AcademicSearchRequest"},{"$ref":"#/components/schemas/ScriptureSearchRequest"},{"$ref":"#/components/schemas/ClassicsSearchRequest"},{"$ref":"#/components/schemas/BooksSearchRequest"},{"$ref":"#/components/schemas/MusicSearchRequest"},{"$ref":"#/components/schemas/YoutubeSearchRequest"},{"$ref":"#/components/schemas/WeatherForecastRequest"},{"$ref":"#/components/schemas/NavigationRouteRequest"},{"$ref":"#/components/schemas/NavigationMatrixRequest"},{"$ref":"#/components/schemas/HotelsSearchRequest"},{"$ref":"#/components/schemas/FlightsSearchRequest"},{"$ref":"#/components/schemas/GithubSearchRequest"},{"$ref":"#/components/schemas/NpmSearchRequest"},{"$ref":"#/components/schemas/NpmPackageRequest"},{"$ref":"#/components/schemas/NpmDownloadsRequest"},{"$ref":"#/components/schemas/PypiDetailsRequest"},{"$ref":"#/components/schemas/PypiVersionsRequest"},{"$ref":"#/components/schemas/PypiDownloadsRequest"},{"$ref":"#/components/schemas/PypiSearchRequest"},{"$ref":"#/components/schemas/SocialSearchRequest"},{"$ref":"#/components/schemas/ShoppingSearchRequest"},{"$ref":"#/components/schemas/MarketsQuoteRequest"},{"$ref":"#/components/schemas/JobsSearchRequest"},{"$ref":"#/components/schemas/PatentsSearchRequest"},{"$ref":"#/components/schemas/RealestateSearchRequest"},{"$ref":"#/components/schemas/NewsSearchRequest"},{"$ref":"#/components/schemas/TrendsSearchRequest"},{"$ref":"#/components/schemas/RecipesSearchRequest"},{"$ref":"#/components/schemas/FitnessExercisesRequest"},{"$ref":"#/components/schemas/PlacesSearchRequest"},{"$ref":"#/components/schemas/TransitRoutesRequest"},{"$ref":"#/components/schemas/CompaniesFinancialsRequest"},{"$ref":"#/components/schemas/LegalSearchRequest"},{"$ref":"#/components/schemas/LegalReadRequest"}]}}}},"parameters":[{"schema":{"minLength":1,"maxLength":64,"type":"string"},"in":"path","name":"id","required":true}],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"summary":"Execute any capability by id","description":"Dynamic form of the per-capability execute operations below. The body must match the request schema of the capability named in the path; unknown keys are rejected with 400 invalid_request."}},"/v1/capabilities/web.search/execute":{"post":{"tags":["Web and news"],"operationId":"executeWebSearch","summary":"Web search","description":"Runs a Google web search and returns organic results with title, url and snippet, plus any answer box or knowledge graph. Follow up with `read` on a record to fetch the page as markdown.\n\nTypical credits: 1. Cost basis: $0.001 per Serper credit; 1 credit per page of results.\n\nRules enforced after schema validation (400 invalid_request):\n- `read` requires the record to carry a `url`; answer boxes without one are refused.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for web.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSearchRequest"},"examples":{"recent-news":{"summary":"Recent news","value":{"query":"fastify 5 release notes","time_range":"month","num":5}},"localised":{"summary":"Localised","value":{"query":"best ramen","country":"jp","language":"ja"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"web.search","x-aipa-pillar":"web","x-aipa-vendor":"Serper","x-aipa-typical-credits":1,"x-aipa-cost-basis":"$0.001 per Serper credit; 1 credit per page of results.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["read"],"x-aipa-update-params":{"$ref":"#/components/schemas/WebSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"kind","type":"\"organic\" | \"answer_box\" | \"knowledge_graph\"","presence":"always"},{"key":"position","type":"integer","presence":"when_available","note":"Organic rank on the provider page."},{"key":"date","type":"string","presence":"when_available"},{"key":"type","type":"string","presence":"when_available","note":"Knowledge graph."},{"key":"attributes","type":"object","presence":"when_available","note":"Knowledge graph, provider-shaped."}],"x-aipa-record-details":{},"x-aipa-rules":["`read` requires the record to carry a `url`; answer boxes without one are refused."]}},"/v1/capabilities/web.read/execute":{"post":{"tags":["Web and news"],"operationId":"executeWebRead","summary":"Read a web page","description":"Scrapes a single page and returns its main content as markdown (or plain text), truncated to `max_chars`. One record per call.\n\nTypical credits: 5. Cost basis: $0.005 per scrape.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for web.read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebReadRequest"},"examples":{"read-a-docs-page":{"summary":"Read a docs page","value":{"url":"https://fastify.dev/docs/latest/","max_chars":8000}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebReadExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"web.read","x-aipa-pillar":"web","x-aipa-vendor":"Firecrawl","x-aipa-typical-credits":5,"x-aipa-cost-basis":"$0.005 per scrape.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"none","x-aipa-search-actions":[],"x-aipa-record-actions":[],"x-aipa-update-params":{"$ref":"#/components/schemas/WebReadUpdateParams"},"x-aipa-summary-keys":[{"key":"content","type":"string","presence":"always","note":"Markdown or plain text, truncated to `max_chars`."},{"key":"chars","type":"integer","presence":"always"},{"key":"truncated","type":"boolean","presence":"always"},{"key":"format","type":"\"markdown\" | \"text\"","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/academic.search/execute":{"post":{"tags":["Research and reading"],"operationId":"executeAcademicSearch","summary":"Academic search","description":"Searches OpenAlex works. Each result carries year, venue, authors, citation count and DOI; `details` adds the abstract, referenced-works count and an open-access PDF when one exists.\n\nTypical credits: 0. Cost basis: Free (OpenAlex polite pool).\n\nRules enforced after schema validation (400 invalid_request):\n- `details` needs the OpenAlex id stored with the record; records without one are refused.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for academic.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcademicSearchRequest"},"examples":{"most-cited":{"summary":"Most cited","value":{"query":"transformer attention","sort":"cited","num":5}},"recent-open-access":{"summary":"Recent open access","value":{"query":"protein folding","from_year":2024,"open_access_only":true}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcademicSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"academic.search","x-aipa-pillar":"research","x-aipa-vendor":"OpenAlex","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free (OpenAlex polite pool).","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/AcademicSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"year","type":"integer","presence":"when_available"},{"key":"venue","type":"string","presence":"when_available"},{"key":"authors","type":"string[]","presence":"when_available"},{"key":"cited_by","type":"integer","presence":"when_available"},{"key":"type","type":"string","presence":"when_available"},{"key":"open_access","type":"boolean","presence":"when_available"},{"key":"oa_url","type":"string","presence":"when_available"},{"key":"doi","type":"string","presence":"when_available"},{"key":"openalex_id","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["`details` needs the OpenAlex id stored with the record; records without one are refused."]}},"/v1/capabilities/scripture.search/execute":{"post":{"tags":["Research and reading"],"operationId":"executeScriptureSearch","summary":"Scripture search","description":"Full-text search or reference lookup in the Bible or the Quran. Results are verses with translation text; `details` returns the surrounding chapter.\n\nTypical credits: 0. Cost basis: Free.\n\nRules enforced after schema validation (400 invalid_request):\n- Provide `query` or `reference`; an empty selector is refused.\n- An unparseable `reference`, an unknown book or an unknown Bible translation is refused with a `violations[]` entry.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for scripture.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptureSearchRequest"},"examples":{"bible-phrase":{"summary":"Bible phrase","value":{"text":"bible","query":"love thy neighbour","translation":"KJV"}},"bible-reference":{"summary":"Bible reference","value":{"text":"bible","reference":"John 3:16-18"}},"quran-reference":{"summary":"Quran reference","value":{"text":"quran","reference":"2:255"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptureSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"scripture.search","x-aipa-pillar":"research","x-aipa-vendor":"Bolls Bible + Quran.com","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free.","x-aipa-paging":"offset","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/ScriptureSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"text","type":"string","presence":"always","note":"The verse text in the requested translation."},{"key":"book","type":"string","presence":"always"},{"key":"chapter","type":"integer","presence":"always"},{"key":"verse","type":"integer","presence":"always"},{"key":"translation","type":"string","presence":"always"},{"key":"arabic","type":"string","presence":"when_available","note":"Quran only."}],"x-aipa-record-details":{},"x-aipa-rules":["Provide `query` or `reference`; an empty selector is refused.","An unparseable `reference`, an unknown book or an unknown Bible translation is refused with a `violations[]` entry."]}},"/v1/capabilities/classics.search/execute":{"post":{"tags":["Research and reading"],"operationId":"executeClassicsSearch","summary":"Classic texts","description":"Searches Project Gutenberg (via Gutendex, with the Gutenberg OPDS catalogue as fallback) and Wikisource. `details` returns an excerpt and download links (plain text, EPUB, HTML).\n\nTypical credits: 0. Cost basis: Free.\n\nRules enforced after schema validation (400 invalid_request):\n- Provide `query` or `author`; an empty selector is refused.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for classics.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassicsSearchRequest"},"examples":{"by-title":{"summary":"By title","value":{"query":"meditations","author":"aurelius"}},"in-french":{"summary":"In French","value":{"query":"candide","language":"fr"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassicsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"classics.search","x-aipa-pillar":"research","x-aipa-vendor":"Gutendex + Wikisource","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/ClassicsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"source","type":"\"gutenberg\" | \"wikisource\"","presence":"always"},{"key":"authors","type":"string[]","presence":"when_available"},{"key":"languages","type":"string[]","presence":"when_available"},{"key":"subjects","type":"string[]","presence":"when_available"},{"key":"downloads","type":"integer","presence":"when_available"},{"key":"words","type":"integer","presence":"when_available"}],"x-aipa-record-details":{},"x-aipa-rules":["Provide `query` or `author`; an empty selector is refused."]}},"/v1/capabilities/books.search/execute":{"post":{"tags":["Research and reading"],"operationId":"executeBooksSearch","summary":"Book search","description":"Searches Open Library. `details` returns the work description, subjects, a few editions with ISBNs and links to Open Library and the Internet Archive.\n\nTypical credits: 0. Cost basis: Free.\n\nRules enforced after schema validation (400 invalid_request):\n- Provide `query`, `author` or `subject`; an empty selector is refused.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for books.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BooksSearchRequest"},"examples":{"by-title":{"summary":"By title","value":{"query":"dune","num":5}},"by-author-and-subject":{"summary":"By author and subject","value":{"author":"ursula le guin","subject":"science fiction"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BooksSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"books.search","x-aipa-pillar":"research","x-aipa-vendor":"Open Library","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/BooksSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"authors","type":"string[]","presence":"when_available"},{"key":"first_published","type":"integer","presence":"when_available"},{"key":"editions","type":"integer","presence":"when_available"},{"key":"rating","type":"number","presence":"when_available"},{"key":"subjects","type":"string[]","presence":"when_available"},{"key":"isbn","type":"string","presence":"when_available"},{"key":"cover_url","type":"string","presence":"when_available"}],"x-aipa-record-details":{},"x-aipa-rules":["Provide `query`, `author` or `subject`; an empty selector is refused."]}},"/v1/capabilities/music.search/execute":{"post":{"tags":["Media and social"],"operationId":"executeMusicSearch","summary":"Music search","description":"Searches Deezer for tracks, artists or albums and enriches with MusicBrainz identifiers. `details` adds album, duration, release date, preview link and MusicBrainz metadata.\n\nTypical credits: 0. Cost basis: Free.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for music.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicSearchRequest"},"examples":{"track":{"summary":"Track","value":{"query":"bohemian rhapsody","kind":"track","num":5}},"artist":{"summary":"Artist","value":{"query":"radiohead","kind":"artist"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MusicSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"music.search","x-aipa-pillar":"media","x-aipa-vendor":"MusicBrainz + Deezer","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free.","x-aipa-paging":"offset","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/MusicSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"kind","type":"\"track\" | \"artist\" | \"album\"","presence":"always"},{"key":"artist","type":"string","presence":"when_available"},{"key":"album","type":"string","presence":"when_available"},{"key":"duration","type":"string","presence":"when_available","note":"Formatted m:ss; tracks only."},{"key":"explicit","type":"boolean","presence":"when_available"},{"key":"preview_url","type":"string","presence":"when_available"},{"key":"fans","type":"integer","presence":"when_available","note":"Artists only."},{"key":"albums","type":"integer","presence":"when_available","note":"Artists only."},{"key":"picture","type":"string","presence":"when_available","note":"Artists only."},{"key":"tracks","type":"integer","presence":"when_available","note":"Albums only."},{"key":"type","type":"string","presence":"when_available","note":"Albums only."},{"key":"cover","type":"string","presence":"when_available","note":"Albums only."},{"key":"country","type":"string","presence":"when_available","note":"MusicBrainz fallback."},{"key":"disambiguation","type":"string","presence":"when_available","note":"MusicBrainz fallback."},{"key":"musicbrainz_id","type":"string","presence":"when_available","note":"MusicBrainz fallback."}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/youtube.search/execute":{"post":{"tags":["Media and social"],"operationId":"executeYoutubeSearch","summary":"YouTube search","description":"Searches YouTube videos. `details` returns statistics, duration and description; `transcript` fetches the spoken text (paid).\n\nTypical credits: 0. Cost basis: Search: free quota. Transcript: $0.004 per video.\n\nRules enforced after schema validation (400 invalid_request):\n- Record actions need the video id stored with the record.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for youtube.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YoutubeSearchRequest"},"examples":{"long-talks":{"summary":"Long talks","value":{"query":"rust async explained","duration":"long","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/YoutubeSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"youtube.search","x-aipa-pillar":"media","x-aipa-vendor":"YouTube Data API + SearchApi","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Search: free quota. Transcript: $0.004 per video.","x-aipa-paging":"token","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details","transcript"],"x-aipa-update-params":{"$ref":"#/components/schemas/YoutubeSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"channel","type":"string","presence":"when_available"},{"key":"published_at","type":"string","presence":"when_available"},{"key":"thumbnail","type":"string","presence":"when_available"}],"x-aipa-record-details":{"details":{"$ref":"#/components/schemas/YoutubeSearchDetailsDetail"},"transcript":{"$ref":"#/components/schemas/YoutubeSearchTranscriptDetail"}},"x-aipa-rules":["Record actions need the video id stored with the record."]}},"/v1/capabilities/weather.forecast/execute":{"post":{"tags":["Travel and places"],"operationId":"executeWeatherForecast","summary":"Weather forecast","description":"Returns current conditions and a daily forecast for a place name or coordinates. Optional `include` adds current air quality with its timestamp and units, or daily marine (waves) data. Air quality is a current snapshot, not a forecast. One record per call.\n\nTypical credits: 0. Cost basis: Free.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for weather.forecast.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherForecastRequest"},"examples":{"city":{"summary":"City","value":{"location":"London","days":3}},"coordinates-imperial-with-air-quality":{"summary":"Coordinates, imperial, with air quality","value":{"location":{"lat":40.71,"lon":-74},"units":"imperial","include":["air_quality"]}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeatherForecastExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"weather.forecast","x-aipa-pillar":"travel","x-aipa-vendor":"Open-Meteo","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"none","x-aipa-search-actions":[],"x-aipa-record-actions":[],"x-aipa-update-params":{"$ref":"#/components/schemas/WeatherForecastUpdateParams"},"x-aipa-summary-keys":[{"key":"attribution","type":"string","presence":"always"},{"key":"source_url","type":"string","presence":"always"},{"key":"license","type":"string","presence":"always"},{"key":"license_url","type":"string","presence":"always"},{"key":"location","type":"object","presence":"always","note":"`name`, `lat`, `lon`, `timezone`, `elevation_m`."},{"key":"units","type":"object","presence":"always","note":"`temperature`, `wind`, `precipitation` unit labels."},{"key":"current","type":"object","presence":"always"},{"key":"daily","type":"object[]","presence":"always","note":"One entry per requested day."},{"key":"air_quality","type":"object","presence":"when_available","note":"Only with `include: [\"air_quality\"]`."},{"key":"marine","type":"object[]","presence":"when_available","note":"Only with `include: [\"marine\"]` near a coast."}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/navigation.route/execute":{"post":{"tags":["Travel and places"],"operationId":"executeNavigationRoute","summary":"Route","description":"Computes a route (driving, walking or cycling) between an origin and destination with optional waypoints. Each route is a record; `details` returns turn-by-turn steps.\n\nTypical credits: 0. Cost basis: Free tier.\n\nRules enforced after schema validation (400 invalid_request):\n- Origin and destination must geocode; an unresolvable place is refused.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for navigation.route.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationRouteRequest"},"examples":{"drive":{"summary":"Drive","value":{"origin":"Berlin","destination":"Potsdam","mode":"driving"}},"walk-with-alternatives":{"summary":"Walk with alternatives","value":{"origin":{"lat":51.5007,"lon":-0.1246},"destination":"British Museum","mode":"walking","alternatives":true}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationRouteExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"navigation.route","x-aipa-pillar":"travel","x-aipa-vendor":"OpenRouteService (OSRM fallback in dev)","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free tier.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":[],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/NavigationRouteUpdateParams"},"x-aipa-summary-keys":[{"key":"distance_km","type":"number","presence":"always"},{"key":"duration_min","type":"number","presence":"always"},{"key":"steps","type":"integer","presence":"always"},{"key":"via","type":"string[]","presence":"when_available"},{"key":"engine","type":"string","presence":"always"},{"key":"attribution","type":"string","presence":"always"},{"key":"license","type":"string","presence":"always"},{"key":"license_url","type":"string","presence":"always"}],"x-aipa-record-details":{"details":{"$ref":"#/components/schemas/NavigationRouteDetailsDetail"}},"x-aipa-rules":["Origin and destination must geocode; an unresolvable place is refused."]}},"/v1/capabilities/navigation.matrix/execute":{"post":{"tags":["Travel and places"],"operationId":"executeNavigationMatrix","summary":"Distance matrix","description":"Returns a duration and distance matrix between every pair of the given locations for the chosen mode. One record per call.\n\nTypical credits: 0. Cost basis: Free tier.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for navigation.matrix.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationMatrixRequest"},"examples":{"three-cities":{"summary":"Three cities","value":{"locations":["Berlin","Potsdam","Leipzig"],"mode":"driving"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavigationMatrixExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"navigation.matrix","x-aipa-pillar":"travel","x-aipa-vendor":"OpenRouteService (OSRM fallback in dev)","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free tier.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"none","x-aipa-search-actions":[],"x-aipa-record-actions":[],"x-aipa-update-params":{"$ref":"#/components/schemas/NavigationMatrixUpdateParams"},"x-aipa-summary-keys":[{"key":"locations","type":"string[]","presence":"always"},{"key":"durations_min","type":"number[][]","presence":"always"},{"key":"distances_km","type":"number[][]","presence":"always"},{"key":"engine","type":"string","presence":"always"},{"key":"attribution","type":"string","presence":"always"},{"key":"license","type":"string","presence":"always"},{"key":"license_url","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/hotels.search/execute":{"post":{"tags":["Travel and places"],"operationId":"executeHotelsSearch","summary":"Hotel search","description":"Searches Google Hotels for a destination and date range. Results carry nightly and total prices, rating, review count and amenities; `details` adds the description, nearby places and a booking link.\n\nTypical credits: 4. Cost basis: $0.004 per search page.\n\nRules enforced after schema validation (400 invalid_request):\n- At least one adult; child ages 1 to 17; at most six guests for hotels and ten for vacation rentals.\n- `children_ages` is not accepted with `property_type: \"vacation_rental\"`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for hotels.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelsSearchRequest"},"examples":{"weekend":{"summary":"Weekend","value":{"destination":"Lisbon","check_in":"2026-10-09","check_out":"2026-10-11","adults":2,"currency":"EUR","sort":"highest_rating"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotelsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"hotels.search","x-aipa-pillar":"travel","x-aipa-vendor":"SearchApi (Google Hotels)","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per search page.","x-aipa-paging":"token","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/HotelsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"price_per_night","type":"number","presence":"when_available"},{"key":"total_price","type":"number","presence":"when_available"},{"key":"currency","type":"string","presence":"when_available"},{"key":"rating","type":"number","presence":"when_available"},{"key":"reviews","type":"integer","presence":"when_available"},{"key":"hotel_class","type":"string","presence":"when_available"},{"key":"type","type":"string","presence":"when_available"},{"key":"amenities","type":"string[]","presence":"when_available"},{"key":"location","type":"string","presence":"when_available"},{"key":"lat","type":"number","presence":"when_available"},{"key":"lon","type":"number","presence":"when_available"},{"key":"requested_occupancy","type":"object","presence":"always"},{"key":"occupancy_status","type":"string","presence":"always"},{"key":"occupancy_note","type":"string","presence":"when_available"}],"x-aipa-record-details":{},"x-aipa-rules":["At least one adult; child ages 1 to 17; at most six guests for hotels and ten for vacation rentals.","`children_ages` is not accepted with `property_type: \"vacation_rental\"`."]}},"/v1/capabilities/flights.search/execute":{"post":{"tags":["Travel and places"],"operationId":"executeFlightsSearch","summary":"Flight search","description":"Searches Google Flights between two airports for adults, children, seated infants and lap infants, up to nine passengers. Child ages are not accepted by this source. Results include legs, duration, stops, price and requested passenger counts. For round trips, outbound details supplies return_search parameters; execute that search and request details on the chosen return to get booking options for both legs. Passenger counts are preserved throughout. One-way details returns booking options directly.\n\nTypical credits: 4. Cost basis: $0.004 per search.\n\nRules enforced after schema validation (400 invalid_request):\n- At most nine passengers in total (adults, children, infants).\n- `departure_token` requires the original round-trip `return_date`.\n- `return_date` must not precede `departure_date`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for flights.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightsSearchRequest"},"examples":{"return-trip":{"summary":"Return trip","value":{"origin":"LHR","destination":"JFK","departure_date":"2026-11-03","return_date":"2026-11-10","adults":2,"children":1,"cabin":"economy","max_stops":1}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FlightsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"flights.search","x-aipa-pillar":"travel","x-aipa-vendor":"SearchApi (Google Flights)","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per search.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":[],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/FlightsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"price","type":"number","presence":"when_available"},{"key":"currency","type":"string","presence":"always"},{"key":"requested_passengers","type":"object","presence":"always"},{"key":"total_duration","type":"string","presence":"when_available","note":"Formatted, e.g. \"5h 30m\"."},{"key":"stops","type":"integer","presence":"when_available"},{"key":"layovers","type":"object[]","presence":"when_available"},{"key":"departure","type":"string","presence":"when_available"},{"key":"arrival","type":"string","presence":"when_available"},{"key":"legs","type":"object[]","presence":"always"},{"key":"emissions_kg","type":"number","presence":"when_available"},{"key":"needs_return_selection","type":"boolean","presence":"when_available","note":"Round trips: pick the outbound first."}],"x-aipa-record-details":{"details":{"$ref":"#/components/schemas/FlightsSearchDetailsDetail"}},"x-aipa-rules":["At most nine passengers in total (adults, children, infants).","`departure_token` requires the original round-trip `return_date`.","`return_date` must not precede `departure_date`."]}},"/v1/capabilities/github.search/execute":{"post":{"tags":["Dev"],"operationId":"executeGithubSearch","summary":"GitHub search","description":"Searches GitHub repositories, code (needs GITHUB_TOKEN) or issues/PRs. `details` on a repository returns the README head, top-level tree and stats.\n\nTypical credits: 0. Cost basis: Free (60 req/h unauthenticated, 5000 with GITHUB_TOKEN).\n\nRules enforced after schema validation (400 invalid_request):\n- `kind: \"code\"` needs a GitHub token in the deployment; without one the call fails with `capability_unavailable`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for github.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GithubSearchRequest"},"examples":{"repos":{"summary":"Repos","value":{"query":"fastify plugin language:typescript","kind":"repositories","sort":"stars","num":5}},"issues":{"summary":"Issues","value":{"query":"repo:fastify/fastify is:issue hooks","kind":"issues"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GithubSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"github.search","x-aipa-pillar":"dev","x-aipa-vendor":"GitHub REST","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free (60 req/h unauthenticated, 5000 with GITHUB_TOKEN).","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/GithubSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"kind","type":"\"repository\" | \"issue\" | \"pull_request\" | \"code\"","presence":"always"},{"key":"stars","type":"integer","presence":"when_available","note":"Repositories."},{"key":"forks","type":"integer","presence":"when_available","note":"Repositories."},{"key":"open_issues","type":"integer","presence":"when_available","note":"Repositories."},{"key":"language","type":"string","presence":"when_available","note":"Repositories."},{"key":"topics","type":"string[]","presence":"when_available","note":"Repositories."},{"key":"created_at","type":"string","presence":"when_available","note":"Issues and pull requests."},{"key":"updated_at","type":"string","presence":"when_available"},{"key":"archived","type":"boolean","presence":"when_available","note":"Repositories."},{"key":"license","type":"string","presence":"when_available","note":"Repositories."},{"key":"repo","type":"string","presence":"when_available","note":"Issues and code."},{"key":"number","type":"integer","presence":"when_available","note":"Issues."},{"key":"state","type":"string","presence":"when_available","note":"Issues."},{"key":"author","type":"string","presence":"when_available","note":"Issues."},{"key":"comments","type":"integer","presence":"when_available","note":"Issues."},{"key":"labels","type":"string[]","presence":"when_available","note":"Issues."},{"key":"path","type":"string","presence":"when_available","note":"Code."},{"key":"matches","type":"string[]","presence":"when_available","note":"Code."}],"x-aipa-record-details":{},"x-aipa-rules":["`kind: \"code\"` needs a GitHub token in the deployment; without one the call fails with `capability_unavailable`."]}},"/v1/capabilities/npm.search/execute":{"post":{"tags":["Dev"],"operationId":"executeNpmSearch","summary":"npm search","description":"Search the public npm registry without a provider API key. Supports npm text filters including keywords:, scope: and maintainer:. Pagination uses size (up to 250) and from. `details` retrieves full package metadata, version history and README when available.\n\nTypical credits: 0. Cost basis: Free public npm API; no provider API key required.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for npm.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpmSearchRequest"},"examples":{"react-tables":{"summary":"React tables","value":{"text":"react table","size":10,"from":0}},"validation-packages":{"summary":"Validation packages","value":{"text":"keywords:validation","size":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpmSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"npm.search","x-aipa-pillar":"dev","x-aipa-vendor":"npm Registry","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free public npm API; no provider API key required.","x-aipa-paging":"offset","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/NpmSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"version","type":"string","presence":"when_available"},{"key":"keywords","type":"string[]","presence":"when_available"},{"key":"maintainers","type":"object[]","presence":"when_available"},{"key":"repository","type":"string","presence":"when_available"},{"key":"links","type":"object","presence":"when_available"},{"key":"score","type":"object","presence":"when_available"},{"key":"search_score","type":"number","presence":"when_available"},{"key":"published_at","type":"string","presence":"when_available"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/npm.package/execute":{"post":{"tags":["Dev"],"operationId":"executeNpmPackage","summary":"npm package details","description":"Retrieve a public npm package, including scoped names. Omit version for the full package document and version history, or specify latest, a dist-tag or an exact version. Returns a compact summary; `details` returns the complete retrieved document, including dependencies, license, repository, maintainers, tarball URLs and README when available.\n\nTypical credits: 0. Cost basis: Free public npm API; cached details cost 0 credits.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for npm.package.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpmPackageRequest"},"examples":{"full-version-history":{"summary":"Full version history","value":{"package":"zod"}},"latest-version":{"summary":"Latest version","value":{"package":"zod","version":"latest"}},"specific-version":{"summary":"Specific version","value":{"package":"zod","version":"3.23.8"}},"scoped-package":{"summary":"Scoped package","value":{"package":"@babel/core","version":"latest"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpmPackageExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"npm.package","x-aipa-pillar":"dev","x-aipa-vendor":"npm Registry","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free public npm API; cached details cost 0 credits.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"cached","x-aipa-search-actions":[],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/NpmPackageUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"version","type":"string","presence":"when_available"},{"key":"license","type":"string | object","presence":"when_available"},{"key":"repository","type":"string | object","presence":"when_available"},{"key":"maintainers","type":"object[]","presence":"when_available"},{"key":"dependencies","type":"object","presence":"when_available"},{"key":"dist","type":"object","presence":"when_available"},{"key":"dist_tags","type":"object","presence":"when_available"},{"key":"version_count","type":"integer","presence":"when_available"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/npm.downloads/execute":{"post":{"tags":["Dev"],"operationId":"executeNpmDownloads","summary":"npm download statistics","description":"Retrieve download totals (kind: point) or daily counts (kind: range) for one public npm package. Supports last-day, last-week, last-month, last-year, a date, or an inclusive date range. last-month means the last 30 available days, not the previous calendar month. Returns the actual start and end dates from npm; upstream limits a request to 18 months.\n\nTypical credits: 0. Cost basis: Free public npm API; no provider API key required.\n\nRules enforced after schema validation (400 invalid_request):\n- Explicit dates must be valid calendar dates; the end date must not precede the start date.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for npm.downloads.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpmDownloadsRequest"},"examples":{"last-30-available-days":{"summary":"Last 30 available days","value":{"package":"zod","period":"last-month","kind":"point"}},"daily-counts":{"summary":"Daily counts","value":{"package":"zod","period":"last-month","kind":"range"}},"calendar-month":{"summary":"Calendar month","value":{"package":"zod","period":"2026-08-01:2026-08-31"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NpmDownloadsExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"npm.downloads","x-aipa-pillar":"dev","x-aipa-vendor":"npm Downloads API","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free public npm API; no provider API key required.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"none","x-aipa-search-actions":[],"x-aipa-record-actions":[],"x-aipa-update-params":{"$ref":"#/components/schemas/NpmDownloadsUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"kind","type":"\"point\" | \"range\"","presence":"always"},{"key":"start","type":"string","presence":"always"},{"key":"end","type":"string","presence":"always"},{"key":"downloads","type":"integer | object[]","presence":"always","note":"Total, or daily { day, downloads } entries for range."}],"x-aipa-record-details":{},"x-aipa-rules":["Explicit dates must be valid calendar dates; the end date must not precede the start date."]}},"/v1/capabilities/pypi.details/execute":{"post":{"tags":["Dev"],"operationId":"executePypiDetails","summary":"PyPI package details","description":"Official PyPI JSON metadata for the latest or an exact published version. No provider key needed. The summary includes Python requirements, dependencies, license and known vulnerabilities when supplied. `details` returns cached info with the full description, project links, distribution files and hashes. Deprecated downloads and releases fields are omitted; use pypi.versions and pypi.downloads instead.\n\nTypical credits: 0. Cost basis: Free public PyPI API; cached details cost 0 credits.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for pypi.details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiDetailsRequest"},"examples":{"latest-requests-metadata":{"summary":"Latest requests metadata","value":{"package":"requests"}},"exact-version":{"summary":"Exact version","value":{"package":"requests","version":"2.32.3"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiDetailsExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"pypi.details","x-aipa-pillar":"dev","x-aipa-vendor":"PyPI JSON API","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free public PyPI API; cached details cost 0 credits.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"cached","x-aipa-search-actions":[],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/PypiDetailsUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"version","type":"string","presence":"always"},{"key":"requires_python","type":"string","presence":"when_available"},{"key":"requires_dist","type":"string[]","presence":"when_available"},{"key":"license","type":"string","presence":"when_available"},{"key":"license_expression","type":"string","presence":"when_available"},{"key":"project_urls","type":"object","presence":"when_available"},{"key":"vulnerabilities","type":"object[]","presence":"when_available"},{"key":"file_count","type":"integer","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/pypi.versions/execute":{"post":{"tags":["Dev"],"operationId":"executePypiVersions","summary":"PyPI versions and files","description":"Uses the official Simple Index API with application/vnd.pypi.simple.v1+json. Returns version names and file counts; `details` returns all distribution files with download URLs, hashes, Python requirements and yanked status. Version order is provider-defined, not a recommendation of which release to install. No provider key needed.\n\nTypical credits: 0. Cost basis: Free public PyPI API; cached details cost 0 credits.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for pypi.versions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiVersionsRequest"},"examples":{"requests-releases-and-distributions":{"summary":"Requests releases and distributions","value":{"package":"requests"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiVersionsExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"pypi.versions","x-aipa-pillar":"dev","x-aipa-vendor":"PyPI Simple Index","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free public PyPI API; cached details cost 0 credits.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"cached","x-aipa-search-actions":[],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/PypiVersionsUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"versions","type":"string[]","presence":"always"},{"key":"version_count","type":"integer","presence":"always"},{"key":"file_count","type":"integer","presence":"always"},{"key":"source","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/pypi.downloads/execute":{"post":{"tags":["Dev"],"operationId":"executePypiDownloads","summary":"PyPI download statistics","description":"Uses PyPI Stats, a separate service from PyPI. kind recent returns last-day/week/month totals; overall returns daily history excluding known mirrors, retained for up to 180 days. Data updates daily and is cached for 24 hours per API process with shared in-flight requests. Rate-limit cooldowns apply; fetched_at reports retrieval time, not the upstream data timestamp. No provider key needed.\n\nTypical credits: 0. Cost basis: Free PyPI Stats API with a 24-hour process-local cache.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for pypi.downloads.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiDownloadsRequest"},"examples":{"recent-totals":{"summary":"Recent totals","value":{"package":"requests","kind":"recent"}},"daily-history-without-mirrors":{"summary":"Daily history without mirrors","value":{"package":"requests","kind":"overall"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiDownloadsExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"pypi.downloads","x-aipa-pillar":"dev","x-aipa-vendor":"PyPI Stats","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Free PyPI Stats API with a 24-hour process-local cache.","x-aipa-paging":"none","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"none","x-aipa-search-actions":[],"x-aipa-record-actions":[],"x-aipa-update-params":{"$ref":"#/components/schemas/PypiDownloadsUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"kind","type":"\"recent\" | \"overall\"","presence":"always"},{"key":"source","type":"string","presence":"always"},{"key":"data","type":"object | object[]","presence":"always"},{"key":"fetched_at","type":"string","presence":"always"},{"key":"cache_hit","type":"boolean","presence":"always"},{"key":"mirrors","type":"boolean","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/pypi.search/execute":{"post":{"tags":["Dev"],"operationId":"executePypiSearch","summary":"Python package discovery","description":"PyPI has no supported keyword-search API. Uses Serper to search site:pypi.org/project/, returning only PyPI project links, deduplicated within each page. Results are unverified discovery candidates; `details` verifies the package through official PyPI JSON metadata. Requires the existing SERPER_API_KEY. Supports more and update; does not download the entire package index.\n\nTypical credits: 1. Cost basis: $0.001 per Serper credit; official metadata details are free.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for pypi.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiSearchRequest"},"examples":{"pdf-extraction-libraries":{"summary":"PDF extraction libraries","value":{"query":"Python PDF extraction","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PypiSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"pypi.search","x-aipa-pillar":"dev","x-aipa-vendor":"Serper discovery + PyPI","x-aipa-typical-credits":1,"x-aipa-cost-basis":"$0.001 per Serper credit; official metadata details are free.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/PypiSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"package","type":"string","presence":"always"},{"key":"source","type":"string","presence":"always"},{"key":"verified","type":"boolean","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/social.search/execute":{"post":{"tags":["Media and social"],"operationId":"executeSocialSearch","summary":"Social search","description":"Searches X posts or profiles (paid, per tweet) or Reddit posts/subreddits (free). `details` returns the full post with engagement, or the profile.\n\nTypical credits: 2. Cost basis: X: $0.00015 per tweet returned. Reddit: free.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for social.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialSearchRequest"},"examples":{"x-posts":{"summary":"X posts","value":{"platform":"x","query":"fastify","kind":"posts","num":10}},"reddit-posts":{"summary":"Reddit posts","value":{"platform":"reddit","query":"fastify vs express","num":10}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SocialSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"social.search","x-aipa-pillar":"media","x-aipa-vendor":"twitterapi.io + Reddit","x-aipa-typical-credits":2,"x-aipa-cost-basis":"X: $0.00015 per tweet returned. Reddit: free.","x-aipa-paging":"token","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/SocialSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"platform","type":"\"x\" | \"reddit\"","presence":"always"},{"key":"kind","type":"\"post\" | \"profile\"","presence":"always"},{"key":"author","type":"string","presence":"when_available"},{"key":"author_name","type":"string","presence":"when_available"},{"key":"created_at","type":"string","presence":"when_available"},{"key":"likes","type":"integer","presence":"when_available"},{"key":"reposts","type":"integer","presence":"when_available"},{"key":"replies","type":"integer","presence":"when_available"},{"key":"views","type":"integer","presence":"when_available"},{"key":"followers","type":"integer","presence":"when_available","note":"Profiles."},{"key":"following","type":"integer","presence":"when_available","note":"Profiles."},{"key":"posts","type":"integer","presence":"when_available","note":"Profiles."},{"key":"verified","type":"boolean","presence":"when_available","note":"Profiles."},{"key":"location","type":"string","presence":"when_available","note":"Profiles."},{"key":"subreddit","type":"string","presence":"when_available","note":"Reddit."},{"key":"score","type":"integer","presence":"when_available","note":"Reddit."},{"key":"comments","type":"integer","presence":"when_available","note":"Reddit."},{"key":"link_url","type":"string","presence":"when_available","note":"Reddit."},{"key":"subscribers","type":"integer","presence":"when_available","note":"Reddit."},{"key":"karma","type":"integer","presence":"when_available","note":"Reddit."}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/shopping.search/execute":{"post":{"tags":["Commerce and markets"],"operationId":"executeShoppingSearch","summary":"Shopping","description":"Searches structured product listings with source prices and merchant links. Returned filters have session-owned ids: use update with filter_id to select, or null to clear. Query/localization changes clear the selection; filter choices cannot combine with sort or condition. Explicit price bounds remain enforced. Details use the provider product token; unavailable or expired offers remain unavailable, never estimated.\n\nTypical credits: 4. Cost basis: $0.004 per provider page or fresh product detail.\n\nRules enforced after schema validation (400 invalid_request):\n- `price_min` must not exceed `price_max`.\n- `filter_id` is accepted only on `update`, must come from this search, and cannot be combined with `sort` or `condition`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for shopping.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingSearchRequest"},"examples":{"products":{"summary":"Products","value":{"query":"noise cancelling headphones","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShoppingSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"shopping.search","x-aipa-pillar":"commerce","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per provider page or fresh product detail.","x-aipa-paging":"page","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/ShoppingSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"price","type":"number","presence":"when_available"},{"key":"price_display","type":"string","presence":"when_available"},{"key":"seller","type":"string","presence":"when_available"},{"key":"rating","type":"number","presence":"when_available"},{"key":"reviews","type":"integer","presence":"when_available"},{"key":"delivery","type":"string","presence":"when_available"},{"key":"condition","type":"string","presence":"when_available"},{"key":"source","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["`price_min` must not exceed `price_max`.","`filter_id` is accepted only on `update`, must come from this search, and cannot be combined with `sort` or `condition`."]}},"/v1/capabilities/markets.quote/execute":{"post":{"tags":["Commerce and markets"],"operationId":"executeMarketsQuote","summary":"Markets & companies","description":"Returns structured instrument quotes and company financial data. Observation times, currencies and missing values are preserved; prices are observations, not guaranteed executable live quotes.\n\nTypical credits: 4. Cost basis: $0.004 per quote refresh; cached details are free.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for markets.quote.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketsQuoteRequest"},"examples":{"nvidia":{"summary":"NVIDIA","value":{"symbol":"NVDA:NASDAQ"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketsQuoteExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"markets.quote","x-aipa-pillar":"commerce","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per quote refresh; cached details are free.","x-aipa-paging":"none","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"cached","x-aipa-search-actions":["update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/MarketsQuoteUpdateParams"},"x-aipa-summary-keys":[{"key":"symbol","type":"string","presence":"always"},{"key":"exchange","type":"string","presence":"when_available"},{"key":"price","type":"number","presence":"when_available"},{"key":"currency","type":"string","presence":"when_available"},{"key":"observed_at","type":"string","presence":"when_available"},{"key":"change","type":"object","presence":"when_available"},{"key":"source","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/jobs.search/execute":{"post":{"tags":["Commerce and markets"],"operationId":"executeJobsSearch","summary":"Jobs","description":"Searches structured job listings and preserves company, location, description and application links. Salary or employment facts are included only when supplied by the source.\n\nTypical credits: 4. Cost basis: $0.004 per fetched provider page; cached details are free.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for jobs.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobsSearchRequest"},"examples":{"roles":{"summary":"Roles","value":{"query":"software engineer","location":"London","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"jobs.search","x-aipa-pillar":"commerce","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per fetched provider page; cached details are free.","x-aipa-paging":"token","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/JobsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"company","type":"string","presence":"when_available"},{"key":"location","type":"string","presence":"when_available"},{"key":"posted_at","type":"string","presence":"when_available"},{"key":"schedule","type":"string","presence":"when_available"},{"key":"salary","type":"string","presence":"when_available"},{"key":"source","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/patents.search/execute":{"post":{"tags":["Research and reading"],"operationId":"executePatentsSearch","summary":"Patents","description":"Searches structured patent records and retrieves the original document details. Dates, status, inventor and assignee fields are reported as source observations, not legal validity opinions.\n\nTypical credits: 4. Cost basis: $0.004 per provider search or fresh detail request.\n\nRules enforced after schema validation (400 invalid_request):\n- `before` and `after` must be real calendar dates in YYYYMMDD form.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for patents.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatentsSearchRequest"},"examples":{"inventions":{"summary":"Inventions","value":{"query":"battery recycling","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatentsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"patents.search","x-aipa-pillar":"research","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per provider search or fresh detail request.","x-aipa-paging":"page","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/PatentsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"publication_number","type":"string","presence":"always"},{"key":"priority_date","type":"string","presence":"when_available"},{"key":"filing_date","type":"string","presence":"when_available"},{"key":"publication_date","type":"string","presence":"when_available"},{"key":"inventor","type":"string","presence":"when_available"},{"key":"assignee","type":"string","presence":"when_available"},{"key":"language","type":"string","presence":"when_available"},{"key":"pdf","type":"string","presence":"when_available"},{"key":"source","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["`before` and `after` must be real calendar dates in YYYYMMDD form."]}},"/v1/capabilities/realestate.search/execute":{"post":{"tags":["Commerce and markets"],"operationId":"executeRealestateSearch","summary":"Real estate","description":"Searches Zillow property listings within its coverage. Details preserve sourced property facts and sale history when available; absent last-sale values remain unknown. Commute times require a separate route or matrix request.\n\nTypical credits: 4. Cost basis: $0.004 per provider listing page or fresh property detail.\n\nRules enforced after schema validation (400 invalid_request):\n- `min_price` must not exceed `max_price`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for realestate.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealestateSearchRequest"},"examples":{"homes":{"summary":"Homes","value":{"query":"Austin, TX","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealestateSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"realestate.search","x-aipa-pillar":"commerce","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per provider listing page or fresh property detail.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/RealestateSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"street","type":"string","presence":"when_available"},{"key":"city","type":"string","presence":"when_available"},{"key":"state","type":"string","presence":"when_available"},{"key":"zipcode","type":"string","presence":"when_available"},{"key":"country","type":"string","presence":"when_available"},{"key":"home_type","type":"string","presence":"when_available"},{"key":"home_status","type":"string","presence":"when_available"},{"key":"status_text","type":"string","presence":"when_available"},{"key":"beds","type":"number","presence":"when_available"},{"key":"baths","type":"number","presence":"when_available"},{"key":"sqft","type":"number","presence":"when_available"},{"key":"lot_sqft","type":"number","presence":"when_available"},{"key":"lot_area_unit","type":"string","presence":"when_available"},{"key":"days_on_zillow","type":"number","presence":"when_available"},{"key":"date_price_changed","type":"string","presence":"when_available"},{"key":"broker","type":"string","presence":"when_available"},{"key":"currency","type":"string","presence":"when_available"},{"key":"is_showcase","type":"boolean","presence":"when_available"},{"key":"price","type":"number","presence":"when_available","note":"Numeric price extracted by the provider."},{"key":"price_label","type":"string","presence":"when_available","note":"Provider display price."},{"key":"price_kind","type":"\"listing_price\" | \"monthly_rent\" | \"reported_sold_price\" | \"unknown\"","presence":"always"},{"key":"latitude","type":"number","presence":"when_available"},{"key":"longitude","type":"number","presence":"when_available"},{"key":"source","type":"string","presence":"always"},{"key":"fetched_at","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["`min_price` must not exceed `max_price`."]}},"/v1/capabilities/news.search/execute":{"post":{"tags":["Web and news"],"operationId":"executeNewsSearch","summary":"News","description":"Searches the news index with article titles, publisher names, dates and source links. Cached detail is the indexed metadata; read the publisher page separately for its full text.\n\nTypical credits: 1. Cost basis: $0.001 per provider-reported credit, including the full fetched page.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for news.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsSearchRequest"},"examples":{"latest-reporting":{"summary":"Latest reporting","value":{"query":"renewable energy","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"news.search","x-aipa-pillar":"web","x-aipa-vendor":"Serper","x-aipa-typical-credits":1,"x-aipa-cost-basis":"$0.001 per provider-reported credit, including the full fetched page.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/NewsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"publisher","type":"string","presence":"when_available"},{"key":"published_label","type":"string","presence":"when_available"},{"key":"image_url","type":"string","presence":"when_available"},{"key":"source","type":"string","presence":"always"},{"key":"fetched_at","type":"string","presence":"always"},{"key":"content_scope","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":[]}},"/v1/capabilities/trends.search/execute":{"post":{"tags":["Commerce and markets"],"operationId":"executeTrendsSearch","summary":"Trends","description":"Returns Google Trends relative interest and related-query or topic data. Indices and breakout markers are not absolute search counts. Refresh changes the query, region or time window.\n\nTypical credits: 4. Cost basis: $0.004 per provider dataset; cached details are free.\n\nRules enforced after schema validation (400 invalid_request):\n- Time series and geography accept up to five comma-separated terms; related queries and topics accept one.\n- `region` requires `data_type: \"GEO_MAP\"`; `region: \"COUNTRY\"` requires worldwide geography (no `geo`).","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for trends.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrendsSearchRequest"},"examples":{"interest-over-time":{"summary":"Interest over time","value":{"query":"electric cars"}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrendsSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"trends.search","x-aipa-pillar":"commerce","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per provider dataset; cached details are free.","x-aipa-paging":"none","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"cached","x-aipa-search-actions":["update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/TrendsSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"data_type","type":"string","presence":"always"},{"key":"time_range","type":"string","presence":"always"},{"key":"source","type":"string","presence":"always"},{"key":"fetched_at","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["Time series and geography accept up to five comma-separated terms; related queries and topics accept one.","`region` requires `data_type: \"GEO_MAP\"`; `region: \"COUNTRY\"` requires worldwide geography (no `geo`)."]}},"/v1/capabilities/recipes.search/execute":{"post":{"tags":["Food and fitness"],"operationId":"executeRecipesSearch","summary":"Food & recipes","description":"Searches recipes by one supported query or filter, then retrieves ingredients, measures and instructions from the source. On update, supplying one query, ingredient, category or cuisine replaces the previous selector while preserving num unless changed. Multiple selectors cannot be combined. Nutrition, allergy safety and storage suitability are not inferred when the source does not provide them.\n\nTypical credits: 0. Cost basis: Commercial provider subscription; no per-request allocation is charged until a usage price is configured.\n\nRules enforced after schema validation (400 invalid_request):\n- Exactly one of `query`, `ingredient`, `category` or `cuisine`; blank filters are refused.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for recipes.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipesSearchRequest"},"examples":{"dinner-ideas":{"summary":"Dinner ideas","value":{"query":"chicken","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecipesSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"recipes.search","x-aipa-pillar":"life","x-aipa-vendor":"TheMealDB","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Commercial provider subscription; no per-request allocation is charged until a usage price is configured.","x-aipa-paging":"local","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/RecipesSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"category","type":"string","presence":"when_available"},{"key":"cuisine","type":"string","presence":"when_available"},{"key":"attribution","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["Exactly one of `query`, `ingredient`, `category` or `cuisine`; blank filters are refused."]}},"/v1/capabilities/fitness.exercises/execute":{"post":{"tags":["Food and fitness"],"operationId":"executeFitnessExercises","summary":"Fitness","description":"Search YMove exercises by movement, equipment and muscle. Available demonstrations are saved to the requesting account under Resources → Workouts. Give the user each workout's URL so they can open its demonstration in Resources → Workouts. The link requires signing in to the same AI Power Ups account that requested it. Playback and video renewal do not charge user credits.\n\nTypical credits: 0. Cost basis: Activation requires an approved positive model-call tariff. Playback and video renewal are included at no credit cost. The runtime supplies the configured call price.\n\nRules enforced after schema validation (400 invalid_request):\n- Filters must not be blank.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for fitness.exercises.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FitnessExercisesRequest"},"examples":{"exercises":{"summary":"Exercises","value":{"query":"squat","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FitnessExercisesExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"fitness.exercises","x-aipa-pillar":"life","x-aipa-vendor":"YMove","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Activation requires an approved positive model-call tariff. Playback and video renewal are included at no credit cost. The runtime supplies the configured call price.","x-aipa-paging":"local","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/FitnessExercisesUpdateParams"},"x-aipa-summary-keys":[{"key":"equipment","type":"string[]","presence":"when_available"},{"key":"muscles","type":"string[]","presence":"when_available"},{"key":"secondary_muscles","type":"string[]","presence":"when_available"},{"key":"attribution","type":"string","presence":"always"},{"key":"author","type":"string","presence":"when_available"},{"key":"licence","type":"object","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["Filters must not be blank."]}},"/v1/capabilities/places.search/execute":{"post":{"tags":["Travel and places"],"operationId":"executePlacesSearch","summary":"Places","description":"Searches structured place listings and retrieves original contact, location, category and opening-hour information. Strict radius and rating filters require source evidence; a listing does not confirm booking capacity or suitability.\n\nTypical credits: 4. Cost basis: $0.004 per fetched provider page or fresh place detail; cached details are free.\n\nRules enforced after schema validation (400 invalid_request):\n- `query` must not be blank.\n- `radius_m` requires `location`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for places.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacesSearchRequest"},"examples":{"surf-lessons-nearby":{"summary":"Surf lessons nearby","value":{"query":"surf schools Carcavelos Portugal","num":5}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacesSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"places.search","x-aipa-pillar":"travel","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per fetched provider page or fresh place detail; cached details are free.","x-aipa-paging":"page","x-aipa-search-deadline-ms":15000,"x-aipa-detail":"fresh","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/PlacesSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"address","type":"string","presence":"when_available"},{"key":"phone","type":"string","presence":"when_available"},{"key":"type","type":"string","presence":"when_available"},{"key":"types","type":"string[]","presence":"when_available"},{"key":"open_state","type":"string","presence":"when_available"},{"key":"hours","type":"string","presence":"when_available"},{"key":"website","type":"string","presence":"when_available"},{"key":"rating","type":"number","presence":"when_available"},{"key":"reviews","type":"integer","presence":"when_available"},{"key":"price_level_label","type":"string","presence":"when_available"},{"key":"coordinates","type":"object","presence":"when_available"},{"key":"distance_m","type":"number","presence":"when_available","note":"Only with `location`."},{"key":"open_now","type":"boolean","presence":"when_available"},{"key":"source","type":"string","presence":"always"},{"key":"fetched_at","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["`query` must not be blank.","`radius_m` requires `location`."]}},"/v1/capabilities/transit.routes/execute":{"post":{"tags":["Travel and places"],"operationId":"executeTransitRoutes","summary":"Public transport","description":"Returns source-reported transit itineraries with timed legs, stops and operator links. Preserves local clock labels and timezones; schedules are not guaranteed real-time predictions, and route preferences do not confirm operational accessibility or ticket availability.\n\nTypical credits: 4. Cost basis: $0.004 per route search or refresh; local alternatives and cached details are free.\n\nRules enforced after schema validation (400 invalid_request):\n- Origin and destination must not be blank.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for transit.routes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitRoutesRequest"},"examples":{"airport-to-shinjuku":{"summary":"Airport to Shinjuku","value":{"origin":"Narita Airport, Japan","destination":"Shinjuku Station, Tokyo, Japan","num":3}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransitRoutesExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"transit.routes","x-aipa-pillar":"travel","x-aipa-vendor":"SearchApi","x-aipa-typical-credits":4,"x-aipa-cost-basis":"$0.004 per route search or refresh; local alternatives and cached details are free.","x-aipa-paging":"local","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/TransitRoutesUpdateParams"},"x-aipa-summary-keys":[{"key":"duration_seconds","type":"integer","presence":"when_available"},{"key":"distance_m","type":"integer","presence":"when_available"},{"key":"duration_label","type":"string","presence":"when_available"},{"key":"distance_label","type":"string","presence":"when_available"},{"key":"time_window","type":"object","presence":"when_available"},{"key":"requested_time","type":"string","presence":"when_available"},{"key":"requested_time_status","type":"string","presence":"always"},{"key":"lines","type":"string[]","presence":"when_available"},{"key":"source","type":"string","presence":"always"},{"key":"fetched_at","type":"string","presence":"always"},{"key":"realtime_status","type":"string","presence":"always"}],"x-aipa-record-details":{},"x-aipa-rules":["Origin and destination must not be blank."]}},"/v1/capabilities/companies.financials/execute":{"post":{"tags":["Research and reading"],"operationId":"executeCompaniesFinancials","summary":"Company filings","description":"Find SEC company filings by ticker or CIK, then read financial facts and revenue dimensions from a specific accession. Facts retain their exact period, unit, context and source. Segment, geographic, product and whole-company figures remain separate. An absent dimension is unknown, never inferred from consolidated revenue.\n\nTypical credits: 0. Cost basis: Public SEC data; no per-request provider charge. Stored facts and buffered pages are free.\n\nRules enforced after schema validation (400 invalid_request):\n- A ticker must identify exactly one SEC filer; otherwise use the CIK.\n- `filed_from` and `filed_to` must be valid ISO dates and `filed_from` must not follow `filed_to`.\n- Fact views (`financials`, `revenue_breakdown`) require `accession`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for companies.financials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesFinancialsRequest"},"examples":{"where-nvidia-earns-its-revenue":{"summary":"Where NVIDIA earns its revenue","value":{"company":{"ticker":"NVDA"},"forms":["10-K"],"num":1}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompaniesFinancialsExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"companies.financials","x-aipa-pillar":"research","x-aipa-vendor":"SEC EDGAR","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Public SEC data; no per-request provider charge. Stored facts and buffered pages are free.","x-aipa-paging":"local","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"mixed","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details","financials","revenue_breakdown"],"x-aipa-update-params":{"$ref":"#/components/schemas/CompaniesFinancialsUpdateParams"},"x-aipa-summary-keys":[{"key":"cik","type":"string","presence":"always"},{"key":"issuer","type":"string","presence":"when_available","note":"Filings view."},{"key":"accession","type":"string","presence":"always"},{"key":"form","type":"string","presence":"when_available","note":"Filings view."},{"key":"filed_at","type":"string","presence":"when_available","note":"Filings view."},{"key":"report_date","type":"string","presence":"when_available","note":"Filings view."},{"key":"accepted_at","type":"string | null","presence":"when_available","note":"Filings view."},{"key":"primary_document","type":"string","presence":"when_available","note":"Filings view."},{"key":"primary_url","type":"string","presence":"when_available","note":"Filings view."},{"key":"is_amendment","type":"boolean","presence":"when_available","note":"Filings view."},{"key":"fact_id","type":"string","presence":"when_available","note":"Fact views."},{"key":"value","type":"number | string","presence":"when_available","note":"Fact views."},{"key":"unit","type":"object","presence":"when_available","note":"Fact views."},{"key":"period","type":"object","presence":"when_available","note":"Fact views."},{"key":"dimensions","type":"object[]","presence":"when_available","note":"Fact views."},{"key":"source","type":"string","presence":"always"}],"x-aipa-record-details":{"details":{"$ref":"#/components/schemas/CompaniesFinancialsDetailsDetail"},"financials":{"$ref":"#/components/schemas/CompaniesFinancialsFinancialsDetail"},"revenue_breakdown":{"$ref":"#/components/schemas/CompaniesFinancialsRevenueBreakdownDetail"}},"x-aipa-rules":["A ticker must identify exactly one SEC filer; otherwise use the CIK.","`filed_from` and `filed_to` must be valid ISO dates and `filed_from` must not follow `filed_to`.","Fact views (`financials`, `revenue_breakdown`) require `accession`."]}},"/v1/capabilities/legal.search/execute":{"post":{"tags":["Research and reading"],"operationId":"executeLegalSearch","summary":"Legal sources","description":"Discover US case law or EU legal sources with source identifiers and links. US court groups and year ranges apply to case-law discovery. EU source identity is verified where the original is accessible. Search results are source records, not a legal opinion; use legal.read for the original text.\n\nTypical credits: 4. Cost basis: US discovery: $0.004 per SearchApi page. EU discovery: actual Serper credits × $0.001, plus actual Firecrawl credits × $0.005 when an original requires retrieval fallback. Direct official sources and cached details are free.\n\nRules enforced after schema validation (400 invalid_request):\n- `from_year` must not exceed `to_year`.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for legal.search.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalSearchRequest"},"examples":{"us-privacy-decisions":{"summary":"US privacy decisions","value":{"search":{"jurisdiction":"us","query":"privacy publication truthful information","courts":"federal"},"num":3}},"eu-right-to-be-forgotten":{"summary":"EU right to be forgotten","value":{"search":{"jurisdiction":"eu","query":"right to be forgotten","kind":"judgment","language":"EN"},"num":3}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalSearchExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"legal.search","x-aipa-pillar":"research","x-aipa-vendor":"SearchApi, Serper and official legal sources","x-aipa-typical-credits":4,"x-aipa-cost-basis":"US discovery: $0.004 per SearchApi page. EU discovery: actual Serper credits × $0.001, plus actual Firecrawl credits × $0.005 when an original requires retrieval fallback. Direct official sources and cached details are free.","x-aipa-paging":"page","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/LegalSearchUpdateParams"},"x-aipa-summary-keys":[{"key":"identifier","type":"string","presence":"always"},{"key":"source","type":"string","presence":"always"},{"key":"source_class","type":"string","presence":"always"},{"key":"language","type":"string","presence":"when_available"},{"key":"ecli","type":"string","presence":"when_available","note":"EU judgments."},{"key":"document_kind","type":"string","presence":"when_available"},{"key":"full_text","type":"object","presence":"when_available","note":"`{ capability: \"legal.read\", params }`, a typed next request."}],"x-aipa-record-details":{},"x-aipa-rules":["`from_year` must not exceed `to_year`."]}},"/v1/capabilities/legal.read/execute":{"post":{"tags":["Research and reading"],"operationId":"executeLegalRead","summary":"Original legal texts","description":"Read an identified EUR-Lex document, Library of Congress U.S. Reports opinion, Google Scholar case or the original 1890 Right to Privacy article. Returns bounded text chunks with source provenance; more continues the same document. PDF page indices and printed court pages remain distinct. Source access failures are reported instead of returning a challenge page as text.\n\nTypical credits: 0. Cost basis: Direct official and historical texts are free. Scholar case retrieval uses SearchApi at $0.004. EUR-Lex and historical-source fallback uses actual Firecrawl credits × $0.005. Buffered text and cached details are free.\n\nRules enforced after schema validation (400 invalid_request):\n- An invalid U.S. Reports identifier is refused before any fetch.","security":[{"apiKey":[]}],"requestBody":{"required":true,"description":"Request body for legal.read.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalReadRequest"},"examples":{"google-spain-judgment":{"summary":"Google Spain judgment","value":{"document":{"source":"eurlex","celex":"62012CJ0131","language":"EN"},"num":3}},"a-us-privacy-case":{"summary":"A US privacy case","value":{"document":{"source":"us_reports","item_id":"usrep532514"},"num":3}},"the-original-1890-argument":{"summary":"The original 1890 argument","value":{"document":{"source":"historical","work_id":"warren-brandeis-right-to-privacy-1890"},"num":3}}}}}},"responses":{"200":{"description":"The execute envelope with this capability's documented record keys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegalReadExecuteResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-aipa-capability":"legal.read","x-aipa-pillar":"research","x-aipa-vendor":"Official sources, SearchApi and Firecrawl","x-aipa-typical-credits":0,"x-aipa-cost-basis":"Direct official and historical texts are free. Scholar case retrieval uses SearchApi at $0.004. EUR-Lex and historical-source fallback uses actual Firecrawl credits × $0.005. Buffered text and cached details are free.","x-aipa-paging":"local","x-aipa-search-deadline-ms":40000,"x-aipa-detail":"cached","x-aipa-search-actions":["more","update"],"x-aipa-record-actions":["details"],"x-aipa-update-params":{"$ref":"#/components/schemas/LegalReadUpdateParams"},"x-aipa-summary-keys":[{"key":"identifier","type":"string","presence":"always"},{"key":"source_class","type":"string","presence":"always"},{"key":"language","type":"string","presence":"when_available"},{"key":"section","type":"integer","presence":"always"},{"key":"total_sections","type":"integer","presence":"always"},{"key":"pdf_page","type":"integer","presence":"when_available","note":"PDF sources."},{"key":"printed_page","type":"string","presence":"when_available","note":"U.S. Reports."},{"key":"paragraph_anchors","type":"string[]","presence":"when_available"},{"key":"extraction_method","type":"string","presence":"always"}],"x-aipa-record-details":{"details":{"$ref":"#/components/schemas/LegalReadDetailsDetail"}},"x-aipa-rules":["An invalid U.S. Reports identifier is refused before any fetch."]}},"/v1/follow-up":{"post":{"operationId":"followUp","tags":["abilities"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowUpRequest"}}}},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ExecuteResponse"},{"$ref":"#/components/schemas/RecordFollowUpResponse"}]}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"410":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"summary":"Continue a search or open a record","description":"Send exactly one of search_id or record_id. Search actions \"more\" and \"update\" return the execute envelope with the same search_id; record actions return a record envelope. `x-aipa-update-params` maps each capability to the params accepted by \"update\"; `x-aipa-record-actions` lists the record actions per capability; `x-aipa-record-details` maps the record actions whose detail our code builds in full to their documented-tier schema (detail stays `unknown` on the wire).","x-aipa-update-params":{"web.search":{"$ref":"#/components/schemas/WebSearchUpdateParams"},"academic.search":{"$ref":"#/components/schemas/AcademicSearchUpdateParams"},"scripture.search":{"$ref":"#/components/schemas/ScriptureSearchUpdateParams"},"classics.search":{"$ref":"#/components/schemas/ClassicsSearchUpdateParams"},"books.search":{"$ref":"#/components/schemas/BooksSearchUpdateParams"},"music.search":{"$ref":"#/components/schemas/MusicSearchUpdateParams"},"youtube.search":{"$ref":"#/components/schemas/YoutubeSearchUpdateParams"},"hotels.search":{"$ref":"#/components/schemas/HotelsSearchUpdateParams"},"github.search":{"$ref":"#/components/schemas/GithubSearchUpdateParams"},"npm.search":{"$ref":"#/components/schemas/NpmSearchUpdateParams"},"pypi.search":{"$ref":"#/components/schemas/PypiSearchUpdateParams"},"social.search":{"$ref":"#/components/schemas/SocialSearchUpdateParams"},"shopping.search":{"$ref":"#/components/schemas/ShoppingSearchUpdateParams"},"markets.quote":{"$ref":"#/components/schemas/MarketsQuoteUpdateParams"},"jobs.search":{"$ref":"#/components/schemas/JobsSearchUpdateParams"},"patents.search":{"$ref":"#/components/schemas/PatentsSearchUpdateParams"},"realestate.search":{"$ref":"#/components/schemas/RealestateSearchUpdateParams"},"news.search":{"$ref":"#/components/schemas/NewsSearchUpdateParams"},"trends.search":{"$ref":"#/components/schemas/TrendsSearchUpdateParams"},"recipes.search":{"$ref":"#/components/schemas/RecipesSearchUpdateParams"},"fitness.exercises":{"$ref":"#/components/schemas/FitnessExercisesUpdateParams"},"places.search":{"$ref":"#/components/schemas/PlacesSearchUpdateParams"},"transit.routes":{"$ref":"#/components/schemas/TransitRoutesUpdateParams"},"companies.financials":{"$ref":"#/components/schemas/CompaniesFinancialsUpdateParams"},"legal.search":{"$ref":"#/components/schemas/LegalSearchUpdateParams"},"legal.read":{"$ref":"#/components/schemas/LegalReadUpdateParams"}},"x-aipa-record-actions":{"web.search":["read"],"web.read":[],"academic.search":["details"],"scripture.search":["details"],"classics.search":["details"],"books.search":["details"],"music.search":["details"],"youtube.search":["details","transcript"],"weather.forecast":[],"navigation.route":["details"],"navigation.matrix":[],"hotels.search":["details"],"flights.search":["details"],"github.search":["details"],"npm.search":["details"],"npm.package":["details"],"npm.downloads":[],"pypi.details":["details"],"pypi.versions":["details"],"pypi.downloads":[],"pypi.search":["details"],"social.search":["details"],"shopping.search":["details"],"markets.quote":["details"],"jobs.search":["details"],"patents.search":["details"],"realestate.search":["details"],"news.search":["details"],"trends.search":["details"],"recipes.search":["details"],"fitness.exercises":["details"],"places.search":["details"],"transit.routes":["details"],"companies.financials":["details","financials","revenue_breakdown"],"legal.search":["details"],"legal.read":["details"]},"x-aipa-record-details":{"youtube.search":{"details":{"$ref":"#/components/schemas/YoutubeSearchDetailsDetail"},"transcript":{"$ref":"#/components/schemas/YoutubeSearchTranscriptDetail"}},"navigation.route":{"details":{"$ref":"#/components/schemas/NavigationRouteDetailsDetail"}},"flights.search":{"details":{"$ref":"#/components/schemas/FlightsSearchDetailsDetail"}},"companies.financials":{"details":{"$ref":"#/components/schemas/CompaniesFinancialsDetailsDetail"},"financials":{"$ref":"#/components/schemas/CompaniesFinancialsFinancialsDetail"},"revenue_breakdown":{"$ref":"#/components/schemas/CompaniesFinancialsRevenueBreakdownDetail"}},"legal.read":{"details":{"$ref":"#/components/schemas/LegalReadDetailsDetail"}}}}},"/v1/sharpen":{"post":{"operationId":"sharpen","tags":["sharpen"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharpenRequest"}}}},"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SharpenResponse"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/account":{"get":{"operationId":"getAccount","tags":["account"],"security":[{"apiKey":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/guide":{"get":{"operationId":"getGuide","tags":["account"],"responses":{"200":{"description":"The guide as text/markdown.","content":{"text/markdown":{"schema":{"type":"string"}}}}},"summary":"Integration guide (Markdown)"}},"/v1/projects/status":{"post":{"operationId":"projectsStatus","tags":["projects-tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":["string","null"],"description":"Absolute virtual project/directory path, or null for /projects.","maxLength":4096},"request_id":{"type":["string","null"],"description":"Existing operation request ID to inspect, or null for workspace status.","maxLength":128},"upload_id":{"type":["string","null"],"description":"Existing upload ID to inspect, or null.","maxLength":128},"cursor":{"type":["string","null"],"description":"Opaque page cursor, or null for the first page.","maxLength":4096}},"required":["path","request_id","upload_id","cursor"],"additionalProperties":false}}}},"security":[{"apiKey":[]},{"bearer":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}}}}},"/v1/projects/bash":{"post":{"operationId":"projectsBash","tags":["projects-tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","minLength":1,"maxLength":128,"description":"Unique ID for this intended operation. Reuse only to retry the identical input. The server scopes this ID to the authenticated account and connection."},"command":{"type":"string","minLength":1,"maxLength":65536,"description":"Bash-compatible source. Handler also enforces a 64 KiB UTF-8 byte ceiling; the character limit alone is not sufficient."},"cwd":{"type":"string","minLength":1,"maxLength":4096,"description":"Absolute virtual starting directory for this call. Use /projects for discovery. cd does not persist to a later call."},"mode":{"type":"string","enum":["read","write"],"description":"read forbids persistent mutation but permits bounded /tmp work. write requests authorized persistent changes; it never elevates privileges."},"base_revision":{"type":["integer","null"],"description":"Observed project revision required for existing-project writes. Null for reads or creation of exactly one new project.","minimum":0,"maximum":9007199254740991}},"required":["request_id","command","cwd","mode","base_revision"],"additionalProperties":false}}}},"security":[{"apiKey":[]},{"bearer":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}}}}},"/v1/projects/open":{"post":{"operationId":"projectsOpen","tags":["projects-tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","minLength":1,"maxLength":4096,"description":"Absolute virtual path under /projects. The server resolves it within the authenticated grant; this is not a local machine or Storage object path."},"view":{"type":"string","enum":["metadata","text","preview","download"],"description":"Requested representation; unsupported previews return a truthful error and metadata/download alternative."},"version_id":{"type":["string","null"],"description":"Specific retained version to open, or null for the current committed version.","maxLength":128},"cursor":{"type":["string","null"],"description":"Opaque text-page cursor bound to one file version, or null.","maxLength":4096}},"required":["path","view","version_id","cursor"],"additionalProperties":false}}}},"security":[{"apiKey":[]},{"bearer":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}}}}},"/v1/projects/uploads":{"post":{"operationId":"projectsUpload","tags":["projects-tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"request_id":{"type":"string","minLength":1,"maxLength":128,"description":"Unique ID for this intended operation. Reuse only to retry the identical input. The server scopes this ID to the authenticated account and connection."},"action":{"type":"string","enum":["prepare","finalize","cancel"],"description":"prepare reserves and creates a transfer grant; finalize publishes validated bytes; cancel revokes and schedules cleanup."},"upload_id":{"type":["string","null"],"description":"Existing upload ID for finalize/cancel; null for prepare.","maxLength":128},"path":{"type":["string","null"],"description":"Destination absolute virtual file path for prepare. On finalize, null keeps the prepared path; an explicit path must remain in the same authorized project.","maxLength":4096},"size_bytes":{"type":["integer","null"],"description":"Expected binary byte count for prepare. Null for finalize/cancel. The server verifies and enforces actual bytes.","minimum":0,"maximum":9007199254740991},"mime_type":{"type":["string","null"],"description":"Declared MIME type for prepare; treated as untrusted metadata. Null for other actions.","maxLength":255},"base_revision":{"type":["integer","null"],"description":"Observed project revision for prepare/finalize. Null for cancel.","minimum":0,"maximum":9007199254740991},"replace":{"type":["boolean","null"],"description":"Explicit replacement intent for prepare. Null for finalize/cancel; finalization preserves the prepared overwrite intent."}},"required":["request_id","action","upload_id","path","size_bytes","mime_type","base_revision","replace"],"additionalProperties":false}}}},"security":[{"apiKey":[]},{"bearer":[]}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}},"202":{"description":"Default Response","content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","commit_status","request_id","operation_id","data","error"],"properties":{"status":{"anyOf":[{"type":"string","enum":["completed"]},{"type":"string","enum":["failed"]},{"type":"string","enum":["pending"]}]},"commit_status":{"anyOf":[{"type":"string","enum":["committed"]},{"type":"string","enum":["not_committed"]},{"type":"string","enum":["not_applicable"]},{"type":"string","enum":["unknown"]}]},"request_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"data":{"type":"object","additionalProperties":{}},"error":{"anyOf":[{"additionalProperties":false,"type":"object","required":["code","message","retryable","retry_strategy","required_bytes","available_bytes","current_revision","recovery_url"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"retry_strategy":{"anyOf":[{"type":"string","enum":["none"]},{"type":"string","enum":["same_request"]},{"type":"string","enum":["refresh_then_new_request"]},{"type":"string","enum":["check_status"]}]},"required_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"available_bytes":{"anyOf":[{"type":"number"},{"type":"null"}]},"current_revision":{"anyOf":[{"type":"number"},{"type":"null"}]},"recovery_url":{"anyOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]}}}}}}}}}}}