Skip to main content
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

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

Describes known settings. Optional enableOnSetting annotations describe visibility in a configuration UI; they do not change settings validation. Additional settings remain accepted. List-valued text settings accept JSON string arrays when advertised by the field schema. Array elements remain separate values, including embedded commas or newlines.

Show child attributes
object

Describes known settings. Optional enableOnSetting annotations describe visibility in a configuration UI; they do not change settings validation. Additional settings remain accepted. List-valued text settings accept JSON string arrays when advertised by the field schema. Array elements remain separate values, including embedded commas or newlines.

Additional properties are supported.

outputSchemaobjectrequired

Known output fields. Results omit legacy compatibility status fields and can include extra data fields. enableOnSetting explains which settings use a field; it never filters results.

Show child attributes
object

Known output fields. Results omit legacy compatibility status fields and can include extra data fields. enableOnSetting explains which settings use a field; it never filters results.

Additional properties are supported.

limitsobjectrequired
Show child attributes
executionDeadlineSecondsinteger