Skip to main content
POST
Start a durable import job

Authorizations

Authorization
string
header
required

Permanent personal API key created in the dashboard. Example: curl -H "Authorization: Bearer aty_…" https://your-host/v1/projects

Headers

Idempotency-Key
string

Optional caller-provided idempotency key.

Maximum string length: 200

Query Parameters

responseFormat
enum<string>
default:compact

Compact is the default: answer, deduplicated sources, outcome, and top-level billing. Use legacy explicitly for the previous detailed format. Applies only to this HTTP response. Does not change execution.

Available options:
legacy,
compact
include
string

Optional comma-separated details: artifacts,evidence,diagnostics. Requires responseFormat=compact. Evidence sourceId points to result.sources[].id. Details are omitted unless requested.

Maximum string length: 100
Example:

"evidence,diagnostics"

Body

application/json
provider
enum<string>
required
Available options:
youtube
Example:

"youtube"

kind
enum<string>
required
Available options:
video,
channel,
playlist,
comments,
deep-comments
entityId
string
required
projectId
string
idempotencyKey
string
Maximum string length: 200

Response

Import queued or an existing idempotent job returned.

id
string
required
status
string
required
progress
integer
required
Required range: 0 <= x <= 100