Codes API

Code is an asset that manages Python scripts or SQL queries for data processing.

1. List Codes

Request

GET /codes/

2. Create Code (Metadata)

Creates metadata for a code asset. (Actual file contents are uploaded via a separate API)

Request

POST /codes/

Body Schema (Code)

Field	Type	Required	Description
name	string	Yes	Code asset name
type	string	No	Code type (python, sql, etc.)
options	object	No	Execution options or environment settings

Example

{
  "name": "etl_script_v1",
  "type": "python",
  "tags": ["etl", "daily"]
}

3. Upload Code File

Uploads the actual script content of the code asset.

Request

PUT /codes/{code_id}/file

• Content-Type: application/octet-stream (or text/plain)
• Body: Full script text

Example

import pandas as pd

def process(df):
    df['processed'] = True
    return df

4. Get Code File

Downloads the stored code script content.

Request

GET /codes/{code_id}/file

Response

• Content-Type: application/octet-stream
• Body: Script text

5. Get Code File Versions

Retrieves the change history (versions) of the code file.

Request

GET /codes/{code_id}/file/versions

Response

[
  {
    "version": "v1",
    "is_latest": false,
    "last_modified": 1704000000000
  },
  {
    "version": "v2",
    "is_latest": true,
    "last_modified": 1704090000000
  }
]