Skip to main content
POST
/
v0
/
events
Create Lineage Events
curl --request POST \
  --url https://{hostname}.gable.ai/v0/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "paths": [
    {
      "ingress": {
        "signature_name": "<string>",
        "schema": {
          "type": "struct",
          "name": "<string>",
          "fields": [
            {
              "type": "struct",
              "name": "<string>",
              "fields": "<array>",
              "alias": "<string>",
              "doc": "<string>",
              "logical": "<string>",
              "optional": true
            }
          ],
          "alias": "<string>",
          "doc": "<string>",
          "logical": "<string>"
        },
        "kind": "<string>",
        "description": "<string>",
        "id": "<string>",
        "payload_name": "<string>"
      },
      "egress": {
        "signature_name": "<string>",
        "schema": {
          "type": "struct",
          "name": "<string>",
          "fields": [
            {
              "type": "struct",
              "name": "<string>",
              "fields": "<array>",
              "alias": "<string>",
              "doc": "<string>",
              "logical": "<string>",
              "optional": true
            }
          ],
          "alias": "<string>",
          "doc": "<string>",
          "logical": "<string>"
        },
        "kind": "<string>",
        "description": "<string>",
        "id": "<string>",
        "payload_name": "<string>"
      },
      "code_anchors": [
        {
          "anchor_id": "<string>",
          "code_uri": {
            "file": "<string>",
            "line_start": 123,
            "column_start": 123,
            "line_end": 123,
            "column_end": 123
          }
        }
      ],
      "field_mappings": [
        {
          "ingress_field": "<string>",
          "egress_field": "<string>",
          "notes": "<string>",
          "field_data_flow_path": [
            {
              "anchor_id": "<string>",
              "code_uri": {
                "file": "<string>",
                "line_start": 123,
                "column_start": 123,
                "line_end": 123,
                "column_end": 123
              }
            }
          ]
        }
      ],
      "transformation_summary": "<string>",
      "transformation_summary_detailed": "<string>",
      "payload_name": "<string>"
    }
  ],
  "run_id": "<string>",
  "type": "CODE",
  "job_id": "<string>",
  "is_final_chunk": true,
  "external_component_id": "<string>",
  "metadata": {
    "extras": {}
  },
  "name": "<string>"
}
'
{
  "message": "<string>",
  "id": 123,
  "title": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Body

application/json

event to create

API request for uploading code lineage paths

paths
object[]
required
run_id
string
required

The ID of the run that the paths belong to

type
enum<string>
required

The type of data being uploaded

Available options:
CODE
job_id
string

The job ID for a continuing chunked upload. Required on continuation chunks.

is_final_chunk
boolean

Whether this is the final chunk for the run. Controls job completion.

upload_context
object
external_component_id
string

Optional ID of the external component that was analyzed

metadata
object

Additional metadata for the component.

name
string

The name of the component that was analyzed

Response

Lineage Event was created