Fastapi Docs

Fastapi Docs Documentation

Comprehensive reference documentation for Fastapi Docs.

Original Sources:

• https://fastapi.tiangolo.com/

Contains: 243 markdown files with full folder structure (crawled at depth 2). Last updated: March 08, 2026

📚 Table of Contents

• 📁 advanced_security_oauth2-scopes/
  • 📁 OAuth2-scopeshttpsfastapi.tiangolo.comadvancedsecurityoauth2-scopesoauth2-scopes/
    • About Third Party Integrationshttpsfastapi.Tiangolo.Comadvancedsecurityoauth2 Scopesabout Third Party Integrations
    • Check Ithttpsfastapi.Tiangolo.Comadvancedsecurityoauth2 Scopescheck It
    • to get a string like this run:
    • Dependency Tree And Scopeshttpsfastapi.Tiangolo.Comadvancedsecurityoauth2 Scopesdependency Tree And Scopes
    • to get a string like this run:
    • to get a string like this run:
    • More Details About Securityscopeshttpsfastapi.Tiangolo.Comadvancedsecurityoauth2 Scopesmore Details About Securityscopes
    • to get a string like this run:
    • Oauth2 Scopes And Openapihttpsfastapi.Tiangolo.Comadvancedsecurityoauth2 Scopesoauth2 Scopes And Openapi
    • Security In Decorator Dependencieshttpsfastapi.Tiangolo.Comadvancedsecurityoauth2 Scopessecurity In Decorator Dependencies
    • to get a string like this run:
    • to get a string like this run:
    • to get a string like this run:
    • to get a string like this run:
  • OAuth2 scopes¶
  • Advanced Security Oauth2 Scopes
  • Table of Contents
• 📁 advanced_stream-data/
  • 📁 Stream-Datahttpsfastapi.tiangolo.comadvancedstream-datastream-data/
    • Code above omitted 👆
    • Code below omitted 👇
    • Use Caseshttpsfastapi.Tiangolo.Comadvancedstream Datause Cases
  • Stream Data¶
  • Advanced Stream Data
  • Table of Contents
• 📁 reference_apirouter/
  • APIRouter class¶
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt1
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt10
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt11
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt2
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt3
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt4
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt5
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt6
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt7
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt8
  • Fastapi.Apirouter Httpsfastapi.Tiangolo.Comreferenceapirouterfastapi.Apirouter Permanent Link Pt9
  • Reference Apirouter
  • Table of Contents
• 📁 reference_fastapi/
  • FastAPI class¶
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt1
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt10
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt11
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt12
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt2
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt3
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt4
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt5
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt6
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt7
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt8
  • Fastapi.Fastapi Httpsfastapi.Tiangolo.Comreferencefastapifastapi.Fastapi Permanent Link Pt9
  • Reference Fastapi
  • Table of Contents
• 📁 reference_openapi_models/
  • OpenAPI models¶
  • Fastapi.Openapi.Models Httpsfastapi.Tiangolo.Comreferenceopenapimodelsfastapi.Openapi.Models Permanent Link Pt1
  • Fastapi.Openapi.Models Httpsfastapi.Tiangolo.Comreferenceopenapimodelsfastapi.Openapi.Models Permanent Link Pt2
  • Fastapi.Openapi.Models Httpsfastapi.Tiangolo.Comreferenceopenapimodelsfastapi.Openapi.Models Permanent Link Pt3
  • Fastapi.Openapi.Models Httpsfastapi.Tiangolo.Comreferenceopenapimodelsfastapi.Openapi.Models Permanent Link Pt4
  • Reference Openapi Models Pt1
  • Reference Openapi Models Pt2
  • Reference Openapi Models Pt3
  • Reference Openapi Models Pt4
  • Table of Contents
• 📁 reference_parameters/
  • 📁 Request-Parametershttpsfastapi.tiangolo.comreferenceparametersrequest-parameters/
    • Fastapi.Body Httpsfastapi.Tiangolo.Comreferenceparametersfastapi.Body Permanent Link
    • Fastapi.File Httpsfastapi.Tiangolo.Comreferenceparametersfastapi.File Permanent Link
    • Fastapi.Header Httpsfastapi.Tiangolo.Comreferenceparametersfastapi.Header Permanent Link
    • Fastapi.Query Httpsfastapi.Tiangolo.Comreferenceparametersfastapi.Query Permanent Link
  • Request Parameters¶
  • Reference Parameters
  • Table of Contents
