Skip to main content
GET
/
v0
/
component
/
{id}
Get a component by id
curl --request GET \
  --url https://{hostname}.gable.ai/v0/component/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runId": "<string>",
  "name": "<string>",
  "ingresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "schema": {
        "name": "<string>",
        "fields": [
          {
            "name": "<string>",
            "fields": "<array>",
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>",
            "optional": true
          }
        ],
        "alias": "<string>",
        "doc": "<string>",
        "logical": "<string>"
      },
      "signatureName": "<string>"
    }
  ],
  "egresses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "schema": {
        "name": "<string>",
        "fields": [
          {
            "name": "<string>",
            "fields": "<array>",
            "alias": "<string>",
            "doc": "<string>",
            "logical": "<string>",
            "optional": true
          }
        ],
        "alias": "<string>",
        "doc": "<string>",
        "logical": "<string>"
      },
      "signatureName": "<string>"
    }
  ],
  "paths": [
    {
      "ingress": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>"
      },
      "egress": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "codeAnchorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>"
      },
      "codeAnchors": [
        {
          "anchorId": "<string>",
          "name": "<string>",
          "codeUri": {
            "file": "<string>",
            "lineStart": 123,
            "columnStart": 123,
            "lineEnd": 123,
            "columnEnd": 123
          },
          "url": "<string>"
        }
      ],
      "fieldMappings": [
        {
          "ingressField": "<string>",
          "egressField": "<string>",
          "notes": "<string>"
        }
      ],
      "transformationSummary": "<string>",
      "transformationSummaryDetailed": "<string>"
    }
  ],
  "type": "<string>",
  "metadata": {
    "extras": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.gable.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string<uuid>
required

UUID of the component

Response

200 - application/json

Full component

​
id
string<uuid>
required

The unique identifier for the component.

​
runId
string
required

The ID of the run that the component belongs to

​
name
string
required

The name of the component.

​
ingresses
object[]
required

The ingresses associated with the component.

​
egresses
object[]
required

The egresses associated with the component.

​
paths
object[]
required

The paths associated with the component.

​
type
string
required

The type of the component.

Allowed value: "CODE"
​
metadata
object