Sources

Create a source

Changed on

The source's origin must be approved for the workspace. Version 1 of the recipe is recorded.

post/v1/sources

Request

  • Base URL: https://sourcefinch.com
  • URL: https://sourcefinch.com/v1/sources
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes retries safe for 24 hours. Reusing a key with a different request returns 422.

X-Request-Idstring

Echoed in the response and logs; generated when absent.

SourceFinch-Projectstring uuid

Project UUID. Required for session tokens; API keys are bound to their project.

Request body

namestring required
urlstring uri required
rightstrue required

Confirms you have the right to collect this source (Terms §4)

schedule'manual' | 'hourly' | 'daily' | 'weekly'
key_fieldstring nullable

Response

The created source

idstring uuid required
project_idstring uuid required
namestring required
urlstring required
recipeobject required

A recipe@1 document (see the Recipe schema)

versioninteger required
recipe_version_idstring uuid nullable

The immutable reviewed recipe version, or null for a custom source

schedule'manual' | 'hourly' | 'daily' | 'weekly' required
key_fieldstring nullable required
next_run_atstring nullable required

ISO-8601 timestamp (UTC)

created_atstring required

ISO-8601 timestamp (UTC)

updated_atstring required

ISO-8601 timestamp (UTC)

Changes

  • 190cbe57a5e8Revision changes
    • info

      added the new optional request property ////

    • info

      added the new optional request property ////