• 📁 reference_responses/
  • 📁 Custom-Response-Classes---File-HTML-Redirect-Streaming-etc.httpsfastapi.tiangolo.comreferenceresponsescustom-response-classes-file-html-redirect-streaming-etc/
    • Fastapi Responseshttpsfastapi.Tiangolo.Comreferenceresponsesfastapi Responses
    • Starlette Responseshttpsfastapi.Tiangolo.Comreferenceresponsesstarlette Responses
    • Fastapi.Responses.Fileresponse Httpsfastapi.Tiangolo.Comreferenceresponsesfastapi.Responses.Fileresponse Permanent Link
    • Fastapi.Responses.Jsonresponse Httpsfastapi.Tiangolo.Comreferenceresponsesfastapi.Responses.Jsonresponse Permanent Link
    • Fastapi.Responses.Redirectresponse Httpsfastapi.Tiangolo.Comreferenceresponsesfastapi.Responses.Redirectresponse Permanent Link
    • Fastapi.Responses.Streamingresponse Httpsfastapi.Tiangolo.Comreferenceresponsesfastapi.Responses.Streamingresponse Permanent Link
    • Fastapi.Responses.Ujsonresponse Httpsfastapi.Tiangolo.Comreferenceresponsesfastapi.Responses.Ujsonresponse Permanent Link
  • Custom Response Classes - File, HTML, Redirect, Streaming, etc.¶
  • Reference Responses
  • Table of Contents
• 📁 reference_security/
  • 📁 Security-Toolshttpsfastapi.tiangolo.comreferencesecuritysecurity-tools/
    • Api Key Security Schemeshttpsfastapi.Tiangolo.Comreferencesecurityapi Key Security Schemes
    • Http Credentialshttpsfastapi.Tiangolo.Comreferencesecurityhttp Credentials
    • Oauth2 Authenticationhttpsfastapi.Tiangolo.Comreferencesecurityoauth2 Authentication
    • Oauth2 Password Formhttpsfastapi.Tiangolo.Comreferencesecurityoauth2 Password Form
    • Oauth2 Security Scopes In Dependencieshttpsfastapi.Tiangolo.Comreferencesecurityoauth2 Security Scopes In Dependencies
    • Fastapi.Security.Apikeycookie Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Apikeycookie Permanent Link
    • Fastapi.Security.Apikeyquery Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Apikeyquery Permanent Link
    • Fastapi.Security.Httpauthorizationcredentials Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Httpauthorizationcredentials Permanent Link
    • Fastapi.Security.Httpbasiccredentials Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Httpbasiccredentials Permanent Link
    • Fastapi.Security.Httpbearer Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Httpbearer Permanent Link
    • Fastapi.Security.Oauth2 Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Oauth2 Permanent Link
    • Fastapi.Security.Oauth2Authorizationcodebearer Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Oauth2Authorizationcodebearer Permanent Link
    • Fastapi.Security.Oauth2Passwordbearer Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Oauth2Passwordbearer Permanent Link
    • Fastapi.Security.Oauth2Passwordrequestform Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Oauth2Passwordrequestform Permanent Link
    • Fastapi.Security.Securityscopes Httpsfastapi.Tiangolo.Comreferencesecurityfastapi.Security.Securityscopes Permanent Link
  • Security Tools¶
  • Reference Security
  • Table of Contents
• 📁 reference_testclient/
  • Test Client - TestClient¶
  • Reference Testclient
  • Table of Contents
• 📁 tutorial_query-params-str-validations/
  • Query Parameters and String Validations¶
  • Table of Contents
  • Tutorial Query Params Str Validations
• 📁 tutorial_security_oauth2-jwt/
  • OAuth2 with Password (and hashing), Bearer with JWT tokens¶
  • Table of Contents
  • Tutorial Security Oauth2 Jwt
• 📁 tutorial_security_simple-oauth2/
  • Simple OAuth2 with Password and Bearer¶
  • Table of Contents
  • Tutorial Security Simple Oauth2
