The identity and technical contract details declared by the specification.
ThinkingPart
object
A thinking response from a model.
6 properties
1 required
AudioUrl
object
A URL to an audio file.
6 properties
3 required
AddressResolveRequest
object
Autocomplete resolve for address entry: free text (street address, place name, or parcel number) — no project exists yet on this path. countyfips (5-digit GEOI…
2 properties
1 required
ValidationError
object
5 properties
3 required
ViewModel-Input
object
Model for a view
18 properties
2 required
ViewsGetResponse
object
Response model for getting project views. Attributes: views: List of view models
1 property
1 required
NativeToolReturnPart
object
A tool return message from a native tool. For native tools with a stable cross-provider shape (currently toolsearch), a NativeToolReturnPart may be promoted to…
10 properties
2 required
ViewModel-Output
object
Model for a view
18 properties
2 required
BatchOutcomeKind
string
Per-row bucket for a batch resolve, derived from a single row's ResolutionResult plus its raw input. Coarser than the single-address ResolutionOutcome: it spli…
ProjectListResponse
object
Response model for listing all projects Attributes: projects: List of projects if available
1 property
ModelResponse
object
A response from a model, e.g. a message from the model to the Pydantic AI app.
14 properties
1 required
ToolSearchReturnPart
object
Typed view of a [ToolReturnPart][pydanticai.messages.ToolReturnPart] for the local searchtools function return. Used on the local-fallback path (and as the syn…
8 properties
1 required
AddressResolveManyRequest
object
Batch resolve for paste-a-handful entry: a few free-text address rows, one per pasted line (blanks already dropped client-side but tolerated here). countyfips…
2 properties
1 required
CompoundFilter-Output
object
5 properties
2 required
ProjectUpdateResponse
object
Response model for project update endpoint. Attributes: success: Boolean indicating if the project was updated successfully message: Descriptive message about…
3 properties
2 required
ViewCreateResponse
object
Response model for creating a new view. Attributes: success: Boolean indicating if the creation was successful view: The created view model
2 properties
2 required
UserPromptPart
object
A user prompt, generally written by the end user. Content comes from the userprompt parameter of [Agent.run][pydanticai.agent.AbstractAgent.run], [Agent.runsyn…
3 properties
1 required
ProjectDeleteResponse
object
Response model for project deletion endpoint Attributes: message: Descriptive message about the result
1 property
1 required
BinaryContent
object
Binary content, e.g. an audio or image file.
5 properties
3 required
ErrorDetails
object
6 properties
4 required
ProjectTitleSource
string
Provenance + lifecycle for the project's name field. Replaces an em-dash string heuristic (" — " not in project.name) that gated whether the sandbox auto-title…
ProjectResponse
object
API response model for a project with string IDs. Attributes: id: String representation of project UUID name: Display name of the project description: Optional…
23 properties
2 required
SpatialOperationType
string
ToolSearchMatch
object
A single match in a tool-search result.
2 properties
2 required
SandboxWarmCountyRequest
object
Pre-warm a county boundary MV without creating a project. Called when the user soft-selects a county in the picker so the boundary MV builds in parallel with p…
1 property
1 required
ChatHistoryResponseSchema
object
Schema for the chat history of a project.
2 properties
1 required
AddressResolveManyResponse
object
Per-row outcomes for a pasted batch, one row per input in input order.
1 property
1 required
AddressBatchCreateFlowRequest
object
Create one sandbox project from several confirmed features (paste flow). Every feature must derive to the same county (a project is scoped to one county under…
1 property
1 required
ProjectStatus
string
Lifecycle status for a project. Replaces the boolean iscreated whose name implied "was created" (always True once inserted) but semantically meant "is ready fo…
LoadCapabilityArgs
object
Typed arguments for a loadcapability tool call.
1 property
1 required
ViewsReorderRequest
object
Request model for reordering a project's views. Attributes: viewids: The full ordered list of view ids; must be an exact permutation of the project's current v…
1 property
1 required
NativeToolSearchCallPart
object
Typed view of a [NativeToolCallPart][pydanticai.messages.NativeToolCallPart] for tool search. Used on the native server-side tool-search path (Anthropic BM25/r…
8 properties
ChatUserInfo
object
Sender info for chat message attribution.
2 properties
ProjectPlan
object
Tracks the current state of all layers in a project. Initially created during project setup, then kept in sync as the agent adds or removes layers. Used by the…
7 properties
4 required
ViewUpdateResponse
object
Response model for updating a single view. Attributes: success: Boolean indicating if the update was successful view: The updated view model
2 properties
2 required
ShareLinkResponse
object
Response containing share link details for a project owner.
5 properties
4 required
CachePoint
object
A cache point marker for prompt caching. Can be inserted into UserPromptPart.content to mark cache boundaries. Models that don't support caching will filter th…
2 properties
SpatialOperation
object
2 properties
1 required
CompactionPart
object
A compaction part that summarizes previous conversation history. Compaction parts contain an opaque or readable summary of prior messages, produced by provider…
5 properties
ChatHistorySchema
object
Schema for a single chat with its full history.
5 properties
2 required
ProjectVisibilityUpdate
string
User-facing visibility options for updating project visibility. Separate from ProjectVisibility to: - Prevent setting visibility to 'example' via the API - Map…
DateCondition
object
4 properties
1 required
CompoundFilter-Input
object
5 properties
2 required
DocumentUrl
object
The URL of the document.
6 properties
3 required
RequestUsage
object
LLM usage associated with a single request. This is an implementation of genaiprices.types.AbstractUsage so it can be used to calculate the price of the reques…
8 properties
ViewDeleteResponse
object
Response model for deleting a view. Attributes: success: Boolean indicating if the deletion was successful message: Optional message providing additional infor…
2 properties
1 required
ToolSearchArgs
object
Typed arguments for a tool-search call. Carried on [NativeToolSearchCallPart.args][pydanticai.messages.NativeToolSearchCallPart.args] (native server-side path)…
1 property
1 required
FilePart
object
A file response from a model.
5 properties
1 required
SetDefaultViewRequest
object
Request model for setting a project's durable default view. Attributes: viewid: The view id to designate as the project default, or null to clear it. A non-nul…
1 property
AddressResolveResponse
object
Ranked, label-hydrated candidates for one resolve. notindataset means the reference isn't in any county the workspace has loaded — the surface reports "not in…
2 properties
1 required
RetryPromptPart
object
A message back to a model asking it to try again. This can be sent for a number of reasons: Pydantic validation of tool arguments failed, here content is deriv…
5 properties
1 required
BatchResolutionRow
object
One pasted row's outcome for the review list. kind buckets the row (matched / ambiguous / notindataset / emptyinput); candidates are the ranked, label-hydrated…
4 properties
4 required
MapFilterModel
object
Model for a map filter (spatial filter)
2 properties
2 required
ToolSearchCallPart
object
Typed view of a [ToolCallPart][pydanticai.messages.ToolCallPart] for the local searchtools function call. Used on the local-fallback path (and as the synthetic…
8 properties
ModelRequest
object
A request generated by Pydantic AI and sent to a model, e.g. a message from the Pydantic AI app to the model.
7 properties
1 required
ProjectUpdate
object
Request model for updating a project's basic information. Attributes: name: Optional new name for the project description: Optional new description for the pro…
3 properties
SourceTable
string
The table a resolved feature lives in — what a caller pulls its data from, and the feature's kind. A text match in the address or place table resolves (point-i…
HTTPValidationError
object
1 property
VideoUrl
object
A URL to a video.
6 properties
3 required
AddressCreateFlowRequest
object
Create a sandbox project from a confirmed resolved feature reference. The FE confirm card holds only (sourcetable, featureid) — the server derives the county s…
2 properties
2 required
ViewUpdateModel
object
Model for partial view updates - all fields optional except id.
17 properties
1 required
AddressCandidate
object
One ranked candidate the confirm surface can render and hand back to POST /project/sandbox/from-feature as (sourcetable, featureid). similarity is the raw matc…
5 properties
4 required
ResolutionOutcome
string
Result classification. notloadedcounty (a real reference in a county this workspace hasn't loaded) is reserved for the forward-geocoder path, the only place ab…
LoadCapabilityReturnPart
object
Typed ToolReturnPart for the loadcapability tool.
8 properties
1 required
UploadedFile
object
A reference to a file uploaded to a provider's file storage by ID. This allows referencing files that have been uploaded via provider-specific file APIs rather…
6 properties
4 required
ThumbnailBounds
object
Bounding box for project thumbnail map rendering. Represents the geographic extent of project features for generating static map thumbnails via Mapbox.
4 properties
4 required
SystemPromptPart
object
A system prompt, generally written by the application developer. This gives the model context and guidance on how to respond.
4 properties
1 required
NativeToolCallPart
object
A tool call to a native tool. For native tools with a stable cross-provider shape (currently toolsearch), this base class can be promoted to a typed subclass w…
8 properties
1 required
ProjectVisibility
string
Visibility status for projects. NULL/None = private (default, only owner can see) WORKSPACEREAD = visible to all workspace members (read-only) WORKSPACEWRITE =…
ImageUrl
object
A URL to an image.
6 properties
3 required
ViewCreateRequest
object
Request model for creating a new view. Attributes: view: The view to create
1 property
1 required
LoadCapabilityCallPart
object
Typed ToolCallPart for the loadcapability tool.
8 properties
NativeToolSearchReturnPart
object
Typed view of a [NativeToolReturnPart][pydanticai.messages.NativeToolReturnPart] for tool search. Used on the native server-side tool-search path (Anthropic BM…
10 properties
1 required
ToolSearchReturnContent
object
Typed return value of the framework-managed tool-search builtin. Carried on [NativeToolSearchReturnPart.content][pydanticai.messages.NativeToolSearchReturnPart…
2 properties
1 required
BooleanCondition
object
3 properties
1 required
AddressProjectResponse
object
Response for the address create-flow. status is always pending at sync-response time; the async DBOS seed flips it to ready/failed and the seeded layer arrives…
3 properties
3 required
SandboxProjectRequest
object
Single-click county sandbox entry. Caller passes the FIPS code of a county already loaded into their workspace; server creates the project + boundary layer ato…
1 property
1 required
SandboxWarmCountyResponse
object
Confirms the workspace-shared county boundary MV is queryable. Returned synchronously — the response shipping means the MV exists in Neon. The picker is free t…
2 properties
1 required
LoadCapabilityReturn
object
Typed return value for the loadcapability tool.
1 property
LayerPlan
object
A plan for creating a single layer as part of a larger spatial analysis.
6 properties
4 required
TextCondition
object
3 properties
1 required
ToolReturnPart
object
A tool return message, this encodes the result of running a tool.
8 properties
2 required
SandboxProjectResponse
object
Response carrying the new project's id so the client can navigate straight into it. The boundary layer is built asynchronously on a Celery worker — its layerid…
1 property
1 required
ViewUpdateRequest
object
Request model for updating a single view with partial updates. Attributes: view: Partial view data with only the fields to update expectedversion: The view ver…
2 properties
1 required
SetCondition
object
3 properties
NumberCondition
object
5 properties
1 required
ViewsReorderResponse
object
Response model for reordering a project's views. Attributes: success: Boolean indicating if the reorder was successful views: The views in their new order
2 properties
2 required
AddressFeatureGeometryResponse
object
Drawable shape for one candidate: GeoJSON geometry plus its envelope bbox (minlng, minlat, maxlng, maxlat) so the confirm card can draw the boundary and frame…
2 properties
2 required
TextContent
object
String content that is tagged with additional metadata. This is useful for including metadata that can be accessed programmatically by the application, but is…
3 properties
1 required
SpatialFilterSpec
object
A single spatial filter that references another layer with a spatial operation. Used in layer plans to specify how a layer relates spatially to other layers. R…
2 properties
2 required
ToolCallPart
object
A tool call from a model.
8 properties
1 required
TextPart
object
A plain text response from a model.
5 properties
1 required
ShareRevokeResponse
object
Response for DELETE (revoke) share link.
1 property
1 required
ShareInfoResponse
object
Response for GET share info. Three possible states: - Never shared: isshared=False, share=None - Previously shared (revoked): isshared=False, share={isactive:…
6 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Maia-analytics publishes across the network.