API and agentsAPI reference
Schemas
The shared schemas the API's operations refer to, each on a page of its own.
189 schemas, in the description's order. A schema named in an operation or in another schema links to its page.
AccountAccountSessionAuthEntrySignedOutPersonA person a resource names where the app draws their face, such as its owner.WrittenInWhere SQL or a dataset name was written: the context whose names it uses.ApiTokenCreatedApiTokenApiTokensPasswordChangedTokenRevokedAccountDeletionStatusAccountDeletionProgressPendingAccountDeletionAccountDeletionPreviewAccountDeletionPreviewResultUserInvitationConflictUsersIssuedSignInLinkInstanceSettingsPatchInstanceSettingsClearedServiceCachesServiceTestAnswerA service's Test: passed, with the milliseconds the service took to answer (Overture: how many releases its listing names and the newest; templates: how many templates the catalogue's index lists, with the milliseconds), or failed with one reason: not_set_up (no address), refused (the egress rules refused it, or the satellite tile template carries a user name or password; message is the refusal's sentence), unreachable (nothing answered), timed_out (no answer within the service's time limit), status (an answer with that status) or unexpected_answer (an answer, but not as the service gives one).StorageReadWhat the data folder holds, by kind (tables, tile_archives, service_caches, thumbnails, profile_pictures, templates, metadata_database, leftover_files, other).PartTestAnswerA part's Test: passed, with the milliseconds the check took, or failed with one reason: not_found (a program, or the spatial extension, is not where its setting points), busy (the part is busy with other work), timed_out (no answer within the Test's own limit) or failed.LibraryStyleA style in the basemap library.LibraryStyleAddLibraryStyleOfferedLibraryStyleRemovedTemplateSourceTemplateCardOne template as its card draws it.TemplateDetailOne template: its card, how it is made, and what its version holds once installed.TemplateDatasetA dataset of an installed template version, or a step's bundled result.TemplateContentsWhat an installed template version holds, read from this server: its map's id, its datasets and a workflow example's workflow.TemplateCatalogueStateWhere the template catalogue stands for this list.TemplateFetchedA template's version, installed on this server.TemplateCopyThe project a copy made, with its members: the copied map, the copied workflow of a workflow example, and the copied datasets.TemplateDownloadsWhat the downloaded templates hold on this server, which DELETE /api/templates/downloads frees.TemplateListExportImageDefinitionAn image export, fully resolved: exact output pixels (the aspect is entailed), the camera, how large the map is drawn, bounded placement and a size step for every element, the included widgets, an optional title, and an optional basemap override for this image alone.MapLookStateThe bounded state identity a check's image is attributed to: what the renderer actually drew, declared by the render page itself, never a later read of the map.MapLookRenderA check's facts: everything but the image bytes, which never enter an event or a receipt.RecordedMapLookStateThe bounded state identity a check's image is attributed to: what the renderer actually drew, declared by the render page itself, never a later read of the map.RecordedMapLookRenderA check's facts: everything but the image bytes, which never enter an event or a receipt.MapLookOvertureScopeWhere an Overture import applies.FeaturePreviewA Run Query result: the features the matching import would land, capped by the render cap and bounded by Bytes drawn per layer.ErrorHealthHealthUnreadyDependencyDatasetOne dataset a map or workflow depends on — the facts both filing checklists carry.MapDependenciesWorkflowDependenciesWorkspaceSettingsConfigSearchResultsThe grouped map-search answer.OperationCatalogThe verbs this instance offers, as data.OperationMeasurementWhere a run measured.OperationDryRunThe answer to dryRun: what the operation would produce, with nothing written.OperationRunOne run of an operation.OperationRunEnvelopeOperationRunListStaleCauseWhy a step's output no longer reflects what it was made from.RecipeStepRecipeRecipeSummaryThe recipe's one-line state, computed by the server so the workflows page and an agent read the same classification.RecipeEnvelopeRecipeListRecipeStepEnvelopeRecipeStepEditedRecipeStepRemovedRecipeStepDiscardedLayoutPositionCanvas units at the canvas's natural zoom.LayoutNoteA layout-only annotation: no reads, no output, no state, no place in a run.RecipeLayoutInputThe whole document.RecipeLayoutRecipeLayoutEnvelopeRecipeDeletedRecipeRunAttemptWhat became of a member's attempt: the job's state, error, times and output, composed from the live job while it is in flight — soqueuedis told fromrunning— and kept with the run once it settles, so the run still says why a member failed after the node's own history is pruned.RecipeRunMemberRecipeRunA recipe run is not an operation run.RecipeRunEnvelopeRecipeRunListRecipeRunStartedRecipeRunPlanGeometryCrsGeometrySampleGeometryCandidateGeometryRecordGeometryChoiceOne exact source column, or two distinct numeric or text-typed coordinate columns in x/y order for pair.GeometryRequestGeometryIssueGeometryInspectionGeometryPreviewGeometryMutationGeometryProjectionGeometryProjectionsTableTableListImportResultAn import answer.PgConnectionA saved PostGIS connection.PgConnectionListTableInspectionColumnListQueryResultLegendCornerWhere the map legend sits, on the builder canvas and the published view alike.LegendOrderThe manual legend arrangement: layer ids in legend order, top first.BasemapAttributionThe active basemap's credit lines, rendered on the builder canvas and the published view; a line with an href renders as a link.CustomBasemapA per-map custom basemap style: the MapLibre style URL, its optional display name, and the attribution snapshot captured server-side at save time — the credit that stays truthful when the style itself cannot be read later.SanitizedIconThe custom-icon sanitizer's answer: the accepted markup (byte-identical to the input when nothing needed removing), whether anything changed, the bounded drop report, and the aspect ratio the renderer derives its raster box from.StyleInspectionThe advisory verdict on a custom basemap style URL.BasemapLayersPer-group basemap visibility: labels, roads, borders, buildings, water, land.MapNoteThe map's one optional info box, shown in a map corner on the builder canvas and the published view.ViewportThe map camera: pitch 0 to 60 degrees, latitude -85.051129 to 85.051129 degrees, zoom -2 to 24, all finite and inclusive.MapTimelineThe map's docked playback timeline — at most one per map.MapWidgetOne dashboard card: a formula (headline aggregate), category (top 5 + Other ranking; clicking a row EXCLUDES it), histogram (distribution with a brushable range), or note (authored title + body, no data).WidgetListThe map's widgets, in rail order (at most 12).WidgetSelectionsEphemeral cross-filter state: at most one entry per widget — {widgetId, kind: 'exclude', values} names a category widget's DEACTIVATED categories (all categories are active by default; Other and unlisted categories stay); {widgetId, kind: 'range', min, max} is a histogram brush (null bounds are open-ended).WidgetValuesBatched widget values.ResourceOwnerA person a resource names: its owner, or the account whose SQL home it is.MapPresenceWhat every map read and listing carries beyond the stored map, the same for the caller's own maps as for maps shared with them.MapCreatedMapMapOverviewMapListProjectAn optional named set over maps, workflows and datasets, with its member counts and size composed in.ProjectListProjectCreatedProjectMembersChangedProjectMembersA project's members, each kind in its ordinary listing shape.ProjectMemberChangeOne atomic membership change: adds and removes together — all applied or none.ProjectDepartureProjectPersonOne of a project's people: never an email or an account identity.DirectoryPersonA person the directory offers: their display name, their SQL name and their picture's version, nothing else.AccountDirectoryDocumentTransferTransferA completed transfer: the resource's identity and its new owner.ProjectPeopleMapWithLayersMapUpdateHistoryTargetHistoryUndo/redo availability on the map's timeline.MapWithHistoryFillPaintA color paint, serving the fill and the data-driven outline: {type: 'constant', color} · categorical {attribute, palette, map: [{value, color}], other} · ramp {type: 'quantile', attribute, palette, method: quantile|equal|natural|custom, breaks, colors, optional classes} (breaks strictly ascending, one fewer than colors) · continuous {type: 'continuous', attribute, palette, domain: [low, high], stops, optional clamp: [low, high], log, center, positions, reversed} (values interpolate smoothly along the stops over the domain; clamp narrows the effective domain, values outside take the end colors; log needs a strictly positive effective domain; center splits the ramp for diverging reads and starts at the mean when a diverging palette is applied).CustomPaletteA saved custom palette: a named gradient of ordered color stops, instance-global, usable wherever palettes are offered (continuous and classified).PaletteOfferEverything the palette picker offers: the curated catalogue and the saved custom palettes.SizeScaleNumeric attribute → pixel-size mapping.AggregateWhat each cell shows: {fn: 'count'}, or {fn: 'sum' | 'avg' | 'min' | 'max', attribute} over a numeric attribute.VizHow the layer's result is drawn.OdEndpointOne arc/line endpoint: a geometry column of the layer's result ({kind: 'geometry', field}) or a pair of numeric longitude/latitude columns ({kind: 'lonlat', lon, lat}).LayerFilterA structured refinement of the layer's result, applied before aggregation.FieldStatsA field's extent and distribution (numeric and time fields) or distinct values (text; bounded, by frequency), for seeding filter controls and the ramp's distribution.StyleA layer's full visual definition.LayerLayerListLayerCreateLayerUpdatePublishedFieldsStatementPer-layer statement of the effective published field set.LayerRenderSliderPreviewDataBounded point input for transient builder slider previews.LayerTilesHow a tiled layer stands.FieldListLayerFieldsLayerExtentA layer's current data extent.EditRevisionResultPublishStateViewerControlsWhich optional reader controls a publication exposes.PublicationStateAn active publication's authored settings.PublishedViewTableCatalogueAssistantContextOptional page grounding, at most 64 KiB of UTF-8 JSON.AssistantSqlResultSummaryThe result of this exact executed SQL.AssistantEffectsAssistantConfirmationAssistantSubjectThe subject of an action as resolved when it happened: its resource, its identity when the call or response named one, and its display name when one was carried.AssistantHistoryWhere a change qualifies for a map's history: the map and the change group the turn stamped.AssistantObservationThe observation attached to a map check: a separate fact recorded when the model's subsequent text arrived, never a change to the check's outcome.AssistantActionA known attempted action, never a raw tool-result body.AssistantConfirmationRecordA settled confirmation, kept in the receipt when its pending representation goes: the exact action and the words as presented, with the decision.AssistantPendingActionExact open action, bound to the original run and target.AssistantModelChoiceA model a request may choose on this instance.AssistantCatalogueStateThe current local model catalogue.AssistantProvenanceWhat a run asked for and what its provider answers reported.AssistantPolicyA page's action policy and default offer.AssistantPendingListAssistantRunRead-only progress snapshot.AssistantStatusAssistantRequestEither a message (optionally with history and a superseded pending action) or a resolution, never both.AssistantEventOne streamed event.
Dezfil · Apache-2.0docs from
7439201b