generated: '2026-10-13'
method: derived
generator: derive-vocabulary.py
source:
- openapi/timescale-analytics-api-openapi.yml
- openapi/timescale-auth-api-openapi.yml
- openapi/timescale-feedback-api-openapi.yml
- openapi/timescale-health-api-openapi.yml
- openapi/timescale-invites-api-openapi.yml
vocabulary:
  name: Timescale Domain Vocabulary
  description: 'Terms declared by Timescale''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-13'
  terms:
  - term: Services
    definition: Manage services, read replicas, and their associated actions.
    tags:
    - Resource Group
    source: openapi/timescale-services-api-openapi.yml
  - term: VPCs
    definition: Manage VPCs and their peering connections.
    tags:
    - Resource Group
    source: openapi/timescale-vpcs-api-openapi.yml
  - term: IdentifyRequest
    definition: User properties to associate with the authenticated user in analytics.
    tags:
    - Object
    source: openapi/timescale-analytics-api-openapi.yml#/components/schemas/IdentifyRequest
  - term: Error
    definition: Standard error response.
    tags:
    - Object
    source: openapi/timescale-analytics-api-openapi.yml#/components/schemas/Error
  - term: ErrorCode
    definition: Machine-readable error code identifying a specific, client-actionable error condition. Clients can match on this to react to specific
      errors without parsing the human-readable message. Errors without a recognized code omit this field.
    tags:
    - Enumeration
    source: openapi/timescale-analytics-api-openapi.yml#/components/schemas/ErrorCode
  - term: StatusResponse
    definition: Generic success response.
    tags:
    - Object
    source: openapi/timescale-analytics-api-openapi.yml#/components/schemas/StatusResponse
  - term: TrackRequest
    definition: An analytics event to record.
    tags:
    - Object
    source: openapi/timescale-analytics-api-openapi.yml#/components/schemas/TrackRequest
  - term: Error_2
    definition: 'Object declared by the contract with fields: code, message, details.'
    tags:
    - Object
    source: openapi/timescale-analytics-api-openapi.yml#/components/schemas/Error_2
  - term: UserInfo
    definition: Authenticated user details.
    tags:
    - Object
    source: openapi/timescale-auth-api-openapi.yml#/components/schemas/UserInfo
  - term: ApiKeyInfo
    definition: Information about the API key used for authentication.
    tags:
    - Object
    source: openapi/timescale-auth-api-openapi.yml#/components/schemas/ApiKeyInfo
  - term: LogoutRequest
    definition: Request to log out by revoking a refresh token.
    tags:
    - Object
    source: openapi/timescale-auth-api-openapi.yml#/components/schemas/LogoutRequest
  - term: AuthInfo
    definition: Information about the authenticated caller.
    tags:
    - Object
    source: openapi/timescale-auth-api-openapi.yml#/components/schemas/AuthInfo
  - term: AuthInfo_2
    definition: Information about the authentication credentials being used. Exactly one of `apiKey` or `oauth` is populated; the `type` field
      discriminates.
    tags:
    - Object
    source: openapi/timescale-auth-api-openapi.yml#/components/schemas/AuthInfo_2
  - term: FeedbackRequest
    definition: User-submitted feedback or bug report.
    tags:
    - Object
    source: openapi/timescale-feedback-api-openapi.yml#/components/schemas/FeedbackRequest
  - term: MemberRole
    definition: A member's role within a space. The `owner` role belongs to the user who created the space; every space has exactly one owner,
      so `owner` is never accepted as an input when granting a role. On the `Space` schema, this is the caller's own role in the space, omitted
      for API-key authentication (API keys are space-scoped and carry no member identity).
    tags:
    - Enumeration
    source: openapi/timescale-invites-api-openapi.yml#/components/schemas/MemberRole
  - term: ReceivedInvite
    definition: A pending invite the authenticated user has received.
    tags:
    - Object
    source: openapi/timescale-invites-api-openapi.yml#/components/schemas/ReceivedInvite
  - term: InviteActionResult
    definition: Result of accepting or declining a received invite.
    tags:
    - Object
    source: openapi/timescale-invites-api-openapi.yml#/components/schemas/InviteActionResult
  - term: StandardComputePrice
    definition: Pricing for standard (shared) compute used beyond the free monthly allowance.
    tags:
    - Object
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/StandardComputePrice
  - term: ComputePrice
    definition: Compute price for one size.
    tags:
    - Object
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/ComputePrice
  - term: DatabaseSize
    definition: Compute size for dedicated databases. Each step up allocates proportionally more vCPU and RAM.
    tags:
    - Enumeration
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/DatabaseSize
  - term: DedicatedPricing
    definition: Pricing for dedicated databases.
    tags:
    - Object
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/DedicatedPricing
  - term: StandardPricing
    definition: Pricing for standard (non-dedicated) databases, which share a space-wide compute allowance.
    tags:
    - Object
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/StandardPricing
  - term: Pricing
    definition: Pricing data grouped by category.
    tags:
    - Object
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/Pricing
  - term: StoragePrice
    definition: Storage pricing.
    tags:
    - Object
    source: openapi/timescale-pricing-api-openapi.yml#/components/schemas/StoragePrice
  - term: Project
    definition: 'Object declared by the contract with fields: id, name.'
    tags:
    - Object
    source: openapi/timescale-projects-api-openapi.yml#/components/schemas/Project
  - term: ResizeInput
    definition: 'Object declared by the contract with fields: cpu_millis, memory_gbs.'
    tags:
    - Object
    source: openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/ResizeInput
  - term: ReadReplicaSet
    definition: 'Object declared by the contract with fields: id, name, status, nodes, cpu_millis, memory_gbs, metadata, endpoint, connection_pooler.'
    tags:
    - Object
    source: openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/ReadReplicaSet
  - term: Endpoint
    definition: 'Object declared by the contract with fields: host, port.'
    tags:
    - Object
    source: openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/Endpoint
  - term: ConnectionPooler
    definition: 'Object declared by the contract with fields: endpoint.'
    tags:
    - Object
    source: openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/ConnectionPooler
  - term: ReadReplicaSetCreate
    definition: 'Object declared by the contract with fields: name, nodes, cpu_millis, memory_gbs.'
    tags:
    - Object
    source: openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/ReadReplicaSetCreate
  - term: SetEnvironmentInput
    definition: 'Object declared by the contract with fields: environment.'
    tags:
    - Object
    source: openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/SetEnvironmentInput
  - term: ForkStrategy
    definition: 'Strategy for creating the fork: - LAST_SNAPSHOT: Use existing snapshot for fast fork - NOW: Create new snapshot for up-to-date
      fork - PITR: Point-in-time recovery using target_time'
    tags:
    - Enumeration
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ForkStrategy
  - term: UpdatePasswordInput
    definition: 'Object declared by the contract with fields: password.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/UpdatePasswordInput
  - term: MetricSeries
    definition: One labeled time series — the label set plus its per-bucket data points.
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/MetricSeries
  - term: DeployStatus
    definition: 'Enumeration declared by the contract with values: QUEUED, DELETING, CONFIGURING, READY, DELETED, UNSTABLE, PAUSING, PAUSED, RESUMING,
      UPGRADING, OPTIMIZING.'
    tags:
    - Enumeration
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/DeployStatus
  - term: MetricsSeriesRequest
    definition: Parameters for a single getServiceMetricsSeries query. Sent as a JSON body so callers can pass an unbounded filter set without
      query-string length pressure.
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/MetricsSeriesRequest
  - term: EnvironmentTag
    definition: The environment tag for the service.
    tags:
    - Enumeration
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/EnvironmentTag
  - term: ForkSpec
    definition: 'Object declared by the contract with fields: project_id, service_id, is_standby.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ForkSpec
  - term: ServiceLogEntry
    definition: 'Object declared by the contract with fields: timestamp, message, severity.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ServiceLogEntry
  - term: ServiceVPCInput
    definition: 'Object declared by the contract with fields: vpc_id.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ServiceVPCInput
  - term: SetHAReplicaInput
    definition: At least one of sync_replica_count or replica_count must be provided.
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/SetHAReplicaInput
  - term: ServiceType
    definition: 'Enumeration declared by the contract with values: TIMESCALEDB, POSTGRES, VECTOR.'
    tags:
    - Enumeration
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ServiceType
  - term: MetricLabelFilter
    definition: A single key/value label match applied to a metric series query.
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/MetricLabelFilter
  - term: ServiceLogs
    definition: 'Object declared by the contract with fields: logs, entries, lastCursor.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ServiceLogs
  - term: ServiceCreate
    definition: 'Object declared by the contract with fields: name, addons, region_code, replica_count, cpu_millis, memory_gbs, environment_tag.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ServiceCreate
  - term: HAReplica
    definition: 'Object declared by the contract with fields: sync_replica_count, replica_count.'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/HAReplica
  - term: ForkServiceCreate
    definition: Create a fork of an existing service. Service type, region code, and storage are always inherited from the parent service. HA
      replica count is always set to 0 for forked services.
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/ForkServiceCreate
  - term: MetricDataPoint
    definition: A single time/value pair within a MetricSeries.
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/MetricDataPoint
  - term: Service
    definition: 'Object declared by the contract with fields: service_id, project_id, name, region_code, service_type, created, initial_password,
      status, resources, metadata, endpoint, vpcEndpoint. (4 more)'
    tags:
    - Object
    source: openapi/timescale-services-api-openapi.yml#/components/schemas/Service
  - term: CreateSpaceRequest
    definition: Request to create a new space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/CreateSpaceRequest
  - term: CreateApiKeyRequest
    definition: Request to create a new API key in a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/CreateApiKeyRequest
  - term: Member
    definition: A member of a Ghost space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/Member
  - term: Space
    definition: A Ghost space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/Space
  - term: RenameDatabaseRequest
    definition: Request to rename a database.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/RenameDatabaseRequest
  - term: DatabaseType
    definition: Database deployment model. - `standard` — shared-resource databases subject to the space's compute and storage limits. - `dedicated`
      — per-instance paid databases with guaranteed resources, exempt from space-level auto-pause.
    tags:
    - Enumeration
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/DatabaseType
  - term: ApiKeyCredentials
    definition: Credentials for a newly created API key. The secret portion cannot be retrieved again later.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/ApiKeyCredentials
  - term: UpdateMemberRoleRequest
    definition: Request to change a member's role within a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/UpdateMemberRoleRequest
  - term: LogsResponse
    definition: A page of database log entries.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/LogsResponse
  - term: UpdatePasswordRequest
    definition: Request to reset the database password.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/UpdatePasswordRequest
  - term: ShareDatabaseRequest
    definition: Options for creating a database share.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/ShareDatabaseRequest
  - term: Invite
    definition: An invite sent for a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/Invite
  - term: LeaveSpaceResult
    definition: Result of leaving a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/LeaveSpaceResult
  - term: PaymentMethod
    definition: A payment method on file for a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/PaymentMethod
  - term: InvoiceDetail
    definition: Line-item breakdown of an invoice.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/InvoiceDetail
  - term: InvoiceLineItem
    definition: A single line item on an invoice.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/InvoiceLineItem
  - term: RenameSpaceRequest
    definition: Request to rename a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/RenameSpaceRequest
  - term: DatabaseStatus
    definition: Current lifecycle status of the database.
    tags:
    - Enumeration
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/DatabaseStatus
  - term: ApiKey
    definition: An API key in a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/ApiKey
  - term: RenameSpaceResult
    definition: Result of renaming a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/RenameSpaceResult
  - term: DatabaseShare
    definition: A shareable snapshot of a database. Can be used to create a new database from the snapshot in another space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/DatabaseShare
  - term: PaymentSetupResponse
    definition: Stripe Setup Intent details for collecting a new payment method.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/PaymentSetupResponse
  - term: DatabaseWithUsage
    definition: A Ghost database with current billing-cycle usage included.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/DatabaseWithUsage
  - term: PaymentMethodsResponse
    definition: A list of payment methods on file for a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/PaymentMethodsResponse
  - term: LogEntry
    definition: A single database log entry.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/LogEntry
  - term: Invoice
    definition: Invoice summary.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/Invoice
  - term: InviteStatus
    definition: Status of a sent invite. `pending` means it's still awaiting a response; `declined` means the invitee declined it. A declined
      invite still occupies the email's slot for the space (one pending-or-declined invite per email), so it must be cancelled before that email
      can be re-invited.
    tags:
    - Enumeration
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/InviteStatus
  - term: ForkDatabaseRequest
    definition: Request body for forking a database. Fields default to the source database's values when omitted.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/ForkDatabaseRequest
  - term: InvoicesResponse
    definition: A list of invoices for a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/InvoicesResponse
  - term: CreateDatabaseRequest
    definition: Request to create a new database in a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/CreateDatabaseRequest
  - term: CreateInviteRequest
    definition: Request to invite a user to a space.
    tags:
    - Object
    source: openapi/timescale-spaces-api-openapi.yml#/components/schemas/CreateInviteRequest