Georgia Civic Data Datatalk API

openapi: 3.2.0
info:
  title: Georgia Civic Data Datatalk API
  description: 'Read-only REST API serving cleaned, standardized tabular data for the state of Georgia: **education**, **census**, **health** and **immigration**, driven entirely by git-tracked ODCS data contracts — so every dataset''s columns, units, ranges, and allowed values are stable and documented.


    **Base path:** all data routes live under `/api/v1`. Every dataset is addressed by its bare name (names are unique), e.g. `act_scores`.


    **Discover, don''t hard-code.** `GET /api/v1/datasets` lists every dataset (compact; `?fields=full` for everything); `GET /api/v1/search?q=` finds one by meaning; `GET /api/v1/datasets/{name}` returns its schema (columns, units, the exact filter parameters with their allowed values, and a runnable `recommended_query` URL); `GET /api/v1/datasets/{name}/rows` returns the data.


    **Note on filters:** every categorical column of a dataset is its own filter parameter, so the filters differ per dataset and are listed in the dataset''s schema (`filters`), not in this generic document. `GET /api/v1/datasets/{name}/openapi.json` is a per-dataset OpenAPI document with every filter and its allowed values, for function-calling clients that need one. Human docs: https://georgiacivicdata.org/api; agent reference: https://georgiacivicdata.org/llms-full.txt.


    **R and Python packages:** `georgiacivicdata` on CRAN and PyPI wraps this API and returns data frames. Docs: https://georgiacivicdata.org/r/ and https://georgiacivicdata.org/py/ (overview: https://georgiacivicdata.org/packages).


    **License:** data and documentation are licensed CC BY 4.0. Credit "Georgia Civic Data (georgiacivicdata.org)" and the original source. The license covers our cleaning, standardization, compilation, and documentation; source data stays under its original publisher''s terms (each dataset names its source). Every response carries a `Link: ; rel="license"` header, and `GET /api/v1/datasets` returns the terms as a `license` object. Details: https://georgiacivicdata.org/about#license.'
  contact:
    name: Georgia Civic Data
    url: https://georgiacivicdata.org/api
    email: shane@georgiacivicdata.org
  license:
    name: Creative Commons Attribution 4.0 International (CC BY 4.0)
    url: https://creativecommons.org/licenses/by/4.0/
  version: 0.2.0
servers:
- url: https://georgiacivicdata.org
  description: Production (brand domain, same-origin proxy)
- url: https://georgia-civic-data-production.up.railway.app
  description: Production (origin)
tags:
- name: datatalk
paths:
  /api/v1/datatalk/sessions:
    post:
      tags:
      - datatalk
      summary: Create Session
      operationId: create_session_api_v1_datatalk_sessions_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSessionBody'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/datatalk/sessions/{session_id}/messages:
    post:
      tags:
      - datatalk
      summary: Post Message
      operationId: post_message_api_v1_datatalk_sessions__session_id__messages_post
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageBody'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/datatalk/sessions/{session_id}/results/{result_id}.xlsx:
    get:
      tags:
      - datatalk
      summary: Download Excel
      operationId: download_excel_api_v1_datatalk_sessions__session_id__results__result_id__xlsx_get
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      - name: result_id
        in: path
        required: true
        schema:
          type: string
          title: Result Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/datatalk/sessions/{session_id}/analyses/{analysis_id}.py:
    get:
      tags:
      - datatalk
      summary: Download Analysis Script
      description: 'The standalone Python reproduction of one computed analysis

        (mirrors the Excel endpoint: re-rendered on demand, nothing stored).'
      operationId: download_analysis_script_api_v1_datatalk_sessions__session_id__analyses__analysis_id__py_get
      parameters:
      - name: session_id
        in: path
        required: true
        schema:
          type: string
          title: Session Id
      - name: analysis_id
        in: path
        required: true
        schema:
          type: string
          title: Analysis Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CreateSessionBody:
      properties:
        locale:
          type: string
          title: Locale
          default: en
        transcript:
          anyOf:
          - items:
              $ref: '#/components/schemas/TranscriptTurn'
            type: array
            maxItems: 80
          - type: 'null'
          title: Transcript
      type: object
      title: CreateSessionBody
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TranscriptTurn:
      properties:
        role:
          type: string
          enum:
          - user
          - assistant
          title: Role
        text:
          type: string
          maxLength: 8000
          minLength: 1
          title: Text
      type: object
      required:
      - role
      - text
      title: TranscriptTurn
    MessageBody:
      properties:
        message:
          type: string
          maxLength: 2000
          minLength: 1
          title: Message
      type: object
      required:
      - message
      title: MessageBody
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError