Catalog

Get a source schema

Read the settings and output schemas for one source, along with its limits. No authentication is required. Use the returned ID as sourceId when creating a task. Sources need settings, not input rows.

get/v1/sources/{sourceId}

Path parameters

sourceIdstringrequired

Response

200404

Resolved public schema and limits

200 · application/json

@idstringrequired

@typestringrequired

const: "Source"

namestringrequired

descriptionstringrequired

coststring | null

Human-readable pricing description. Null when unavailable; actual credit usage is returned with task results.

schemaVersionstringrequired

settingsSchemaobjectrequired

Fields accepted in settings. enableOnSetting explains when to show a field in a settings form; it does not change validation. Extra settings are accepted.

Show child attributes

object

Fields accepted in settings. enableOnSetting explains when to show a field in a settings form; it does not change validation. Extra settings are accepted.

Additional properties are supported.

outputSchemaobjectrequired

Known output fields. enableOnSetting explains which settings use a field. Results can include extra fields; these rules never remove returned data.

Show child attributes

object

Known output fields. enableOnSetting explains which settings use a field. Results can include extra fields; these rules never remove returned data.

Additional properties are supported.

limitsobjectrequired

Show child attributes

executionDeadlineSecondsinteger

Get a source schema

PythoncURLJavaScriptPHPGo

import requests

url = "https://api.datablist.com/v1/sources/<sourceId>"

headers = {
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)

Response · illustrative example

200404

{
  "@id": "string",
  "@type": "Source",
  "name": "string",
  "description": "string",
  "cost": "string",
  "schemaVersion": "string",
  "settingsSchema": {},
  "outputSchema": {},
  "limits": {
    "executionDeadlineSeconds": 0
  }
}