• 📁 tutorial_sql-databases/
  • 📁 SQL-Relational-Databaseshttpsfastapi.tiangolo.comtutorialsql-databasessql-relational-databases/
    • Code below omitted 👇
    • Install Sqlmodelhttpsfastapi.Tiangolo.Comtutorialsql Databasesinstall Sqlmodel
    • Recaphttpsfastapi.Tiangolo.Comtutorialsql Databasesrecap
  • SQL (Relational) Databases¶
  • Code above omitted 👆
  • Code above omitted 👆
  • Code above omitted 👆
  • Table of Contents
  • Tutorial Sql Databases
• Llm Test
• About
• Advanced
• Advanced Additional Responses
• Advanced Additional Status Codes
• Advanced Advanced Dependencies
• Advanced Advanced Python Types
• Advanced Async Tests
• Advanced Behind A Proxy
• Advanced Custom Response
• Advanced Dataclasses
• Advanced Events
• Advanced Generate Clients
• Advanced Json Base64 Bytes
• Advanced Middleware
• Advanced Openapi Callbacks
• Advanced Openapi Webhooks
• Advanced Path Operation Advanced Configuration
• Advanced Response Change Status Code
• Advanced Response Cookies
• Advanced Response Directly
• Advanced Response Headers
• Advanced Security
• Advanced Security Http Basic Auth
• Advanced Settings
• Advanced Strict Content Type
• Advanced Sub Applications
• Advanced Templates
• Advanced Testing Dependencies
• Advanced Testing Events
• Advanced Testing Websockets
• Advanced Using Request Directly
• Advanced Wsgi
• Alternatives
• Async
• Benchmarks
• Contributing
• Deployment Concepts
• Deployment Docker
• Deployment Fastapicloud
• Deployment Https
• Deployment Manually
• Deployment Server Workers
• Editor Support
• Environment Variables
• Fastapi Cli
• Fastapi People
• Features
• Help Fastapi
• How To
• How To Authentication Error Status Code
• How To Conditional Openapi
• How To Configure Swagger Ui
• How To Custom Docs Ui Assets
• How To Custom Request And Route
• How To Extending Openapi
• How To General
• How To Graphql
• How To Migrate From Pydantic V1 To Pydantic V2
• How To Separate Openapi Schemas
• How To Testing Database
• Index
• Learn
• Management Tasks
• Management
• Newsletter
• Project Generation
• Python Types
• Reference
• Reference Background
• Reference Dependencies
• Reference Encoders
• Reference Exceptions
• Reference Httpconnection
• Reference Middleware
• Reference Openapi Docs
• Reference Request
• Reference Response
• Reference Staticfiles
• Reference Status
• Reference Templating
• Reference Uploadfile
• Reference Websockets
• Resources
• Translation Banner
• Tutorial
• Tutorial Background Tasks
• Tutorial Bigger Applications
• Tutorial Body Fields
• Tutorial Body Multiple Params
• Tutorial Body Nested Models
• Tutorial Body Updates
• Tutorial Body
• Tutorial Cookie Param Models
• Tutorial Debugging
• Tutorial Dependencies Classes As Dependencies
• Tutorial Dependencies Dependencies In Path Operation Decorators
• Tutorial Dependencies Global Dependencies
• Tutorial Encoder
• Tutorial Extra Data Types
• Tutorial Extra Models
• Tutorial First Steps
• Tutorial Handling Errors
• Tutorial Header Param Models
• Tutorial Header Params
• Tutorial Metadata
• Tutorial Middleware
• Tutorial Path Operation Configuration
• Tutorial Path Params Numeric Validations
• Tutorial Path Params
• Tutorial Query Param Models
• Tutorial Query Params
• Tutorial Request Files
• Tutorial Request Form Models
• Tutorial Request Forms And Files
• Tutorial Request Forms
• Tutorial Response Model
• Tutorial Response Status Code
• Tutorial Schema Extra Example
• Tutorial Security
• Tutorial Security First Steps
• Tutorial Security Get Current User
• Tutorial Server Sent Events
• Tutorial Static Files
• Tutorial Stream Json Lines

🤖 Agent Usage Guide

• When the user asks anything about Fastapi Docs, consult the reference files.
• Prefer exact quotes and direct links to the relevant file/section.
• The hierarchical TOC above makes navigation fast and intuitive.
• All images and assets are preserved so links work perfectly.